lusid-sdk 2.0.50b0__py3-none-any.whl → 2.1.684__py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- lusid/__init__.py +1647 -15
- lusid/api/__init__.py +87 -0
- lusid/api/abor_api.py +807 -305
- lusid/api/abor_configuration_api.py +72 -70
- lusid/api/address_key_definition_api.py +30 -29
- lusid/api/aggregation_api.py +41 -40
- lusid/api/allocations_api.py +83 -71
- lusid/api/amortisation_rule_sets_api.py +1101 -0
- lusid/api/application_metadata_api.py +30 -29
- lusid/api/blocks_api.py +45 -44
- lusid/api/calendars_api.py +492 -142
- lusid/api/chart_of_accounts_api.py +2488 -644
- lusid/api/complex_market_data_api.py +41 -40
- lusid/api/compliance_api.py +1147 -444
- lusid/api/configuration_recipe_api.py +1237 -94
- lusid/api/conventions_api.py +111 -110
- lusid/api/corporate_action_sources_api.py +98 -97
- lusid/api/counterparties_api.py +75 -74
- lusid/api/custom_data_models_api.py +1043 -0
- lusid/api/custom_entities_api.py +116 -115
- lusid/api/custom_entity_definitions_api.py +39 -38
- lusid/api/custom_entity_types_api.py +39 -38
- lusid/api/cut_label_definitions_api.py +57 -64
- lusid/api/data_types_api.py +417 -97
- lusid/api/derived_transaction_portfolios_api.py +21 -20
- lusid/api/entities_api.py +1110 -13
- lusid/api/executions_api.py +49 -48
- lusid/api/fee_types_api.py +1053 -0
- lusid/api/fund_configuration_api.py +1120 -0
- lusid/api/funds_api.py +4402 -0
- lusid/api/group_reconciliations_api.py +2497 -0
- lusid/api/instrument_event_types_api.py +1288 -0
- lusid/api/instrument_events_api.py +232 -42
- lusid/api/instruments_api.py +391 -211
- lusid/api/legacy_compliance_api.py +87 -86
- lusid/api/legal_entities_api.py +201 -200
- lusid/api/order_graph_api.py +46 -45
- lusid/api/order_instructions_api.py +45 -44
- lusid/api/order_management_api.py +1537 -67
- lusid/api/orders_api.py +58 -65
- lusid/api/packages_api.py +45 -44
- lusid/api/participations_api.py +39 -38
- lusid/api/persons_api.py +342 -182
- lusid/api/placements_api.py +51 -50
- lusid/api/portfolio_groups_api.py +263 -254
- lusid/api/portfolios_api.py +1343 -417
- lusid/api/property_definitions_api.py +304 -98
- lusid/api/queryable_keys_api.py +212 -0
- lusid/api/quotes_api.py +106 -121
- lusid/api/reconciliations_api.py +548 -2115
- lusid/api/reference_lists_api.py +41 -40
- lusid/api/reference_portfolio_api.py +215 -38
- lusid/api/relation_definitions_api.py +30 -29
- lusid/api/relations_api.py +22 -21
- lusid/api/relationship_definitions_api.py +48 -47
- lusid/api/relationships_api.py +23 -22
- lusid/api/schemas_api.py +46 -53
- lusid/api/scopes_api.py +192 -11
- lusid/api/scripted_translation_api.py +105 -102
- lusid/api/search_api.py +39 -38
- lusid/api/sequences_api.py +39 -38
- lusid/api/simple_position_portfolios_api.py +213 -0
- lusid/api/staged_modifications_api.py +763 -0
- lusid/api/staging_rule_set_api.py +886 -0
- lusid/api/structured_result_data_api.py +90 -89
- lusid/api/system_configuration_api.py +66 -65
- lusid/api/tax_rule_sets_api.py +48 -47
- lusid/api/timelines_api.py +1307 -0
- lusid/api/transaction_configuration_api.py +124 -123
- lusid/api/transaction_fees_api.py +48 -47
- lusid/api/transaction_portfolios_api.py +1454 -925
- lusid/api/translation_api.py +21 -20
- lusid/api/workspace_api.py +3482 -0
- lusid/api_client.py +31 -20
- lusid/api_response.py +1 -1
- lusid/configuration.py +102 -8
- lusid/extensions/__init__.py +12 -7
- lusid/extensions/api_client.py +28 -18
- lusid/extensions/api_client_factory.py +168 -45
- lusid/extensions/api_configuration.py +172 -14
- lusid/extensions/configuration_loaders.py +117 -20
- lusid/extensions/configuration_options.py +67 -0
- lusid/extensions/file_access_token.py +42 -0
- lusid/extensions/proxy_config.py +8 -5
- lusid/extensions/rest.py +78 -26
- lusid/extensions/retry.py +109 -37
- lusid/extensions/socket_keep_alive.py +14 -15
- lusid/extensions/tcp_keep_alive_connector.py +93 -46
- lusid/models/__init__.py +1537 -14
- lusid/models/a2_b_breakdown.py +9 -1
- lusid/models/a2_b_category.py +9 -1
- lusid/models/a2_b_data_record.py +9 -1
- lusid/models/a2_b_movement_record.py +9 -1
- lusid/models/abor.py +18 -3
- lusid/models/abor_configuration.py +17 -9
- lusid/models/abor_configuration_properties.py +9 -1
- lusid/models/abor_configuration_request.py +18 -10
- lusid/models/abor_properties.py +9 -1
- lusid/models/abor_request.py +10 -2
- lusid/models/accept_estimate_valuation_point_response.py +108 -0
- lusid/models/access_controlled_action.py +9 -1
- lusid/models/access_controlled_resource.py +9 -1
- lusid/models/access_metadata_operation.py +12 -4
- lusid/models/access_metadata_value.py +10 -2
- lusid/models/account.py +16 -3
- lusid/models/account_properties.py +9 -1
- lusid/models/accounted_transaction.py +96 -0
- lusid/models/accounting_method.py +10 -0
- lusid/models/accounts_upsert_response.py +9 -1
- lusid/models/accumulation_event.py +112 -0
- lusid/models/action_id.py +10 -2
- lusid/models/add_business_days_to_date_request.py +9 -1
- lusid/models/add_business_days_to_date_response.py +9 -1
- lusid/models/additional_payment.py +12 -4
- lusid/models/address_definition.py +9 -1
- lusid/models/address_key_compliance_parameter.py +13 -12
- lusid/models/address_key_definition.py +9 -1
- lusid/models/address_key_filter.py +9 -1
- lusid/models/address_key_list.py +13 -5
- lusid/models/address_key_list_compliance_parameter.py +12 -4
- lusid/models/address_key_option_definition.py +12 -2
- lusid/models/adjust_global_commitment_event.py +101 -0
- lusid/models/adjust_holding.py +9 -1
- lusid/models/adjust_holding_for_date_request.py +9 -1
- lusid/models/adjust_holding_request.py +9 -1
- lusid/models/aggregate_spec.py +12 -4
- lusid/models/aggregated_return.py +9 -1
- lusid/models/aggregated_returns_dispersion_request.py +9 -1
- lusid/models/aggregated_returns_request.py +9 -1
- lusid/models/aggregated_returns_response.py +9 -1
- lusid/models/aggregated_transactions_request.py +9 -1
- lusid/models/aggregation_context.py +9 -1
- lusid/models/aggregation_measure_failure_detail.py +9 -1
- lusid/models/aggregation_op.py +1 -0
- lusid/models/aggregation_options.py +9 -1
- lusid/models/aggregation_query.py +9 -1
- lusid/models/alias.py +79 -0
- lusid/models/allocation.py +9 -1
- lusid/models/allocation_request.py +9 -1
- lusid/models/allocation_service_run_response.py +9 -1
- lusid/models/allocation_set_request.py +9 -1
- lusid/models/amortisation_event.py +13 -7
- lusid/models/amortisation_rule.py +112 -0
- lusid/models/amortisation_rule_set.py +141 -0
- lusid/models/amount.py +77 -0
- lusid/models/annul_quotes_response.py +9 -1
- lusid/models/annul_single_structured_data_response.py +9 -1
- lusid/models/annul_structured_data_response.py +9 -1
- lusid/models/applicable_instrument_event.py +138 -0
- lusid/models/{underlying_leg.py → asset_leg.py} +25 -17
- lusid/models/barrier.py +9 -1
- lusid/models/basket.py +12 -4
- lusid/models/basket_identifier.py +9 -1
- lusid/models/batch_adjust_holdings_response.py +9 -1
- lusid/models/batch_update_user_review_for_comparison_result_request.py +89 -0
- lusid/models/batch_update_user_review_for_comparison_result_response.py +154 -0
- lusid/models/batch_upsert_dates_for_calendar_response.py +154 -0
- lusid/models/batch_upsert_instrument_properties_response.py +9 -1
- lusid/models/batch_upsert_portfolio_access_metadata_request.py +100 -0
- lusid/models/batch_upsert_portfolio_access_metadata_response.py +130 -0
- lusid/models/batch_upsert_portfolio_access_metadata_response_item.py +100 -0
- lusid/models/batch_upsert_portfolio_transactions_response.py +9 -1
- lusid/models/batch_upsert_property_definition_properties_response.py +9 -1
- lusid/models/block.py +9 -1
- lusid/models/block_and_order_id_request.py +86 -0
- lusid/models/block_and_orders.py +91 -0
- lusid/models/block_and_orders_create_request.py +85 -0
- lusid/models/block_and_orders_request.py +142 -0
- lusid/models/block_request.py +9 -1
- lusid/models/block_set_request.py +9 -1
- lusid/models/blocked_order_request.py +138 -0
- lusid/models/bond.py +29 -8
- lusid/models/bond_conversion_entry.py +83 -0
- lusid/models/bond_conversion_schedule.py +138 -0
- lusid/models/bond_coupon_event.py +110 -0
- lusid/models/bond_default_event.py +16 -18
- lusid/models/bond_principal_event.py +110 -0
- lusid/models/bonus_issue_event.py +174 -0
- lusid/models/book_transactions_request.py +105 -0
- lusid/models/book_transactions_response.py +9 -1
- lusid/models/bool_compliance_parameter.py +12 -4
- lusid/models/bool_list_compliance_parameter.py +12 -4
- lusid/models/branch_step.py +109 -0
- lusid/models/branch_step_request.py +106 -0
- lusid/models/break_code_source.py +81 -0
- lusid/models/bucketed_cash_flow_request.py +9 -1
- lusid/models/bucketed_cash_flow_response.py +9 -1
- lusid/models/bucketing_schedule.py +9 -1
- lusid/models/calculation_info.py +9 -1
- lusid/models/calendar.py +26 -3
- lusid/models/calendar_date.py +9 -1
- lusid/models/calendar_dependency.py +9 -1
- lusid/models/call_on_intermediate_securities_event.py +147 -0
- lusid/models/cancel_order_and_move_remaining_result.py +92 -0
- lusid/models/cancel_orders_and_move_remaining_request.py +91 -0
- lusid/models/cancel_orders_and_move_remaining_response.py +161 -0
- lusid/models/cancel_orders_response.py +161 -0
- lusid/models/cancel_placements_response.py +161 -0
- lusid/models/cancel_single_holding_adjustment_request.py +104 -0
- lusid/models/cancelled_order_result.py +81 -0
- lusid/models/cancelled_placement_result.py +91 -0
- lusid/models/cap_floor.py +42 -9
- lusid/models/capital_distribution_event.py +125 -0
- lusid/models/cash.py +101 -0
- lusid/models/cash_and_security_offer_election.py +98 -0
- lusid/models/cash_dependency.py +9 -1
- lusid/models/cash_dividend_event.py +40 -10
- lusid/models/cash_election.py +99 -0
- lusid/models/cash_flow_event.py +14 -8
- lusid/models/cash_flow_lineage.py +9 -1
- lusid/models/cash_flow_value.py +9 -1
- lusid/models/cash_flow_value_set.py +9 -1
- lusid/models/cash_ladder_record.py +9 -1
- lusid/models/cash_offer_election.py +85 -0
- lusid/models/cash_perpetual.py +12 -4
- lusid/models/cds_credit_event.py +113 -0
- lusid/models/cds_flow_conventions.py +10 -2
- lusid/models/cds_index.py +31 -8
- lusid/models/cds_protection_detail_specification.py +9 -1
- lusid/models/cdx_credit_event.py +122 -0
- lusid/models/change.py +9 -1
- lusid/models/change_history.py +9 -1
- lusid/models/change_interval.py +131 -0
- lusid/models/change_interval_with_order_management_detail.py +145 -0
- lusid/models/change_item.py +9 -1
- lusid/models/chart_of_accounts.py +9 -1
- lusid/models/chart_of_accounts_properties.py +9 -1
- lusid/models/chart_of_accounts_request.py +9 -1
- lusid/models/check_step.py +118 -0
- lusid/models/check_step_request.py +106 -0
- lusid/models/cleardown_module_details.py +103 -0
- lusid/models/cleardown_module_request.py +125 -0
- lusid/models/cleardown_module_response.py +147 -0
- lusid/models/cleardown_module_rule.py +102 -0
- lusid/models/cleardown_module_rules_updated_response.py +118 -0
- lusid/models/client.py +9 -1
- lusid/models/close_event.py +12 -4
- lusid/models/close_period_diary_entry_request.py +157 -0
- lusid/models/closed_period.py +136 -0
- lusid/models/comparison_attribute_value_pair.py +84 -0
- lusid/models/complete_portfolio.py +20 -5
- lusid/models/complete_relation.py +9 -1
- lusid/models/complete_relationship.py +9 -1
- lusid/models/complex_bond.py +30 -9
- lusid/models/complex_market_data.py +15 -6
- lusid/models/complex_market_data_id.py +9 -1
- lusid/models/compliance_breached_order_info.py +9 -1
- lusid/models/compliance_parameter.py +19 -6
- lusid/models/compliance_parameter_type.py +5 -0
- lusid/models/compliance_rule.py +9 -1
- lusid/models/compliance_rule_breakdown.py +25 -9
- lusid/models/compliance_rule_breakdown_request.py +21 -5
- lusid/models/compliance_rule_response.py +9 -1
- lusid/models/compliance_rule_result.py +9 -1
- lusid/models/compliance_rule_result_detail.py +9 -1
- lusid/models/compliance_rule_result_portfolio_detail.py +9 -1
- lusid/models/compliance_rule_result_v2.py +93 -0
- lusid/models/compliance_rule_template.py +161 -0
- lusid/models/compliance_rule_upsert_request.py +9 -1
- lusid/models/compliance_rule_upsert_response.py +9 -1
- lusid/models/compliance_run_configuration.py +81 -0
- lusid/models/compliance_run_info.py +9 -1
- lusid/models/compliance_run_info_v2.py +9 -1
- lusid/models/compliance_step.py +108 -0
- lusid/models/compliance_step_request.py +107 -0
- lusid/models/compliance_step_type.py +43 -0
- lusid/models/compliance_step_type_request.py +42 -0
- lusid/models/compliance_summary_rule_result.py +20 -15
- lusid/models/compliance_summary_rule_result_request.py +20 -15
- lusid/models/compliance_template.py +9 -1
- lusid/models/compliance_template_parameter.py +9 -1
- lusid/models/compliance_template_variation.py +29 -4
- lusid/models/compliance_template_variation_dto.py +120 -0
- lusid/models/compliance_template_variation_request.py +120 -0
- lusid/models/component_filter.py +93 -0
- lusid/models/component_transaction.py +107 -0
- lusid/models/composite_breakdown.py +9 -1
- lusid/models/composite_breakdown_request.py +9 -1
- lusid/models/composite_breakdown_response.py +9 -1
- lusid/models/composite_dispersion.py +39 -6
- lusid/models/composite_dispersion_response.py +9 -1
- lusid/models/compounding.py +13 -5
- lusid/models/configuration_recipe.py +18 -19
- lusid/models/constant_volatility_surface.py +110 -0
- lusid/models/constituents_adjustment_header.py +9 -1
- lusid/models/contract_details.py +109 -0
- lusid/models/contract_for_difference.py +16 -6
- lusid/models/contract_initialisation_event.py +107 -0
- lusid/models/contribution_to_non_passing_rule_detail.py +97 -0
- lusid/models/corporate_action.py +9 -1
- lusid/models/corporate_action_source.py +9 -1
- lusid/models/corporate_action_transition.py +9 -1
- lusid/models/corporate_action_transition_component.py +9 -1
- lusid/models/corporate_action_transition_component_request.py +9 -1
- lusid/models/corporate_action_transition_request.py +9 -1
- lusid/models/counterparty_agreement.py +9 -1
- lusid/models/counterparty_risk_information.py +9 -1
- lusid/models/counterparty_signatory.py +9 -1
- lusid/models/create_address_key_definition_request.py +9 -1
- lusid/models/create_amortisation_rule_set_request.py +110 -0
- lusid/models/create_calendar_request.py +9 -1
- lusid/models/create_closed_period_request.py +104 -0
- lusid/models/create_compliance_template_request.py +103 -0
- lusid/models/create_corporate_action_source_request.py +9 -1
- lusid/models/create_custom_entity_type_request.py +9 -1
- lusid/models/create_cut_label_definition_request.py +9 -1
- lusid/models/create_data_map_request.py +9 -1
- lusid/models/create_data_type_request.py +9 -1
- lusid/models/create_date_request.py +9 -1
- lusid/models/create_derived_property_definition_request.py +16 -6
- lusid/models/create_derived_transaction_portfolio_request.py +33 -7
- lusid/models/create_group_reconciliation_comparison_ruleset_request.py +105 -0
- lusid/models/create_group_reconciliation_definition_request.py +121 -0
- lusid/models/create_portfolio_details.py +9 -1
- lusid/models/create_portfolio_group_request.py +9 -1
- lusid/models/create_property_definition_request.py +21 -6
- lusid/models/create_recipe_request.py +9 -1
- lusid/models/create_reconciliation_request.py +9 -1
- lusid/models/create_reference_portfolio_request.py +9 -1
- lusid/models/create_relation_definition_request.py +9 -1
- lusid/models/create_relation_request.py +9 -1
- lusid/models/create_relationship_definition_request.py +11 -3
- lusid/models/create_relationship_request.py +9 -1
- lusid/models/create_sequence_request.py +9 -1
- lusid/models/create_simple_position_portfolio_request.py +196 -0
- lusid/models/create_staging_rule_set_request.py +94 -0
- lusid/models/create_tax_rule_set_request.py +9 -1
- lusid/models/create_timeline_request.py +110 -0
- lusid/models/create_trade_tickets_response.py +95 -0
- lusid/models/create_transaction_portfolio_request.py +33 -7
- lusid/models/create_unit_definition.py +9 -1
- lusid/models/credit_default_swap.py +32 -9
- lusid/models/credit_premium_cash_flow_event.py +110 -0
- lusid/models/credit_rating.py +9 -1
- lusid/models/credit_spread_curve_data.py +13 -5
- lusid/models/credit_support_annex.py +9 -1
- lusid/models/currency_and_amount.py +10 -7
- lusid/models/curve_options.py +9 -1
- lusid/models/custodian_account.py +10 -2
- lusid/models/custodian_account_properties.py +9 -1
- lusid/models/custodian_account_request.py +11 -3
- lusid/models/custodian_accounts_upsert_response.py +9 -1
- lusid/models/custom_data_model.py +97 -0
- lusid/models/custom_data_model_criteria.py +142 -0
- lusid/models/custom_data_model_identifier_type_specification.py +79 -0
- lusid/models/custom_data_model_identifier_type_specification_with_display_name.py +86 -0
- lusid/models/custom_data_model_property_specification.py +79 -0
- lusid/models/custom_data_model_property_specification_with_display_name.py +86 -0
- lusid/models/custom_entity_definition.py +32 -3
- lusid/models/custom_entity_definition_request.py +9 -1
- lusid/models/custom_entity_entity.py +154 -0
- lusid/models/custom_entity_field.py +9 -1
- lusid/models/custom_entity_field_definition.py +9 -1
- lusid/models/custom_entity_id.py +9 -1
- lusid/models/custom_entity_request.py +9 -1
- lusid/models/custom_entity_response.py +16 -2
- lusid/models/custom_entity_type.py +32 -3
- lusid/models/cut_label_definition.py +16 -2
- lusid/models/cut_local_time.py +14 -4
- lusid/models/data_definition.py +9 -1
- lusid/models/data_map_key.py +9 -1
- lusid/models/data_mapping.py +9 -1
- lusid/models/data_model_summary.py +120 -0
- lusid/models/data_scope.py +9 -1
- lusid/models/data_type.py +29 -9
- lusid/models/data_type_entity.py +139 -0
- lusid/models/data_type_summary.py +17 -3
- lusid/models/date_attributes.py +9 -1
- lusid/models/date_or_diary_entry.py +9 -1
- lusid/models/date_range.py +9 -1
- lusid/models/date_time_compliance_parameter.py +12 -4
- lusid/models/date_time_list_compliance_parameter.py +12 -4
- lusid/models/day_month.py +79 -0
- lusid/models/decimal_compliance_parameter.py +12 -4
- lusid/models/decimal_list.py +13 -5
- lusid/models/decimal_list_compliance_parameter.py +12 -4
- lusid/models/decorated_compliance_run_summary.py +9 -1
- lusid/models/delete_accounts_response.py +9 -1
- lusid/models/delete_custodian_accounts_response.py +9 -1
- lusid/models/delete_instrument_properties_response.py +16 -2
- lusid/models/delete_instrument_response.py +16 -2
- lusid/models/delete_instruments_response.py +31 -2
- lusid/models/delete_relation_request.py +9 -1
- lusid/models/delete_relationship_request.py +9 -1
- lusid/models/deleted_entity_response.py +30 -2
- lusid/models/dependency_source_filter.py +34 -4
- lusid/models/described_address_key.py +9 -1
- lusid/models/dialect.py +18 -4
- lusid/models/dialect_id.py +9 -1
- lusid/models/dialect_schema.py +9 -1
- lusid/models/diary_entry.py +10 -2
- lusid/models/diary_entry_request.py +20 -3
- lusid/models/discount_factor_curve_data.py +12 -4
- lusid/models/discounting_dependency.py +9 -1
- lusid/models/dividend_option_event.py +137 -0
- lusid/models/dividend_reinvestment_event.py +137 -0
- lusid/models/drawdown_event.py +107 -0
- lusid/models/early_redemption_election.py +81 -0
- lusid/models/early_redemption_event.py +132 -0
- lusid/models/economic_dependency.py +9 -1
- lusid/models/economic_dependency_with_complex_market_data.py +9 -1
- lusid/models/economic_dependency_with_quote.py +9 -1
- lusid/models/effective_range.py +79 -0
- lusid/models/election_specification.py +81 -0
- lusid/models/eligibility_calculation.py +81 -0
- lusid/models/empty_model_options.py +12 -4
- lusid/models/entity_identifier.py +9 -1
- lusid/models/equity.py +16 -6
- lusid/models/equity_all_of_identifiers.py +9 -1
- lusid/models/equity_curve_by_prices_data.py +12 -4
- lusid/models/equity_curve_dependency.py +9 -1
- lusid/models/equity_model_options.py +12 -4
- lusid/models/equity_option.py +54 -10
- lusid/models/equity_swap.py +31 -8
- lusid/models/equity_vol_dependency.py +9 -1
- lusid/models/equity_vol_surface_data.py +12 -4
- lusid/models/error_detail.py +9 -1
- lusid/models/event_date_range.py +9 -1
- lusid/models/ex_dividend_configuration.py +9 -1
- lusid/models/exchange_traded_option.py +21 -7
- lusid/models/exchange_traded_option_contract_details.py +29 -5
- lusid/models/execution.py +9 -1
- lusid/models/execution_request.py +9 -1
- lusid/models/execution_set_request.py +9 -1
- lusid/models/exercise_event.py +13 -7
- lusid/models/exotic_instrument.py +12 -4
- lusid/models/expanded_group.py +9 -1
- lusid/models/expiry_event.py +99 -0
- lusid/models/external_fee_component_filter.py +102 -0
- lusid/models/fee.py +223 -0
- lusid/models/fee_accrual.py +113 -0
- lusid/models/{reconciliation_run_break.py → fee_properties.py} +42 -35
- lusid/models/fee_request.py +192 -0
- lusid/models/fee_rule.py +9 -1
- lusid/models/fee_rule_upsert_request.py +9 -1
- lusid/models/fee_rule_upsert_response.py +9 -1
- lusid/models/fee_transaction_template_specification.py +87 -0
- lusid/models/fee_type.py +123 -0
- lusid/models/fee_type_request.py +113 -0
- lusid/models/field_definition.py +19 -4
- lusid/models/field_schema.py +9 -1
- lusid/models/field_value.py +25 -5
- lusid/models/file_response.py +9 -1
- lusid/models/filter_predicate_compliance_parameter.py +99 -0
- lusid/models/filter_step.py +109 -0
- lusid/models/filter_step_request.py +106 -0
- lusid/models/fixed_leg.py +12 -4
- lusid/models/fixed_leg_all_of_overrides.py +9 -1
- lusid/models/fixed_schedule.py +16 -13
- lusid/models/flexible_deposit.py +113 -0
- lusid/models/flexible_loan.py +113 -0
- lusid/models/float_schedule.py +34 -16
- lusid/models/floating_leg.py +12 -4
- lusid/models/flow_convention_name.py +10 -2
- lusid/models/flow_conventions.py +26 -5
- lusid/models/forward_rate_agreement.py +12 -4
- lusid/models/from_recipe.py +89 -0
- lusid/models/fund.py +195 -0
- lusid/models/fund_amount.py +77 -0
- lusid/models/fund_configuration.py +201 -0
- lusid/models/fund_configuration_properties.py +123 -0
- lusid/models/fund_configuration_request.py +171 -0
- lusid/models/fund_details.py +82 -0
- lusid/models/fund_id_list.py +107 -0
- lusid/models/fund_pnl_breakdown.py +118 -0
- lusid/models/fund_previous_nav.py +77 -0
- lusid/models/fund_properties.py +123 -0
- lusid/models/fund_request.py +178 -0
- lusid/models/fund_share_class.py +122 -0
- lusid/models/fund_valuation_point_data.py +154 -0
- lusid/models/funding_leg.py +12 -4
- lusid/models/funding_leg_options.py +12 -4
- lusid/models/future.py +28 -8
- lusid/models/future_expiry_event.py +108 -0
- lusid/models/future_mark_to_market_event.py +108 -0
- lusid/models/futures_contract_details.py +24 -4
- lusid/models/fx_conventions.py +81 -0
- lusid/models/fx_dependency.py +9 -1
- lusid/models/fx_forward.py +18 -8
- lusid/models/fx_forward_curve_by_quote_reference.py +13 -5
- lusid/models/fx_forward_curve_data.py +12 -4
- lusid/models/fx_forward_model_options.py +12 -4
- lusid/models/fx_forward_pips_curve_data.py +12 -4
- lusid/models/fx_forward_settlement_event.py +152 -0
- lusid/models/fx_forward_tenor_curve_data.py +13 -5
- lusid/models/fx_forward_tenor_pips_curve_data.py +13 -5
- lusid/models/fx_forwards_dependency.py +9 -1
- lusid/models/fx_linked_notional_schedule.py +116 -0
- lusid/models/fx_option.py +12 -4
- lusid/models/fx_rate_schedule.py +12 -4
- lusid/models/fx_swap.py +13 -5
- lusid/models/fx_tenor_convention.py +9 -1
- lusid/models/fx_vol_dependency.py +9 -1
- lusid/models/fx_vol_surface_data.py +12 -4
- lusid/models/general_ledger_profile_mapping.py +9 -1
- lusid/models/general_ledger_profile_request.py +9 -1
- lusid/models/general_ledger_profile_response.py +9 -1
- lusid/models/generated_event_diagnostics.py +83 -0
- lusid/models/get_cds_flow_conventions_response.py +9 -1
- lusid/models/get_complex_market_data_response.py +9 -1
- lusid/models/get_counterparty_agreement_response.py +9 -1
- lusid/models/get_credit_support_annex_response.py +9 -1
- lusid/models/get_data_map_response.py +9 -1
- lusid/models/get_flow_conventions_response.py +9 -1
- lusid/models/get_index_convention_response.py +9 -1
- lusid/models/get_instruments_response.py +9 -1
- lusid/models/get_quotes_response.py +9 -1
- lusid/models/{reconciliation_run.py → get_recipe_composer_response.py} +24 -16
- lusid/models/get_recipe_response.py +9 -1
- lusid/models/get_reference_portfolio_constituents_response.py +9 -1
- lusid/models/get_structured_result_data_response.py +9 -1
- lusid/models/get_virtual_document_response.py +9 -1
- lusid/models/group_by_selector_compliance_parameter.py +99 -0
- lusid/models/group_by_step.py +109 -0
- lusid/models/group_by_step_request.py +106 -0
- lusid/models/group_calculation_compliance_parameter.py +99 -0
- lusid/models/group_filter_predicate_compliance_parameter.py +99 -0
- lusid/models/group_filter_step.py +109 -0
- lusid/models/group_filter_step_request.py +106 -0
- lusid/models/group_of_market_data_key_rules.py +87 -0
- lusid/models/group_reconciliation_aggregate_attribute_rule.py +92 -0
- lusid/models/group_reconciliation_aggregate_attribute_values.py +94 -0
- lusid/models/group_reconciliation_aggregate_comparison_rule_operand.py +79 -0
- lusid/models/group_reconciliation_comparison_result.py +156 -0
- lusid/models/group_reconciliation_comparison_rule_string_value_map.py +81 -0
- lusid/models/group_reconciliation_comparison_rule_tolerance.py +79 -0
- lusid/models/group_reconciliation_comparison_ruleset.py +133 -0
- lusid/models/group_reconciliation_core_attribute_rule.py +103 -0
- lusid/models/group_reconciliation_core_attribute_values.py +94 -0
- lusid/models/group_reconciliation_core_comparison_rule_operand.py +79 -0
- lusid/models/group_reconciliation_date_pair.py +89 -0
- lusid/models/group_reconciliation_dates.py +86 -0
- lusid/models/group_reconciliation_definition.py +144 -0
- lusid/models/group_reconciliation_definition_comparison_ruleset_ids.py +91 -0
- lusid/models/group_reconciliation_definition_currencies.py +79 -0
- lusid/models/group_reconciliation_definition_portfolio_entity_ids.py +94 -0
- lusid/models/group_reconciliation_definition_recipe_ids.py +86 -0
- lusid/models/group_reconciliation_instance_id.py +79 -0
- lusid/models/group_reconciliation_result_statuses.py +97 -0
- lusid/models/group_reconciliation_result_types.py +104 -0
- lusid/models/group_reconciliation_review_statuses.py +104 -0
- lusid/models/group_reconciliation_run_details.py +84 -0
- lusid/models/group_reconciliation_run_request.py +83 -0
- lusid/models/group_reconciliation_run_response.py +85 -0
- lusid/models/group_reconciliation_summary.py +129 -0
- lusid/models/group_reconciliation_user_review.py +120 -0
- lusid/models/group_reconciliation_user_review_add.py +96 -0
- lusid/models/group_reconciliation_user_review_break_code.py +88 -0
- lusid/models/group_reconciliation_user_review_comment.py +88 -0
- lusid/models/group_reconciliation_user_review_match_key.py +88 -0
- lusid/models/group_reconciliation_user_review_remove.py +96 -0
- lusid/models/grouped_result_of_address_key.py +9 -1
- lusid/models/holding_adjustment.py +9 -1
- lusid/models/holding_adjustment_with_date.py +9 -1
- lusid/models/holding_context.py +9 -1
- lusid/models/holding_contributor.py +19 -4
- lusid/models/holding_ids_request.py +77 -0
- lusid/models/holding_pricing_info.py +118 -0
- lusid/models/holdings_adjustment.py +9 -1
- lusid/models/holdings_adjustment_header.py +9 -1
- lusid/models/i_unit_definition_dto.py +9 -1
- lusid/models/id_selector_definition.py +9 -1
- lusid/models/identifier_part_schema.py +9 -1
- lusid/models/index_convention.py +11 -3
- lusid/models/index_model_options.py +12 -4
- lusid/models/index_projection_dependency.py +9 -1
- lusid/models/industry_classifier.py +9 -1
- lusid/models/inflation_fixing_dependency.py +9 -1
- lusid/models/inflation_index_conventions.py +11 -3
- lusid/models/inflation_leg.py +12 -4
- lusid/models/inflation_linked_bond.py +28 -7
- lusid/models/inflation_swap.py +31 -8
- lusid/models/informational_error_event.py +12 -4
- lusid/models/informational_event.py +13 -7
- lusid/models/inline_valuation_request.py +9 -1
- lusid/models/inline_valuations_reconciliation_request.py +9 -1
- lusid/models/input_transition.py +9 -1
- lusid/models/instrument.py +22 -2
- lusid/models/instrument_capabilities.py +9 -1
- lusid/models/instrument_cash_flow.py +9 -1
- lusid/models/instrument_definition.py +17 -3
- lusid/models/instrument_definition_format.py +9 -1
- lusid/models/instrument_entity.py +154 -0
- lusid/models/instrument_event.py +54 -6
- lusid/models/instrument_event_configuration.py +88 -0
- lusid/models/instrument_event_holder.py +28 -3
- lusid/models/instrument_event_instruction.py +151 -0
- lusid/models/instrument_event_instruction_request.py +102 -0
- lusid/models/instrument_event_instructions_response.py +115 -0
- lusid/models/instrument_event_type.py +40 -0
- lusid/models/instrument_id_type_descriptor.py +9 -1
- lusid/models/instrument_id_value.py +9 -1
- lusid/models/instrument_leg.py +12 -4
- lusid/models/instrument_list.py +13 -5
- lusid/models/instrument_list_compliance_parameter.py +12 -4
- lusid/models/instrument_match.py +9 -1
- lusid/models/instrument_models.py +9 -1
- lusid/models/instrument_payment_diary.py +9 -1
- lusid/models/instrument_payment_diary_leg.py +13 -3
- lusid/models/instrument_payment_diary_row.py +9 -1
- lusid/models/instrument_properties.py +9 -1
- lusid/models/instrument_resolution_detail.py +127 -0
- lusid/models/instrument_search_property.py +9 -1
- lusid/models/instrument_type.py +7 -0
- lusid/models/interest_rate_swap.py +14 -6
- lusid/models/interest_rate_swaption.py +13 -5
- lusid/models/intermediate_compliance_step.py +118 -0
- lusid/models/intermediate_compliance_step_request.py +106 -0
- lusid/models/intermediate_securities_distribution_event.py +148 -0
- lusid/models/ir_vol_cube_data.py +12 -4
- lusid/models/ir_vol_dependency.py +9 -1
- lusid/models/is_business_day_response.py +9 -1
- lusid/models/journal_entry_line.py +60 -5
- lusid/models/journal_entry_lines_query_parameters.py +10 -2
- lusid/models/label_value_set.py +10 -2
- lusid/models/lapse_election.py +81 -0
- lusid/models/leg_definition.py +24 -3
- lusid/models/legal_entity.py +9 -1
- lusid/models/level_step.py +9 -1
- lusid/models/life_cycle_event_lineage.py +9 -1
- lusid/models/life_cycle_event_value.py +9 -1
- lusid/models/lineage_member.py +95 -0
- lusid/models/link.py +9 -1
- lusid/models/list_aggregation_reconciliation.py +9 -1
- lusid/models/list_aggregation_response.py +9 -1
- lusid/models/list_complex_market_data_with_meta_data_response.py +9 -1
- lusid/models/loan_facility.py +115 -0
- lusid/models/loan_interest_repayment_event.py +105 -0
- lusid/models/loan_period.py +9 -1
- lusid/models/lock_period_diary_entry_request.py +99 -0
- lusid/models/lusid_instrument.py +20 -6
- lusid/models/lusid_problem_details.py +9 -1
- lusid/models/lusid_trade_ticket.py +17 -2
- lusid/models/lusid_unique_id.py +9 -1
- lusid/models/lusid_validation_problem_details.py +9 -1
- lusid/models/mapped_string.py +9 -1
- lusid/models/mapping.py +9 -1
- lusid/models/mapping_rule.py +9 -1
- lusid/models/mark_to_market_conventions.py +82 -0
- lusid/models/market_context.py +26 -3
- lusid/models/market_context_suppliers.py +9 -1
- lusid/models/market_data_key_rule.py +17 -7
- lusid/models/market_data_options.py +9 -1
- lusid/models/market_data_overrides.py +9 -1
- lusid/models/market_data_specific_rule.py +17 -7
- lusid/models/market_data_type.py +1 -0
- lusid/models/market_options.py +9 -1
- lusid/models/market_quote.py +12 -4
- lusid/models/mastered_instrument.py +147 -0
- lusid/models/match_criterion.py +9 -1
- lusid/models/maturity_event.py +99 -0
- lusid/models/mbs_coupon_event.py +110 -0
- lusid/models/mbs_interest_deferral_event.py +110 -0
- lusid/models/mbs_interest_shortfall_event.py +110 -0
- lusid/models/mbs_principal_event.py +110 -0
- lusid/models/mbs_principal_write_off_event.py +110 -0
- lusid/models/merger_event.py +180 -0
- lusid/models/metric_value.py +9 -1
- lusid/models/model_options.py +14 -7
- lusid/models/model_options_type.py +0 -1
- lusid/models/model_property.py +9 -1
- lusid/models/model_schema.py +9 -1
- lusid/models/model_selection.py +12 -4
- lusid/models/move_orders_to_different_blocks_request.py +85 -0
- lusid/models/moved_order_to_different_block_response.py +93 -0
- lusid/models/movement_type.py +4 -0
- lusid/models/multi_currency_amounts.py +79 -0
- lusid/models/new_instrument.py +101 -0
- lusid/models/next_value_in_sequence_response.py +9 -1
- lusid/models/opaque_dependency.py +9 -1
- lusid/models/opaque_market_data.py +12 -4
- lusid/models/opaque_model_options.py +12 -4
- lusid/models/open_event.py +12 -4
- lusid/models/operation.py +10 -2
- lusid/models/operation_type.py +1 -0
- lusid/models/option_entry.py +19 -4
- lusid/models/option_exercise_cash_event.py +159 -0
- lusid/models/option_exercise_election.py +81 -0
- lusid/models/option_exercise_physical_event.py +164 -0
- lusid/models/optionality_schedule.py +12 -4
- lusid/models/order.py +9 -1
- lusid/models/order_by_spec.py +9 -1
- lusid/models/order_flow_configuration.py +10 -2
- lusid/models/order_graph_block.py +19 -3
- lusid/models/order_graph_block_allocation_detail.py +9 -1
- lusid/models/order_graph_block_allocation_synopsis.py +9 -1
- lusid/models/order_graph_block_execution_detail.py +9 -1
- lusid/models/order_graph_block_execution_synopsis.py +9 -1
- lusid/models/order_graph_block_order_detail.py +42 -5
- lusid/models/order_graph_block_order_synopsis.py +18 -3
- lusid/models/order_graph_block_placement_detail.py +9 -1
- lusid/models/order_graph_block_placement_synopsis.py +18 -3
- lusid/models/{upsert_reconciliation_run_request.py → order_graph_block_transaction_detail.py} +21 -15
- lusid/models/order_graph_block_transaction_synopsis.py +87 -0
- lusid/models/order_graph_placement.py +9 -1
- lusid/models/order_graph_placement_allocation_detail.py +9 -1
- lusid/models/order_graph_placement_allocation_synopsis.py +9 -1
- lusid/models/order_graph_placement_child_placement_detail.py +9 -1
- lusid/models/order_graph_placement_execution_detail.py +9 -1
- lusid/models/order_graph_placement_execution_synopsis.py +9 -1
- lusid/models/order_graph_placement_order_detail.py +9 -1
- lusid/models/order_graph_placement_order_synopsis.py +9 -1
- lusid/models/order_graph_placement_placement_synopsis.py +9 -1
- lusid/models/order_instruction.py +9 -1
- lusid/models/order_instruction_request.py +9 -1
- lusid/models/order_instruction_set_request.py +9 -1
- lusid/models/order_request.py +9 -1
- lusid/models/order_set_request.py +9 -1
- lusid/models/order_update_request.py +129 -0
- lusid/models/otc_confirmation.py +9 -1
- lusid/models/output_transaction.py +46 -3
- lusid/models/output_transition.py +9 -1
- lusid/models/package.py +9 -1
- lusid/models/package_request.py +9 -1
- lusid/models/package_set_request.py +9 -1
- lusid/models/paged_resource_list_of_abor.py +9 -1
- lusid/models/paged_resource_list_of_abor_configuration.py +9 -1
- lusid/models/paged_resource_list_of_account.py +9 -1
- lusid/models/paged_resource_list_of_address_key_definition.py +9 -1
- lusid/models/paged_resource_list_of_allocation.py +9 -1
- lusid/models/paged_resource_list_of_amortisation_rule_set.py +121 -0
- lusid/models/paged_resource_list_of_block.py +9 -1
- lusid/models/paged_resource_list_of_calendar.py +9 -1
- lusid/models/paged_resource_list_of_chart_of_accounts.py +9 -1
- lusid/models/paged_resource_list_of_cleardown_module_response.py +121 -0
- lusid/models/paged_resource_list_of_cleardown_module_rule.py +121 -0
- lusid/models/paged_resource_list_of_closed_period.py +121 -0
- lusid/models/paged_resource_list_of_compliance_rule_response.py +9 -1
- lusid/models/paged_resource_list_of_compliance_run_info_v2.py +9 -1
- lusid/models/paged_resource_list_of_compliance_template.py +9 -1
- lusid/models/paged_resource_list_of_corporate_action_source.py +9 -1
- lusid/models/paged_resource_list_of_custodian_account.py +9 -1
- lusid/models/paged_resource_list_of_custom_entity_definition.py +9 -1
- lusid/models/paged_resource_list_of_custom_entity_response.py +9 -1
- lusid/models/paged_resource_list_of_custom_entity_type.py +9 -1
- lusid/models/paged_resource_list_of_cut_label_definition.py +9 -1
- lusid/models/paged_resource_list_of_data_type_summary.py +9 -1
- lusid/models/paged_resource_list_of_dialect_id.py +9 -1
- lusid/models/paged_resource_list_of_diary_entry.py +9 -1
- lusid/models/paged_resource_list_of_execution.py +9 -1
- lusid/models/{paged_resource_list_of_reconciliation_run.py → paged_resource_list_of_fee.py} +20 -12
- lusid/models/paged_resource_list_of_fee_type.py +121 -0
- lusid/models/{paged_resource_list_of_reconciliation_run_break.py → paged_resource_list_of_fund.py} +20 -12
- lusid/models/paged_resource_list_of_fund_configuration.py +121 -0
- lusid/models/paged_resource_list_of_general_ledger_profile_response.py +9 -1
- lusid/models/paged_resource_list_of_group_reconciliation_comparison_result.py +121 -0
- lusid/models/paged_resource_list_of_group_reconciliation_comparison_ruleset.py +121 -0
- lusid/models/paged_resource_list_of_group_reconciliation_definition.py +121 -0
- lusid/models/paged_resource_list_of_instrument.py +9 -1
- lusid/models/paged_resource_list_of_instrument_event_holder.py +9 -1
- lusid/models/paged_resource_list_of_instrument_event_instruction.py +121 -0
- lusid/models/paged_resource_list_of_legal_entity.py +9 -1
- lusid/models/paged_resource_list_of_order.py +9 -1
- lusid/models/paged_resource_list_of_order_graph_block.py +9 -1
- lusid/models/paged_resource_list_of_order_graph_placement.py +9 -1
- lusid/models/paged_resource_list_of_order_instruction.py +9 -1
- lusid/models/paged_resource_list_of_package.py +9 -1
- lusid/models/paged_resource_list_of_participation.py +9 -1
- lusid/models/paged_resource_list_of_person.py +9 -1
- lusid/models/paged_resource_list_of_placement.py +9 -1
- lusid/models/paged_resource_list_of_portfolio_group.py +9 -1
- lusid/models/paged_resource_list_of_portfolio_group_search_result.py +9 -1
- lusid/models/paged_resource_list_of_portfolio_search_result.py +9 -1
- lusid/models/paged_resource_list_of_posting_module_response.py +9 -1
- lusid/models/paged_resource_list_of_posting_module_rule.py +9 -1
- lusid/models/paged_resource_list_of_property_definition.py +121 -0
- lusid/models/paged_resource_list_of_property_definition_search_result.py +9 -1
- lusid/models/paged_resource_list_of_reconciliation.py +9 -1
- lusid/models/paged_resource_list_of_reference_list_response.py +9 -1
- lusid/models/paged_resource_list_of_relationship_definition.py +9 -1
- lusid/models/paged_resource_list_of_sequence_definition.py +9 -1
- lusid/models/paged_resource_list_of_staged_modification.py +121 -0
- lusid/models/paged_resource_list_of_staged_modifications_requested_change_interval.py +121 -0
- lusid/models/paged_resource_list_of_staging_rule_set.py +121 -0
- lusid/models/paged_resource_list_of_transaction_template.py +121 -0
- lusid/models/paged_resource_list_of_transaction_template_specification.py +121 -0
- lusid/models/paged_resource_list_of_translation_script_id.py +9 -1
- lusid/models/paged_resource_list_of_valuation_point_overview.py +121 -0
- lusid/models/paged_resource_list_of_virtual_row.py +9 -1
- lusid/models/paged_resource_list_of_workspace.py +121 -0
- lusid/models/paged_resource_list_of_workspace_item.py +121 -0
- lusid/models/participation.py +9 -1
- lusid/models/participation_request.py +12 -10
- lusid/models/participation_set_request.py +9 -1
- lusid/models/percent_check_step.py +118 -0
- lusid/models/percent_check_step_request.py +106 -0
- lusid/models/performance_return.py +9 -1
- lusid/models/performance_returns_metric.py +10 -2
- lusid/models/period_diary_entries_reopened_response.py +112 -0
- lusid/models/perpetual_property.py +9 -1
- lusid/models/person.py +26 -3
- lusid/models/place_blocks_request.py +85 -0
- lusid/models/placement.py +9 -1
- lusid/models/placement_request.py +9 -1
- lusid/models/placement_set_request.py +9 -1
- lusid/models/placement_update_request.py +129 -0
- lusid/models/pnl_journal_entry_line.py +103 -0
- lusid/models/portfolio.py +41 -9
- lusid/models/portfolio_cash_flow.py +9 -1
- lusid/models/portfolio_cash_ladder.py +9 -1
- lusid/models/portfolio_details.py +38 -6
- lusid/models/portfolio_entity.py +154 -0
- lusid/models/portfolio_entity_id.py +11 -19
- lusid/models/portfolio_group.py +9 -1
- lusid/models/portfolio_group_id_compliance_parameter.py +12 -4
- lusid/models/portfolio_group_id_list.py +13 -5
- lusid/models/portfolio_group_id_list_compliance_parameter.py +12 -4
- lusid/models/portfolio_group_properties.py +9 -1
- lusid/models/portfolio_group_search_result.py +9 -1
- lusid/models/portfolio_holding.py +52 -4
- lusid/models/portfolio_id.py +88 -0
- lusid/models/portfolio_id_compliance_parameter.py +12 -4
- lusid/models/portfolio_id_list.py +13 -5
- lusid/models/portfolio_id_list_compliance_parameter.py +12 -4
- lusid/models/portfolio_properties.py +16 -2
- lusid/models/portfolio_reconciliation_request.py +9 -1
- lusid/models/portfolio_result_data_key_rule.py +9 -1
- lusid/models/portfolio_return_breakdown.py +9 -1
- lusid/models/portfolio_search_result.py +12 -4
- lusid/models/portfolio_trade_ticket.py +9 -1
- lusid/models/portfolio_type.py +1 -0
- lusid/models/portfolio_without_href.py +228 -0
- lusid/models/portfolios_reconciliation_request.py +9 -1
- lusid/models/posting_module_details.py +9 -1
- lusid/models/posting_module_request.py +9 -1
- lusid/models/posting_module_response.py +9 -1
- lusid/models/posting_module_rule.py +14 -6
- lusid/models/posting_module_rules_updated_response.py +9 -1
- lusid/models/pre_trade_configuration.py +77 -0
- lusid/models/premium.py +9 -1
- lusid/models/previous_fund_valuation_point_data.py +81 -0
- lusid/models/{action_result_of_portfolio.py → previous_nav.py} +24 -18
- lusid/models/previous_share_class_breakdown.py +89 -0
- lusid/models/pricing_context.py +17 -3
- lusid/models/pricing_model.py +3 -1
- lusid/models/pricing_options.py +17 -3
- lusid/models/processed_command.py +9 -1
- lusid/models/property_definition.py +34 -5
- lusid/models/property_definition_entity.py +154 -0
- lusid/models/property_definition_search_result.py +15 -5
- lusid/models/property_domain.py +41 -0
- lusid/models/property_filter.py +9 -1
- lusid/models/property_interval.py +9 -1
- lusid/models/property_key_compliance_parameter.py +12 -4
- lusid/models/property_key_list_compliance_parameter.py +12 -4
- lusid/models/property_list.py +107 -0
- lusid/models/property_list_compliance_parameter.py +103 -0
- lusid/models/property_schema.py +9 -1
- lusid/models/property_value.py +9 -1
- lusid/models/property_value_equals.py +9 -1
- lusid/models/property_value_in.py +9 -1
- lusid/models/protection_payout_cash_flow_event.py +110 -0
- lusid/models/query_applicable_instrument_events_request.py +97 -0
- lusid/models/query_bucketed_cash_flows_request.py +9 -1
- lusid/models/query_cash_flows_request.py +9 -1
- lusid/models/query_instrument_events_request.py +9 -1
- lusid/models/query_trade_tickets_request.py +9 -1
- lusid/models/queryable_key.py +132 -0
- lusid/models/quote.py +9 -1
- lusid/models/quote_access_metadata_rule.py +9 -1
- lusid/models/quote_access_metadata_rule_id.py +11 -3
- lusid/models/quote_dependency.py +9 -1
- lusid/models/quote_id.py +9 -1
- lusid/models/quote_series_id.py +15 -23
- lusid/models/quote_type.py +3 -0
- lusid/models/raw_vendor_event.py +14 -8
- lusid/models/re_open_period_diary_entry_request.py +92 -0
- lusid/models/realised_gain_loss.py +11 -3
- lusid/models/recipe_block.py +95 -0
- lusid/models/recipe_composer.py +108 -0
- lusid/models/recipe_value.py +95 -0
- lusid/models/recombine_step.py +109 -0
- lusid/models/recommended_sort_by.py +84 -0
- lusid/models/reconcile_date_time_rule.py +9 -1
- lusid/models/reconcile_numeric_rule.py +9 -1
- lusid/models/reconcile_string_rule.py +9 -1
- lusid/models/reconciled_transaction.py +9 -1
- lusid/models/reconciliation.py +9 -1
- lusid/models/reconciliation_break.py +9 -1
- lusid/models/reconciliation_configuration.py +9 -1
- lusid/models/reconciliation_id.py +9 -1
- lusid/models/reconciliation_left_right_address_key_pair.py +9 -1
- lusid/models/reconciliation_line.py +9 -1
- lusid/models/reconciliation_request.py +9 -1
- lusid/models/reconciliation_response.py +9 -1
- lusid/models/reconciliation_rule.py +9 -1
- lusid/models/reconciliation_side_configuration.py +9 -1
- lusid/models/reconciliation_transactions.py +9 -1
- lusid/models/reference_data.py +9 -1
- lusid/models/reference_instrument.py +12 -4
- lusid/models/reference_list.py +16 -6
- lusid/models/reference_list_request.py +9 -1
- lusid/models/reference_list_response.py +9 -1
- lusid/models/reference_list_type.py +2 -0
- lusid/models/reference_portfolio_constituent.py +9 -1
- lusid/models/reference_portfolio_constituent_request.py +9 -1
- lusid/models/related_entity.py +10 -2
- lusid/models/relation.py +9 -1
- lusid/models/relation_definition.py +9 -1
- lusid/models/relationship.py +9 -1
- lusid/models/relationship_definition.py +9 -1
- lusid/models/relative_date_offset.py +86 -0
- lusid/models/repo.py +12 -4
- lusid/models/requested_changes.py +84 -0
- lusid/models/reset_event.py +13 -7
- lusid/models/resource_id.py +9 -1
- lusid/models/resource_list_of_access_controlled_resource.py +9 -1
- lusid/models/resource_list_of_access_metadata_value_of.py +9 -1
- lusid/models/resource_list_of_address_key_definition.py +9 -1
- lusid/models/resource_list_of_aggregated_return.py +9 -1
- lusid/models/resource_list_of_aggregation_query.py +9 -1
- lusid/models/resource_list_of_allocation.py +9 -1
- lusid/models/resource_list_of_applicable_instrument_event.py +121 -0
- lusid/models/resource_list_of_block.py +9 -1
- lusid/models/resource_list_of_block_and_orders.py +121 -0
- lusid/models/resource_list_of_calendar_date.py +9 -1
- lusid/models/resource_list_of_change.py +9 -1
- lusid/models/resource_list_of_change_history.py +9 -1
- lusid/models/resource_list_of_change_interval.py +121 -0
- lusid/models/resource_list_of_change_interval_with_order_management_detail.py +121 -0
- lusid/models/resource_list_of_compliance_breached_order_info.py +9 -1
- lusid/models/resource_list_of_compliance_rule.py +9 -1
- lusid/models/resource_list_of_compliance_rule_result.py +9 -1
- lusid/models/resource_list_of_compliance_run_info.py +9 -1
- lusid/models/resource_list_of_constituents_adjustment_header.py +9 -1
- lusid/models/resource_list_of_corporate_action.py +9 -1
- lusid/models/resource_list_of_data_model_summary.py +121 -0
- lusid/models/resource_list_of_data_type.py +9 -1
- lusid/models/resource_list_of_execution.py +9 -1
- lusid/models/resource_list_of_fee_rule.py +9 -1
- lusid/models/resource_list_of_get_cds_flow_conventions_response.py +9 -1
- lusid/models/resource_list_of_get_counterparty_agreement_response.py +9 -1
- lusid/models/resource_list_of_get_credit_support_annex_response.py +9 -1
- lusid/models/resource_list_of_get_flow_conventions_response.py +9 -1
- lusid/models/resource_list_of_get_index_convention_response.py +9 -1
- lusid/models/resource_list_of_get_recipe_composer_response.py +121 -0
- lusid/models/resource_list_of_get_recipe_response.py +9 -1
- lusid/models/resource_list_of_holdings_adjustment_header.py +9 -1
- lusid/models/resource_list_of_i_unit_definition_dto.py +9 -1
- lusid/models/resource_list_of_instrument_cash_flow.py +9 -1
- lusid/models/resource_list_of_instrument_event_holder.py +9 -1
- lusid/models/resource_list_of_instrument_id_type_descriptor.py +9 -1
- lusid/models/resource_list_of_legal_entity.py +9 -1
- lusid/models/resource_list_of_list_complex_market_data_with_meta_data_response.py +9 -1
- lusid/models/resource_list_of_mapping.py +9 -1
- lusid/models/resource_list_of_moved_order_to_different_block_response.py +121 -0
- lusid/models/resource_list_of_order.py +9 -1
- lusid/models/resource_list_of_order_instruction.py +9 -1
- lusid/models/resource_list_of_output_transaction.py +121 -0
- lusid/models/resource_list_of_package.py +9 -1
- lusid/models/resource_list_of_participation.py +9 -1
- lusid/models/resource_list_of_performance_return.py +9 -1
- lusid/models/resource_list_of_person.py +9 -1
- lusid/models/resource_list_of_placement.py +9 -1
- lusid/models/resource_list_of_portfolio.py +9 -1
- lusid/models/resource_list_of_portfolio_cash_flow.py +9 -1
- lusid/models/resource_list_of_portfolio_cash_ladder.py +9 -1
- lusid/models/resource_list_of_portfolio_trade_ticket.py +9 -1
- lusid/models/resource_list_of_processed_command.py +9 -1
- lusid/models/resource_list_of_property.py +9 -1
- lusid/models/resource_list_of_property_definition.py +9 -1
- lusid/models/resource_list_of_property_interval.py +9 -1
- lusid/models/resource_list_of_queryable_key.py +121 -0
- lusid/models/resource_list_of_quote.py +9 -1
- lusid/models/resource_list_of_quote_access_metadata_rule.py +9 -1
- lusid/models/resource_list_of_reconciliation_break.py +9 -1
- lusid/models/resource_list_of_relation.py +9 -1
- lusid/models/resource_list_of_relationship.py +9 -1
- lusid/models/resource_list_of_scope_definition.py +9 -1
- lusid/models/resource_list_of_side_definition.py +9 -1
- lusid/models/resource_list_of_string.py +9 -1
- lusid/models/resource_list_of_tax_rule_set.py +9 -1
- lusid/models/resource_list_of_transaction.py +9 -1
- lusid/models/resource_list_of_transaction_type.py +9 -1
- lusid/models/resource_list_of_value_type.py +9 -1
- lusid/models/response_meta_data.py +9 -1
- lusid/models/result_data_key_rule.py +9 -1
- lusid/models/result_data_schema.py +9 -1
- lusid/models/result_key_rule.py +9 -1
- lusid/models/result_value.py +9 -1
- lusid/models/result_value0_d.py +9 -1
- lusid/models/result_value_bool.py +9 -1
- lusid/models/result_value_currency.py +9 -1
- lusid/models/result_value_date_time_offset.py +9 -1
- lusid/models/result_value_decimal.py +9 -1
- lusid/models/result_value_dictionary.py +9 -1
- lusid/models/result_value_int.py +9 -1
- lusid/models/result_value_string.py +9 -1
- lusid/models/return_zero_pv_options.py +77 -0
- lusid/models/reverse_stock_split_event.py +135 -0
- lusid/models/rounding_configuration.py +9 -1
- lusid/models/rounding_configuration_component.py +9 -1
- lusid/models/rounding_convention.py +9 -1
- lusid/models/rules_interval.py +91 -0
- lusid/models/schedule.py +16 -6
- lusid/models/schedule_type.py +2 -0
- lusid/models/scope_definition.py +9 -1
- lusid/models/scrip_dividend_event.py +135 -0
- lusid/models/script_map_reference.py +102 -0
- lusid/models/security_election.py +94 -0
- lusid/models/security_offer_election.py +87 -0
- lusid/models/sequence_definition.py +9 -1
- lusid/models/set_amortisation_rules_request.py +81 -0
- lusid/models/set_legal_entity_identifiers_request.py +9 -1
- lusid/models/set_legal_entity_properties_request.py +9 -1
- lusid/models/set_person_identifiers_request.py +9 -1
- lusid/models/set_person_properties_request.py +9 -1
- lusid/models/set_share_class_instruments_request.py +87 -0
- lusid/models/set_transaction_configuration_alias.py +9 -1
- lusid/models/set_transaction_configuration_source_request.py +9 -1
- lusid/models/settlement_cycle.py +87 -0
- lusid/models/settlement_schedule.py +86 -0
- lusid/models/share_class_amount.py +79 -0
- lusid/models/share_class_breakdown.py +162 -0
- lusid/models/share_class_data.py +87 -0
- lusid/models/share_class_dealing_breakdown.py +105 -0
- lusid/models/share_class_details.py +135 -0
- lusid/models/share_class_pnl_breakdown.py +118 -0
- lusid/models/side_configuration_data.py +9 -1
- lusid/models/side_configuration_data_request.py +9 -1
- lusid/models/side_definition.py +17 -9
- lusid/models/side_definition_request.py +18 -3
- lusid/models/sides_definition_request.py +9 -8
- lusid/models/simple_cash_flow_loan.py +12 -4
- lusid/models/simple_instrument.py +12 -4
- lusid/models/simple_rounding_convention.py +84 -0
- lusid/models/specific_holding_pricing_info.py +83 -0
- lusid/models/spin_off_event.py +148 -0
- lusid/models/staged_modification.py +197 -0
- lusid/models/staged_modification_decision.py +105 -0
- lusid/models/staged_modification_decision_request.py +79 -0
- lusid/models/staged_modification_effective_range.py +79 -0
- lusid/models/staged_modification_staging_rule.py +93 -0
- lusid/models/staged_modifications_entity_hrefs.py +111 -0
- lusid/models/staged_modifications_info.py +86 -0
- lusid/models/staged_modifications_requested_change_interval.py +121 -0
- lusid/models/staging_rule.py +98 -0
- lusid/models/staging_rule_approval_criteria.py +96 -0
- lusid/models/staging_rule_match_criteria.py +103 -0
- lusid/models/staging_rule_set.py +126 -0
- lusid/models/step_schedule.py +12 -4
- lusid/models/stock_dividend_event.py +135 -0
- lusid/models/stock_split_event.py +51 -11
- lusid/models/strategy.py +89 -0
- lusid/models/stream.py +9 -1
- lusid/models/string_compliance_parameter.py +12 -4
- lusid/models/string_list.py +13 -5
- lusid/models/string_list_compliance_parameter.py +12 -4
- lusid/models/structured_result_data.py +9 -1
- lusid/models/structured_result_data_id.py +9 -1
- lusid/models/sub_holding_key_value_equals.py +9 -1
- lusid/models/swap_cash_flow_event.py +105 -0
- lusid/models/swap_principal_event.py +105 -0
- lusid/models/target_tax_lot.py +32 -3
- lusid/models/target_tax_lot_request.py +32 -3
- lusid/models/tax_rule.py +9 -1
- lusid/models/tax_rule_set.py +9 -1
- lusid/models/template_field.py +87 -0
- lusid/models/tender_event.py +180 -0
- lusid/models/term_deposit.py +12 -4
- lusid/models/term_deposit_interest_event.py +108 -0
- lusid/models/term_deposit_principal_event.py +108 -0
- lusid/models/timeline.py +143 -0
- lusid/models/total_return_swap.py +41 -18
- lusid/models/touch.py +9 -1
- lusid/models/trade_ticket.py +9 -1
- lusid/models/trading_conventions.py +81 -0
- lusid/models/transaction.py +40 -4
- lusid/models/transaction_configuration_data.py +9 -1
- lusid/models/transaction_configuration_data_request.py +9 -1
- lusid/models/transaction_configuration_movement_data.py +13 -5
- lusid/models/transaction_configuration_movement_data_request.py +13 -5
- lusid/models/transaction_configuration_type_alias.py +9 -1
- lusid/models/transaction_currency_and_amount.py +89 -0
- lusid/models/transaction_date_windows.py +93 -0
- lusid/models/transaction_diagnostics.py +79 -0
- lusid/models/transaction_field_map.py +110 -0
- lusid/models/transaction_price.py +12 -4
- lusid/models/transaction_price_and_type.py +89 -0
- lusid/models/transaction_price_type.py +3 -0
- lusid/models/transaction_property_map.py +89 -0
- lusid/models/transaction_property_mapping.py +9 -1
- lusid/models/transaction_property_mapping_request.py +9 -1
- lusid/models/transaction_query_parameters.py +9 -1
- lusid/models/transaction_reconciliation_request.py +9 -1
- lusid/models/transaction_reconciliation_request_v2.py +9 -1
- lusid/models/transaction_request.py +34 -4
- lusid/models/transaction_set_configuration_data.py +9 -1
- lusid/models/transaction_set_configuration_data_request.py +9 -1
- lusid/models/transaction_template.py +108 -0
- lusid/models/transaction_template_request.py +87 -0
- lusid/models/transaction_template_specification.py +107 -0
- lusid/models/transaction_type.py +9 -1
- lusid/models/transaction_type_alias.py +9 -8
- lusid/models/transaction_type_calculation.py +26 -13
- lusid/models/transaction_type_details.py +81 -0
- lusid/models/transaction_type_movement.py +30 -5
- lusid/models/transaction_type_property_mapping.py +35 -3
- lusid/models/transaction_type_request.py +9 -1
- lusid/models/transactions_reconciliations_response.py +9 -1
- lusid/models/transition_event.py +12 -4
- lusid/models/translate_entities_inlined_request.py +9 -1
- lusid/models/translate_entities_request.py +9 -1
- lusid/models/translate_entities_response.py +9 -1
- lusid/models/translate_instrument_definitions_request.py +9 -1
- lusid/models/translate_instrument_definitions_response.py +9 -1
- lusid/models/translate_trade_ticket_request.py +9 -1
- lusid/models/translate_trade_tickets_response.py +9 -1
- lusid/models/translation_context.py +83 -0
- lusid/models/translation_input.py +9 -1
- lusid/models/translation_result.py +9 -1
- lusid/models/translation_script.py +18 -4
- lusid/models/translation_script_id.py +9 -1
- lusid/models/trial_balance.py +58 -15
- lusid/models/trial_balance_query_parameters.py +23 -6
- lusid/models/trigger_event.py +12 -4
- lusid/models/typed_resource_id.py +9 -1
- lusid/models/unitisation_data.py +81 -0
- lusid/models/units_ratio.py +79 -0
- lusid/models/update_amortisation_rule_set_details_request.py +101 -0
- lusid/models/update_calendar_request.py +9 -1
- lusid/models/update_compliance_template_request.py +103 -0
- lusid/models/update_custom_entity_definition_request.py +9 -1
- lusid/models/update_custom_entity_type_request.py +9 -1
- lusid/models/update_cut_label_definition_request.py +9 -1
- lusid/models/update_data_type_request.py +9 -1
- lusid/models/update_derived_property_definition_request.py +13 -3
- lusid/models/update_fee_type_request.py +104 -0
- lusid/models/update_group_reconciliation_comparison_ruleset_request.py +99 -0
- lusid/models/update_group_reconciliation_definition_request.py +115 -0
- lusid/models/update_instrument_identifier_request.py +9 -1
- lusid/models/update_orders_response.py +161 -0
- lusid/models/update_placements_response.py +161 -0
- lusid/models/update_portfolio_group_request.py +9 -1
- lusid/models/update_portfolio_request.py +9 -1
- lusid/models/update_property_definition_request.py +9 -1
- lusid/models/update_reconciliation_request.py +9 -1
- lusid/models/update_reference_data_request.py +95 -0
- lusid/models/update_relationship_definition_request.py +9 -1
- lusid/models/update_staging_rule_set_request.py +94 -0
- lusid/models/update_tax_rule_set_request.py +9 -1
- lusid/models/update_timeline_request.py +104 -0
- lusid/models/update_unit_request.py +9 -1
- lusid/models/upsert_cds_flow_conventions_request.py +9 -1
- lusid/models/upsert_complex_market_data_request.py +9 -1
- lusid/models/upsert_compliance_rule_request.py +9 -1
- lusid/models/upsert_compliance_run_summary_request.py +9 -1
- lusid/models/{compliance_run_summary.py → upsert_compliance_run_summary_result.py} +17 -9
- lusid/models/upsert_corporate_action_request.py +9 -1
- lusid/models/upsert_corporate_actions_response.py +9 -1
- lusid/models/upsert_counterparty_agreement_request.py +9 -1
- lusid/models/upsert_credit_support_annex_request.py +9 -1
- lusid/models/upsert_custom_data_model_request.py +176 -0
- lusid/models/upsert_custom_entities_response.py +29 -2
- lusid/models/upsert_custom_entity_access_metadata_request.py +9 -1
- lusid/models/upsert_dialect_request.py +87 -0
- lusid/models/upsert_flow_conventions_request.py +9 -1
- lusid/models/upsert_index_convention_request.py +9 -1
- lusid/models/upsert_instrument_event_request.py +20 -3
- lusid/models/upsert_instrument_events_response.py +9 -1
- lusid/models/upsert_instrument_properties_response.py +9 -1
- lusid/models/upsert_instrument_property_request.py +9 -1
- lusid/models/upsert_instruments_response.py +29 -2
- lusid/models/upsert_legal_entities_response.py +9 -1
- lusid/models/upsert_legal_entity_access_metadata_request.py +9 -1
- lusid/models/upsert_legal_entity_request.py +9 -1
- lusid/models/upsert_person_access_metadata_request.py +9 -1
- lusid/models/upsert_person_request.py +9 -1
- lusid/models/upsert_persons_response.py +122 -0
- lusid/models/upsert_portfolio_access_metadata_request.py +9 -1
- lusid/models/upsert_portfolio_group_access_metadata_request.py +9 -1
- lusid/models/upsert_portfolio_transactions_response.py +9 -1
- lusid/models/upsert_quote_access_metadata_rule_request.py +9 -1
- lusid/models/upsert_quote_request.py +10 -2
- lusid/models/upsert_quotes_response.py +9 -1
- lusid/models/upsert_recipe_composer_request.py +81 -0
- lusid/models/upsert_recipe_request.py +12 -10
- lusid/models/upsert_reference_portfolio_constituent_properties_request.py +92 -0
- lusid/models/upsert_reference_portfolio_constituent_properties_response.py +123 -0
- lusid/models/upsert_reference_portfolio_constituents_request.py +9 -1
- lusid/models/upsert_reference_portfolio_constituents_response.py +9 -1
- lusid/models/upsert_result_values_data_request.py +9 -1
- lusid/models/upsert_returns_response.py +9 -1
- lusid/models/upsert_single_structured_data_response.py +9 -1
- lusid/models/upsert_structured_data_response.py +9 -1
- lusid/models/upsert_structured_result_data_request.py +9 -1
- lusid/models/upsert_transaction_properties_response.py +9 -1
- lusid/models/upsert_translation_script_request.py +83 -0
- lusid/models/upsert_valuation_point_request.py +130 -0
- lusid/models/user.py +9 -1
- lusid/models/valuation_point_data_query_parameters.py +81 -0
- lusid/models/valuation_point_data_request.py +84 -0
- lusid/models/valuation_point_data_response.py +164 -0
- lusid/models/valuation_point_overview.py +133 -0
- lusid/models/valuation_point_resource_list_of_accounted_transaction.py +133 -0
- lusid/models/valuation_point_resource_list_of_journal_entry_line.py +133 -0
- lusid/models/valuation_point_resource_list_of_pnl_journal_entry_line.py +133 -0
- lusid/models/valuation_point_resource_list_of_trial_balance.py +133 -0
- lusid/models/valuation_request.py +9 -1
- lusid/models/valuation_schedule.py +19 -4
- lusid/models/valuations_reconciliation_request.py +9 -1
- lusid/models/vendor_dependency.py +9 -1
- lusid/models/vendor_model_rule.py +9 -1
- lusid/models/version.py +25 -10
- lusid/models/version_summary_dto.py +9 -1
- lusid/models/versioned_resource_list_of_a2_b_data_record.py +9 -1
- lusid/models/versioned_resource_list_of_a2_b_movement_record.py +9 -1
- lusid/models/versioned_resource_list_of_holding_contributor.py +9 -1
- lusid/models/versioned_resource_list_of_journal_entry_line.py +9 -1
- lusid/models/versioned_resource_list_of_output_transaction.py +9 -1
- lusid/models/versioned_resource_list_of_portfolio_holding.py +9 -1
- lusid/models/versioned_resource_list_of_transaction.py +9 -1
- lusid/models/versioned_resource_list_of_trial_balance.py +9 -1
- lusid/models/versioned_resource_list_with_warnings_of_portfolio_holding.py +9 -1
- lusid/models/virtual_document.py +9 -1
- lusid/models/virtual_document_row.py +9 -1
- lusid/models/virtual_row.py +9 -1
- lusid/models/warning.py +9 -1
- lusid/models/weekend_mask.py +9 -1
- lusid/models/weighted_instrument.py +29 -3
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +97 -0
- lusid/models/weighted_instruments.py +9 -1
- lusid/models/workspace.py +100 -0
- lusid/models/workspace_creation_request.py +86 -0
- lusid/models/workspace_item.py +120 -0
- lusid/models/workspace_item_creation_request.py +113 -0
- lusid/models/workspace_item_update_request.py +95 -0
- lusid/models/workspace_update_request.py +77 -0
- lusid/models/yield_curve_data.py +12 -4
- lusid/rest.py +75 -22
- {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.1.684.dist-info}/METADATA +614 -245
- lusid_sdk-2.1.684.dist-info/RECORD +1273 -0
- {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.1.684.dist-info}/WHEEL +1 -1
- lusid/extensions/api_client_builder.py +0 -138
- lusid/models/configuration_recipe_snippet.py +0 -139
- lusid/models/je_lines_query_parameters.py +0 -105
- lusid/models/look_up_pricing_model_options.py +0 -93
- lusid/models/reconciliation_break_id.py +0 -88
- lusid/models/reconciliation_run_id.py +0 -85
- lusid/models/upsert_reconciliation_break_request.py +0 -98
- lusid_sdk-2.0.50b0.dist-info/RECORD +0 -917
@@ -0,0 +1,3482 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
|
3
|
+
"""
|
4
|
+
LUSID API
|
5
|
+
|
6
|
+
FINBOURNE Technology # noqa: E501
|
7
|
+
|
8
|
+
Contact: info@finbourne.com
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
10
|
+
|
11
|
+
Do not edit the class manually.
|
12
|
+
"""
|
13
|
+
|
14
|
+
|
15
|
+
import re # noqa: F401
|
16
|
+
import io
|
17
|
+
import warnings
|
18
|
+
|
19
|
+
from pydantic.v1 import validate_arguments, ValidationError
|
20
|
+
from typing import overload, Optional, Union, Awaitable
|
21
|
+
|
22
|
+
from typing_extensions import Annotated
|
23
|
+
from datetime import datetime
|
24
|
+
|
25
|
+
from pydantic.v1 import Field, StrictStr, conint, conlist, constr, validator
|
26
|
+
|
27
|
+
from typing import Optional
|
28
|
+
|
29
|
+
from lusid.models.deleted_entity_response import DeletedEntityResponse
|
30
|
+
from lusid.models.paged_resource_list_of_workspace import PagedResourceListOfWorkspace
|
31
|
+
from lusid.models.paged_resource_list_of_workspace_item import PagedResourceListOfWorkspaceItem
|
32
|
+
from lusid.models.workspace import Workspace
|
33
|
+
from lusid.models.workspace_creation_request import WorkspaceCreationRequest
|
34
|
+
from lusid.models.workspace_item import WorkspaceItem
|
35
|
+
from lusid.models.workspace_item_creation_request import WorkspaceItemCreationRequest
|
36
|
+
from lusid.models.workspace_item_update_request import WorkspaceItemUpdateRequest
|
37
|
+
from lusid.models.workspace_update_request import WorkspaceUpdateRequest
|
38
|
+
|
39
|
+
from lusid.api_client import ApiClient
|
40
|
+
from lusid.api_response import ApiResponse
|
41
|
+
from lusid.exceptions import ( # noqa: F401
|
42
|
+
ApiTypeError,
|
43
|
+
ApiValueError
|
44
|
+
)
|
45
|
+
from lusid.extensions.configuration_options import ConfigurationOptions
|
46
|
+
|
47
|
+
|
48
|
+
class WorkspaceApi:
|
49
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
50
|
+
Ref: https://openapi-generator.tech
|
51
|
+
|
52
|
+
Do not edit the class manually.
|
53
|
+
"""
|
54
|
+
|
55
|
+
def __init__(self, api_client=None) -> None:
|
56
|
+
if api_client is None:
|
57
|
+
api_client = ApiClient.get_default()
|
58
|
+
self.api_client = api_client
|
59
|
+
|
60
|
+
@overload
|
61
|
+
async def create_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
62
|
+
...
|
63
|
+
|
64
|
+
@overload
|
65
|
+
def create_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
66
|
+
...
|
67
|
+
|
68
|
+
@validate_arguments
|
69
|
+
def create_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
70
|
+
"""[EXPERIMENTAL] CreatePersonalItem: Create a new item in a personal workspace. # noqa: E501
|
71
|
+
|
72
|
+
Create a new item in a personal workspace. # noqa: E501
|
73
|
+
This method makes a synchronous HTTP request by default. To make an
|
74
|
+
asynchronous HTTP request, please pass async_req=True
|
75
|
+
|
76
|
+
>>> thread = api.create_personal_item(workspace_name, workspace_item_creation_request, async_req=True)
|
77
|
+
>>> result = thread.get()
|
78
|
+
|
79
|
+
:param workspace_name: The item's workspace name. (required)
|
80
|
+
:type workspace_name: str
|
81
|
+
:param workspace_item_creation_request: The item to be created.
|
82
|
+
:type workspace_item_creation_request: WorkspaceItemCreationRequest
|
83
|
+
:param async_req: Whether to execute the request asynchronously.
|
84
|
+
:type async_req: bool, optional
|
85
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
86
|
+
:param opts: Configuration options for this request
|
87
|
+
:type opts: ConfigurationOptions, optional
|
88
|
+
:return: Returns the result object.
|
89
|
+
If the method is called asynchronously,
|
90
|
+
returns the request thread.
|
91
|
+
:rtype: WorkspaceItem
|
92
|
+
"""
|
93
|
+
kwargs['_return_http_data_only'] = True
|
94
|
+
if '_preload_content' in kwargs:
|
95
|
+
message = "Error! Please call the create_personal_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
96
|
+
raise ValueError(message)
|
97
|
+
if async_req is not None:
|
98
|
+
kwargs['async_req'] = async_req
|
99
|
+
return self.create_personal_item_with_http_info(workspace_name, workspace_item_creation_request, **kwargs) # noqa: E501
|
100
|
+
|
101
|
+
@validate_arguments
|
102
|
+
def create_personal_item_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
103
|
+
"""[EXPERIMENTAL] CreatePersonalItem: Create a new item in a personal workspace. # noqa: E501
|
104
|
+
|
105
|
+
Create a new item in a personal workspace. # noqa: E501
|
106
|
+
This method makes a synchronous HTTP request by default. To make an
|
107
|
+
asynchronous HTTP request, please pass async_req=True
|
108
|
+
|
109
|
+
>>> thread = api.create_personal_item_with_http_info(workspace_name, workspace_item_creation_request, async_req=True)
|
110
|
+
>>> result = thread.get()
|
111
|
+
|
112
|
+
:param workspace_name: The item's workspace name. (required)
|
113
|
+
:type workspace_name: str
|
114
|
+
:param workspace_item_creation_request: The item to be created.
|
115
|
+
:type workspace_item_creation_request: WorkspaceItemCreationRequest
|
116
|
+
:param async_req: Whether to execute the request asynchronously.
|
117
|
+
:type async_req: bool, optional
|
118
|
+
:param _preload_content: if False, the ApiResponse.data will
|
119
|
+
be set to none and raw_data will store the
|
120
|
+
HTTP response body without reading/decoding.
|
121
|
+
Default is True.
|
122
|
+
:type _preload_content: bool, optional
|
123
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
124
|
+
object with status code, headers, etc
|
125
|
+
:type _return_http_data_only: bool, optional
|
126
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
127
|
+
:param opts: Configuration options for this request
|
128
|
+
:type opts: ConfigurationOptions, optional
|
129
|
+
:param _request_auth: set to override the auth_settings for an a single
|
130
|
+
request; this effectively ignores the authentication
|
131
|
+
in the spec for a single request.
|
132
|
+
:type _request_auth: dict, optional
|
133
|
+
:type _content_type: string, optional: force content-type for the request
|
134
|
+
:return: Returns the result object.
|
135
|
+
If the method is called asynchronously,
|
136
|
+
returns the request thread.
|
137
|
+
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
138
|
+
"""
|
139
|
+
|
140
|
+
_params = locals()
|
141
|
+
|
142
|
+
_all_params = [
|
143
|
+
'workspace_name',
|
144
|
+
'workspace_item_creation_request'
|
145
|
+
]
|
146
|
+
_all_params.extend(
|
147
|
+
[
|
148
|
+
'async_req',
|
149
|
+
'_return_http_data_only',
|
150
|
+
'_preload_content',
|
151
|
+
'_request_timeout',
|
152
|
+
'_request_auth',
|
153
|
+
'_content_type',
|
154
|
+
'_headers',
|
155
|
+
'opts'
|
156
|
+
]
|
157
|
+
)
|
158
|
+
|
159
|
+
# validate the arguments
|
160
|
+
for _key, _val in _params['kwargs'].items():
|
161
|
+
if _key not in _all_params:
|
162
|
+
raise ApiTypeError(
|
163
|
+
"Got an unexpected keyword argument '%s'"
|
164
|
+
" to method create_personal_item" % _key
|
165
|
+
)
|
166
|
+
_params[_key] = _val
|
167
|
+
del _params['kwargs']
|
168
|
+
|
169
|
+
_collection_formats = {}
|
170
|
+
|
171
|
+
# process the path parameters
|
172
|
+
_path_params = {}
|
173
|
+
if _params['workspace_name']:
|
174
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
175
|
+
|
176
|
+
|
177
|
+
# process the query parameters
|
178
|
+
_query_params = []
|
179
|
+
# process the header parameters
|
180
|
+
_header_params = dict(_params.get('_headers', {}))
|
181
|
+
# process the form parameters
|
182
|
+
_form_params = []
|
183
|
+
_files = {}
|
184
|
+
# process the body parameter
|
185
|
+
_body_params = None
|
186
|
+
if _params['workspace_item_creation_request'] is not None:
|
187
|
+
_body_params = _params['workspace_item_creation_request']
|
188
|
+
|
189
|
+
# set the HTTP header `Accept`
|
190
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
191
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
192
|
+
|
193
|
+
# set the HTTP header `Content-Type`
|
194
|
+
_content_types_list = _params.get('_content_type',
|
195
|
+
self.api_client.select_header_content_type(
|
196
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
197
|
+
if _content_types_list:
|
198
|
+
_header_params['Content-Type'] = _content_types_list
|
199
|
+
|
200
|
+
# authentication setting
|
201
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
202
|
+
|
203
|
+
_response_types_map = {
|
204
|
+
'201': "WorkspaceItem",
|
205
|
+
'400': "LusidValidationProblemDetails",
|
206
|
+
}
|
207
|
+
|
208
|
+
return self.api_client.call_api(
|
209
|
+
'/api/workspaces/personal/{workspaceName}/items', 'POST',
|
210
|
+
_path_params,
|
211
|
+
_query_params,
|
212
|
+
_header_params,
|
213
|
+
body=_body_params,
|
214
|
+
post_params=_form_params,
|
215
|
+
files=_files,
|
216
|
+
response_types_map=_response_types_map,
|
217
|
+
auth_settings=_auth_settings,
|
218
|
+
async_req=_params.get('async_req'),
|
219
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
220
|
+
_preload_content=_params.get('_preload_content', True),
|
221
|
+
_request_timeout=_params.get('_request_timeout'),
|
222
|
+
opts=_params.get('opts'),
|
223
|
+
collection_formats=_collection_formats,
|
224
|
+
_request_auth=_params.get('_request_auth'))
|
225
|
+
|
226
|
+
@overload
|
227
|
+
async def create_personal_workspace(self, workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, **kwargs) -> Workspace: # noqa: E501
|
228
|
+
...
|
229
|
+
|
230
|
+
@overload
|
231
|
+
def create_personal_workspace(self, workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
232
|
+
...
|
233
|
+
|
234
|
+
@validate_arguments
|
235
|
+
def create_personal_workspace(self, workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
236
|
+
"""[EXPERIMENTAL] CreatePersonalWorkspace: Create a new personal workspace. # noqa: E501
|
237
|
+
|
238
|
+
Create a new personal workspace. # noqa: E501
|
239
|
+
This method makes a synchronous HTTP request by default. To make an
|
240
|
+
asynchronous HTTP request, please pass async_req=True
|
241
|
+
|
242
|
+
>>> thread = api.create_personal_workspace(workspace_creation_request, async_req=True)
|
243
|
+
>>> result = thread.get()
|
244
|
+
|
245
|
+
:param workspace_creation_request: The workspace to be created.
|
246
|
+
:type workspace_creation_request: WorkspaceCreationRequest
|
247
|
+
:param async_req: Whether to execute the request asynchronously.
|
248
|
+
:type async_req: bool, optional
|
249
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
250
|
+
:param opts: Configuration options for this request
|
251
|
+
:type opts: ConfigurationOptions, optional
|
252
|
+
:return: Returns the result object.
|
253
|
+
If the method is called asynchronously,
|
254
|
+
returns the request thread.
|
255
|
+
:rtype: Workspace
|
256
|
+
"""
|
257
|
+
kwargs['_return_http_data_only'] = True
|
258
|
+
if '_preload_content' in kwargs:
|
259
|
+
message = "Error! Please call the create_personal_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
260
|
+
raise ValueError(message)
|
261
|
+
if async_req is not None:
|
262
|
+
kwargs['async_req'] = async_req
|
263
|
+
return self.create_personal_workspace_with_http_info(workspace_creation_request, **kwargs) # noqa: E501
|
264
|
+
|
265
|
+
@validate_arguments
|
266
|
+
def create_personal_workspace_with_http_info(self, workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
267
|
+
"""[EXPERIMENTAL] CreatePersonalWorkspace: Create a new personal workspace. # noqa: E501
|
268
|
+
|
269
|
+
Create a new personal workspace. # noqa: E501
|
270
|
+
This method makes a synchronous HTTP request by default. To make an
|
271
|
+
asynchronous HTTP request, please pass async_req=True
|
272
|
+
|
273
|
+
>>> thread = api.create_personal_workspace_with_http_info(workspace_creation_request, async_req=True)
|
274
|
+
>>> result = thread.get()
|
275
|
+
|
276
|
+
:param workspace_creation_request: The workspace to be created.
|
277
|
+
:type workspace_creation_request: WorkspaceCreationRequest
|
278
|
+
:param async_req: Whether to execute the request asynchronously.
|
279
|
+
:type async_req: bool, optional
|
280
|
+
:param _preload_content: if False, the ApiResponse.data will
|
281
|
+
be set to none and raw_data will store the
|
282
|
+
HTTP response body without reading/decoding.
|
283
|
+
Default is True.
|
284
|
+
:type _preload_content: bool, optional
|
285
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
286
|
+
object with status code, headers, etc
|
287
|
+
:type _return_http_data_only: bool, optional
|
288
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
289
|
+
:param opts: Configuration options for this request
|
290
|
+
:type opts: ConfigurationOptions, optional
|
291
|
+
:param _request_auth: set to override the auth_settings for an a single
|
292
|
+
request; this effectively ignores the authentication
|
293
|
+
in the spec for a single request.
|
294
|
+
:type _request_auth: dict, optional
|
295
|
+
:type _content_type: string, optional: force content-type for the request
|
296
|
+
:return: Returns the result object.
|
297
|
+
If the method is called asynchronously,
|
298
|
+
returns the request thread.
|
299
|
+
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
300
|
+
"""
|
301
|
+
|
302
|
+
_params = locals()
|
303
|
+
|
304
|
+
_all_params = [
|
305
|
+
'workspace_creation_request'
|
306
|
+
]
|
307
|
+
_all_params.extend(
|
308
|
+
[
|
309
|
+
'async_req',
|
310
|
+
'_return_http_data_only',
|
311
|
+
'_preload_content',
|
312
|
+
'_request_timeout',
|
313
|
+
'_request_auth',
|
314
|
+
'_content_type',
|
315
|
+
'_headers',
|
316
|
+
'opts'
|
317
|
+
]
|
318
|
+
)
|
319
|
+
|
320
|
+
# validate the arguments
|
321
|
+
for _key, _val in _params['kwargs'].items():
|
322
|
+
if _key not in _all_params:
|
323
|
+
raise ApiTypeError(
|
324
|
+
"Got an unexpected keyword argument '%s'"
|
325
|
+
" to method create_personal_workspace" % _key
|
326
|
+
)
|
327
|
+
_params[_key] = _val
|
328
|
+
del _params['kwargs']
|
329
|
+
|
330
|
+
_collection_formats = {}
|
331
|
+
|
332
|
+
# process the path parameters
|
333
|
+
_path_params = {}
|
334
|
+
|
335
|
+
# process the query parameters
|
336
|
+
_query_params = []
|
337
|
+
# process the header parameters
|
338
|
+
_header_params = dict(_params.get('_headers', {}))
|
339
|
+
# process the form parameters
|
340
|
+
_form_params = []
|
341
|
+
_files = {}
|
342
|
+
# process the body parameter
|
343
|
+
_body_params = None
|
344
|
+
if _params['workspace_creation_request'] is not None:
|
345
|
+
_body_params = _params['workspace_creation_request']
|
346
|
+
|
347
|
+
# set the HTTP header `Accept`
|
348
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
349
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
350
|
+
|
351
|
+
# set the HTTP header `Content-Type`
|
352
|
+
_content_types_list = _params.get('_content_type',
|
353
|
+
self.api_client.select_header_content_type(
|
354
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
355
|
+
if _content_types_list:
|
356
|
+
_header_params['Content-Type'] = _content_types_list
|
357
|
+
|
358
|
+
# authentication setting
|
359
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
360
|
+
|
361
|
+
_response_types_map = {
|
362
|
+
'201': "Workspace",
|
363
|
+
'400': "LusidValidationProblemDetails",
|
364
|
+
}
|
365
|
+
|
366
|
+
return self.api_client.call_api(
|
367
|
+
'/api/workspaces/personal', 'POST',
|
368
|
+
_path_params,
|
369
|
+
_query_params,
|
370
|
+
_header_params,
|
371
|
+
body=_body_params,
|
372
|
+
post_params=_form_params,
|
373
|
+
files=_files,
|
374
|
+
response_types_map=_response_types_map,
|
375
|
+
auth_settings=_auth_settings,
|
376
|
+
async_req=_params.get('async_req'),
|
377
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
378
|
+
_preload_content=_params.get('_preload_content', True),
|
379
|
+
_request_timeout=_params.get('_request_timeout'),
|
380
|
+
opts=_params.get('opts'),
|
381
|
+
collection_formats=_collection_formats,
|
382
|
+
_request_auth=_params.get('_request_auth'))
|
383
|
+
|
384
|
+
@overload
|
385
|
+
async def create_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
386
|
+
...
|
387
|
+
|
388
|
+
@overload
|
389
|
+
def create_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
390
|
+
...
|
391
|
+
|
392
|
+
@validate_arguments
|
393
|
+
def create_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
394
|
+
"""[EXPERIMENTAL] CreateSharedItem: Create a new item in a shared workspace. # noqa: E501
|
395
|
+
|
396
|
+
Create a new item in a shared workspace. # noqa: E501
|
397
|
+
This method makes a synchronous HTTP request by default. To make an
|
398
|
+
asynchronous HTTP request, please pass async_req=True
|
399
|
+
|
400
|
+
>>> thread = api.create_shared_item(workspace_name, workspace_item_creation_request, async_req=True)
|
401
|
+
>>> result = thread.get()
|
402
|
+
|
403
|
+
:param workspace_name: The item's workspace name. (required)
|
404
|
+
:type workspace_name: str
|
405
|
+
:param workspace_item_creation_request: The item to be created.
|
406
|
+
:type workspace_item_creation_request: WorkspaceItemCreationRequest
|
407
|
+
:param async_req: Whether to execute the request asynchronously.
|
408
|
+
:type async_req: bool, optional
|
409
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
410
|
+
:param opts: Configuration options for this request
|
411
|
+
:type opts: ConfigurationOptions, optional
|
412
|
+
:return: Returns the result object.
|
413
|
+
If the method is called asynchronously,
|
414
|
+
returns the request thread.
|
415
|
+
:rtype: WorkspaceItem
|
416
|
+
"""
|
417
|
+
kwargs['_return_http_data_only'] = True
|
418
|
+
if '_preload_content' in kwargs:
|
419
|
+
message = "Error! Please call the create_shared_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
420
|
+
raise ValueError(message)
|
421
|
+
if async_req is not None:
|
422
|
+
kwargs['async_req'] = async_req
|
423
|
+
return self.create_shared_item_with_http_info(workspace_name, workspace_item_creation_request, **kwargs) # noqa: E501
|
424
|
+
|
425
|
+
@validate_arguments
|
426
|
+
def create_shared_item_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], workspace_item_creation_request : Annotated[Optional[WorkspaceItemCreationRequest], Field(description="The item to be created.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
427
|
+
"""[EXPERIMENTAL] CreateSharedItem: Create a new item in a shared workspace. # noqa: E501
|
428
|
+
|
429
|
+
Create a new item in a shared workspace. # noqa: E501
|
430
|
+
This method makes a synchronous HTTP request by default. To make an
|
431
|
+
asynchronous HTTP request, please pass async_req=True
|
432
|
+
|
433
|
+
>>> thread = api.create_shared_item_with_http_info(workspace_name, workspace_item_creation_request, async_req=True)
|
434
|
+
>>> result = thread.get()
|
435
|
+
|
436
|
+
:param workspace_name: The item's workspace name. (required)
|
437
|
+
:type workspace_name: str
|
438
|
+
:param workspace_item_creation_request: The item to be created.
|
439
|
+
:type workspace_item_creation_request: WorkspaceItemCreationRequest
|
440
|
+
:param async_req: Whether to execute the request asynchronously.
|
441
|
+
:type async_req: bool, optional
|
442
|
+
:param _preload_content: if False, the ApiResponse.data will
|
443
|
+
be set to none and raw_data will store the
|
444
|
+
HTTP response body without reading/decoding.
|
445
|
+
Default is True.
|
446
|
+
:type _preload_content: bool, optional
|
447
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
448
|
+
object with status code, headers, etc
|
449
|
+
:type _return_http_data_only: bool, optional
|
450
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
451
|
+
:param opts: Configuration options for this request
|
452
|
+
:type opts: ConfigurationOptions, optional
|
453
|
+
:param _request_auth: set to override the auth_settings for an a single
|
454
|
+
request; this effectively ignores the authentication
|
455
|
+
in the spec for a single request.
|
456
|
+
:type _request_auth: dict, optional
|
457
|
+
:type _content_type: string, optional: force content-type for the request
|
458
|
+
:return: Returns the result object.
|
459
|
+
If the method is called asynchronously,
|
460
|
+
returns the request thread.
|
461
|
+
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
462
|
+
"""
|
463
|
+
|
464
|
+
_params = locals()
|
465
|
+
|
466
|
+
_all_params = [
|
467
|
+
'workspace_name',
|
468
|
+
'workspace_item_creation_request'
|
469
|
+
]
|
470
|
+
_all_params.extend(
|
471
|
+
[
|
472
|
+
'async_req',
|
473
|
+
'_return_http_data_only',
|
474
|
+
'_preload_content',
|
475
|
+
'_request_timeout',
|
476
|
+
'_request_auth',
|
477
|
+
'_content_type',
|
478
|
+
'_headers',
|
479
|
+
'opts'
|
480
|
+
]
|
481
|
+
)
|
482
|
+
|
483
|
+
# validate the arguments
|
484
|
+
for _key, _val in _params['kwargs'].items():
|
485
|
+
if _key not in _all_params:
|
486
|
+
raise ApiTypeError(
|
487
|
+
"Got an unexpected keyword argument '%s'"
|
488
|
+
" to method create_shared_item" % _key
|
489
|
+
)
|
490
|
+
_params[_key] = _val
|
491
|
+
del _params['kwargs']
|
492
|
+
|
493
|
+
_collection_formats = {}
|
494
|
+
|
495
|
+
# process the path parameters
|
496
|
+
_path_params = {}
|
497
|
+
if _params['workspace_name']:
|
498
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
499
|
+
|
500
|
+
|
501
|
+
# process the query parameters
|
502
|
+
_query_params = []
|
503
|
+
# process the header parameters
|
504
|
+
_header_params = dict(_params.get('_headers', {}))
|
505
|
+
# process the form parameters
|
506
|
+
_form_params = []
|
507
|
+
_files = {}
|
508
|
+
# process the body parameter
|
509
|
+
_body_params = None
|
510
|
+
if _params['workspace_item_creation_request'] is not None:
|
511
|
+
_body_params = _params['workspace_item_creation_request']
|
512
|
+
|
513
|
+
# set the HTTP header `Accept`
|
514
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
515
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
516
|
+
|
517
|
+
# set the HTTP header `Content-Type`
|
518
|
+
_content_types_list = _params.get('_content_type',
|
519
|
+
self.api_client.select_header_content_type(
|
520
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
521
|
+
if _content_types_list:
|
522
|
+
_header_params['Content-Type'] = _content_types_list
|
523
|
+
|
524
|
+
# authentication setting
|
525
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
526
|
+
|
527
|
+
_response_types_map = {
|
528
|
+
'201': "WorkspaceItem",
|
529
|
+
'400': "LusidValidationProblemDetails",
|
530
|
+
}
|
531
|
+
|
532
|
+
return self.api_client.call_api(
|
533
|
+
'/api/workspaces/shared/{workspaceName}/items', 'POST',
|
534
|
+
_path_params,
|
535
|
+
_query_params,
|
536
|
+
_header_params,
|
537
|
+
body=_body_params,
|
538
|
+
post_params=_form_params,
|
539
|
+
files=_files,
|
540
|
+
response_types_map=_response_types_map,
|
541
|
+
auth_settings=_auth_settings,
|
542
|
+
async_req=_params.get('async_req'),
|
543
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
544
|
+
_preload_content=_params.get('_preload_content', True),
|
545
|
+
_request_timeout=_params.get('_request_timeout'),
|
546
|
+
opts=_params.get('opts'),
|
547
|
+
collection_formats=_collection_formats,
|
548
|
+
_request_auth=_params.get('_request_auth'))
|
549
|
+
|
550
|
+
@overload
|
551
|
+
async def create_shared_workspace(self, workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, **kwargs) -> Workspace: # noqa: E501
|
552
|
+
...
|
553
|
+
|
554
|
+
@overload
|
555
|
+
def create_shared_workspace(self, workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
556
|
+
...
|
557
|
+
|
558
|
+
@validate_arguments
|
559
|
+
def create_shared_workspace(self, workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
560
|
+
"""[EXPERIMENTAL] CreateSharedWorkspace: Create a new shared workspace. # noqa: E501
|
561
|
+
|
562
|
+
Create a new shared workspace. # noqa: E501
|
563
|
+
This method makes a synchronous HTTP request by default. To make an
|
564
|
+
asynchronous HTTP request, please pass async_req=True
|
565
|
+
|
566
|
+
>>> thread = api.create_shared_workspace(workspace_creation_request, async_req=True)
|
567
|
+
>>> result = thread.get()
|
568
|
+
|
569
|
+
:param workspace_creation_request: The workspace to be created.
|
570
|
+
:type workspace_creation_request: WorkspaceCreationRequest
|
571
|
+
:param async_req: Whether to execute the request asynchronously.
|
572
|
+
:type async_req: bool, optional
|
573
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
574
|
+
:param opts: Configuration options for this request
|
575
|
+
:type opts: ConfigurationOptions, optional
|
576
|
+
:return: Returns the result object.
|
577
|
+
If the method is called asynchronously,
|
578
|
+
returns the request thread.
|
579
|
+
:rtype: Workspace
|
580
|
+
"""
|
581
|
+
kwargs['_return_http_data_only'] = True
|
582
|
+
if '_preload_content' in kwargs:
|
583
|
+
message = "Error! Please call the create_shared_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
584
|
+
raise ValueError(message)
|
585
|
+
if async_req is not None:
|
586
|
+
kwargs['async_req'] = async_req
|
587
|
+
return self.create_shared_workspace_with_http_info(workspace_creation_request, **kwargs) # noqa: E501
|
588
|
+
|
589
|
+
@validate_arguments
|
590
|
+
def create_shared_workspace_with_http_info(self, workspace_creation_request : Annotated[Optional[WorkspaceCreationRequest], Field(description="The workspace to be created.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
591
|
+
"""[EXPERIMENTAL] CreateSharedWorkspace: Create a new shared workspace. # noqa: E501
|
592
|
+
|
593
|
+
Create a new shared workspace. # noqa: E501
|
594
|
+
This method makes a synchronous HTTP request by default. To make an
|
595
|
+
asynchronous HTTP request, please pass async_req=True
|
596
|
+
|
597
|
+
>>> thread = api.create_shared_workspace_with_http_info(workspace_creation_request, async_req=True)
|
598
|
+
>>> result = thread.get()
|
599
|
+
|
600
|
+
:param workspace_creation_request: The workspace to be created.
|
601
|
+
:type workspace_creation_request: WorkspaceCreationRequest
|
602
|
+
:param async_req: Whether to execute the request asynchronously.
|
603
|
+
:type async_req: bool, optional
|
604
|
+
:param _preload_content: if False, the ApiResponse.data will
|
605
|
+
be set to none and raw_data will store the
|
606
|
+
HTTP response body without reading/decoding.
|
607
|
+
Default is True.
|
608
|
+
:type _preload_content: bool, optional
|
609
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
610
|
+
object with status code, headers, etc
|
611
|
+
:type _return_http_data_only: bool, optional
|
612
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
613
|
+
:param opts: Configuration options for this request
|
614
|
+
:type opts: ConfigurationOptions, optional
|
615
|
+
:param _request_auth: set to override the auth_settings for an a single
|
616
|
+
request; this effectively ignores the authentication
|
617
|
+
in the spec for a single request.
|
618
|
+
:type _request_auth: dict, optional
|
619
|
+
:type _content_type: string, optional: force content-type for the request
|
620
|
+
:return: Returns the result object.
|
621
|
+
If the method is called asynchronously,
|
622
|
+
returns the request thread.
|
623
|
+
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
624
|
+
"""
|
625
|
+
|
626
|
+
_params = locals()
|
627
|
+
|
628
|
+
_all_params = [
|
629
|
+
'workspace_creation_request'
|
630
|
+
]
|
631
|
+
_all_params.extend(
|
632
|
+
[
|
633
|
+
'async_req',
|
634
|
+
'_return_http_data_only',
|
635
|
+
'_preload_content',
|
636
|
+
'_request_timeout',
|
637
|
+
'_request_auth',
|
638
|
+
'_content_type',
|
639
|
+
'_headers',
|
640
|
+
'opts'
|
641
|
+
]
|
642
|
+
)
|
643
|
+
|
644
|
+
# validate the arguments
|
645
|
+
for _key, _val in _params['kwargs'].items():
|
646
|
+
if _key not in _all_params:
|
647
|
+
raise ApiTypeError(
|
648
|
+
"Got an unexpected keyword argument '%s'"
|
649
|
+
" to method create_shared_workspace" % _key
|
650
|
+
)
|
651
|
+
_params[_key] = _val
|
652
|
+
del _params['kwargs']
|
653
|
+
|
654
|
+
_collection_formats = {}
|
655
|
+
|
656
|
+
# process the path parameters
|
657
|
+
_path_params = {}
|
658
|
+
|
659
|
+
# process the query parameters
|
660
|
+
_query_params = []
|
661
|
+
# process the header parameters
|
662
|
+
_header_params = dict(_params.get('_headers', {}))
|
663
|
+
# process the form parameters
|
664
|
+
_form_params = []
|
665
|
+
_files = {}
|
666
|
+
# process the body parameter
|
667
|
+
_body_params = None
|
668
|
+
if _params['workspace_creation_request'] is not None:
|
669
|
+
_body_params = _params['workspace_creation_request']
|
670
|
+
|
671
|
+
# set the HTTP header `Accept`
|
672
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
673
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
674
|
+
|
675
|
+
# set the HTTP header `Content-Type`
|
676
|
+
_content_types_list = _params.get('_content_type',
|
677
|
+
self.api_client.select_header_content_type(
|
678
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
679
|
+
if _content_types_list:
|
680
|
+
_header_params['Content-Type'] = _content_types_list
|
681
|
+
|
682
|
+
# authentication setting
|
683
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
684
|
+
|
685
|
+
_response_types_map = {
|
686
|
+
'201': "Workspace",
|
687
|
+
'400': "LusidValidationProblemDetails",
|
688
|
+
}
|
689
|
+
|
690
|
+
return self.api_client.call_api(
|
691
|
+
'/api/workspaces/shared', 'POST',
|
692
|
+
_path_params,
|
693
|
+
_query_params,
|
694
|
+
_header_params,
|
695
|
+
body=_body_params,
|
696
|
+
post_params=_form_params,
|
697
|
+
files=_files,
|
698
|
+
response_types_map=_response_types_map,
|
699
|
+
auth_settings=_auth_settings,
|
700
|
+
async_req=_params.get('async_req'),
|
701
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
702
|
+
_preload_content=_params.get('_preload_content', True),
|
703
|
+
_request_timeout=_params.get('_request_timeout'),
|
704
|
+
opts=_params.get('opts'),
|
705
|
+
collection_formats=_collection_formats,
|
706
|
+
_request_auth=_params.get('_request_auth'))
|
707
|
+
|
708
|
+
@overload
|
709
|
+
async def delete_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
710
|
+
...
|
711
|
+
|
712
|
+
@overload
|
713
|
+
def delete_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
714
|
+
...
|
715
|
+
|
716
|
+
@validate_arguments
|
717
|
+
def delete_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
718
|
+
"""[EXPERIMENTAL] DeletePersonalItem: Delete an item from a personal workspace. # noqa: E501
|
719
|
+
|
720
|
+
Delete an item from a personal workspace. # noqa: E501
|
721
|
+
This method makes a synchronous HTTP request by default. To make an
|
722
|
+
asynchronous HTTP request, please pass async_req=True
|
723
|
+
|
724
|
+
>>> thread = api.delete_personal_item(workspace_name, group_name, item_name, async_req=True)
|
725
|
+
>>> result = thread.get()
|
726
|
+
|
727
|
+
:param workspace_name: The name of the personal workspace. (required)
|
728
|
+
:type workspace_name: str
|
729
|
+
:param group_name: The group containing the item. (required)
|
730
|
+
:type group_name: str
|
731
|
+
:param item_name: The name of the item. (required)
|
732
|
+
:type item_name: str
|
733
|
+
:param async_req: Whether to execute the request asynchronously.
|
734
|
+
:type async_req: bool, optional
|
735
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
736
|
+
:param opts: Configuration options for this request
|
737
|
+
:type opts: ConfigurationOptions, optional
|
738
|
+
:return: Returns the result object.
|
739
|
+
If the method is called asynchronously,
|
740
|
+
returns the request thread.
|
741
|
+
:rtype: DeletedEntityResponse
|
742
|
+
"""
|
743
|
+
kwargs['_return_http_data_only'] = True
|
744
|
+
if '_preload_content' in kwargs:
|
745
|
+
message = "Error! Please call the delete_personal_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
746
|
+
raise ValueError(message)
|
747
|
+
if async_req is not None:
|
748
|
+
kwargs['async_req'] = async_req
|
749
|
+
return self.delete_personal_item_with_http_info(workspace_name, group_name, item_name, **kwargs) # noqa: E501
|
750
|
+
|
751
|
+
@validate_arguments
|
752
|
+
def delete_personal_item_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], **kwargs) -> ApiResponse: # noqa: E501
|
753
|
+
"""[EXPERIMENTAL] DeletePersonalItem: Delete an item from a personal workspace. # noqa: E501
|
754
|
+
|
755
|
+
Delete an item from a personal workspace. # noqa: E501
|
756
|
+
This method makes a synchronous HTTP request by default. To make an
|
757
|
+
asynchronous HTTP request, please pass async_req=True
|
758
|
+
|
759
|
+
>>> thread = api.delete_personal_item_with_http_info(workspace_name, group_name, item_name, async_req=True)
|
760
|
+
>>> result = thread.get()
|
761
|
+
|
762
|
+
:param workspace_name: The name of the personal workspace. (required)
|
763
|
+
:type workspace_name: str
|
764
|
+
:param group_name: The group containing the item. (required)
|
765
|
+
:type group_name: str
|
766
|
+
:param item_name: The name of the item. (required)
|
767
|
+
:type item_name: str
|
768
|
+
:param async_req: Whether to execute the request asynchronously.
|
769
|
+
:type async_req: bool, optional
|
770
|
+
:param _preload_content: if False, the ApiResponse.data will
|
771
|
+
be set to none and raw_data will store the
|
772
|
+
HTTP response body without reading/decoding.
|
773
|
+
Default is True.
|
774
|
+
:type _preload_content: bool, optional
|
775
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
776
|
+
object with status code, headers, etc
|
777
|
+
:type _return_http_data_only: bool, optional
|
778
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
779
|
+
:param opts: Configuration options for this request
|
780
|
+
:type opts: ConfigurationOptions, optional
|
781
|
+
:param _request_auth: set to override the auth_settings for an a single
|
782
|
+
request; this effectively ignores the authentication
|
783
|
+
in the spec for a single request.
|
784
|
+
:type _request_auth: dict, optional
|
785
|
+
:type _content_type: string, optional: force content-type for the request
|
786
|
+
:return: Returns the result object.
|
787
|
+
If the method is called asynchronously,
|
788
|
+
returns the request thread.
|
789
|
+
:rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
790
|
+
"""
|
791
|
+
|
792
|
+
_params = locals()
|
793
|
+
|
794
|
+
_all_params = [
|
795
|
+
'workspace_name',
|
796
|
+
'group_name',
|
797
|
+
'item_name'
|
798
|
+
]
|
799
|
+
_all_params.extend(
|
800
|
+
[
|
801
|
+
'async_req',
|
802
|
+
'_return_http_data_only',
|
803
|
+
'_preload_content',
|
804
|
+
'_request_timeout',
|
805
|
+
'_request_auth',
|
806
|
+
'_content_type',
|
807
|
+
'_headers',
|
808
|
+
'opts'
|
809
|
+
]
|
810
|
+
)
|
811
|
+
|
812
|
+
# validate the arguments
|
813
|
+
for _key, _val in _params['kwargs'].items():
|
814
|
+
if _key not in _all_params:
|
815
|
+
raise ApiTypeError(
|
816
|
+
"Got an unexpected keyword argument '%s'"
|
817
|
+
" to method delete_personal_item" % _key
|
818
|
+
)
|
819
|
+
_params[_key] = _val
|
820
|
+
del _params['kwargs']
|
821
|
+
|
822
|
+
_collection_formats = {}
|
823
|
+
|
824
|
+
# process the path parameters
|
825
|
+
_path_params = {}
|
826
|
+
if _params['workspace_name']:
|
827
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
828
|
+
|
829
|
+
if _params['group_name']:
|
830
|
+
_path_params['groupName'] = _params['group_name']
|
831
|
+
|
832
|
+
if _params['item_name']:
|
833
|
+
_path_params['itemName'] = _params['item_name']
|
834
|
+
|
835
|
+
|
836
|
+
# process the query parameters
|
837
|
+
_query_params = []
|
838
|
+
# process the header parameters
|
839
|
+
_header_params = dict(_params.get('_headers', {}))
|
840
|
+
# process the form parameters
|
841
|
+
_form_params = []
|
842
|
+
_files = {}
|
843
|
+
# process the body parameter
|
844
|
+
_body_params = None
|
845
|
+
# set the HTTP header `Accept`
|
846
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
847
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
848
|
+
|
849
|
+
# authentication setting
|
850
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
851
|
+
|
852
|
+
_response_types_map = {
|
853
|
+
'200': "DeletedEntityResponse",
|
854
|
+
'400': "LusidValidationProblemDetails",
|
855
|
+
}
|
856
|
+
|
857
|
+
return self.api_client.call_api(
|
858
|
+
'/api/workspaces/personal/{workspaceName}/items/{groupName}/{itemName}', 'DELETE',
|
859
|
+
_path_params,
|
860
|
+
_query_params,
|
861
|
+
_header_params,
|
862
|
+
body=_body_params,
|
863
|
+
post_params=_form_params,
|
864
|
+
files=_files,
|
865
|
+
response_types_map=_response_types_map,
|
866
|
+
auth_settings=_auth_settings,
|
867
|
+
async_req=_params.get('async_req'),
|
868
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
869
|
+
_preload_content=_params.get('_preload_content', True),
|
870
|
+
_request_timeout=_params.get('_request_timeout'),
|
871
|
+
opts=_params.get('opts'),
|
872
|
+
collection_formats=_collection_formats,
|
873
|
+
_request_auth=_params.get('_request_auth'))
|
874
|
+
|
875
|
+
@overload
|
876
|
+
async def delete_personal_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
877
|
+
...
|
878
|
+
|
879
|
+
@overload
|
880
|
+
def delete_personal_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
881
|
+
...
|
882
|
+
|
883
|
+
@validate_arguments
|
884
|
+
def delete_personal_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
885
|
+
"""[EXPERIMENTAL] DeletePersonalWorkspace: Delete a personal workspace. # noqa: E501
|
886
|
+
|
887
|
+
Delete a personal workspace. # noqa: E501
|
888
|
+
This method makes a synchronous HTTP request by default. To make an
|
889
|
+
asynchronous HTTP request, please pass async_req=True
|
890
|
+
|
891
|
+
>>> thread = api.delete_personal_workspace(workspace_name, async_req=True)
|
892
|
+
>>> result = thread.get()
|
893
|
+
|
894
|
+
:param workspace_name: The name of the personal workspace. (required)
|
895
|
+
:type workspace_name: str
|
896
|
+
:param async_req: Whether to execute the request asynchronously.
|
897
|
+
:type async_req: bool, optional
|
898
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
899
|
+
:param opts: Configuration options for this request
|
900
|
+
:type opts: ConfigurationOptions, optional
|
901
|
+
:return: Returns the result object.
|
902
|
+
If the method is called asynchronously,
|
903
|
+
returns the request thread.
|
904
|
+
:rtype: DeletedEntityResponse
|
905
|
+
"""
|
906
|
+
kwargs['_return_http_data_only'] = True
|
907
|
+
if '_preload_content' in kwargs:
|
908
|
+
message = "Error! Please call the delete_personal_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
909
|
+
raise ValueError(message)
|
910
|
+
if async_req is not None:
|
911
|
+
kwargs['async_req'] = async_req
|
912
|
+
return self.delete_personal_workspace_with_http_info(workspace_name, **kwargs) # noqa: E501
|
913
|
+
|
914
|
+
@validate_arguments
|
915
|
+
def delete_personal_workspace_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], **kwargs) -> ApiResponse: # noqa: E501
|
916
|
+
"""[EXPERIMENTAL] DeletePersonalWorkspace: Delete a personal workspace. # noqa: E501
|
917
|
+
|
918
|
+
Delete a personal workspace. # noqa: E501
|
919
|
+
This method makes a synchronous HTTP request by default. To make an
|
920
|
+
asynchronous HTTP request, please pass async_req=True
|
921
|
+
|
922
|
+
>>> thread = api.delete_personal_workspace_with_http_info(workspace_name, async_req=True)
|
923
|
+
>>> result = thread.get()
|
924
|
+
|
925
|
+
:param workspace_name: The name of the personal workspace. (required)
|
926
|
+
:type workspace_name: str
|
927
|
+
:param async_req: Whether to execute the request asynchronously.
|
928
|
+
:type async_req: bool, optional
|
929
|
+
:param _preload_content: if False, the ApiResponse.data will
|
930
|
+
be set to none and raw_data will store the
|
931
|
+
HTTP response body without reading/decoding.
|
932
|
+
Default is True.
|
933
|
+
:type _preload_content: bool, optional
|
934
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
935
|
+
object with status code, headers, etc
|
936
|
+
:type _return_http_data_only: bool, optional
|
937
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
938
|
+
:param opts: Configuration options for this request
|
939
|
+
:type opts: ConfigurationOptions, optional
|
940
|
+
:param _request_auth: set to override the auth_settings for an a single
|
941
|
+
request; this effectively ignores the authentication
|
942
|
+
in the spec for a single request.
|
943
|
+
:type _request_auth: dict, optional
|
944
|
+
:type _content_type: string, optional: force content-type for the request
|
945
|
+
:return: Returns the result object.
|
946
|
+
If the method is called asynchronously,
|
947
|
+
returns the request thread.
|
948
|
+
:rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
949
|
+
"""
|
950
|
+
|
951
|
+
_params = locals()
|
952
|
+
|
953
|
+
_all_params = [
|
954
|
+
'workspace_name'
|
955
|
+
]
|
956
|
+
_all_params.extend(
|
957
|
+
[
|
958
|
+
'async_req',
|
959
|
+
'_return_http_data_only',
|
960
|
+
'_preload_content',
|
961
|
+
'_request_timeout',
|
962
|
+
'_request_auth',
|
963
|
+
'_content_type',
|
964
|
+
'_headers',
|
965
|
+
'opts'
|
966
|
+
]
|
967
|
+
)
|
968
|
+
|
969
|
+
# validate the arguments
|
970
|
+
for _key, _val in _params['kwargs'].items():
|
971
|
+
if _key not in _all_params:
|
972
|
+
raise ApiTypeError(
|
973
|
+
"Got an unexpected keyword argument '%s'"
|
974
|
+
" to method delete_personal_workspace" % _key
|
975
|
+
)
|
976
|
+
_params[_key] = _val
|
977
|
+
del _params['kwargs']
|
978
|
+
|
979
|
+
_collection_formats = {}
|
980
|
+
|
981
|
+
# process the path parameters
|
982
|
+
_path_params = {}
|
983
|
+
if _params['workspace_name']:
|
984
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
985
|
+
|
986
|
+
|
987
|
+
# process the query parameters
|
988
|
+
_query_params = []
|
989
|
+
# process the header parameters
|
990
|
+
_header_params = dict(_params.get('_headers', {}))
|
991
|
+
# process the form parameters
|
992
|
+
_form_params = []
|
993
|
+
_files = {}
|
994
|
+
# process the body parameter
|
995
|
+
_body_params = None
|
996
|
+
# set the HTTP header `Accept`
|
997
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
998
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
999
|
+
|
1000
|
+
# authentication setting
|
1001
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1002
|
+
|
1003
|
+
_response_types_map = {
|
1004
|
+
'200': "DeletedEntityResponse",
|
1005
|
+
'400': "LusidValidationProblemDetails",
|
1006
|
+
}
|
1007
|
+
|
1008
|
+
return self.api_client.call_api(
|
1009
|
+
'/api/workspaces/personal/{workspaceName}', 'DELETE',
|
1010
|
+
_path_params,
|
1011
|
+
_query_params,
|
1012
|
+
_header_params,
|
1013
|
+
body=_body_params,
|
1014
|
+
post_params=_form_params,
|
1015
|
+
files=_files,
|
1016
|
+
response_types_map=_response_types_map,
|
1017
|
+
auth_settings=_auth_settings,
|
1018
|
+
async_req=_params.get('async_req'),
|
1019
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1020
|
+
_preload_content=_params.get('_preload_content', True),
|
1021
|
+
_request_timeout=_params.get('_request_timeout'),
|
1022
|
+
opts=_params.get('opts'),
|
1023
|
+
collection_formats=_collection_formats,
|
1024
|
+
_request_auth=_params.get('_request_auth'))
|
1025
|
+
|
1026
|
+
@overload
|
1027
|
+
async def delete_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1028
|
+
...
|
1029
|
+
|
1030
|
+
@overload
|
1031
|
+
def delete_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1032
|
+
...
|
1033
|
+
|
1034
|
+
@validate_arguments
|
1035
|
+
def delete_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
1036
|
+
"""[EXPERIMENTAL] DeleteSharedItem: Delete an item from a shared workspace. # noqa: E501
|
1037
|
+
|
1038
|
+
Delete an item from a shared workspace. # noqa: E501
|
1039
|
+
This method makes a synchronous HTTP request by default. To make an
|
1040
|
+
asynchronous HTTP request, please pass async_req=True
|
1041
|
+
|
1042
|
+
>>> thread = api.delete_shared_item(workspace_name, group_name, item_name, async_req=True)
|
1043
|
+
>>> result = thread.get()
|
1044
|
+
|
1045
|
+
:param workspace_name: The name of the shared workspace. (required)
|
1046
|
+
:type workspace_name: str
|
1047
|
+
:param group_name: The group containing the item. (required)
|
1048
|
+
:type group_name: str
|
1049
|
+
:param item_name: The name of the item. (required)
|
1050
|
+
:type item_name: str
|
1051
|
+
:param async_req: Whether to execute the request asynchronously.
|
1052
|
+
:type async_req: bool, optional
|
1053
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1054
|
+
:param opts: Configuration options for this request
|
1055
|
+
:type opts: ConfigurationOptions, optional
|
1056
|
+
:return: Returns the result object.
|
1057
|
+
If the method is called asynchronously,
|
1058
|
+
returns the request thread.
|
1059
|
+
:rtype: DeletedEntityResponse
|
1060
|
+
"""
|
1061
|
+
kwargs['_return_http_data_only'] = True
|
1062
|
+
if '_preload_content' in kwargs:
|
1063
|
+
message = "Error! Please call the delete_shared_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1064
|
+
raise ValueError(message)
|
1065
|
+
if async_req is not None:
|
1066
|
+
kwargs['async_req'] = async_req
|
1067
|
+
return self.delete_shared_item_with_http_info(workspace_name, group_name, item_name, **kwargs) # noqa: E501
|
1068
|
+
|
1069
|
+
@validate_arguments
|
1070
|
+
def delete_shared_item_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], **kwargs) -> ApiResponse: # noqa: E501
|
1071
|
+
"""[EXPERIMENTAL] DeleteSharedItem: Delete an item from a shared workspace. # noqa: E501
|
1072
|
+
|
1073
|
+
Delete an item from a shared workspace. # noqa: E501
|
1074
|
+
This method makes a synchronous HTTP request by default. To make an
|
1075
|
+
asynchronous HTTP request, please pass async_req=True
|
1076
|
+
|
1077
|
+
>>> thread = api.delete_shared_item_with_http_info(workspace_name, group_name, item_name, async_req=True)
|
1078
|
+
>>> result = thread.get()
|
1079
|
+
|
1080
|
+
:param workspace_name: The name of the shared workspace. (required)
|
1081
|
+
:type workspace_name: str
|
1082
|
+
:param group_name: The group containing the item. (required)
|
1083
|
+
:type group_name: str
|
1084
|
+
:param item_name: The name of the item. (required)
|
1085
|
+
:type item_name: str
|
1086
|
+
:param async_req: Whether to execute the request asynchronously.
|
1087
|
+
:type async_req: bool, optional
|
1088
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1089
|
+
be set to none and raw_data will store the
|
1090
|
+
HTTP response body without reading/decoding.
|
1091
|
+
Default is True.
|
1092
|
+
:type _preload_content: bool, optional
|
1093
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1094
|
+
object with status code, headers, etc
|
1095
|
+
:type _return_http_data_only: bool, optional
|
1096
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1097
|
+
:param opts: Configuration options for this request
|
1098
|
+
:type opts: ConfigurationOptions, optional
|
1099
|
+
:param _request_auth: set to override the auth_settings for an a single
|
1100
|
+
request; this effectively ignores the authentication
|
1101
|
+
in the spec for a single request.
|
1102
|
+
:type _request_auth: dict, optional
|
1103
|
+
:type _content_type: string, optional: force content-type for the request
|
1104
|
+
:return: Returns the result object.
|
1105
|
+
If the method is called asynchronously,
|
1106
|
+
returns the request thread.
|
1107
|
+
:rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
1108
|
+
"""
|
1109
|
+
|
1110
|
+
_params = locals()
|
1111
|
+
|
1112
|
+
_all_params = [
|
1113
|
+
'workspace_name',
|
1114
|
+
'group_name',
|
1115
|
+
'item_name'
|
1116
|
+
]
|
1117
|
+
_all_params.extend(
|
1118
|
+
[
|
1119
|
+
'async_req',
|
1120
|
+
'_return_http_data_only',
|
1121
|
+
'_preload_content',
|
1122
|
+
'_request_timeout',
|
1123
|
+
'_request_auth',
|
1124
|
+
'_content_type',
|
1125
|
+
'_headers',
|
1126
|
+
'opts'
|
1127
|
+
]
|
1128
|
+
)
|
1129
|
+
|
1130
|
+
# validate the arguments
|
1131
|
+
for _key, _val in _params['kwargs'].items():
|
1132
|
+
if _key not in _all_params:
|
1133
|
+
raise ApiTypeError(
|
1134
|
+
"Got an unexpected keyword argument '%s'"
|
1135
|
+
" to method delete_shared_item" % _key
|
1136
|
+
)
|
1137
|
+
_params[_key] = _val
|
1138
|
+
del _params['kwargs']
|
1139
|
+
|
1140
|
+
_collection_formats = {}
|
1141
|
+
|
1142
|
+
# process the path parameters
|
1143
|
+
_path_params = {}
|
1144
|
+
if _params['workspace_name']:
|
1145
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
1146
|
+
|
1147
|
+
if _params['group_name']:
|
1148
|
+
_path_params['groupName'] = _params['group_name']
|
1149
|
+
|
1150
|
+
if _params['item_name']:
|
1151
|
+
_path_params['itemName'] = _params['item_name']
|
1152
|
+
|
1153
|
+
|
1154
|
+
# process the query parameters
|
1155
|
+
_query_params = []
|
1156
|
+
# process the header parameters
|
1157
|
+
_header_params = dict(_params.get('_headers', {}))
|
1158
|
+
# process the form parameters
|
1159
|
+
_form_params = []
|
1160
|
+
_files = {}
|
1161
|
+
# process the body parameter
|
1162
|
+
_body_params = None
|
1163
|
+
# set the HTTP header `Accept`
|
1164
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1165
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1166
|
+
|
1167
|
+
# authentication setting
|
1168
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1169
|
+
|
1170
|
+
_response_types_map = {
|
1171
|
+
'200': "DeletedEntityResponse",
|
1172
|
+
'400': "LusidValidationProblemDetails",
|
1173
|
+
}
|
1174
|
+
|
1175
|
+
return self.api_client.call_api(
|
1176
|
+
'/api/workspaces/shared/{workspaceName}/items/{groupName}/{itemName}', 'DELETE',
|
1177
|
+
_path_params,
|
1178
|
+
_query_params,
|
1179
|
+
_header_params,
|
1180
|
+
body=_body_params,
|
1181
|
+
post_params=_form_params,
|
1182
|
+
files=_files,
|
1183
|
+
response_types_map=_response_types_map,
|
1184
|
+
auth_settings=_auth_settings,
|
1185
|
+
async_req=_params.get('async_req'),
|
1186
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1187
|
+
_preload_content=_params.get('_preload_content', True),
|
1188
|
+
_request_timeout=_params.get('_request_timeout'),
|
1189
|
+
opts=_params.get('opts'),
|
1190
|
+
collection_formats=_collection_formats,
|
1191
|
+
_request_auth=_params.get('_request_auth'))
|
1192
|
+
|
1193
|
+
@overload
|
1194
|
+
async def delete_shared_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1195
|
+
...
|
1196
|
+
|
1197
|
+
@overload
|
1198
|
+
def delete_shared_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
1199
|
+
...
|
1200
|
+
|
1201
|
+
@validate_arguments
|
1202
|
+
def delete_shared_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
1203
|
+
"""[EXPERIMENTAL] DeleteSharedWorkspace: Delete a shared workspace. # noqa: E501
|
1204
|
+
|
1205
|
+
Delete a shared workspace. # noqa: E501
|
1206
|
+
This method makes a synchronous HTTP request by default. To make an
|
1207
|
+
asynchronous HTTP request, please pass async_req=True
|
1208
|
+
|
1209
|
+
>>> thread = api.delete_shared_workspace(workspace_name, async_req=True)
|
1210
|
+
>>> result = thread.get()
|
1211
|
+
|
1212
|
+
:param workspace_name: The name of the shared workspace. (required)
|
1213
|
+
:type workspace_name: str
|
1214
|
+
:param async_req: Whether to execute the request asynchronously.
|
1215
|
+
:type async_req: bool, optional
|
1216
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1217
|
+
:param opts: Configuration options for this request
|
1218
|
+
:type opts: ConfigurationOptions, optional
|
1219
|
+
:return: Returns the result object.
|
1220
|
+
If the method is called asynchronously,
|
1221
|
+
returns the request thread.
|
1222
|
+
:rtype: DeletedEntityResponse
|
1223
|
+
"""
|
1224
|
+
kwargs['_return_http_data_only'] = True
|
1225
|
+
if '_preload_content' in kwargs:
|
1226
|
+
message = "Error! Please call the delete_shared_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1227
|
+
raise ValueError(message)
|
1228
|
+
if async_req is not None:
|
1229
|
+
kwargs['async_req'] = async_req
|
1230
|
+
return self.delete_shared_workspace_with_http_info(workspace_name, **kwargs) # noqa: E501
|
1231
|
+
|
1232
|
+
@validate_arguments
|
1233
|
+
def delete_shared_workspace_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], **kwargs) -> ApiResponse: # noqa: E501
|
1234
|
+
"""[EXPERIMENTAL] DeleteSharedWorkspace: Delete a shared workspace. # noqa: E501
|
1235
|
+
|
1236
|
+
Delete a shared workspace. # noqa: E501
|
1237
|
+
This method makes a synchronous HTTP request by default. To make an
|
1238
|
+
asynchronous HTTP request, please pass async_req=True
|
1239
|
+
|
1240
|
+
>>> thread = api.delete_shared_workspace_with_http_info(workspace_name, async_req=True)
|
1241
|
+
>>> result = thread.get()
|
1242
|
+
|
1243
|
+
:param workspace_name: The name of the shared workspace. (required)
|
1244
|
+
:type workspace_name: str
|
1245
|
+
:param async_req: Whether to execute the request asynchronously.
|
1246
|
+
:type async_req: bool, optional
|
1247
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1248
|
+
be set to none and raw_data will store the
|
1249
|
+
HTTP response body without reading/decoding.
|
1250
|
+
Default is True.
|
1251
|
+
:type _preload_content: bool, optional
|
1252
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1253
|
+
object with status code, headers, etc
|
1254
|
+
:type _return_http_data_only: bool, optional
|
1255
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1256
|
+
:param opts: Configuration options for this request
|
1257
|
+
:type opts: ConfigurationOptions, optional
|
1258
|
+
:param _request_auth: set to override the auth_settings for an a single
|
1259
|
+
request; this effectively ignores the authentication
|
1260
|
+
in the spec for a single request.
|
1261
|
+
:type _request_auth: dict, optional
|
1262
|
+
:type _content_type: string, optional: force content-type for the request
|
1263
|
+
:return: Returns the result object.
|
1264
|
+
If the method is called asynchronously,
|
1265
|
+
returns the request thread.
|
1266
|
+
:rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
1267
|
+
"""
|
1268
|
+
|
1269
|
+
_params = locals()
|
1270
|
+
|
1271
|
+
_all_params = [
|
1272
|
+
'workspace_name'
|
1273
|
+
]
|
1274
|
+
_all_params.extend(
|
1275
|
+
[
|
1276
|
+
'async_req',
|
1277
|
+
'_return_http_data_only',
|
1278
|
+
'_preload_content',
|
1279
|
+
'_request_timeout',
|
1280
|
+
'_request_auth',
|
1281
|
+
'_content_type',
|
1282
|
+
'_headers',
|
1283
|
+
'opts'
|
1284
|
+
]
|
1285
|
+
)
|
1286
|
+
|
1287
|
+
# validate the arguments
|
1288
|
+
for _key, _val in _params['kwargs'].items():
|
1289
|
+
if _key not in _all_params:
|
1290
|
+
raise ApiTypeError(
|
1291
|
+
"Got an unexpected keyword argument '%s'"
|
1292
|
+
" to method delete_shared_workspace" % _key
|
1293
|
+
)
|
1294
|
+
_params[_key] = _val
|
1295
|
+
del _params['kwargs']
|
1296
|
+
|
1297
|
+
_collection_formats = {}
|
1298
|
+
|
1299
|
+
# process the path parameters
|
1300
|
+
_path_params = {}
|
1301
|
+
if _params['workspace_name']:
|
1302
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
1303
|
+
|
1304
|
+
|
1305
|
+
# process the query parameters
|
1306
|
+
_query_params = []
|
1307
|
+
# process the header parameters
|
1308
|
+
_header_params = dict(_params.get('_headers', {}))
|
1309
|
+
# process the form parameters
|
1310
|
+
_form_params = []
|
1311
|
+
_files = {}
|
1312
|
+
# process the body parameter
|
1313
|
+
_body_params = None
|
1314
|
+
# set the HTTP header `Accept`
|
1315
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1316
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1317
|
+
|
1318
|
+
# authentication setting
|
1319
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1320
|
+
|
1321
|
+
_response_types_map = {
|
1322
|
+
'200': "DeletedEntityResponse",
|
1323
|
+
'400': "LusidValidationProblemDetails",
|
1324
|
+
}
|
1325
|
+
|
1326
|
+
return self.api_client.call_api(
|
1327
|
+
'/api/workspaces/shared/{workspaceName}', 'DELETE',
|
1328
|
+
_path_params,
|
1329
|
+
_query_params,
|
1330
|
+
_header_params,
|
1331
|
+
body=_body_params,
|
1332
|
+
post_params=_form_params,
|
1333
|
+
files=_files,
|
1334
|
+
response_types_map=_response_types_map,
|
1335
|
+
auth_settings=_auth_settings,
|
1336
|
+
async_req=_params.get('async_req'),
|
1337
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1338
|
+
_preload_content=_params.get('_preload_content', True),
|
1339
|
+
_request_timeout=_params.get('_request_timeout'),
|
1340
|
+
opts=_params.get('opts'),
|
1341
|
+
collection_formats=_collection_formats,
|
1342
|
+
_request_auth=_params.get('_request_auth'))
|
1343
|
+
|
1344
|
+
@overload
|
1345
|
+
async def get_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
1346
|
+
...
|
1347
|
+
|
1348
|
+
@overload
|
1349
|
+
def get_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
1350
|
+
...
|
1351
|
+
|
1352
|
+
@validate_arguments
|
1353
|
+
def get_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
1354
|
+
"""[EXPERIMENTAL] GetPersonalItem: Get a single personal workspace item. # noqa: E501
|
1355
|
+
|
1356
|
+
Get a single personal workspace item. # noqa: E501
|
1357
|
+
This method makes a synchronous HTTP request by default. To make an
|
1358
|
+
asynchronous HTTP request, please pass async_req=True
|
1359
|
+
|
1360
|
+
>>> thread = api.get_personal_item(workspace_name, group_name, item_name, as_at, async_req=True)
|
1361
|
+
>>> result = thread.get()
|
1362
|
+
|
1363
|
+
:param workspace_name: The name of the personal workspace. (required)
|
1364
|
+
:type workspace_name: str
|
1365
|
+
:param group_name: The group containing the item. (required)
|
1366
|
+
:type group_name: str
|
1367
|
+
:param item_name: The name of the item. (required)
|
1368
|
+
:type item_name: str
|
1369
|
+
:param as_at: The datetime at which to request the workspace item. If not provided, defaults to 'latest'.
|
1370
|
+
:type as_at: datetime
|
1371
|
+
:param async_req: Whether to execute the request asynchronously.
|
1372
|
+
:type async_req: bool, optional
|
1373
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1374
|
+
:param opts: Configuration options for this request
|
1375
|
+
:type opts: ConfigurationOptions, optional
|
1376
|
+
:return: Returns the result object.
|
1377
|
+
If the method is called asynchronously,
|
1378
|
+
returns the request thread.
|
1379
|
+
:rtype: WorkspaceItem
|
1380
|
+
"""
|
1381
|
+
kwargs['_return_http_data_only'] = True
|
1382
|
+
if '_preload_content' in kwargs:
|
1383
|
+
message = "Error! Please call the get_personal_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1384
|
+
raise ValueError(message)
|
1385
|
+
if async_req is not None:
|
1386
|
+
kwargs['async_req'] = async_req
|
1387
|
+
return self.get_personal_item_with_http_info(workspace_name, group_name, item_name, as_at, **kwargs) # noqa: E501
|
1388
|
+
|
1389
|
+
@validate_arguments
|
1390
|
+
def get_personal_item_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the personal workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1391
|
+
"""[EXPERIMENTAL] GetPersonalItem: Get a single personal workspace item. # noqa: E501
|
1392
|
+
|
1393
|
+
Get a single personal workspace item. # noqa: E501
|
1394
|
+
This method makes a synchronous HTTP request by default. To make an
|
1395
|
+
asynchronous HTTP request, please pass async_req=True
|
1396
|
+
|
1397
|
+
>>> thread = api.get_personal_item_with_http_info(workspace_name, group_name, item_name, as_at, async_req=True)
|
1398
|
+
>>> result = thread.get()
|
1399
|
+
|
1400
|
+
:param workspace_name: The name of the personal workspace. (required)
|
1401
|
+
:type workspace_name: str
|
1402
|
+
:param group_name: The group containing the item. (required)
|
1403
|
+
:type group_name: str
|
1404
|
+
:param item_name: The name of the item. (required)
|
1405
|
+
:type item_name: str
|
1406
|
+
:param as_at: The datetime at which to request the workspace item. If not provided, defaults to 'latest'.
|
1407
|
+
:type as_at: datetime
|
1408
|
+
:param async_req: Whether to execute the request asynchronously.
|
1409
|
+
:type async_req: bool, optional
|
1410
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1411
|
+
be set to none and raw_data will store the
|
1412
|
+
HTTP response body without reading/decoding.
|
1413
|
+
Default is True.
|
1414
|
+
:type _preload_content: bool, optional
|
1415
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1416
|
+
object with status code, headers, etc
|
1417
|
+
:type _return_http_data_only: bool, optional
|
1418
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1419
|
+
:param opts: Configuration options for this request
|
1420
|
+
:type opts: ConfigurationOptions, optional
|
1421
|
+
:param _request_auth: set to override the auth_settings for an a single
|
1422
|
+
request; this effectively ignores the authentication
|
1423
|
+
in the spec for a single request.
|
1424
|
+
:type _request_auth: dict, optional
|
1425
|
+
:type _content_type: string, optional: force content-type for the request
|
1426
|
+
:return: Returns the result object.
|
1427
|
+
If the method is called asynchronously,
|
1428
|
+
returns the request thread.
|
1429
|
+
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
1430
|
+
"""
|
1431
|
+
|
1432
|
+
_params = locals()
|
1433
|
+
|
1434
|
+
_all_params = [
|
1435
|
+
'workspace_name',
|
1436
|
+
'group_name',
|
1437
|
+
'item_name',
|
1438
|
+
'as_at'
|
1439
|
+
]
|
1440
|
+
_all_params.extend(
|
1441
|
+
[
|
1442
|
+
'async_req',
|
1443
|
+
'_return_http_data_only',
|
1444
|
+
'_preload_content',
|
1445
|
+
'_request_timeout',
|
1446
|
+
'_request_auth',
|
1447
|
+
'_content_type',
|
1448
|
+
'_headers',
|
1449
|
+
'opts'
|
1450
|
+
]
|
1451
|
+
)
|
1452
|
+
|
1453
|
+
# validate the arguments
|
1454
|
+
for _key, _val in _params['kwargs'].items():
|
1455
|
+
if _key not in _all_params:
|
1456
|
+
raise ApiTypeError(
|
1457
|
+
"Got an unexpected keyword argument '%s'"
|
1458
|
+
" to method get_personal_item" % _key
|
1459
|
+
)
|
1460
|
+
_params[_key] = _val
|
1461
|
+
del _params['kwargs']
|
1462
|
+
|
1463
|
+
_collection_formats = {}
|
1464
|
+
|
1465
|
+
# process the path parameters
|
1466
|
+
_path_params = {}
|
1467
|
+
if _params['workspace_name']:
|
1468
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
1469
|
+
|
1470
|
+
if _params['group_name']:
|
1471
|
+
_path_params['groupName'] = _params['group_name']
|
1472
|
+
|
1473
|
+
if _params['item_name']:
|
1474
|
+
_path_params['itemName'] = _params['item_name']
|
1475
|
+
|
1476
|
+
|
1477
|
+
# process the query parameters
|
1478
|
+
_query_params = []
|
1479
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1480
|
+
if isinstance(_params['as_at'], datetime):
|
1481
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1482
|
+
else:
|
1483
|
+
_query_params.append(('asAt', _params['as_at']))
|
1484
|
+
|
1485
|
+
# process the header parameters
|
1486
|
+
_header_params = dict(_params.get('_headers', {}))
|
1487
|
+
# process the form parameters
|
1488
|
+
_form_params = []
|
1489
|
+
_files = {}
|
1490
|
+
# process the body parameter
|
1491
|
+
_body_params = None
|
1492
|
+
# set the HTTP header `Accept`
|
1493
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1494
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1495
|
+
|
1496
|
+
# authentication setting
|
1497
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1498
|
+
|
1499
|
+
_response_types_map = {
|
1500
|
+
'200': "WorkspaceItem",
|
1501
|
+
'400': "LusidValidationProblemDetails",
|
1502
|
+
}
|
1503
|
+
|
1504
|
+
return self.api_client.call_api(
|
1505
|
+
'/api/workspaces/personal/{workspaceName}/items/{groupName}/{itemName}', 'GET',
|
1506
|
+
_path_params,
|
1507
|
+
_query_params,
|
1508
|
+
_header_params,
|
1509
|
+
body=_body_params,
|
1510
|
+
post_params=_form_params,
|
1511
|
+
files=_files,
|
1512
|
+
response_types_map=_response_types_map,
|
1513
|
+
auth_settings=_auth_settings,
|
1514
|
+
async_req=_params.get('async_req'),
|
1515
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1516
|
+
_preload_content=_params.get('_preload_content', True),
|
1517
|
+
_request_timeout=_params.get('_request_timeout'),
|
1518
|
+
opts=_params.get('opts'),
|
1519
|
+
collection_formats=_collection_formats,
|
1520
|
+
_request_auth=_params.get('_request_auth'))
|
1521
|
+
|
1522
|
+
@overload
|
1523
|
+
async def get_personal_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> Workspace: # noqa: E501
|
1524
|
+
...
|
1525
|
+
|
1526
|
+
@overload
|
1527
|
+
def get_personal_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
1528
|
+
...
|
1529
|
+
|
1530
|
+
@validate_arguments
|
1531
|
+
def get_personal_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
1532
|
+
"""[EXPERIMENTAL] GetPersonalWorkspace: Get a personal workspace. # noqa: E501
|
1533
|
+
|
1534
|
+
Get a personal workspace. # noqa: E501
|
1535
|
+
This method makes a synchronous HTTP request by default. To make an
|
1536
|
+
asynchronous HTTP request, please pass async_req=True
|
1537
|
+
|
1538
|
+
>>> thread = api.get_personal_workspace(workspace_name, as_at, async_req=True)
|
1539
|
+
>>> result = thread.get()
|
1540
|
+
|
1541
|
+
:param workspace_name: The personal workspace name. (required)
|
1542
|
+
:type workspace_name: str
|
1543
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1544
|
+
:type as_at: datetime
|
1545
|
+
:param async_req: Whether to execute the request asynchronously.
|
1546
|
+
:type async_req: bool, optional
|
1547
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1548
|
+
:param opts: Configuration options for this request
|
1549
|
+
:type opts: ConfigurationOptions, optional
|
1550
|
+
:return: Returns the result object.
|
1551
|
+
If the method is called asynchronously,
|
1552
|
+
returns the request thread.
|
1553
|
+
:rtype: Workspace
|
1554
|
+
"""
|
1555
|
+
kwargs['_return_http_data_only'] = True
|
1556
|
+
if '_preload_content' in kwargs:
|
1557
|
+
message = "Error! Please call the get_personal_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1558
|
+
raise ValueError(message)
|
1559
|
+
if async_req is not None:
|
1560
|
+
kwargs['async_req'] = async_req
|
1561
|
+
return self.get_personal_workspace_with_http_info(workspace_name, as_at, **kwargs) # noqa: E501
|
1562
|
+
|
1563
|
+
@validate_arguments
|
1564
|
+
def get_personal_workspace_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1565
|
+
"""[EXPERIMENTAL] GetPersonalWorkspace: Get a personal workspace. # noqa: E501
|
1566
|
+
|
1567
|
+
Get a personal workspace. # noqa: E501
|
1568
|
+
This method makes a synchronous HTTP request by default. To make an
|
1569
|
+
asynchronous HTTP request, please pass async_req=True
|
1570
|
+
|
1571
|
+
>>> thread = api.get_personal_workspace_with_http_info(workspace_name, as_at, async_req=True)
|
1572
|
+
>>> result = thread.get()
|
1573
|
+
|
1574
|
+
:param workspace_name: The personal workspace name. (required)
|
1575
|
+
:type workspace_name: str
|
1576
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1577
|
+
:type as_at: datetime
|
1578
|
+
:param async_req: Whether to execute the request asynchronously.
|
1579
|
+
:type async_req: bool, optional
|
1580
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1581
|
+
be set to none and raw_data will store the
|
1582
|
+
HTTP response body without reading/decoding.
|
1583
|
+
Default is True.
|
1584
|
+
:type _preload_content: bool, optional
|
1585
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1586
|
+
object with status code, headers, etc
|
1587
|
+
:type _return_http_data_only: bool, optional
|
1588
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1589
|
+
:param opts: Configuration options for this request
|
1590
|
+
:type opts: ConfigurationOptions, optional
|
1591
|
+
:param _request_auth: set to override the auth_settings for an a single
|
1592
|
+
request; this effectively ignores the authentication
|
1593
|
+
in the spec for a single request.
|
1594
|
+
:type _request_auth: dict, optional
|
1595
|
+
:type _content_type: string, optional: force content-type for the request
|
1596
|
+
:return: Returns the result object.
|
1597
|
+
If the method is called asynchronously,
|
1598
|
+
returns the request thread.
|
1599
|
+
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
1600
|
+
"""
|
1601
|
+
|
1602
|
+
_params = locals()
|
1603
|
+
|
1604
|
+
_all_params = [
|
1605
|
+
'workspace_name',
|
1606
|
+
'as_at'
|
1607
|
+
]
|
1608
|
+
_all_params.extend(
|
1609
|
+
[
|
1610
|
+
'async_req',
|
1611
|
+
'_return_http_data_only',
|
1612
|
+
'_preload_content',
|
1613
|
+
'_request_timeout',
|
1614
|
+
'_request_auth',
|
1615
|
+
'_content_type',
|
1616
|
+
'_headers',
|
1617
|
+
'opts'
|
1618
|
+
]
|
1619
|
+
)
|
1620
|
+
|
1621
|
+
# validate the arguments
|
1622
|
+
for _key, _val in _params['kwargs'].items():
|
1623
|
+
if _key not in _all_params:
|
1624
|
+
raise ApiTypeError(
|
1625
|
+
"Got an unexpected keyword argument '%s'"
|
1626
|
+
" to method get_personal_workspace" % _key
|
1627
|
+
)
|
1628
|
+
_params[_key] = _val
|
1629
|
+
del _params['kwargs']
|
1630
|
+
|
1631
|
+
_collection_formats = {}
|
1632
|
+
|
1633
|
+
# process the path parameters
|
1634
|
+
_path_params = {}
|
1635
|
+
if _params['workspace_name']:
|
1636
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
1637
|
+
|
1638
|
+
|
1639
|
+
# process the query parameters
|
1640
|
+
_query_params = []
|
1641
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1642
|
+
if isinstance(_params['as_at'], datetime):
|
1643
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1644
|
+
else:
|
1645
|
+
_query_params.append(('asAt', _params['as_at']))
|
1646
|
+
|
1647
|
+
# process the header parameters
|
1648
|
+
_header_params = dict(_params.get('_headers', {}))
|
1649
|
+
# process the form parameters
|
1650
|
+
_form_params = []
|
1651
|
+
_files = {}
|
1652
|
+
# process the body parameter
|
1653
|
+
_body_params = None
|
1654
|
+
# set the HTTP header `Accept`
|
1655
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1656
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1657
|
+
|
1658
|
+
# authentication setting
|
1659
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1660
|
+
|
1661
|
+
_response_types_map = {
|
1662
|
+
'200': "Workspace",
|
1663
|
+
'400': "LusidValidationProblemDetails",
|
1664
|
+
}
|
1665
|
+
|
1666
|
+
return self.api_client.call_api(
|
1667
|
+
'/api/workspaces/personal/{workspaceName}', 'GET',
|
1668
|
+
_path_params,
|
1669
|
+
_query_params,
|
1670
|
+
_header_params,
|
1671
|
+
body=_body_params,
|
1672
|
+
post_params=_form_params,
|
1673
|
+
files=_files,
|
1674
|
+
response_types_map=_response_types_map,
|
1675
|
+
auth_settings=_auth_settings,
|
1676
|
+
async_req=_params.get('async_req'),
|
1677
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1678
|
+
_preload_content=_params.get('_preload_content', True),
|
1679
|
+
_request_timeout=_params.get('_request_timeout'),
|
1680
|
+
opts=_params.get('opts'),
|
1681
|
+
collection_formats=_collection_formats,
|
1682
|
+
_request_auth=_params.get('_request_auth'))
|
1683
|
+
|
1684
|
+
@overload
|
1685
|
+
async def get_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
1686
|
+
...
|
1687
|
+
|
1688
|
+
@overload
|
1689
|
+
def get_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
1690
|
+
...
|
1691
|
+
|
1692
|
+
@validate_arguments
|
1693
|
+
def get_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
1694
|
+
"""[EXPERIMENTAL] GetSharedItem: Get a single shared workspace item. # noqa: E501
|
1695
|
+
|
1696
|
+
Get a single shared workspace item. # noqa: E501
|
1697
|
+
This method makes a synchronous HTTP request by default. To make an
|
1698
|
+
asynchronous HTTP request, please pass async_req=True
|
1699
|
+
|
1700
|
+
>>> thread = api.get_shared_item(workspace_name, group_name, item_name, as_at, async_req=True)
|
1701
|
+
>>> result = thread.get()
|
1702
|
+
|
1703
|
+
:param workspace_name: The name of the shared workspace. (required)
|
1704
|
+
:type workspace_name: str
|
1705
|
+
:param group_name: The group containing the item. (required)
|
1706
|
+
:type group_name: str
|
1707
|
+
:param item_name: The name of the item. (required)
|
1708
|
+
:type item_name: str
|
1709
|
+
:param as_at: The datetime at which to request the workspace item. If not provided, defaults to 'latest'.
|
1710
|
+
:type as_at: datetime
|
1711
|
+
:param async_req: Whether to execute the request asynchronously.
|
1712
|
+
:type async_req: bool, optional
|
1713
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1714
|
+
:param opts: Configuration options for this request
|
1715
|
+
:type opts: ConfigurationOptions, optional
|
1716
|
+
:return: Returns the result object.
|
1717
|
+
If the method is called asynchronously,
|
1718
|
+
returns the request thread.
|
1719
|
+
:rtype: WorkspaceItem
|
1720
|
+
"""
|
1721
|
+
kwargs['_return_http_data_only'] = True
|
1722
|
+
if '_preload_content' in kwargs:
|
1723
|
+
message = "Error! Please call the get_shared_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1724
|
+
raise ValueError(message)
|
1725
|
+
if async_req is not None:
|
1726
|
+
kwargs['async_req'] = async_req
|
1727
|
+
return self.get_shared_item_with_http_info(workspace_name, group_name, item_name, as_at, **kwargs) # noqa: E501
|
1728
|
+
|
1729
|
+
@validate_arguments
|
1730
|
+
def get_shared_item_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the shared workspace.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The name of the item.")], as_at : Annotated[Optional[datetime], Field(description="The datetime at which to request the workspace item. If not provided, defaults to 'latest'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1731
|
+
"""[EXPERIMENTAL] GetSharedItem: Get a single shared workspace item. # noqa: E501
|
1732
|
+
|
1733
|
+
Get a single shared workspace item. # noqa: E501
|
1734
|
+
This method makes a synchronous HTTP request by default. To make an
|
1735
|
+
asynchronous HTTP request, please pass async_req=True
|
1736
|
+
|
1737
|
+
>>> thread = api.get_shared_item_with_http_info(workspace_name, group_name, item_name, as_at, async_req=True)
|
1738
|
+
>>> result = thread.get()
|
1739
|
+
|
1740
|
+
:param workspace_name: The name of the shared workspace. (required)
|
1741
|
+
:type workspace_name: str
|
1742
|
+
:param group_name: The group containing the item. (required)
|
1743
|
+
:type group_name: str
|
1744
|
+
:param item_name: The name of the item. (required)
|
1745
|
+
:type item_name: str
|
1746
|
+
:param as_at: The datetime at which to request the workspace item. If not provided, defaults to 'latest'.
|
1747
|
+
:type as_at: datetime
|
1748
|
+
:param async_req: Whether to execute the request asynchronously.
|
1749
|
+
:type async_req: bool, optional
|
1750
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1751
|
+
be set to none and raw_data will store the
|
1752
|
+
HTTP response body without reading/decoding.
|
1753
|
+
Default is True.
|
1754
|
+
:type _preload_content: bool, optional
|
1755
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1756
|
+
object with status code, headers, etc
|
1757
|
+
:type _return_http_data_only: bool, optional
|
1758
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1759
|
+
:param opts: Configuration options for this request
|
1760
|
+
:type opts: ConfigurationOptions, optional
|
1761
|
+
:param _request_auth: set to override the auth_settings for an a single
|
1762
|
+
request; this effectively ignores the authentication
|
1763
|
+
in the spec for a single request.
|
1764
|
+
:type _request_auth: dict, optional
|
1765
|
+
:type _content_type: string, optional: force content-type for the request
|
1766
|
+
:return: Returns the result object.
|
1767
|
+
If the method is called asynchronously,
|
1768
|
+
returns the request thread.
|
1769
|
+
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
1770
|
+
"""
|
1771
|
+
|
1772
|
+
_params = locals()
|
1773
|
+
|
1774
|
+
_all_params = [
|
1775
|
+
'workspace_name',
|
1776
|
+
'group_name',
|
1777
|
+
'item_name',
|
1778
|
+
'as_at'
|
1779
|
+
]
|
1780
|
+
_all_params.extend(
|
1781
|
+
[
|
1782
|
+
'async_req',
|
1783
|
+
'_return_http_data_only',
|
1784
|
+
'_preload_content',
|
1785
|
+
'_request_timeout',
|
1786
|
+
'_request_auth',
|
1787
|
+
'_content_type',
|
1788
|
+
'_headers',
|
1789
|
+
'opts'
|
1790
|
+
]
|
1791
|
+
)
|
1792
|
+
|
1793
|
+
# validate the arguments
|
1794
|
+
for _key, _val in _params['kwargs'].items():
|
1795
|
+
if _key not in _all_params:
|
1796
|
+
raise ApiTypeError(
|
1797
|
+
"Got an unexpected keyword argument '%s'"
|
1798
|
+
" to method get_shared_item" % _key
|
1799
|
+
)
|
1800
|
+
_params[_key] = _val
|
1801
|
+
del _params['kwargs']
|
1802
|
+
|
1803
|
+
_collection_formats = {}
|
1804
|
+
|
1805
|
+
# process the path parameters
|
1806
|
+
_path_params = {}
|
1807
|
+
if _params['workspace_name']:
|
1808
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
1809
|
+
|
1810
|
+
if _params['group_name']:
|
1811
|
+
_path_params['groupName'] = _params['group_name']
|
1812
|
+
|
1813
|
+
if _params['item_name']:
|
1814
|
+
_path_params['itemName'] = _params['item_name']
|
1815
|
+
|
1816
|
+
|
1817
|
+
# process the query parameters
|
1818
|
+
_query_params = []
|
1819
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1820
|
+
if isinstance(_params['as_at'], datetime):
|
1821
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1822
|
+
else:
|
1823
|
+
_query_params.append(('asAt', _params['as_at']))
|
1824
|
+
|
1825
|
+
# process the header parameters
|
1826
|
+
_header_params = dict(_params.get('_headers', {}))
|
1827
|
+
# process the form parameters
|
1828
|
+
_form_params = []
|
1829
|
+
_files = {}
|
1830
|
+
# process the body parameter
|
1831
|
+
_body_params = None
|
1832
|
+
# set the HTTP header `Accept`
|
1833
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1834
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1835
|
+
|
1836
|
+
# authentication setting
|
1837
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1838
|
+
|
1839
|
+
_response_types_map = {
|
1840
|
+
'200': "WorkspaceItem",
|
1841
|
+
'400': "LusidValidationProblemDetails",
|
1842
|
+
}
|
1843
|
+
|
1844
|
+
return self.api_client.call_api(
|
1845
|
+
'/api/workspaces/shared/{workspaceName}/items/{groupName}/{itemName}', 'GET',
|
1846
|
+
_path_params,
|
1847
|
+
_query_params,
|
1848
|
+
_header_params,
|
1849
|
+
body=_body_params,
|
1850
|
+
post_params=_form_params,
|
1851
|
+
files=_files,
|
1852
|
+
response_types_map=_response_types_map,
|
1853
|
+
auth_settings=_auth_settings,
|
1854
|
+
async_req=_params.get('async_req'),
|
1855
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1856
|
+
_preload_content=_params.get('_preload_content', True),
|
1857
|
+
_request_timeout=_params.get('_request_timeout'),
|
1858
|
+
opts=_params.get('opts'),
|
1859
|
+
collection_formats=_collection_formats,
|
1860
|
+
_request_auth=_params.get('_request_auth'))
|
1861
|
+
|
1862
|
+
@overload
|
1863
|
+
async def get_shared_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> Workspace: # noqa: E501
|
1864
|
+
...
|
1865
|
+
|
1866
|
+
@overload
|
1867
|
+
def get_shared_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
1868
|
+
...
|
1869
|
+
|
1870
|
+
@validate_arguments
|
1871
|
+
def get_shared_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
1872
|
+
"""[EXPERIMENTAL] GetSharedWorkspace: Get a shared workspace. # noqa: E501
|
1873
|
+
|
1874
|
+
Get a shared workspace. # noqa: E501
|
1875
|
+
This method makes a synchronous HTTP request by default. To make an
|
1876
|
+
asynchronous HTTP request, please pass async_req=True
|
1877
|
+
|
1878
|
+
>>> thread = api.get_shared_workspace(workspace_name, as_at, async_req=True)
|
1879
|
+
>>> result = thread.get()
|
1880
|
+
|
1881
|
+
:param workspace_name: The shared workspace name. (required)
|
1882
|
+
:type workspace_name: str
|
1883
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1884
|
+
:type as_at: datetime
|
1885
|
+
:param async_req: Whether to execute the request asynchronously.
|
1886
|
+
:type async_req: bool, optional
|
1887
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1888
|
+
:param opts: Configuration options for this request
|
1889
|
+
:type opts: ConfigurationOptions, optional
|
1890
|
+
:return: Returns the result object.
|
1891
|
+
If the method is called asynchronously,
|
1892
|
+
returns the request thread.
|
1893
|
+
:rtype: Workspace
|
1894
|
+
"""
|
1895
|
+
kwargs['_return_http_data_only'] = True
|
1896
|
+
if '_preload_content' in kwargs:
|
1897
|
+
message = "Error! Please call the get_shared_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1898
|
+
raise ValueError(message)
|
1899
|
+
if async_req is not None:
|
1900
|
+
kwargs['async_req'] = async_req
|
1901
|
+
return self.get_shared_workspace_with_http_info(workspace_name, as_at, **kwargs) # noqa: E501
|
1902
|
+
|
1903
|
+
@validate_arguments
|
1904
|
+
def get_shared_workspace_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1905
|
+
"""[EXPERIMENTAL] GetSharedWorkspace: Get a shared workspace. # noqa: E501
|
1906
|
+
|
1907
|
+
Get a shared workspace. # noqa: E501
|
1908
|
+
This method makes a synchronous HTTP request by default. To make an
|
1909
|
+
asynchronous HTTP request, please pass async_req=True
|
1910
|
+
|
1911
|
+
>>> thread = api.get_shared_workspace_with_http_info(workspace_name, as_at, async_req=True)
|
1912
|
+
>>> result = thread.get()
|
1913
|
+
|
1914
|
+
:param workspace_name: The shared workspace name. (required)
|
1915
|
+
:type workspace_name: str
|
1916
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
1917
|
+
:type as_at: datetime
|
1918
|
+
:param async_req: Whether to execute the request asynchronously.
|
1919
|
+
:type async_req: bool, optional
|
1920
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1921
|
+
be set to none and raw_data will store the
|
1922
|
+
HTTP response body without reading/decoding.
|
1923
|
+
Default is True.
|
1924
|
+
:type _preload_content: bool, optional
|
1925
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1926
|
+
object with status code, headers, etc
|
1927
|
+
:type _return_http_data_only: bool, optional
|
1928
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1929
|
+
:param opts: Configuration options for this request
|
1930
|
+
:type opts: ConfigurationOptions, optional
|
1931
|
+
:param _request_auth: set to override the auth_settings for an a single
|
1932
|
+
request; this effectively ignores the authentication
|
1933
|
+
in the spec for a single request.
|
1934
|
+
:type _request_auth: dict, optional
|
1935
|
+
:type _content_type: string, optional: force content-type for the request
|
1936
|
+
:return: Returns the result object.
|
1937
|
+
If the method is called asynchronously,
|
1938
|
+
returns the request thread.
|
1939
|
+
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
1940
|
+
"""
|
1941
|
+
|
1942
|
+
_params = locals()
|
1943
|
+
|
1944
|
+
_all_params = [
|
1945
|
+
'workspace_name',
|
1946
|
+
'as_at'
|
1947
|
+
]
|
1948
|
+
_all_params.extend(
|
1949
|
+
[
|
1950
|
+
'async_req',
|
1951
|
+
'_return_http_data_only',
|
1952
|
+
'_preload_content',
|
1953
|
+
'_request_timeout',
|
1954
|
+
'_request_auth',
|
1955
|
+
'_content_type',
|
1956
|
+
'_headers',
|
1957
|
+
'opts'
|
1958
|
+
]
|
1959
|
+
)
|
1960
|
+
|
1961
|
+
# validate the arguments
|
1962
|
+
for _key, _val in _params['kwargs'].items():
|
1963
|
+
if _key not in _all_params:
|
1964
|
+
raise ApiTypeError(
|
1965
|
+
"Got an unexpected keyword argument '%s'"
|
1966
|
+
" to method get_shared_workspace" % _key
|
1967
|
+
)
|
1968
|
+
_params[_key] = _val
|
1969
|
+
del _params['kwargs']
|
1970
|
+
|
1971
|
+
_collection_formats = {}
|
1972
|
+
|
1973
|
+
# process the path parameters
|
1974
|
+
_path_params = {}
|
1975
|
+
if _params['workspace_name']:
|
1976
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
1977
|
+
|
1978
|
+
|
1979
|
+
# process the query parameters
|
1980
|
+
_query_params = []
|
1981
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1982
|
+
if isinstance(_params['as_at'], datetime):
|
1983
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1984
|
+
else:
|
1985
|
+
_query_params.append(('asAt', _params['as_at']))
|
1986
|
+
|
1987
|
+
# process the header parameters
|
1988
|
+
_header_params = dict(_params.get('_headers', {}))
|
1989
|
+
# process the form parameters
|
1990
|
+
_form_params = []
|
1991
|
+
_files = {}
|
1992
|
+
# process the body parameter
|
1993
|
+
_body_params = None
|
1994
|
+
# set the HTTP header `Accept`
|
1995
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1996
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1997
|
+
|
1998
|
+
# authentication setting
|
1999
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2000
|
+
|
2001
|
+
_response_types_map = {
|
2002
|
+
'200': "Workspace",
|
2003
|
+
'400': "LusidValidationProblemDetails",
|
2004
|
+
}
|
2005
|
+
|
2006
|
+
return self.api_client.call_api(
|
2007
|
+
'/api/workspaces/shared/{workspaceName}', 'GET',
|
2008
|
+
_path_params,
|
2009
|
+
_query_params,
|
2010
|
+
_header_params,
|
2011
|
+
body=_body_params,
|
2012
|
+
post_params=_form_params,
|
2013
|
+
files=_files,
|
2014
|
+
response_types_map=_response_types_map,
|
2015
|
+
auth_settings=_auth_settings,
|
2016
|
+
async_req=_params.get('async_req'),
|
2017
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2018
|
+
_preload_content=_params.get('_preload_content', True),
|
2019
|
+
_request_timeout=_params.get('_request_timeout'),
|
2020
|
+
opts=_params.get('opts'),
|
2021
|
+
collection_formats=_collection_formats,
|
2022
|
+
_request_auth=_params.get('_request_auth'))
|
2023
|
+
|
2024
|
+
@overload
|
2025
|
+
async def list_personal_items(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
2026
|
+
...
|
2027
|
+
|
2028
|
+
@overload
|
2029
|
+
def list_personal_items(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
2030
|
+
...
|
2031
|
+
|
2032
|
+
@validate_arguments
|
2033
|
+
def list_personal_items(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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[PagedResourceListOfWorkspaceItem, Awaitable[PagedResourceListOfWorkspaceItem]]: # noqa: E501
|
2034
|
+
"""[EXPERIMENTAL] ListPersonalItems: List the items in a personal workspace. # noqa: E501
|
2035
|
+
|
2036
|
+
List the items in a personal workspace. # noqa: E501
|
2037
|
+
This method makes a synchronous HTTP request by default. To make an
|
2038
|
+
asynchronous HTTP request, please pass async_req=True
|
2039
|
+
|
2040
|
+
>>> thread = api.list_personal_items(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
2041
|
+
>>> result = thread.get()
|
2042
|
+
|
2043
|
+
:param workspace_name: The item's workspace name. (required)
|
2044
|
+
:type workspace_name: str
|
2045
|
+
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
2046
|
+
:type as_at: datetime
|
2047
|
+
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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.
|
2048
|
+
:type page: str
|
2049
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2050
|
+
:type sort_by: List[str]
|
2051
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
2052
|
+
:type limit: int
|
2053
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2054
|
+
:type filter: str
|
2055
|
+
:param async_req: Whether to execute the request asynchronously.
|
2056
|
+
:type async_req: bool, optional
|
2057
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2058
|
+
:param opts: Configuration options for this request
|
2059
|
+
:type opts: ConfigurationOptions, optional
|
2060
|
+
:return: Returns the result object.
|
2061
|
+
If the method is called asynchronously,
|
2062
|
+
returns the request thread.
|
2063
|
+
:rtype: PagedResourceListOfWorkspaceItem
|
2064
|
+
"""
|
2065
|
+
kwargs['_return_http_data_only'] = True
|
2066
|
+
if '_preload_content' in kwargs:
|
2067
|
+
message = "Error! Please call the list_personal_items_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2068
|
+
raise ValueError(message)
|
2069
|
+
if async_req is not None:
|
2070
|
+
kwargs['async_req'] = async_req
|
2071
|
+
return self.list_personal_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
2072
|
+
|
2073
|
+
@validate_arguments
|
2074
|
+
def list_personal_items_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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
|
2075
|
+
"""[EXPERIMENTAL] ListPersonalItems: List the items in a personal workspace. # noqa: E501
|
2076
|
+
|
2077
|
+
List the items in a personal workspace. # noqa: E501
|
2078
|
+
This method makes a synchronous HTTP request by default. To make an
|
2079
|
+
asynchronous HTTP request, please pass async_req=True
|
2080
|
+
|
2081
|
+
>>> thread = api.list_personal_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
2082
|
+
>>> result = thread.get()
|
2083
|
+
|
2084
|
+
:param workspace_name: The item's workspace name. (required)
|
2085
|
+
:type workspace_name: str
|
2086
|
+
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
2087
|
+
:type as_at: datetime
|
2088
|
+
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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.
|
2089
|
+
:type page: str
|
2090
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2091
|
+
:type sort_by: List[str]
|
2092
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
2093
|
+
:type limit: int
|
2094
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2095
|
+
:type filter: str
|
2096
|
+
:param async_req: Whether to execute the request asynchronously.
|
2097
|
+
:type async_req: bool, optional
|
2098
|
+
:param _preload_content: if False, the ApiResponse.data will
|
2099
|
+
be set to none and raw_data will store the
|
2100
|
+
HTTP response body without reading/decoding.
|
2101
|
+
Default is True.
|
2102
|
+
:type _preload_content: bool, optional
|
2103
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
2104
|
+
object with status code, headers, etc
|
2105
|
+
:type _return_http_data_only: bool, optional
|
2106
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2107
|
+
:param opts: Configuration options for this request
|
2108
|
+
:type opts: ConfigurationOptions, optional
|
2109
|
+
:param _request_auth: set to override the auth_settings for an a single
|
2110
|
+
request; this effectively ignores the authentication
|
2111
|
+
in the spec for a single request.
|
2112
|
+
:type _request_auth: dict, optional
|
2113
|
+
:type _content_type: string, optional: force content-type for the request
|
2114
|
+
:return: Returns the result object.
|
2115
|
+
If the method is called asynchronously,
|
2116
|
+
returns the request thread.
|
2117
|
+
:rtype: tuple(PagedResourceListOfWorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
2118
|
+
"""
|
2119
|
+
|
2120
|
+
_params = locals()
|
2121
|
+
|
2122
|
+
_all_params = [
|
2123
|
+
'workspace_name',
|
2124
|
+
'as_at',
|
2125
|
+
'page',
|
2126
|
+
'sort_by',
|
2127
|
+
'limit',
|
2128
|
+
'filter'
|
2129
|
+
]
|
2130
|
+
_all_params.extend(
|
2131
|
+
[
|
2132
|
+
'async_req',
|
2133
|
+
'_return_http_data_only',
|
2134
|
+
'_preload_content',
|
2135
|
+
'_request_timeout',
|
2136
|
+
'_request_auth',
|
2137
|
+
'_content_type',
|
2138
|
+
'_headers',
|
2139
|
+
'opts'
|
2140
|
+
]
|
2141
|
+
)
|
2142
|
+
|
2143
|
+
# validate the arguments
|
2144
|
+
for _key, _val in _params['kwargs'].items():
|
2145
|
+
if _key not in _all_params:
|
2146
|
+
raise ApiTypeError(
|
2147
|
+
"Got an unexpected keyword argument '%s'"
|
2148
|
+
" to method list_personal_items" % _key
|
2149
|
+
)
|
2150
|
+
_params[_key] = _val
|
2151
|
+
del _params['kwargs']
|
2152
|
+
|
2153
|
+
_collection_formats = {}
|
2154
|
+
|
2155
|
+
# process the path parameters
|
2156
|
+
_path_params = {}
|
2157
|
+
if _params['workspace_name']:
|
2158
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
2159
|
+
|
2160
|
+
|
2161
|
+
# process the query parameters
|
2162
|
+
_query_params = []
|
2163
|
+
if _params.get('as_at') is not None: # noqa: E501
|
2164
|
+
if isinstance(_params['as_at'], datetime):
|
2165
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
2166
|
+
else:
|
2167
|
+
_query_params.append(('asAt', _params['as_at']))
|
2168
|
+
|
2169
|
+
if _params.get('page') is not None: # noqa: E501
|
2170
|
+
_query_params.append(('page', _params['page']))
|
2171
|
+
|
2172
|
+
if _params.get('sort_by') is not None: # noqa: E501
|
2173
|
+
_query_params.append(('sortBy', _params['sort_by']))
|
2174
|
+
_collection_formats['sortBy'] = 'multi'
|
2175
|
+
|
2176
|
+
if _params.get('limit') is not None: # noqa: E501
|
2177
|
+
_query_params.append(('limit', _params['limit']))
|
2178
|
+
|
2179
|
+
if _params.get('filter') is not None: # noqa: E501
|
2180
|
+
_query_params.append(('filter', _params['filter']))
|
2181
|
+
|
2182
|
+
# process the header parameters
|
2183
|
+
_header_params = dict(_params.get('_headers', {}))
|
2184
|
+
# process the form parameters
|
2185
|
+
_form_params = []
|
2186
|
+
_files = {}
|
2187
|
+
# process the body parameter
|
2188
|
+
_body_params = None
|
2189
|
+
# set the HTTP header `Accept`
|
2190
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
2191
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2192
|
+
|
2193
|
+
# authentication setting
|
2194
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2195
|
+
|
2196
|
+
_response_types_map = {
|
2197
|
+
'200': "PagedResourceListOfWorkspaceItem",
|
2198
|
+
'400': "LusidValidationProblemDetails",
|
2199
|
+
}
|
2200
|
+
|
2201
|
+
return self.api_client.call_api(
|
2202
|
+
'/api/workspaces/personal/{workspaceName}/items', 'GET',
|
2203
|
+
_path_params,
|
2204
|
+
_query_params,
|
2205
|
+
_header_params,
|
2206
|
+
body=_body_params,
|
2207
|
+
post_params=_form_params,
|
2208
|
+
files=_files,
|
2209
|
+
response_types_map=_response_types_map,
|
2210
|
+
auth_settings=_auth_settings,
|
2211
|
+
async_req=_params.get('async_req'),
|
2212
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2213
|
+
_preload_content=_params.get('_preload_content', True),
|
2214
|
+
_request_timeout=_params.get('_request_timeout'),
|
2215
|
+
opts=_params.get('opts'),
|
2216
|
+
collection_formats=_collection_formats,
|
2217
|
+
_request_auth=_params.get('_request_auth'))
|
2218
|
+
|
2219
|
+
@overload
|
2220
|
+
async def list_personal_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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) -> PagedResourceListOfWorkspace: # noqa: E501
|
2221
|
+
...
|
2222
|
+
|
2223
|
+
@overload
|
2224
|
+
def list_personal_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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) -> PagedResourceListOfWorkspace: # noqa: E501
|
2225
|
+
...
|
2226
|
+
|
2227
|
+
@validate_arguments
|
2228
|
+
def list_personal_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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[PagedResourceListOfWorkspace, Awaitable[PagedResourceListOfWorkspace]]: # noqa: E501
|
2229
|
+
"""[EXPERIMENTAL] ListPersonalWorkspaces: List personal workspaces. # noqa: E501
|
2230
|
+
|
2231
|
+
List personal workspaces. # noqa: E501
|
2232
|
+
This method makes a synchronous HTTP request by default. To make an
|
2233
|
+
asynchronous HTTP request, please pass async_req=True
|
2234
|
+
|
2235
|
+
>>> thread = api.list_personal_workspaces(as_at, page, sort_by, limit, filter, async_req=True)
|
2236
|
+
>>> result = thread.get()
|
2237
|
+
|
2238
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
2239
|
+
:type as_at: datetime
|
2240
|
+
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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.
|
2241
|
+
:type page: str
|
2242
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2243
|
+
:type sort_by: List[str]
|
2244
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
2245
|
+
:type limit: int
|
2246
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2247
|
+
:type filter: str
|
2248
|
+
:param async_req: Whether to execute the request asynchronously.
|
2249
|
+
:type async_req: bool, optional
|
2250
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2251
|
+
:param opts: Configuration options for this request
|
2252
|
+
:type opts: ConfigurationOptions, optional
|
2253
|
+
:return: Returns the result object.
|
2254
|
+
If the method is called asynchronously,
|
2255
|
+
returns the request thread.
|
2256
|
+
:rtype: PagedResourceListOfWorkspace
|
2257
|
+
"""
|
2258
|
+
kwargs['_return_http_data_only'] = True
|
2259
|
+
if '_preload_content' in kwargs:
|
2260
|
+
message = "Error! Please call the list_personal_workspaces_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2261
|
+
raise ValueError(message)
|
2262
|
+
if async_req is not None:
|
2263
|
+
kwargs['async_req'] = async_req
|
2264
|
+
return self.list_personal_workspaces_with_http_info(as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
2265
|
+
|
2266
|
+
@validate_arguments
|
2267
|
+
def list_personal_workspaces_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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
|
2268
|
+
"""[EXPERIMENTAL] ListPersonalWorkspaces: List personal workspaces. # noqa: E501
|
2269
|
+
|
2270
|
+
List personal workspaces. # noqa: E501
|
2271
|
+
This method makes a synchronous HTTP request by default. To make an
|
2272
|
+
asynchronous HTTP request, please pass async_req=True
|
2273
|
+
|
2274
|
+
>>> thread = api.list_personal_workspaces_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
|
2275
|
+
>>> result = thread.get()
|
2276
|
+
|
2277
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
2278
|
+
:type as_at: datetime
|
2279
|
+
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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.
|
2280
|
+
:type page: str
|
2281
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2282
|
+
:type sort_by: List[str]
|
2283
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
2284
|
+
:type limit: int
|
2285
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2286
|
+
:type filter: str
|
2287
|
+
:param async_req: Whether to execute the request asynchronously.
|
2288
|
+
:type async_req: bool, optional
|
2289
|
+
:param _preload_content: if False, the ApiResponse.data will
|
2290
|
+
be set to none and raw_data will store the
|
2291
|
+
HTTP response body without reading/decoding.
|
2292
|
+
Default is True.
|
2293
|
+
:type _preload_content: bool, optional
|
2294
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
2295
|
+
object with status code, headers, etc
|
2296
|
+
:type _return_http_data_only: bool, optional
|
2297
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2298
|
+
:param opts: Configuration options for this request
|
2299
|
+
:type opts: ConfigurationOptions, optional
|
2300
|
+
:param _request_auth: set to override the auth_settings for an a single
|
2301
|
+
request; this effectively ignores the authentication
|
2302
|
+
in the spec for a single request.
|
2303
|
+
:type _request_auth: dict, optional
|
2304
|
+
:type _content_type: string, optional: force content-type for the request
|
2305
|
+
:return: Returns the result object.
|
2306
|
+
If the method is called asynchronously,
|
2307
|
+
returns the request thread.
|
2308
|
+
:rtype: tuple(PagedResourceListOfWorkspace, status_code(int), headers(HTTPHeaderDict))
|
2309
|
+
"""
|
2310
|
+
|
2311
|
+
_params = locals()
|
2312
|
+
|
2313
|
+
_all_params = [
|
2314
|
+
'as_at',
|
2315
|
+
'page',
|
2316
|
+
'sort_by',
|
2317
|
+
'limit',
|
2318
|
+
'filter'
|
2319
|
+
]
|
2320
|
+
_all_params.extend(
|
2321
|
+
[
|
2322
|
+
'async_req',
|
2323
|
+
'_return_http_data_only',
|
2324
|
+
'_preload_content',
|
2325
|
+
'_request_timeout',
|
2326
|
+
'_request_auth',
|
2327
|
+
'_content_type',
|
2328
|
+
'_headers',
|
2329
|
+
'opts'
|
2330
|
+
]
|
2331
|
+
)
|
2332
|
+
|
2333
|
+
# validate the arguments
|
2334
|
+
for _key, _val in _params['kwargs'].items():
|
2335
|
+
if _key not in _all_params:
|
2336
|
+
raise ApiTypeError(
|
2337
|
+
"Got an unexpected keyword argument '%s'"
|
2338
|
+
" to method list_personal_workspaces" % _key
|
2339
|
+
)
|
2340
|
+
_params[_key] = _val
|
2341
|
+
del _params['kwargs']
|
2342
|
+
|
2343
|
+
_collection_formats = {}
|
2344
|
+
|
2345
|
+
# process the path parameters
|
2346
|
+
_path_params = {}
|
2347
|
+
|
2348
|
+
# process the query parameters
|
2349
|
+
_query_params = []
|
2350
|
+
if _params.get('as_at') is not None: # noqa: E501
|
2351
|
+
if isinstance(_params['as_at'], datetime):
|
2352
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
2353
|
+
else:
|
2354
|
+
_query_params.append(('asAt', _params['as_at']))
|
2355
|
+
|
2356
|
+
if _params.get('page') is not None: # noqa: E501
|
2357
|
+
_query_params.append(('page', _params['page']))
|
2358
|
+
|
2359
|
+
if _params.get('sort_by') is not None: # noqa: E501
|
2360
|
+
_query_params.append(('sortBy', _params['sort_by']))
|
2361
|
+
_collection_formats['sortBy'] = 'multi'
|
2362
|
+
|
2363
|
+
if _params.get('limit') is not None: # noqa: E501
|
2364
|
+
_query_params.append(('limit', _params['limit']))
|
2365
|
+
|
2366
|
+
if _params.get('filter') is not None: # noqa: E501
|
2367
|
+
_query_params.append(('filter', _params['filter']))
|
2368
|
+
|
2369
|
+
# process the header parameters
|
2370
|
+
_header_params = dict(_params.get('_headers', {}))
|
2371
|
+
# process the form parameters
|
2372
|
+
_form_params = []
|
2373
|
+
_files = {}
|
2374
|
+
# process the body parameter
|
2375
|
+
_body_params = None
|
2376
|
+
# set the HTTP header `Accept`
|
2377
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
2378
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2379
|
+
|
2380
|
+
# authentication setting
|
2381
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2382
|
+
|
2383
|
+
_response_types_map = {
|
2384
|
+
'200': "PagedResourceListOfWorkspace",
|
2385
|
+
'400': "LusidValidationProblemDetails",
|
2386
|
+
}
|
2387
|
+
|
2388
|
+
return self.api_client.call_api(
|
2389
|
+
'/api/workspaces/personal', 'GET',
|
2390
|
+
_path_params,
|
2391
|
+
_query_params,
|
2392
|
+
_header_params,
|
2393
|
+
body=_body_params,
|
2394
|
+
post_params=_form_params,
|
2395
|
+
files=_files,
|
2396
|
+
response_types_map=_response_types_map,
|
2397
|
+
auth_settings=_auth_settings,
|
2398
|
+
async_req=_params.get('async_req'),
|
2399
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2400
|
+
_preload_content=_params.get('_preload_content', True),
|
2401
|
+
_request_timeout=_params.get('_request_timeout'),
|
2402
|
+
opts=_params.get('opts'),
|
2403
|
+
collection_formats=_collection_formats,
|
2404
|
+
_request_auth=_params.get('_request_auth'))
|
2405
|
+
|
2406
|
+
@overload
|
2407
|
+
async def list_shared_items(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
2408
|
+
...
|
2409
|
+
|
2410
|
+
@overload
|
2411
|
+
def list_shared_items(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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) -> PagedResourceListOfWorkspaceItem: # noqa: E501
|
2412
|
+
...
|
2413
|
+
|
2414
|
+
@validate_arguments
|
2415
|
+
def list_shared_items(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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[PagedResourceListOfWorkspaceItem, Awaitable[PagedResourceListOfWorkspaceItem]]: # noqa: E501
|
2416
|
+
"""[EXPERIMENTAL] ListSharedItems: List the items in a shared workspace. # noqa: E501
|
2417
|
+
|
2418
|
+
List the items in a shared workspace. # noqa: E501
|
2419
|
+
This method makes a synchronous HTTP request by default. To make an
|
2420
|
+
asynchronous HTTP request, please pass async_req=True
|
2421
|
+
|
2422
|
+
>>> thread = api.list_shared_items(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
2423
|
+
>>> result = thread.get()
|
2424
|
+
|
2425
|
+
:param workspace_name: The item's workspace name. (required)
|
2426
|
+
:type workspace_name: str
|
2427
|
+
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
2428
|
+
:type as_at: datetime
|
2429
|
+
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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.
|
2430
|
+
:type page: str
|
2431
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2432
|
+
:type sort_by: List[str]
|
2433
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
2434
|
+
:type limit: int
|
2435
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2436
|
+
:type filter: str
|
2437
|
+
:param async_req: Whether to execute the request asynchronously.
|
2438
|
+
:type async_req: bool, optional
|
2439
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2440
|
+
:param opts: Configuration options for this request
|
2441
|
+
:type opts: ConfigurationOptions, optional
|
2442
|
+
:return: Returns the result object.
|
2443
|
+
If the method is called asynchronously,
|
2444
|
+
returns the request thread.
|
2445
|
+
:rtype: PagedResourceListOfWorkspaceItem
|
2446
|
+
"""
|
2447
|
+
kwargs['_return_http_data_only'] = True
|
2448
|
+
if '_preload_content' in kwargs:
|
2449
|
+
message = "Error! Please call the list_shared_items_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2450
|
+
raise ValueError(message)
|
2451
|
+
if async_req is not None:
|
2452
|
+
kwargs['async_req'] = async_req
|
2453
|
+
return self.list_shared_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
2454
|
+
|
2455
|
+
@validate_arguments
|
2456
|
+
def list_shared_items_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item's workspace name.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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
|
2457
|
+
"""[EXPERIMENTAL] ListSharedItems: List the items in a shared workspace. # noqa: E501
|
2458
|
+
|
2459
|
+
List the items in a shared workspace. # noqa: E501
|
2460
|
+
This method makes a synchronous HTTP request by default. To make an
|
2461
|
+
asynchronous HTTP request, please pass async_req=True
|
2462
|
+
|
2463
|
+
>>> thread = api.list_shared_items_with_http_info(workspace_name, as_at, page, sort_by, limit, filter, async_req=True)
|
2464
|
+
>>> result = thread.get()
|
2465
|
+
|
2466
|
+
:param workspace_name: The item's workspace name. (required)
|
2467
|
+
:type workspace_name: str
|
2468
|
+
:param as_at: The asAt datetime at which to retrieve workspace items. Defaults to 'latest' if not specified.
|
2469
|
+
:type as_at: datetime
|
2470
|
+
:param page: The pagination token to use to continue listing workspaces items from a previous call to list workspaces items. 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.
|
2471
|
+
:type page: str
|
2472
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2473
|
+
:type sort_by: List[str]
|
2474
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
2475
|
+
:type limit: int
|
2476
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2477
|
+
:type filter: str
|
2478
|
+
:param async_req: Whether to execute the request asynchronously.
|
2479
|
+
:type async_req: bool, optional
|
2480
|
+
:param _preload_content: if False, the ApiResponse.data will
|
2481
|
+
be set to none and raw_data will store the
|
2482
|
+
HTTP response body without reading/decoding.
|
2483
|
+
Default is True.
|
2484
|
+
:type _preload_content: bool, optional
|
2485
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
2486
|
+
object with status code, headers, etc
|
2487
|
+
:type _return_http_data_only: bool, optional
|
2488
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2489
|
+
:param opts: Configuration options for this request
|
2490
|
+
:type opts: ConfigurationOptions, optional
|
2491
|
+
:param _request_auth: set to override the auth_settings for an a single
|
2492
|
+
request; this effectively ignores the authentication
|
2493
|
+
in the spec for a single request.
|
2494
|
+
:type _request_auth: dict, optional
|
2495
|
+
:type _content_type: string, optional: force content-type for the request
|
2496
|
+
:return: Returns the result object.
|
2497
|
+
If the method is called asynchronously,
|
2498
|
+
returns the request thread.
|
2499
|
+
:rtype: tuple(PagedResourceListOfWorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
2500
|
+
"""
|
2501
|
+
|
2502
|
+
_params = locals()
|
2503
|
+
|
2504
|
+
_all_params = [
|
2505
|
+
'workspace_name',
|
2506
|
+
'as_at',
|
2507
|
+
'page',
|
2508
|
+
'sort_by',
|
2509
|
+
'limit',
|
2510
|
+
'filter'
|
2511
|
+
]
|
2512
|
+
_all_params.extend(
|
2513
|
+
[
|
2514
|
+
'async_req',
|
2515
|
+
'_return_http_data_only',
|
2516
|
+
'_preload_content',
|
2517
|
+
'_request_timeout',
|
2518
|
+
'_request_auth',
|
2519
|
+
'_content_type',
|
2520
|
+
'_headers',
|
2521
|
+
'opts'
|
2522
|
+
]
|
2523
|
+
)
|
2524
|
+
|
2525
|
+
# validate the arguments
|
2526
|
+
for _key, _val in _params['kwargs'].items():
|
2527
|
+
if _key not in _all_params:
|
2528
|
+
raise ApiTypeError(
|
2529
|
+
"Got an unexpected keyword argument '%s'"
|
2530
|
+
" to method list_shared_items" % _key
|
2531
|
+
)
|
2532
|
+
_params[_key] = _val
|
2533
|
+
del _params['kwargs']
|
2534
|
+
|
2535
|
+
_collection_formats = {}
|
2536
|
+
|
2537
|
+
# process the path parameters
|
2538
|
+
_path_params = {}
|
2539
|
+
if _params['workspace_name']:
|
2540
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
2541
|
+
|
2542
|
+
|
2543
|
+
# process the query parameters
|
2544
|
+
_query_params = []
|
2545
|
+
if _params.get('as_at') is not None: # noqa: E501
|
2546
|
+
if isinstance(_params['as_at'], datetime):
|
2547
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
2548
|
+
else:
|
2549
|
+
_query_params.append(('asAt', _params['as_at']))
|
2550
|
+
|
2551
|
+
if _params.get('page') is not None: # noqa: E501
|
2552
|
+
_query_params.append(('page', _params['page']))
|
2553
|
+
|
2554
|
+
if _params.get('sort_by') is not None: # noqa: E501
|
2555
|
+
_query_params.append(('sortBy', _params['sort_by']))
|
2556
|
+
_collection_formats['sortBy'] = 'multi'
|
2557
|
+
|
2558
|
+
if _params.get('limit') is not None: # noqa: E501
|
2559
|
+
_query_params.append(('limit', _params['limit']))
|
2560
|
+
|
2561
|
+
if _params.get('filter') is not None: # noqa: E501
|
2562
|
+
_query_params.append(('filter', _params['filter']))
|
2563
|
+
|
2564
|
+
# process the header parameters
|
2565
|
+
_header_params = dict(_params.get('_headers', {}))
|
2566
|
+
# process the form parameters
|
2567
|
+
_form_params = []
|
2568
|
+
_files = {}
|
2569
|
+
# process the body parameter
|
2570
|
+
_body_params = None
|
2571
|
+
# set the HTTP header `Accept`
|
2572
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
2573
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2574
|
+
|
2575
|
+
# authentication setting
|
2576
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2577
|
+
|
2578
|
+
_response_types_map = {
|
2579
|
+
'200': "PagedResourceListOfWorkspaceItem",
|
2580
|
+
'400': "LusidValidationProblemDetails",
|
2581
|
+
}
|
2582
|
+
|
2583
|
+
return self.api_client.call_api(
|
2584
|
+
'/api/workspaces/shared/{workspaceName}/items', 'GET',
|
2585
|
+
_path_params,
|
2586
|
+
_query_params,
|
2587
|
+
_header_params,
|
2588
|
+
body=_body_params,
|
2589
|
+
post_params=_form_params,
|
2590
|
+
files=_files,
|
2591
|
+
response_types_map=_response_types_map,
|
2592
|
+
auth_settings=_auth_settings,
|
2593
|
+
async_req=_params.get('async_req'),
|
2594
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2595
|
+
_preload_content=_params.get('_preload_content', True),
|
2596
|
+
_request_timeout=_params.get('_request_timeout'),
|
2597
|
+
opts=_params.get('opts'),
|
2598
|
+
collection_formats=_collection_formats,
|
2599
|
+
_request_auth=_params.get('_request_auth'))
|
2600
|
+
|
2601
|
+
@overload
|
2602
|
+
async def list_shared_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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) -> PagedResourceListOfWorkspace: # noqa: E501
|
2603
|
+
...
|
2604
|
+
|
2605
|
+
@overload
|
2606
|
+
def list_shared_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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) -> PagedResourceListOfWorkspace: # noqa: E501
|
2607
|
+
...
|
2608
|
+
|
2609
|
+
@validate_arguments
|
2610
|
+
def list_shared_workspaces(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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[PagedResourceListOfWorkspace, Awaitable[PagedResourceListOfWorkspace]]: # noqa: E501
|
2611
|
+
"""[EXPERIMENTAL] ListSharedWorkspaces: List shared workspaces. # noqa: E501
|
2612
|
+
|
2613
|
+
List shared workspaces. # noqa: E501
|
2614
|
+
This method makes a synchronous HTTP request by default. To make an
|
2615
|
+
asynchronous HTTP request, please pass async_req=True
|
2616
|
+
|
2617
|
+
>>> thread = api.list_shared_workspaces(as_at, page, sort_by, limit, filter, async_req=True)
|
2618
|
+
>>> result = thread.get()
|
2619
|
+
|
2620
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
2621
|
+
:type as_at: datetime
|
2622
|
+
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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.
|
2623
|
+
:type page: str
|
2624
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2625
|
+
:type sort_by: List[str]
|
2626
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
2627
|
+
:type limit: int
|
2628
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2629
|
+
:type filter: str
|
2630
|
+
:param async_req: Whether to execute the request asynchronously.
|
2631
|
+
:type async_req: bool, optional
|
2632
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2633
|
+
:param opts: Configuration options for this request
|
2634
|
+
:type opts: ConfigurationOptions, optional
|
2635
|
+
:return: Returns the result object.
|
2636
|
+
If the method is called asynchronously,
|
2637
|
+
returns the request thread.
|
2638
|
+
:rtype: PagedResourceListOfWorkspace
|
2639
|
+
"""
|
2640
|
+
kwargs['_return_http_data_only'] = True
|
2641
|
+
if '_preload_content' in kwargs:
|
2642
|
+
message = "Error! Please call the list_shared_workspaces_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2643
|
+
raise ValueError(message)
|
2644
|
+
if async_req is not None:
|
2645
|
+
kwargs['async_req'] = async_req
|
2646
|
+
return self.list_shared_workspaces_with_http_info(as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
2647
|
+
|
2648
|
+
@validate_arguments
|
2649
|
+
def list_shared_workspaces_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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
|
2650
|
+
"""[EXPERIMENTAL] ListSharedWorkspaces: List shared workspaces. # noqa: E501
|
2651
|
+
|
2652
|
+
List shared workspaces. # noqa: E501
|
2653
|
+
This method makes a synchronous HTTP request by default. To make an
|
2654
|
+
asynchronous HTTP request, please pass async_req=True
|
2655
|
+
|
2656
|
+
>>> thread = api.list_shared_workspaces_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
|
2657
|
+
>>> result = thread.get()
|
2658
|
+
|
2659
|
+
:param as_at: The asAt datetime at which to retrieve workspaces. Defaults to 'latest' if not specified.
|
2660
|
+
:type as_at: datetime
|
2661
|
+
:param page: The pagination token to use to continue listing workspaces from a previous call to list workspaces. 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.
|
2662
|
+
:type page: str
|
2663
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
2664
|
+
:type sort_by: List[str]
|
2665
|
+
:param limit: When paginating, limit the number of returned results to this many.
|
2666
|
+
:type limit: int
|
2667
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
2668
|
+
:type filter: str
|
2669
|
+
:param async_req: Whether to execute the request asynchronously.
|
2670
|
+
:type async_req: bool, optional
|
2671
|
+
:param _preload_content: if False, the ApiResponse.data will
|
2672
|
+
be set to none and raw_data will store the
|
2673
|
+
HTTP response body without reading/decoding.
|
2674
|
+
Default is True.
|
2675
|
+
:type _preload_content: bool, optional
|
2676
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
2677
|
+
object with status code, headers, etc
|
2678
|
+
:type _return_http_data_only: bool, optional
|
2679
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2680
|
+
:param opts: Configuration options for this request
|
2681
|
+
:type opts: ConfigurationOptions, optional
|
2682
|
+
:param _request_auth: set to override the auth_settings for an a single
|
2683
|
+
request; this effectively ignores the authentication
|
2684
|
+
in the spec for a single request.
|
2685
|
+
:type _request_auth: dict, optional
|
2686
|
+
:type _content_type: string, optional: force content-type for the request
|
2687
|
+
:return: Returns the result object.
|
2688
|
+
If the method is called asynchronously,
|
2689
|
+
returns the request thread.
|
2690
|
+
:rtype: tuple(PagedResourceListOfWorkspace, status_code(int), headers(HTTPHeaderDict))
|
2691
|
+
"""
|
2692
|
+
|
2693
|
+
_params = locals()
|
2694
|
+
|
2695
|
+
_all_params = [
|
2696
|
+
'as_at',
|
2697
|
+
'page',
|
2698
|
+
'sort_by',
|
2699
|
+
'limit',
|
2700
|
+
'filter'
|
2701
|
+
]
|
2702
|
+
_all_params.extend(
|
2703
|
+
[
|
2704
|
+
'async_req',
|
2705
|
+
'_return_http_data_only',
|
2706
|
+
'_preload_content',
|
2707
|
+
'_request_timeout',
|
2708
|
+
'_request_auth',
|
2709
|
+
'_content_type',
|
2710
|
+
'_headers',
|
2711
|
+
'opts'
|
2712
|
+
]
|
2713
|
+
)
|
2714
|
+
|
2715
|
+
# validate the arguments
|
2716
|
+
for _key, _val in _params['kwargs'].items():
|
2717
|
+
if _key not in _all_params:
|
2718
|
+
raise ApiTypeError(
|
2719
|
+
"Got an unexpected keyword argument '%s'"
|
2720
|
+
" to method list_shared_workspaces" % _key
|
2721
|
+
)
|
2722
|
+
_params[_key] = _val
|
2723
|
+
del _params['kwargs']
|
2724
|
+
|
2725
|
+
_collection_formats = {}
|
2726
|
+
|
2727
|
+
# process the path parameters
|
2728
|
+
_path_params = {}
|
2729
|
+
|
2730
|
+
# process the query parameters
|
2731
|
+
_query_params = []
|
2732
|
+
if _params.get('as_at') is not None: # noqa: E501
|
2733
|
+
if isinstance(_params['as_at'], datetime):
|
2734
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
2735
|
+
else:
|
2736
|
+
_query_params.append(('asAt', _params['as_at']))
|
2737
|
+
|
2738
|
+
if _params.get('page') is not None: # noqa: E501
|
2739
|
+
_query_params.append(('page', _params['page']))
|
2740
|
+
|
2741
|
+
if _params.get('sort_by') is not None: # noqa: E501
|
2742
|
+
_query_params.append(('sortBy', _params['sort_by']))
|
2743
|
+
_collection_formats['sortBy'] = 'multi'
|
2744
|
+
|
2745
|
+
if _params.get('limit') is not None: # noqa: E501
|
2746
|
+
_query_params.append(('limit', _params['limit']))
|
2747
|
+
|
2748
|
+
if _params.get('filter') is not None: # noqa: E501
|
2749
|
+
_query_params.append(('filter', _params['filter']))
|
2750
|
+
|
2751
|
+
# process the header parameters
|
2752
|
+
_header_params = dict(_params.get('_headers', {}))
|
2753
|
+
# process the form parameters
|
2754
|
+
_form_params = []
|
2755
|
+
_files = {}
|
2756
|
+
# process the body parameter
|
2757
|
+
_body_params = None
|
2758
|
+
# set the HTTP header `Accept`
|
2759
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
2760
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2761
|
+
|
2762
|
+
# authentication setting
|
2763
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2764
|
+
|
2765
|
+
_response_types_map = {
|
2766
|
+
'200': "PagedResourceListOfWorkspace",
|
2767
|
+
'400': "LusidValidationProblemDetails",
|
2768
|
+
}
|
2769
|
+
|
2770
|
+
return self.api_client.call_api(
|
2771
|
+
'/api/workspaces/shared', 'GET',
|
2772
|
+
_path_params,
|
2773
|
+
_query_params,
|
2774
|
+
_header_params,
|
2775
|
+
body=_body_params,
|
2776
|
+
post_params=_form_params,
|
2777
|
+
files=_files,
|
2778
|
+
response_types_map=_response_types_map,
|
2779
|
+
auth_settings=_auth_settings,
|
2780
|
+
async_req=_params.get('async_req'),
|
2781
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2782
|
+
_preload_content=_params.get('_preload_content', True),
|
2783
|
+
_request_timeout=_params.get('_request_timeout'),
|
2784
|
+
opts=_params.get('opts'),
|
2785
|
+
collection_formats=_collection_formats,
|
2786
|
+
_request_auth=_params.get('_request_auth'))
|
2787
|
+
|
2788
|
+
@overload
|
2789
|
+
async def update_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
2790
|
+
...
|
2791
|
+
|
2792
|
+
@overload
|
2793
|
+
def update_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
2794
|
+
...
|
2795
|
+
|
2796
|
+
@validate_arguments
|
2797
|
+
def update_personal_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
2798
|
+
"""[EXPERIMENTAL] UpdatePersonalItem: Update an item in a personal workspace. # noqa: E501
|
2799
|
+
|
2800
|
+
Update an item in a personal workspace. # noqa: E501
|
2801
|
+
This method makes a synchronous HTTP request by default. To make an
|
2802
|
+
asynchronous HTTP request, please pass async_req=True
|
2803
|
+
|
2804
|
+
>>> thread = api.update_personal_item(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
2805
|
+
>>> result = thread.get()
|
2806
|
+
|
2807
|
+
:param workspace_name: The personal workspace name. (required)
|
2808
|
+
:type workspace_name: str
|
2809
|
+
:param group_name: The group containing the item. (required)
|
2810
|
+
:type group_name: str
|
2811
|
+
:param item_name: The item name. (required)
|
2812
|
+
:type item_name: str
|
2813
|
+
:param workspace_item_update_request: The new item details.
|
2814
|
+
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
2815
|
+
:param async_req: Whether to execute the request asynchronously.
|
2816
|
+
:type async_req: bool, optional
|
2817
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2818
|
+
:param opts: Configuration options for this request
|
2819
|
+
:type opts: ConfigurationOptions, optional
|
2820
|
+
:return: Returns the result object.
|
2821
|
+
If the method is called asynchronously,
|
2822
|
+
returns the request thread.
|
2823
|
+
:rtype: WorkspaceItem
|
2824
|
+
"""
|
2825
|
+
kwargs['_return_http_data_only'] = True
|
2826
|
+
if '_preload_content' in kwargs:
|
2827
|
+
message = "Error! Please call the update_personal_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2828
|
+
raise ValueError(message)
|
2829
|
+
if async_req is not None:
|
2830
|
+
kwargs['async_req'] = async_req
|
2831
|
+
return self.update_personal_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, **kwargs) # noqa: E501
|
2832
|
+
|
2833
|
+
@validate_arguments
|
2834
|
+
def update_personal_item_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2835
|
+
"""[EXPERIMENTAL] UpdatePersonalItem: Update an item in a personal workspace. # noqa: E501
|
2836
|
+
|
2837
|
+
Update an item in a personal workspace. # noqa: E501
|
2838
|
+
This method makes a synchronous HTTP request by default. To make an
|
2839
|
+
asynchronous HTTP request, please pass async_req=True
|
2840
|
+
|
2841
|
+
>>> thread = api.update_personal_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
2842
|
+
>>> result = thread.get()
|
2843
|
+
|
2844
|
+
:param workspace_name: The personal workspace name. (required)
|
2845
|
+
:type workspace_name: str
|
2846
|
+
:param group_name: The group containing the item. (required)
|
2847
|
+
:type group_name: str
|
2848
|
+
:param item_name: The item name. (required)
|
2849
|
+
:type item_name: str
|
2850
|
+
:param workspace_item_update_request: The new item details.
|
2851
|
+
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
2852
|
+
:param async_req: Whether to execute the request asynchronously.
|
2853
|
+
:type async_req: bool, optional
|
2854
|
+
:param _preload_content: if False, the ApiResponse.data will
|
2855
|
+
be set to none and raw_data will store the
|
2856
|
+
HTTP response body without reading/decoding.
|
2857
|
+
Default is True.
|
2858
|
+
:type _preload_content: bool, optional
|
2859
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
2860
|
+
object with status code, headers, etc
|
2861
|
+
:type _return_http_data_only: bool, optional
|
2862
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2863
|
+
:param opts: Configuration options for this request
|
2864
|
+
:type opts: ConfigurationOptions, optional
|
2865
|
+
:param _request_auth: set to override the auth_settings for an a single
|
2866
|
+
request; this effectively ignores the authentication
|
2867
|
+
in the spec for a single request.
|
2868
|
+
:type _request_auth: dict, optional
|
2869
|
+
:type _content_type: string, optional: force content-type for the request
|
2870
|
+
:return: Returns the result object.
|
2871
|
+
If the method is called asynchronously,
|
2872
|
+
returns the request thread.
|
2873
|
+
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
2874
|
+
"""
|
2875
|
+
|
2876
|
+
_params = locals()
|
2877
|
+
|
2878
|
+
_all_params = [
|
2879
|
+
'workspace_name',
|
2880
|
+
'group_name',
|
2881
|
+
'item_name',
|
2882
|
+
'workspace_item_update_request'
|
2883
|
+
]
|
2884
|
+
_all_params.extend(
|
2885
|
+
[
|
2886
|
+
'async_req',
|
2887
|
+
'_return_http_data_only',
|
2888
|
+
'_preload_content',
|
2889
|
+
'_request_timeout',
|
2890
|
+
'_request_auth',
|
2891
|
+
'_content_type',
|
2892
|
+
'_headers',
|
2893
|
+
'opts'
|
2894
|
+
]
|
2895
|
+
)
|
2896
|
+
|
2897
|
+
# validate the arguments
|
2898
|
+
for _key, _val in _params['kwargs'].items():
|
2899
|
+
if _key not in _all_params:
|
2900
|
+
raise ApiTypeError(
|
2901
|
+
"Got an unexpected keyword argument '%s'"
|
2902
|
+
" to method update_personal_item" % _key
|
2903
|
+
)
|
2904
|
+
_params[_key] = _val
|
2905
|
+
del _params['kwargs']
|
2906
|
+
|
2907
|
+
_collection_formats = {}
|
2908
|
+
|
2909
|
+
# process the path parameters
|
2910
|
+
_path_params = {}
|
2911
|
+
if _params['workspace_name']:
|
2912
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
2913
|
+
|
2914
|
+
if _params['group_name']:
|
2915
|
+
_path_params['groupName'] = _params['group_name']
|
2916
|
+
|
2917
|
+
if _params['item_name']:
|
2918
|
+
_path_params['itemName'] = _params['item_name']
|
2919
|
+
|
2920
|
+
|
2921
|
+
# process the query parameters
|
2922
|
+
_query_params = []
|
2923
|
+
# process the header parameters
|
2924
|
+
_header_params = dict(_params.get('_headers', {}))
|
2925
|
+
# process the form parameters
|
2926
|
+
_form_params = []
|
2927
|
+
_files = {}
|
2928
|
+
# process the body parameter
|
2929
|
+
_body_params = None
|
2930
|
+
if _params['workspace_item_update_request'] is not None:
|
2931
|
+
_body_params = _params['workspace_item_update_request']
|
2932
|
+
|
2933
|
+
# set the HTTP header `Accept`
|
2934
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
2935
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2936
|
+
|
2937
|
+
# set the HTTP header `Content-Type`
|
2938
|
+
_content_types_list = _params.get('_content_type',
|
2939
|
+
self.api_client.select_header_content_type(
|
2940
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
2941
|
+
if _content_types_list:
|
2942
|
+
_header_params['Content-Type'] = _content_types_list
|
2943
|
+
|
2944
|
+
# authentication setting
|
2945
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2946
|
+
|
2947
|
+
_response_types_map = {
|
2948
|
+
'200': "WorkspaceItem",
|
2949
|
+
'400': "LusidValidationProblemDetails",
|
2950
|
+
}
|
2951
|
+
|
2952
|
+
return self.api_client.call_api(
|
2953
|
+
'/api/workspaces/personal/{workspaceName}/items/{groupName}/{itemName}', 'PUT',
|
2954
|
+
_path_params,
|
2955
|
+
_query_params,
|
2956
|
+
_header_params,
|
2957
|
+
body=_body_params,
|
2958
|
+
post_params=_form_params,
|
2959
|
+
files=_files,
|
2960
|
+
response_types_map=_response_types_map,
|
2961
|
+
auth_settings=_auth_settings,
|
2962
|
+
async_req=_params.get('async_req'),
|
2963
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2964
|
+
_preload_content=_params.get('_preload_content', True),
|
2965
|
+
_request_timeout=_params.get('_request_timeout'),
|
2966
|
+
opts=_params.get('opts'),
|
2967
|
+
collection_formats=_collection_formats,
|
2968
|
+
_request_auth=_params.get('_request_auth'))
|
2969
|
+
|
2970
|
+
@overload
|
2971
|
+
async def update_personal_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, **kwargs) -> Workspace: # noqa: E501
|
2972
|
+
...
|
2973
|
+
|
2974
|
+
@overload
|
2975
|
+
def update_personal_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
2976
|
+
...
|
2977
|
+
|
2978
|
+
@validate_arguments
|
2979
|
+
def update_personal_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
2980
|
+
"""[EXPERIMENTAL] UpdatePersonalWorkspace: Update a personal workspace. # noqa: E501
|
2981
|
+
|
2982
|
+
Update a personal workspace. # noqa: E501
|
2983
|
+
This method makes a synchronous HTTP request by default. To make an
|
2984
|
+
asynchronous HTTP request, please pass async_req=True
|
2985
|
+
|
2986
|
+
>>> thread = api.update_personal_workspace(workspace_name, workspace_update_request, async_req=True)
|
2987
|
+
>>> result = thread.get()
|
2988
|
+
|
2989
|
+
:param workspace_name: The personal workspace name. (required)
|
2990
|
+
:type workspace_name: str
|
2991
|
+
:param workspace_update_request: The new workspace details.
|
2992
|
+
:type workspace_update_request: WorkspaceUpdateRequest
|
2993
|
+
:param async_req: Whether to execute the request asynchronously.
|
2994
|
+
:type async_req: bool, optional
|
2995
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2996
|
+
:param opts: Configuration options for this request
|
2997
|
+
:type opts: ConfigurationOptions, optional
|
2998
|
+
:return: Returns the result object.
|
2999
|
+
If the method is called asynchronously,
|
3000
|
+
returns the request thread.
|
3001
|
+
:rtype: Workspace
|
3002
|
+
"""
|
3003
|
+
kwargs['_return_http_data_only'] = True
|
3004
|
+
if '_preload_content' in kwargs:
|
3005
|
+
message = "Error! Please call the update_personal_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
3006
|
+
raise ValueError(message)
|
3007
|
+
if async_req is not None:
|
3008
|
+
kwargs['async_req'] = async_req
|
3009
|
+
return self.update_personal_workspace_with_http_info(workspace_name, workspace_update_request, **kwargs) # noqa: E501
|
3010
|
+
|
3011
|
+
@validate_arguments
|
3012
|
+
def update_personal_workspace_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The personal workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3013
|
+
"""[EXPERIMENTAL] UpdatePersonalWorkspace: Update a personal workspace. # noqa: E501
|
3014
|
+
|
3015
|
+
Update a personal workspace. # noqa: E501
|
3016
|
+
This method makes a synchronous HTTP request by default. To make an
|
3017
|
+
asynchronous HTTP request, please pass async_req=True
|
3018
|
+
|
3019
|
+
>>> thread = api.update_personal_workspace_with_http_info(workspace_name, workspace_update_request, async_req=True)
|
3020
|
+
>>> result = thread.get()
|
3021
|
+
|
3022
|
+
:param workspace_name: The personal workspace name. (required)
|
3023
|
+
:type workspace_name: str
|
3024
|
+
:param workspace_update_request: The new workspace details.
|
3025
|
+
:type workspace_update_request: WorkspaceUpdateRequest
|
3026
|
+
:param async_req: Whether to execute the request asynchronously.
|
3027
|
+
:type async_req: bool, optional
|
3028
|
+
:param _preload_content: if False, the ApiResponse.data will
|
3029
|
+
be set to none and raw_data will store the
|
3030
|
+
HTTP response body without reading/decoding.
|
3031
|
+
Default is True.
|
3032
|
+
:type _preload_content: bool, optional
|
3033
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
3034
|
+
object with status code, headers, etc
|
3035
|
+
:type _return_http_data_only: bool, optional
|
3036
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
3037
|
+
:param opts: Configuration options for this request
|
3038
|
+
:type opts: ConfigurationOptions, optional
|
3039
|
+
:param _request_auth: set to override the auth_settings for an a single
|
3040
|
+
request; this effectively ignores the authentication
|
3041
|
+
in the spec for a single request.
|
3042
|
+
:type _request_auth: dict, optional
|
3043
|
+
:type _content_type: string, optional: force content-type for the request
|
3044
|
+
:return: Returns the result object.
|
3045
|
+
If the method is called asynchronously,
|
3046
|
+
returns the request thread.
|
3047
|
+
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
3048
|
+
"""
|
3049
|
+
|
3050
|
+
_params = locals()
|
3051
|
+
|
3052
|
+
_all_params = [
|
3053
|
+
'workspace_name',
|
3054
|
+
'workspace_update_request'
|
3055
|
+
]
|
3056
|
+
_all_params.extend(
|
3057
|
+
[
|
3058
|
+
'async_req',
|
3059
|
+
'_return_http_data_only',
|
3060
|
+
'_preload_content',
|
3061
|
+
'_request_timeout',
|
3062
|
+
'_request_auth',
|
3063
|
+
'_content_type',
|
3064
|
+
'_headers',
|
3065
|
+
'opts'
|
3066
|
+
]
|
3067
|
+
)
|
3068
|
+
|
3069
|
+
# validate the arguments
|
3070
|
+
for _key, _val in _params['kwargs'].items():
|
3071
|
+
if _key not in _all_params:
|
3072
|
+
raise ApiTypeError(
|
3073
|
+
"Got an unexpected keyword argument '%s'"
|
3074
|
+
" to method update_personal_workspace" % _key
|
3075
|
+
)
|
3076
|
+
_params[_key] = _val
|
3077
|
+
del _params['kwargs']
|
3078
|
+
|
3079
|
+
_collection_formats = {}
|
3080
|
+
|
3081
|
+
# process the path parameters
|
3082
|
+
_path_params = {}
|
3083
|
+
if _params['workspace_name']:
|
3084
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
3085
|
+
|
3086
|
+
|
3087
|
+
# process the query parameters
|
3088
|
+
_query_params = []
|
3089
|
+
# process the header parameters
|
3090
|
+
_header_params = dict(_params.get('_headers', {}))
|
3091
|
+
# process the form parameters
|
3092
|
+
_form_params = []
|
3093
|
+
_files = {}
|
3094
|
+
# process the body parameter
|
3095
|
+
_body_params = None
|
3096
|
+
if _params['workspace_update_request'] is not None:
|
3097
|
+
_body_params = _params['workspace_update_request']
|
3098
|
+
|
3099
|
+
# set the HTTP header `Accept`
|
3100
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
3101
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
3102
|
+
|
3103
|
+
# set the HTTP header `Content-Type`
|
3104
|
+
_content_types_list = _params.get('_content_type',
|
3105
|
+
self.api_client.select_header_content_type(
|
3106
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
3107
|
+
if _content_types_list:
|
3108
|
+
_header_params['Content-Type'] = _content_types_list
|
3109
|
+
|
3110
|
+
# authentication setting
|
3111
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
3112
|
+
|
3113
|
+
_response_types_map = {
|
3114
|
+
'200': "Workspace",
|
3115
|
+
'400': "LusidValidationProblemDetails",
|
3116
|
+
}
|
3117
|
+
|
3118
|
+
return self.api_client.call_api(
|
3119
|
+
'/api/workspaces/personal/{workspaceName}', 'PUT',
|
3120
|
+
_path_params,
|
3121
|
+
_query_params,
|
3122
|
+
_header_params,
|
3123
|
+
body=_body_params,
|
3124
|
+
post_params=_form_params,
|
3125
|
+
files=_files,
|
3126
|
+
response_types_map=_response_types_map,
|
3127
|
+
auth_settings=_auth_settings,
|
3128
|
+
async_req=_params.get('async_req'),
|
3129
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
3130
|
+
_preload_content=_params.get('_preload_content', True),
|
3131
|
+
_request_timeout=_params.get('_request_timeout'),
|
3132
|
+
opts=_params.get('opts'),
|
3133
|
+
collection_formats=_collection_formats,
|
3134
|
+
_request_auth=_params.get('_request_auth'))
|
3135
|
+
|
3136
|
+
@overload
|
3137
|
+
async def update_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> WorkspaceItem: # noqa: E501
|
3138
|
+
...
|
3139
|
+
|
3140
|
+
@overload
|
3141
|
+
def update_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=True, **kwargs) -> WorkspaceItem: # noqa: E501
|
3142
|
+
...
|
3143
|
+
|
3144
|
+
@validate_arguments
|
3145
|
+
def update_shared_item(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[WorkspaceItem, Awaitable[WorkspaceItem]]: # noqa: E501
|
3146
|
+
"""[EXPERIMENTAL] UpdateSharedItem: Update an item in a shared workspace. # noqa: E501
|
3147
|
+
|
3148
|
+
Update an item in a shared workspace. # noqa: E501
|
3149
|
+
This method makes a synchronous HTTP request by default. To make an
|
3150
|
+
asynchronous HTTP request, please pass async_req=True
|
3151
|
+
|
3152
|
+
>>> thread = api.update_shared_item(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
3153
|
+
>>> result = thread.get()
|
3154
|
+
|
3155
|
+
:param workspace_name: The shared workspace name. (required)
|
3156
|
+
:type workspace_name: str
|
3157
|
+
:param group_name: The group containing the item. (required)
|
3158
|
+
:type group_name: str
|
3159
|
+
:param item_name: The item name. (required)
|
3160
|
+
:type item_name: str
|
3161
|
+
:param workspace_item_update_request: The new item details.
|
3162
|
+
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
3163
|
+
:param async_req: Whether to execute the request asynchronously.
|
3164
|
+
:type async_req: bool, optional
|
3165
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
3166
|
+
:param opts: Configuration options for this request
|
3167
|
+
:type opts: ConfigurationOptions, optional
|
3168
|
+
:return: Returns the result object.
|
3169
|
+
If the method is called asynchronously,
|
3170
|
+
returns the request thread.
|
3171
|
+
:rtype: WorkspaceItem
|
3172
|
+
"""
|
3173
|
+
kwargs['_return_http_data_only'] = True
|
3174
|
+
if '_preload_content' in kwargs:
|
3175
|
+
message = "Error! Please call the update_shared_item_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
3176
|
+
raise ValueError(message)
|
3177
|
+
if async_req is not None:
|
3178
|
+
kwargs['async_req'] = async_req
|
3179
|
+
return self.update_shared_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, **kwargs) # noqa: E501
|
3180
|
+
|
3181
|
+
@validate_arguments
|
3182
|
+
def update_shared_item_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], group_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The group containing the item.")], item_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The item name.")], workspace_item_update_request : Annotated[Optional[WorkspaceItemUpdateRequest], Field(description="The new item details.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3183
|
+
"""[EXPERIMENTAL] UpdateSharedItem: Update an item in a shared workspace. # noqa: E501
|
3184
|
+
|
3185
|
+
Update an item in a shared workspace. # noqa: E501
|
3186
|
+
This method makes a synchronous HTTP request by default. To make an
|
3187
|
+
asynchronous HTTP request, please pass async_req=True
|
3188
|
+
|
3189
|
+
>>> thread = api.update_shared_item_with_http_info(workspace_name, group_name, item_name, workspace_item_update_request, async_req=True)
|
3190
|
+
>>> result = thread.get()
|
3191
|
+
|
3192
|
+
:param workspace_name: The shared workspace name. (required)
|
3193
|
+
:type workspace_name: str
|
3194
|
+
:param group_name: The group containing the item. (required)
|
3195
|
+
:type group_name: str
|
3196
|
+
:param item_name: The item name. (required)
|
3197
|
+
:type item_name: str
|
3198
|
+
:param workspace_item_update_request: The new item details.
|
3199
|
+
:type workspace_item_update_request: WorkspaceItemUpdateRequest
|
3200
|
+
:param async_req: Whether to execute the request asynchronously.
|
3201
|
+
:type async_req: bool, optional
|
3202
|
+
:param _preload_content: if False, the ApiResponse.data will
|
3203
|
+
be set to none and raw_data will store the
|
3204
|
+
HTTP response body without reading/decoding.
|
3205
|
+
Default is True.
|
3206
|
+
:type _preload_content: bool, optional
|
3207
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
3208
|
+
object with status code, headers, etc
|
3209
|
+
:type _return_http_data_only: bool, optional
|
3210
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
3211
|
+
:param opts: Configuration options for this request
|
3212
|
+
:type opts: ConfigurationOptions, optional
|
3213
|
+
:param _request_auth: set to override the auth_settings for an a single
|
3214
|
+
request; this effectively ignores the authentication
|
3215
|
+
in the spec for a single request.
|
3216
|
+
:type _request_auth: dict, optional
|
3217
|
+
:type _content_type: string, optional: force content-type for the request
|
3218
|
+
:return: Returns the result object.
|
3219
|
+
If the method is called asynchronously,
|
3220
|
+
returns the request thread.
|
3221
|
+
:rtype: tuple(WorkspaceItem, status_code(int), headers(HTTPHeaderDict))
|
3222
|
+
"""
|
3223
|
+
|
3224
|
+
_params = locals()
|
3225
|
+
|
3226
|
+
_all_params = [
|
3227
|
+
'workspace_name',
|
3228
|
+
'group_name',
|
3229
|
+
'item_name',
|
3230
|
+
'workspace_item_update_request'
|
3231
|
+
]
|
3232
|
+
_all_params.extend(
|
3233
|
+
[
|
3234
|
+
'async_req',
|
3235
|
+
'_return_http_data_only',
|
3236
|
+
'_preload_content',
|
3237
|
+
'_request_timeout',
|
3238
|
+
'_request_auth',
|
3239
|
+
'_content_type',
|
3240
|
+
'_headers',
|
3241
|
+
'opts'
|
3242
|
+
]
|
3243
|
+
)
|
3244
|
+
|
3245
|
+
# validate the arguments
|
3246
|
+
for _key, _val in _params['kwargs'].items():
|
3247
|
+
if _key not in _all_params:
|
3248
|
+
raise ApiTypeError(
|
3249
|
+
"Got an unexpected keyword argument '%s'"
|
3250
|
+
" to method update_shared_item" % _key
|
3251
|
+
)
|
3252
|
+
_params[_key] = _val
|
3253
|
+
del _params['kwargs']
|
3254
|
+
|
3255
|
+
_collection_formats = {}
|
3256
|
+
|
3257
|
+
# process the path parameters
|
3258
|
+
_path_params = {}
|
3259
|
+
if _params['workspace_name']:
|
3260
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
3261
|
+
|
3262
|
+
if _params['group_name']:
|
3263
|
+
_path_params['groupName'] = _params['group_name']
|
3264
|
+
|
3265
|
+
if _params['item_name']:
|
3266
|
+
_path_params['itemName'] = _params['item_name']
|
3267
|
+
|
3268
|
+
|
3269
|
+
# process the query parameters
|
3270
|
+
_query_params = []
|
3271
|
+
# process the header parameters
|
3272
|
+
_header_params = dict(_params.get('_headers', {}))
|
3273
|
+
# process the form parameters
|
3274
|
+
_form_params = []
|
3275
|
+
_files = {}
|
3276
|
+
# process the body parameter
|
3277
|
+
_body_params = None
|
3278
|
+
if _params['workspace_item_update_request'] is not None:
|
3279
|
+
_body_params = _params['workspace_item_update_request']
|
3280
|
+
|
3281
|
+
# set the HTTP header `Accept`
|
3282
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
3283
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
3284
|
+
|
3285
|
+
# set the HTTP header `Content-Type`
|
3286
|
+
_content_types_list = _params.get('_content_type',
|
3287
|
+
self.api_client.select_header_content_type(
|
3288
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
3289
|
+
if _content_types_list:
|
3290
|
+
_header_params['Content-Type'] = _content_types_list
|
3291
|
+
|
3292
|
+
# authentication setting
|
3293
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
3294
|
+
|
3295
|
+
_response_types_map = {
|
3296
|
+
'200': "WorkspaceItem",
|
3297
|
+
'400': "LusidValidationProblemDetails",
|
3298
|
+
}
|
3299
|
+
|
3300
|
+
return self.api_client.call_api(
|
3301
|
+
'/api/workspaces/shared/{workspaceName}/items/{groupName}/{itemName}', 'PUT',
|
3302
|
+
_path_params,
|
3303
|
+
_query_params,
|
3304
|
+
_header_params,
|
3305
|
+
body=_body_params,
|
3306
|
+
post_params=_form_params,
|
3307
|
+
files=_files,
|
3308
|
+
response_types_map=_response_types_map,
|
3309
|
+
auth_settings=_auth_settings,
|
3310
|
+
async_req=_params.get('async_req'),
|
3311
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
3312
|
+
_preload_content=_params.get('_preload_content', True),
|
3313
|
+
_request_timeout=_params.get('_request_timeout'),
|
3314
|
+
opts=_params.get('opts'),
|
3315
|
+
collection_formats=_collection_formats,
|
3316
|
+
_request_auth=_params.get('_request_auth'))
|
3317
|
+
|
3318
|
+
@overload
|
3319
|
+
async def update_shared_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, **kwargs) -> Workspace: # noqa: E501
|
3320
|
+
...
|
3321
|
+
|
3322
|
+
@overload
|
3323
|
+
def update_shared_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, async_req: Optional[bool]=True, **kwargs) -> Workspace: # noqa: E501
|
3324
|
+
...
|
3325
|
+
|
3326
|
+
@validate_arguments
|
3327
|
+
def update_shared_workspace(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Workspace, Awaitable[Workspace]]: # noqa: E501
|
3328
|
+
"""[EXPERIMENTAL] UpdateSharedWorkspace: Update a shared workspace. # noqa: E501
|
3329
|
+
|
3330
|
+
Update a shared workspace. # noqa: E501
|
3331
|
+
This method makes a synchronous HTTP request by default. To make an
|
3332
|
+
asynchronous HTTP request, please pass async_req=True
|
3333
|
+
|
3334
|
+
>>> thread = api.update_shared_workspace(workspace_name, workspace_update_request, async_req=True)
|
3335
|
+
>>> result = thread.get()
|
3336
|
+
|
3337
|
+
:param workspace_name: The shared workspace name. (required)
|
3338
|
+
:type workspace_name: str
|
3339
|
+
:param workspace_update_request: The new workspace details.
|
3340
|
+
:type workspace_update_request: WorkspaceUpdateRequest
|
3341
|
+
:param async_req: Whether to execute the request asynchronously.
|
3342
|
+
:type async_req: bool, optional
|
3343
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
3344
|
+
:param opts: Configuration options for this request
|
3345
|
+
:type opts: ConfigurationOptions, optional
|
3346
|
+
:return: Returns the result object.
|
3347
|
+
If the method is called asynchronously,
|
3348
|
+
returns the request thread.
|
3349
|
+
:rtype: Workspace
|
3350
|
+
"""
|
3351
|
+
kwargs['_return_http_data_only'] = True
|
3352
|
+
if '_preload_content' in kwargs:
|
3353
|
+
message = "Error! Please call the update_shared_workspace_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
3354
|
+
raise ValueError(message)
|
3355
|
+
if async_req is not None:
|
3356
|
+
kwargs['async_req'] = async_req
|
3357
|
+
return self.update_shared_workspace_with_http_info(workspace_name, workspace_update_request, **kwargs) # noqa: E501
|
3358
|
+
|
3359
|
+
@validate_arguments
|
3360
|
+
def update_shared_workspace_with_http_info(self, workspace_name : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The shared workspace name.")], workspace_update_request : Annotated[Optional[WorkspaceUpdateRequest], Field(description="The new workspace details.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3361
|
+
"""[EXPERIMENTAL] UpdateSharedWorkspace: Update a shared workspace. # noqa: E501
|
3362
|
+
|
3363
|
+
Update a shared workspace. # noqa: E501
|
3364
|
+
This method makes a synchronous HTTP request by default. To make an
|
3365
|
+
asynchronous HTTP request, please pass async_req=True
|
3366
|
+
|
3367
|
+
>>> thread = api.update_shared_workspace_with_http_info(workspace_name, workspace_update_request, async_req=True)
|
3368
|
+
>>> result = thread.get()
|
3369
|
+
|
3370
|
+
:param workspace_name: The shared workspace name. (required)
|
3371
|
+
:type workspace_name: str
|
3372
|
+
:param workspace_update_request: The new workspace details.
|
3373
|
+
:type workspace_update_request: WorkspaceUpdateRequest
|
3374
|
+
:param async_req: Whether to execute the request asynchronously.
|
3375
|
+
:type async_req: bool, optional
|
3376
|
+
:param _preload_content: if False, the ApiResponse.data will
|
3377
|
+
be set to none and raw_data will store the
|
3378
|
+
HTTP response body without reading/decoding.
|
3379
|
+
Default is True.
|
3380
|
+
:type _preload_content: bool, optional
|
3381
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
3382
|
+
object with status code, headers, etc
|
3383
|
+
:type _return_http_data_only: bool, optional
|
3384
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
3385
|
+
:param opts: Configuration options for this request
|
3386
|
+
:type opts: ConfigurationOptions, optional
|
3387
|
+
:param _request_auth: set to override the auth_settings for an a single
|
3388
|
+
request; this effectively ignores the authentication
|
3389
|
+
in the spec for a single request.
|
3390
|
+
:type _request_auth: dict, optional
|
3391
|
+
:type _content_type: string, optional: force content-type for the request
|
3392
|
+
:return: Returns the result object.
|
3393
|
+
If the method is called asynchronously,
|
3394
|
+
returns the request thread.
|
3395
|
+
:rtype: tuple(Workspace, status_code(int), headers(HTTPHeaderDict))
|
3396
|
+
"""
|
3397
|
+
|
3398
|
+
_params = locals()
|
3399
|
+
|
3400
|
+
_all_params = [
|
3401
|
+
'workspace_name',
|
3402
|
+
'workspace_update_request'
|
3403
|
+
]
|
3404
|
+
_all_params.extend(
|
3405
|
+
[
|
3406
|
+
'async_req',
|
3407
|
+
'_return_http_data_only',
|
3408
|
+
'_preload_content',
|
3409
|
+
'_request_timeout',
|
3410
|
+
'_request_auth',
|
3411
|
+
'_content_type',
|
3412
|
+
'_headers',
|
3413
|
+
'opts'
|
3414
|
+
]
|
3415
|
+
)
|
3416
|
+
|
3417
|
+
# validate the arguments
|
3418
|
+
for _key, _val in _params['kwargs'].items():
|
3419
|
+
if _key not in _all_params:
|
3420
|
+
raise ApiTypeError(
|
3421
|
+
"Got an unexpected keyword argument '%s'"
|
3422
|
+
" to method update_shared_workspace" % _key
|
3423
|
+
)
|
3424
|
+
_params[_key] = _val
|
3425
|
+
del _params['kwargs']
|
3426
|
+
|
3427
|
+
_collection_formats = {}
|
3428
|
+
|
3429
|
+
# process the path parameters
|
3430
|
+
_path_params = {}
|
3431
|
+
if _params['workspace_name']:
|
3432
|
+
_path_params['workspaceName'] = _params['workspace_name']
|
3433
|
+
|
3434
|
+
|
3435
|
+
# process the query parameters
|
3436
|
+
_query_params = []
|
3437
|
+
# process the header parameters
|
3438
|
+
_header_params = dict(_params.get('_headers', {}))
|
3439
|
+
# process the form parameters
|
3440
|
+
_form_params = []
|
3441
|
+
_files = {}
|
3442
|
+
# process the body parameter
|
3443
|
+
_body_params = None
|
3444
|
+
if _params['workspace_update_request'] is not None:
|
3445
|
+
_body_params = _params['workspace_update_request']
|
3446
|
+
|
3447
|
+
# set the HTTP header `Accept`
|
3448
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
3449
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
3450
|
+
|
3451
|
+
# set the HTTP header `Content-Type`
|
3452
|
+
_content_types_list = _params.get('_content_type',
|
3453
|
+
self.api_client.select_header_content_type(
|
3454
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
3455
|
+
if _content_types_list:
|
3456
|
+
_header_params['Content-Type'] = _content_types_list
|
3457
|
+
|
3458
|
+
# authentication setting
|
3459
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
3460
|
+
|
3461
|
+
_response_types_map = {
|
3462
|
+
'200': "Workspace",
|
3463
|
+
'400': "LusidValidationProblemDetails",
|
3464
|
+
}
|
3465
|
+
|
3466
|
+
return self.api_client.call_api(
|
3467
|
+
'/api/workspaces/shared/{workspaceName}', 'PUT',
|
3468
|
+
_path_params,
|
3469
|
+
_query_params,
|
3470
|
+
_header_params,
|
3471
|
+
body=_body_params,
|
3472
|
+
post_params=_form_params,
|
3473
|
+
files=_files,
|
3474
|
+
response_types_map=_response_types_map,
|
3475
|
+
auth_settings=_auth_settings,
|
3476
|
+
async_req=_params.get('async_req'),
|
3477
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
3478
|
+
_preload_content=_params.get('_preload_content', True),
|
3479
|
+
_request_timeout=_params.get('_request_timeout'),
|
3480
|
+
opts=_params.get('opts'),
|
3481
|
+
collection_formats=_collection_formats,
|
3482
|
+
_request_auth=_params.get('_request_auth'))
|