lusid-sdk 1.1.118__py3-none-any.whl → 2.0.50b0__py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- lusid/__init__.py +247 -180
- lusid/api/__init__.py +14 -2
- lusid/api/abor_api.py +1963 -0
- lusid/api/abor_configuration_api.py +943 -0
- lusid/api/address_key_definition_api.py +296 -269
- lusid/api/aggregation_api.py +469 -260
- lusid/api/allocations_api.py +419 -404
- lusid/api/application_metadata_api.py +266 -244
- lusid/api/blocks_api.py +409 -402
- lusid/api/calendars_api.py +1185 -1262
- lusid/api/chart_of_accounts_api.py +4087 -0
- lusid/api/complex_market_data_api.py +469 -308
- lusid/api/compliance_api.py +1081 -1169
- lusid/api/configuration_recipe_api.py +381 -375
- lusid/api/conventions_api.py +1982 -0
- lusid/api/corporate_action_sources_api.py +961 -885
- lusid/api/counterparties_api.py +729 -711
- lusid/api/custom_entities_api.py +1186 -1465
- lusid/api/custom_entity_definitions_api.py +387 -364
- lusid/api/custom_entity_types_api.py +393 -369
- lusid/api/cut_label_definitions_api.py +492 -453
- lusid/api/data_types_api.py +726 -734
- lusid/api/derived_transaction_portfolios_api.py +204 -213
- lusid/api/entities_api.py +113 -113
- lusid/api/executions_api.py +409 -402
- lusid/api/instrument_events_api.py +734 -0
- lusid/api/instruments_api.py +2407 -1721
- lusid/api/legacy_compliance_api.py +1449 -0
- lusid/api/legal_entities_api.py +1982 -2102
- lusid/api/order_graph_api.py +357 -364
- lusid/api/order_instructions_api.py +745 -0
- lusid/api/order_management_api.py +240 -342
- lusid/api/orders_api.py +423 -408
- lusid/api/packages_api.py +745 -0
- lusid/api/participations_api.py +407 -400
- lusid/api/persons_api.py +1791 -1945
- lusid/api/placements_api.py +411 -404
- lusid/api/portfolio_groups_api.py +2810 -2975
- lusid/api/portfolios_api.py +3022 -2898
- lusid/api/property_definitions_api.py +981 -1267
- lusid/api/quotes_api.py +1314 -517
- lusid/api/reconciliations_api.py +3548 -855
- lusid/api/reference_lists_api.py +388 -388
- lusid/api/reference_portfolio_api.py +409 -432
- lusid/api/relation_definitions_api.py +538 -0
- lusid/api/relations_api.py +414 -0
- lusid/api/relationship_definitions_api.py +484 -494
- lusid/api/relationships_api.py +204 -222
- lusid/api/schemas_api.py +374 -322
- lusid/api/scopes_api.py +100 -241
- lusid/api/scripted_translation_api.py +784 -795
- lusid/api/search_api.py +408 -423
- lusid/api/sequences_api.py +376 -404
- lusid/api/structured_result_data_api.py +1472 -325
- lusid/api/system_configuration_api.py +979 -143
- lusid/api/tax_rule_sets_api.py +900 -0
- lusid/api/transaction_configuration_api.py +1066 -1104
- lusid/api/transaction_fees_api.py +935 -0
- lusid/api/transaction_portfolios_api.py +5285 -3517
- lusid/api/translation_api.py +364 -0
- lusid/api_client.py +195 -124
- lusid/api_response.py +25 -0
- lusid/configuration.py +58 -81
- lusid/exceptions.py +17 -15
- lusid/extensions/__init__.py +15 -0
- lusid/extensions/api_client.py +764 -0
- lusid/extensions/api_client_builder.py +138 -0
- lusid/extensions/api_client_factory.py +137 -0
- lusid/{utilities → extensions}/api_configuration.py +4 -5
- lusid/extensions/configuration_loaders.py +203 -0
- lusid/{utilities → extensions}/proxy_config.py +21 -6
- lusid/{utilities → extensions}/refreshing_token.py +82 -35
- lusid/extensions/rest.py +300 -0
- lusid/extensions/retry.py +357 -0
- lusid/extensions/socket_keep_alive.py +53 -0
- lusid/extensions/tcp_keep_alive_connector.py +66 -0
- lusid/models/__init__.py +232 -172
- lusid/models/a2_b_breakdown.py +65 -187
- lusid/models/a2_b_category.py +60 -154
- lusid/models/a2_b_data_record.py +178 -540
- lusid/models/a2_b_movement_record.py +192 -635
- lusid/models/abor.py +150 -0
- lusid/models/abor_configuration.py +159 -0
- lusid/models/abor_configuration_properties.py +115 -0
- lusid/models/abor_configuration_request.py +145 -0
- lusid/models/abor_properties.py +115 -0
- lusid/models/abor_request.py +131 -0
- lusid/models/access_controlled_action.py +87 -221
- lusid/models/access_controlled_resource.py +105 -283
- lusid/models/access_metadata_operation.py +84 -234
- lusid/models/access_metadata_value.py +58 -166
- lusid/models/account.py +126 -0
- lusid/models/account_properties.py +115 -0
- lusid/models/accounting_method.py +42 -0
- lusid/models/accounts_upsert_response.py +110 -0
- lusid/models/action_id.py +55 -204
- lusid/models/action_result_of_portfolio.py +57 -154
- lusid/models/add_business_days_to_date_request.py +63 -214
- lusid/models/add_business_days_to_date_response.py +52 -127
- lusid/models/additional_payment.py +58 -228
- lusid/models/address_definition.py +97 -284
- lusid/models/address_key_compliance_parameter.py +80 -166
- lusid/models/address_key_definition.py +74 -222
- lusid/models/address_key_filter.py +69 -191
- lusid/models/address_key_list.py +73 -170
- lusid/models/address_key_list_compliance_parameter.py +77 -164
- lusid/models/address_key_option_definition.py +69 -293
- lusid/models/adjust_holding.py +101 -216
- lusid/models/adjust_holding_for_date_request.py +109 -285
- lusid/models/adjust_holding_request.py +107 -250
- lusid/models/aggregate_spec.py +67 -196
- lusid/models/aggregated_return.py +106 -373
- lusid/models/aggregated_returns_dispersion_request.py +102 -291
- lusid/models/aggregated_returns_request.py +128 -403
- lusid/models/aggregated_returns_response.py +95 -186
- lusid/models/aggregated_transactions_request.py +131 -0
- lusid/models/aggregation_context.py +55 -125
- lusid/models/aggregation_measure_failure_detail.py +80 -238
- lusid/models/aggregation_op.py +49 -0
- lusid/models/aggregation_options.py +55 -189
- lusid/models/aggregation_query.py +106 -439
- lusid/models/aggregation_type.py +44 -0
- lusid/models/allocation.py +207 -737
- lusid/models/allocation_request.py +175 -611
- lusid/models/allocation_service_run_response.py +102 -0
- lusid/models/allocation_set_request.py +64 -126
- lusid/models/amortisation_event.py +82 -266
- lusid/models/annul_quotes_response.py +99 -217
- lusid/models/annul_single_structured_data_response.py +74 -188
- lusid/models/annul_structured_data_response.py +99 -217
- lusid/models/asset_class.py +44 -0
- lusid/models/barrier.py +62 -228
- lusid/models/basket.py +85 -229
- lusid/models/basket_identifier.py +57 -224
- lusid/models/batch_adjust_holdings_response.py +128 -216
- lusid/models/batch_upsert_instrument_properties_response.py +101 -223
- lusid/models/batch_upsert_portfolio_transactions_response.py +128 -216
- lusid/models/batch_upsert_property_definition_properties_response.py +97 -223
- lusid/models/block.py +133 -544
- lusid/models/block_request.py +108 -448
- lusid/models/block_set_request.py +64 -126
- lusid/models/bond.py +144 -564
- lusid/models/bond_default_event.py +84 -167
- lusid/models/book_transactions_response.py +107 -0
- lusid/models/bool_compliance_parameter.py +73 -164
- lusid/models/bool_list_compliance_parameter.py +77 -164
- lusid/models/bucketed_cash_flow_request.py +172 -0
- lusid/models/bucketed_cash_flow_response.py +129 -0
- lusid/models/bucketing_schedule.py +74 -0
- lusid/models/calculation_info.py +73 -0
- lusid/models/calendar.py +88 -309
- lusid/models/calendar_date.py +84 -407
- lusid/models/calendar_dependency.py +73 -166
- lusid/models/cap_floor.py +85 -295
- lusid/models/cash_dependency.py +76 -199
- lusid/models/cash_dividend_event.py +78 -291
- lusid/models/cash_flow_event.py +82 -199
- lusid/models/cash_flow_lineage.py +91 -276
- lusid/models/cash_flow_value.py +90 -289
- lusid/models/cash_flow_value_set.py +86 -164
- lusid/models/cash_ladder_record.py +58 -216
- lusid/models/cash_perpetual.py +78 -231
- lusid/models/cds_flow_conventions.py +113 -514
- lusid/models/cds_index.py +100 -382
- lusid/models/cds_protection_detail_specification.py +57 -230
- lusid/models/change.py +110 -357
- lusid/models/change_history.py +90 -299
- lusid/models/change_history_action.py +39 -0
- lusid/models/change_item.py +80 -252
- lusid/models/chart_of_accounts.py +135 -0
- lusid/models/chart_of_accounts_properties.py +115 -0
- lusid/models/chart_of_accounts_request.py +120 -0
- lusid/models/client.py +75 -0
- lusid/models/close_event.py +76 -197
- lusid/models/complete_portfolio.py +142 -495
- lusid/models/complete_relation.py +96 -0
- lusid/models/complete_relationship.py +88 -378
- lusid/models/complex_bond.py +129 -320
- lusid/models/complex_market_data.py +81 -151
- lusid/models/complex_market_data_id.py +74 -274
- lusid/models/compliance_breached_order_info.py +83 -0
- lusid/models/compliance_parameter.py +83 -155
- lusid/models/compliance_parameter_type.py +53 -0
- lusid/models/compliance_rule.py +137 -0
- lusid/models/compliance_rule_breakdown.py +76 -257
- lusid/models/compliance_rule_breakdown_request.py +76 -252
- lusid/models/compliance_rule_response.py +149 -411
- lusid/models/compliance_rule_result.py +91 -0
- lusid/models/compliance_rule_result_detail.py +91 -414
- lusid/models/compliance_rule_result_portfolio_detail.py +57 -159
- lusid/models/compliance_rule_upsert_request.py +178 -0
- lusid/models/compliance_rule_upsert_response.py +82 -0
- lusid/models/compliance_run_info.py +81 -0
- lusid/models/compliance_run_info_v2.py +64 -253
- lusid/models/compliance_run_summary.py +72 -250
- lusid/models/compliance_summary_rule_result.py +97 -342
- lusid/models/compliance_summary_rule_result_request.py +97 -348
- lusid/models/compliance_template.py +89 -253
- lusid/models/compliance_template_parameter.py +55 -201
- lusid/models/compliance_template_variation.py +84 -292
- lusid/models/composite_breakdown.py +72 -188
- lusid/models/composite_breakdown_request.py +97 -281
- lusid/models/composite_breakdown_response.py +90 -188
- lusid/models/composite_dispersion.py +91 -339
- lusid/models/composite_dispersion_response.py +95 -186
- lusid/models/compounding.py +76 -299
- lusid/models/configuration_recipe.py +123 -362
- lusid/models/configuration_recipe_snippet.py +121 -354
- lusid/models/constituents_adjustment_header.py +73 -187
- lusid/models/contract_for_difference.py +90 -430
- lusid/models/corporate_action.py +82 -313
- lusid/models/corporate_action_source.py +104 -304
- lusid/models/corporate_action_transition.py +69 -155
- lusid/models/corporate_action_transition_component.py +59 -262
- lusid/models/corporate_action_transition_component_request.py +55 -192
- lusid/models/corporate_action_transition_request.py +69 -153
- lusid/models/counterparty_agreement.py +73 -292
- lusid/models/counterparty_risk_information.py +78 -197
- lusid/models/counterparty_signatory.py +57 -161
- lusid/models/create_address_key_definition_request.py +53 -163
- lusid/models/create_calendar_request.py +94 -262
- lusid/models/create_corporate_action_source_request.py +100 -291
- lusid/models/create_custom_entity_type_request.py +79 -242
- lusid/models/create_cut_label_definition_request.py +85 -256
- lusid/models/create_data_map_request.py +79 -0
- lusid/models/create_data_type_request.py +143 -462
- lusid/models/create_date_request.py +111 -368
- lusid/models/create_derived_property_definition_request.py +79 -331
- lusid/models/create_derived_transaction_portfolio_request.py +153 -506
- lusid/models/create_portfolio_details.py +55 -125
- lusid/models/create_portfolio_group_request.py +117 -314
- lusid/models/create_property_definition_request.py +98 -424
- lusid/models/create_recipe_request.py +90 -0
- lusid/models/create_reconciliation_request.py +140 -0
- lusid/models/create_reference_portfolio_request.py +102 -317
- lusid/models/create_relation_definition_request.py +95 -0
- lusid/models/create_relation_request.py +71 -0
- lusid/models/create_relationship_definition_request.py +112 -437
- lusid/models/create_relationship_request.py +87 -238
- lusid/models/create_sequence_request.py +105 -327
- lusid/models/create_tax_rule_set_request.py +103 -0
- lusid/models/create_transaction_portfolio_request.py +145 -545
- lusid/models/create_unit_definition.py +83 -241
- lusid/models/credit_default_swap.py +105 -384
- lusid/models/credit_rating.py +67 -178
- lusid/models/credit_spread_curve_data.py +109 -420
- lusid/models/credit_support_annex.py +73 -432
- lusid/models/criterion_type.py +39 -0
- lusid/models/currency_and_amount.py +58 -153
- lusid/models/curve_options.py +110 -0
- lusid/models/custodian_account.py +93 -396
- lusid/models/custodian_account_properties.py +115 -0
- lusid/models/custodian_account_request.py +148 -0
- lusid/models/custodian_accounts_upsert_response.py +110 -0
- lusid/models/custom_entity_definition.py +79 -323
- lusid/models/custom_entity_definition_request.py +79 -242
- lusid/models/custom_entity_field.py +73 -222
- lusid/models/custom_entity_field_definition.py +71 -296
- lusid/models/custom_entity_id.py +91 -280
- lusid/models/custom_entity_request.py +78 -228
- lusid/models/custom_entity_response.py +118 -382
- lusid/models/custom_entity_type.py +79 -323
- lusid/models/cut_label_definition.py +105 -324
- lusid/models/cut_local_time.py +53 -154
- lusid/models/data_definition.py +104 -0
- lusid/models/data_map_key.py +101 -0
- lusid/models/data_mapping.py +82 -0
- lusid/models/data_scope.py +80 -0
- lusid/models/data_type.py +139 -477
- lusid/models/data_type_summary.py +111 -398
- lusid/models/data_type_value_range.py +38 -0
- lusid/models/date_attributes.py +140 -371
- lusid/models/date_or_diary_entry.py +91 -0
- lusid/models/date_range.py +59 -155
- lusid/models/date_time_comparison_type.py +38 -0
- lusid/models/date_time_compliance_parameter.py +74 -165
- lusid/models/date_time_list_compliance_parameter.py +77 -164
- lusid/models/day_of_week.py +20 -102
- lusid/models/decimal_compliance_parameter.py +73 -164
- lusid/models/decimal_list.py +73 -170
- lusid/models/decimal_list_compliance_parameter.py +77 -164
- lusid/models/decorated_compliance_run_summary.py +65 -156
- lusid/models/delete_accounts_response.py +95 -0
- lusid/models/delete_custodian_accounts_response.py +103 -0
- lusid/models/delete_instrument_properties_response.py +67 -159
- lusid/models/delete_instrument_response.py +74 -189
- lusid/models/delete_instruments_response.py +74 -189
- lusid/models/delete_modes.py +38 -0
- lusid/models/delete_relation_request.py +71 -0
- lusid/models/delete_relationship_request.py +87 -238
- lusid/models/deleted_entity_response.py +81 -219
- lusid/models/dependency_source_filter.py +70 -198
- lusid/models/described_address_key.py +81 -0
- lusid/models/dialect.py +61 -185
- lusid/models/dialect_id.py +89 -330
- lusid/models/dialect_schema.py +58 -167
- lusid/models/diary_entry.py +155 -0
- lusid/models/diary_entry_request.py +120 -0
- lusid/models/discount_factor_curve_data.py +91 -296
- lusid/models/discounting_dependency.py +76 -199
- lusid/models/discounting_method.py +39 -0
- lusid/models/economic_dependency.py +82 -150
- lusid/models/economic_dependency_type.py +50 -0
- lusid/models/economic_dependency_with_complex_market_data.py +61 -156
- lusid/models/economic_dependency_with_quote.py +68 -186
- lusid/models/empty_model_options.py +71 -134
- lusid/models/entity_identifier.py +60 -190
- lusid/models/equity.py +84 -225
- lusid/models/equity_all_of_identifiers.py +83 -415
- lusid/models/equity_curve_by_prices_data.py +91 -296
- lusid/models/equity_curve_dependency.py +80 -281
- lusid/models/equity_model_options.py +73 -169
- lusid/models/equity_option.py +117 -554
- lusid/models/equity_swap.py +107 -487
- lusid/models/equity_vol_dependency.py +80 -275
- lusid/models/equity_vol_surface_data.py +101 -267
- lusid/models/error_detail.py +77 -216
- lusid/models/event_date_range.py +54 -155
- lusid/models/ex_dividend_configuration.py +57 -221
- lusid/models/exchange_traded_option.py +84 -261
- lusid/models/exchange_traded_option_contract_details.py +80 -535
- lusid/models/execution.py +144 -673
- lusid/models/execution_request.py +119 -577
- lusid/models/execution_set_request.py +64 -126
- lusid/models/exercise_event.py +85 -228
- lusid/models/exotic_instrument.py +79 -199
- lusid/models/expanded_group.py +121 -340
- lusid/models/fee_rule.py +138 -0
- lusid/models/fee_rule_upsert_request.py +142 -0
- lusid/models/fee_rule_upsert_response.py +97 -0
- lusid/models/field_definition.py +62 -195
- lusid/models/field_schema.py +83 -247
- lusid/models/field_value.py +60 -165
- lusid/models/file_response.py +69 -181
- lusid/models/fixed_leg.py +95 -287
- lusid/models/fixed_leg_all_of_overrides.py +65 -154
- lusid/models/fixed_schedule.py +136 -0
- lusid/models/float_schedule.py +147 -0
- lusid/models/floating_leg.py +109 -349
- lusid/models/flow_convention_name.py +60 -193
- lusid/models/flow_conventions.py +120 -542
- lusid/models/forward_rate_agreement.py +90 -356
- lusid/models/funding_leg.py +89 -259
- lusid/models/funding_leg_options.py +91 -0
- lusid/models/future.py +100 -388
- lusid/models/futures_contract_details.py +112 -537
- lusid/models/fx_dependency.py +78 -231
- lusid/models/fx_forward.py +97 -481
- lusid/models/fx_forward_curve_by_quote_reference.py +114 -387
- lusid/models/fx_forward_curve_data.py +95 -360
- lusid/models/fx_forward_model_options.py +91 -242
- lusid/models/fx_forward_pips_curve_data.py +95 -360
- lusid/models/fx_forward_tenor_curve_data.py +117 -420
- lusid/models/fx_forward_tenor_pips_curve_data.py +117 -420
- lusid/models/fx_forwards_dependency.py +80 -269
- lusid/models/fx_option.py +159 -629
- lusid/models/fx_rate_schedule.py +111 -0
- lusid/models/fx_swap.py +89 -224
- lusid/models/fx_tenor_convention.py +53 -166
- lusid/models/fx_vol_dependency.py +80 -269
- lusid/models/fx_vol_surface_data.py +101 -267
- lusid/models/general_ledger_profile_mapping.py +78 -0
- lusid/models/general_ledger_profile_request.py +112 -0
- lusid/models/general_ledger_profile_response.py +146 -0
- lusid/models/get_cds_flow_conventions_response.py +115 -0
- lusid/models/get_complex_market_data_response.py +111 -216
- lusid/models/get_counterparty_agreement_response.py +97 -215
- lusid/models/get_credit_support_annex_response.py +97 -215
- lusid/models/get_data_map_response.py +129 -0
- lusid/models/get_flow_conventions_response.py +115 -0
- lusid/models/get_index_convention_response.py +115 -0
- lusid/models/get_instruments_response.py +111 -216
- lusid/models/get_quotes_response.py +130 -246
- lusid/models/get_recipe_response.py +77 -185
- lusid/models/get_reference_portfolio_constituents_response.py +117 -321
- lusid/models/get_structured_result_data_response.py +129 -0
- lusid/models/get_virtual_document_response.py +129 -0
- lusid/models/grouped_result_of_address_key.py +89 -0
- lusid/models/holding_adjustment.py +121 -313
- lusid/models/holding_adjustment_with_date.py +124 -345
- lusid/models/holding_context.py +51 -127
- lusid/models/holding_contributor.py +55 -126
- lusid/models/holdings_adjustment.py +92 -259
- lusid/models/holdings_adjustment_header.py +82 -227
- lusid/models/i_unit_definition_dto.py +85 -217
- lusid/models/id_selector_definition.py +75 -227
- lusid/models/identifier_part_schema.py +74 -295
- lusid/models/index_convention.py +100 -388
- lusid/models/index_model_options.py +80 -172
- lusid/models/index_projection_dependency.py +80 -275
- lusid/models/industry_classifier.py +60 -172
- lusid/models/inflation_fixing_dependency.py +78 -237
- lusid/models/inflation_index_conventions.py +71 -307
- lusid/models/inflation_leg.py +120 -455
- lusid/models/inflation_linked_bond.py +153 -595
- lusid/models/inflation_swap.py +88 -259
- lusid/models/informational_error_event.py +78 -237
- lusid/models/informational_event.py +88 -262
- lusid/models/inline_valuation_request.py +150 -497
- lusid/models/inline_valuations_reconciliation_request.py +82 -216
- lusid/models/input_transition.py +53 -160
- lusid/models/instrument.py +160 -541
- lusid/models/instrument_capabilities.py +133 -0
- lusid/models/instrument_cash_flow.py +107 -0
- lusid/models/instrument_definition.py +93 -251
- lusid/models/instrument_definition_format.py +55 -201
- lusid/models/instrument_delete_modes.py +38 -0
- lusid/models/instrument_event.py +81 -157
- lusid/models/instrument_event_holder.py +106 -460
- lusid/models/instrument_event_type.py +50 -0
- lusid/models/instrument_id_type_descriptor.py +55 -195
- lusid/models/instrument_id_value.py +54 -163
- lusid/models/instrument_leg.py +82 -143
- lusid/models/instrument_list.py +73 -170
- lusid/models/instrument_list_compliance_parameter.py +77 -164
- lusid/models/instrument_match.py +78 -156
- lusid/models/instrument_models.py +78 -186
- lusid/models/instrument_payment_diary.py +131 -0
- lusid/models/instrument_payment_diary_leg.py +89 -0
- lusid/models/instrument_payment_diary_row.py +132 -0
- lusid/models/instrument_properties.py +97 -215
- lusid/models/instrument_search_property.py +53 -163
- lusid/models/instrument_type.py +72 -0
- lusid/models/interest_rate_swap.py +110 -322
- lusid/models/interest_rate_swaption.py +90 -296
- lusid/models/ir_vol_cube_data.py +101 -267
- lusid/models/ir_vol_dependency.py +78 -237
- lusid/models/is_business_day_response.py +54 -157
- lusid/models/je_lines_query_parameters.py +105 -0
- lusid/models/journal_entry_line.py +193 -0
- lusid/models/journal_entry_lines_query_parameters.py +109 -0
- lusid/models/label_value_set.py +51 -129
- lusid/models/leg_definition.py +130 -619
- lusid/models/legal_entity.py +158 -394
- lusid/models/level_step.py +54 -161
- lusid/models/life_cycle_event_lineage.py +84 -246
- lusid/models/life_cycle_event_value.py +86 -224
- lusid/models/link.py +62 -222
- lusid/models/list_aggregation_reconciliation.py +73 -211
- lusid/models/list_aggregation_response.py +111 -326
- lusid/models/list_complex_market_data_with_meta_data_response.py +86 -0
- lusid/models/loan_period.py +56 -187
- lusid/models/look_up_pricing_model_options.py +75 -198
- lusid/models/lusid_instrument.py +98 -166
- lusid/models/lusid_problem_details.py +95 -333
- lusid/models/lusid_trade_ticket.py +148 -639
- lusid/models/lusid_unique_id.py +53 -166
- lusid/models/lusid_validation_problem_details.py +106 -362
- lusid/models/mapped_string.py +72 -209
- lusid/models/mapping.py +93 -281
- lusid/models/mapping_rule.py +96 -308
- lusid/models/market_context.py +96 -243
- lusid/models/market_context_suppliers.py +59 -241
- lusid/models/market_data_key_rule.py +114 -462
- lusid/models/market_data_options.py +73 -141
- lusid/models/market_data_options_type.py +37 -0
- lusid/models/market_data_overrides.py +79 -156
- lusid/models/market_data_specific_rule.py +115 -494
- lusid/models/market_data_type.py +49 -0
- lusid/models/market_observable_type.py +41 -0
- lusid/models/market_options.py +108 -318
- lusid/models/market_quote.py +60 -166
- lusid/models/match_criterion.py +95 -0
- lusid/models/metric_value.py +58 -155
- lusid/models/model_options.py +77 -144
- lusid/models/model_options_type.py +44 -0
- lusid/models/model_property.py +72 -218
- lusid/models/model_schema.py +116 -0
- lusid/models/model_selection.py +67 -172
- lusid/models/movement_type.py +54 -0
- lusid/models/next_value_in_sequence_response.py +66 -158
- lusid/models/numeric_comparison_type.py +39 -0
- lusid/models/opaque_dependency.py +71 -134
- lusid/models/opaque_market_data.py +84 -275
- lusid/models/opaque_model_options.py +73 -164
- lusid/models/open_event.py +74 -166
- lusid/models/operand_type.py +38 -0
- lusid/models/operation.py +67 -227
- lusid/models/operation_type.py +37 -0
- lusid/models/operator.py +43 -0
- lusid/models/option_entry.py +71 -0
- lusid/models/optionality_schedule.py +118 -0
- lusid/models/order.py +173 -706
- lusid/models/order_by_spec.py +60 -166
- lusid/models/order_flow_configuration.py +51 -129
- lusid/models/order_graph_block.py +83 -351
- lusid/models/order_graph_block_allocation_detail.py +55 -126
- lusid/models/order_graph_block_allocation_synopsis.py +61 -160
- lusid/models/order_graph_block_execution_detail.py +55 -126
- lusid/models/order_graph_block_execution_synopsis.py +61 -160
- lusid/models/order_graph_block_order_detail.py +69 -314
- lusid/models/order_graph_block_order_synopsis.py +61 -160
- lusid/models/order_graph_block_placement_detail.py +55 -126
- lusid/models/order_graph_block_placement_synopsis.py +61 -160
- lusid/models/order_graph_placement.py +94 -341
- lusid/models/order_graph_placement_allocation_detail.py +55 -126
- lusid/models/order_graph_placement_allocation_synopsis.py +61 -160
- lusid/models/order_graph_placement_child_placement_detail.py +55 -126
- lusid/models/order_graph_placement_execution_detail.py +55 -126
- lusid/models/order_graph_placement_execution_synopsis.py +61 -160
- lusid/models/order_graph_placement_order_detail.py +55 -126
- lusid/models/order_graph_placement_order_synopsis.py +59 -128
- lusid/models/order_graph_placement_placement_synopsis.py +61 -160
- lusid/models/order_instruction.py +157 -0
- lusid/models/order_instruction_request.py +127 -0
- lusid/models/order_instruction_set_request.py +82 -0
- lusid/models/order_request.py +141 -580
- lusid/models/order_set_request.py +64 -126
- lusid/models/otc_confirmation.py +55 -125
- lusid/models/output_transaction.py +189 -815
- lusid/models/output_transition.py +77 -281
- lusid/models/package.py +132 -0
- lusid/models/package_request.py +111 -0
- lusid/models/package_set_request.py +82 -0
- lusid/models/paged_resource_list_of_abor.py +113 -0
- lusid/models/paged_resource_list_of_abor_configuration.py +113 -0
- lusid/models/paged_resource_list_of_account.py +113 -0
- lusid/models/paged_resource_list_of_address_key_definition.py +95 -248
- lusid/models/paged_resource_list_of_allocation.py +95 -248
- lusid/models/paged_resource_list_of_block.py +95 -248
- lusid/models/paged_resource_list_of_calendar.py +95 -248
- lusid/models/paged_resource_list_of_chart_of_accounts.py +113 -0
- lusid/models/paged_resource_list_of_compliance_rule_response.py +95 -248
- lusid/models/paged_resource_list_of_compliance_run_info_v2.py +95 -248
- lusid/models/paged_resource_list_of_compliance_template.py +95 -248
- lusid/models/paged_resource_list_of_corporate_action_source.py +95 -248
- lusid/models/paged_resource_list_of_custodian_account.py +113 -0
- lusid/models/paged_resource_list_of_custom_entity_definition.py +95 -248
- lusid/models/paged_resource_list_of_custom_entity_response.py +95 -248
- lusid/models/paged_resource_list_of_custom_entity_type.py +95 -248
- lusid/models/paged_resource_list_of_cut_label_definition.py +95 -248
- lusid/models/paged_resource_list_of_data_type_summary.py +95 -248
- lusid/models/paged_resource_list_of_dialect_id.py +95 -248
- lusid/models/paged_resource_list_of_diary_entry.py +113 -0
- lusid/models/paged_resource_list_of_execution.py +95 -248
- lusid/models/paged_resource_list_of_general_ledger_profile_response.py +113 -0
- lusid/models/paged_resource_list_of_instrument.py +95 -248
- lusid/models/paged_resource_list_of_instrument_event_holder.py +95 -248
- lusid/models/paged_resource_list_of_legal_entity.py +95 -248
- lusid/models/paged_resource_list_of_order.py +95 -248
- lusid/models/paged_resource_list_of_order_graph_block.py +95 -248
- lusid/models/paged_resource_list_of_order_graph_placement.py +95 -248
- lusid/models/paged_resource_list_of_order_instruction.py +113 -0
- lusid/models/paged_resource_list_of_package.py +113 -0
- lusid/models/paged_resource_list_of_participation.py +95 -248
- lusid/models/paged_resource_list_of_person.py +95 -248
- lusid/models/paged_resource_list_of_placement.py +95 -248
- lusid/models/paged_resource_list_of_portfolio_group.py +95 -248
- lusid/models/paged_resource_list_of_portfolio_group_search_result.py +95 -248
- lusid/models/paged_resource_list_of_portfolio_search_result.py +95 -248
- lusid/models/paged_resource_list_of_posting_module_response.py +113 -0
- lusid/models/paged_resource_list_of_posting_module_rule.py +113 -0
- lusid/models/paged_resource_list_of_property_definition_search_result.py +95 -248
- lusid/models/paged_resource_list_of_reconciliation.py +113 -0
- lusid/models/paged_resource_list_of_reconciliation_run.py +113 -0
- lusid/models/paged_resource_list_of_reconciliation_run_break.py +113 -0
- lusid/models/paged_resource_list_of_reference_list_response.py +95 -248
- lusid/models/paged_resource_list_of_relationship_definition.py +95 -248
- lusid/models/paged_resource_list_of_sequence_definition.py +95 -248
- lusid/models/paged_resource_list_of_translation_script_id.py +95 -248
- lusid/models/paged_resource_list_of_virtual_row.py +95 -248
- lusid/models/participation.py +86 -245
- lusid/models/participation_request.py +71 -186
- lusid/models/participation_set_request.py +64 -126
- lusid/models/performance_return.py +75 -251
- lusid/models/performance_returns_metric.py +83 -309
- lusid/models/period_type.py +41 -0
- lusid/models/perpetual_entity_state.py +39 -0
- lusid/models/perpetual_property.py +57 -157
- lusid/models/person.py +137 -335
- lusid/models/placement.py +161 -698
- lusid/models/placement_request.py +136 -614
- lusid/models/placement_set_request.py +64 -126
- lusid/models/portfolio.py +187 -688
- lusid/models/portfolio_cash_flow.py +139 -593
- lusid/models/portfolio_cash_ladder.py +116 -250
- lusid/models/portfolio_details.py +130 -491
- lusid/models/portfolio_entity_id.py +90 -210
- lusid/models/portfolio_group.py +138 -402
- lusid/models/portfolio_group_id_compliance_parameter.py +77 -164
- lusid/models/portfolio_group_id_list.py +81 -167
- lusid/models/portfolio_group_id_list_compliance_parameter.py +77 -164
- lusid/models/portfolio_group_properties.py +97 -215
- lusid/models/portfolio_group_search_result.py +123 -372
- lusid/models/portfolio_holding.py +142 -644
- lusid/models/portfolio_id_compliance_parameter.py +77 -164
- lusid/models/portfolio_id_list.py +81 -167
- lusid/models/portfolio_id_list_compliance_parameter.py +77 -164
- lusid/models/portfolio_properties.py +97 -215
- lusid/models/portfolio_reconciliation_request.py +65 -192
- lusid/models/portfolio_result_data_key_rule.py +133 -392
- lusid/models/portfolio_return_breakdown.py +109 -492
- lusid/models/portfolio_search_result.py +128 -442
- lusid/models/portfolio_trade_ticket.py +79 -0
- lusid/models/portfolio_type.py +39 -0
- lusid/models/portfolios_reconciliation_request.py +62 -188
- lusid/models/posting_module_details.py +95 -0
- lusid/models/posting_module_request.py +117 -0
- lusid/models/posting_module_response.py +139 -0
- lusid/models/posting_module_rule.py +94 -0
- lusid/models/posting_module_rules_updated_response.py +110 -0
- lusid/models/premium.py +56 -193
- lusid/models/pricing_context.py +105 -215
- lusid/models/pricing_model.py +54 -0
- lusid/models/pricing_options.py +80 -434
- lusid/models/processed_command.py +67 -224
- lusid/models/property_definition.py +221 -736
- lusid/models/property_definition_search_result.py +202 -648
- lusid/models/property_definition_type.py +38 -0
- lusid/models/property_domain.py +73 -0
- lusid/models/property_filter.py +87 -228
- lusid/models/property_interval.py +68 -221
- lusid/models/property_key_compliance_parameter.py +73 -166
- lusid/models/property_key_list_compliance_parameter.py +77 -164
- lusid/models/property_life_time.py +38 -0
- lusid/models/property_schema.py +91 -182
- lusid/models/property_type.py +39 -0
- lusid/models/property_value.py +68 -184
- lusid/models/property_value_equals.py +93 -0
- lusid/models/property_value_in.py +93 -0
- lusid/models/query_bucketed_cash_flows_request.py +162 -0
- lusid/models/query_cash_flows_request.py +96 -0
- lusid/models/query_instrument_events_request.py +113 -0
- lusid/models/query_trade_tickets_request.py +96 -0
- lusid/models/quote.py +87 -313
- lusid/models/quote_access_metadata_rule.py +92 -0
- lusid/models/quote_access_metadata_rule_id.py +129 -0
- lusid/models/quote_dependency.py +78 -240
- lusid/models/quote_id.py +57 -161
- lusid/models/quote_instrument_id_type.py +45 -0
- lusid/models/quote_series_id.py +96 -303
- lusid/models/quote_type.py +50 -0
- lusid/models/raw_vendor_event.py +84 -232
- lusid/models/realised_gain_loss.py +115 -462
- lusid/models/reconcile_date_time_rule.py +88 -233
- lusid/models/reconcile_numeric_rule.py +88 -233
- lusid/models/reconcile_string_rule.py +102 -232
- lusid/models/reconciled_transaction.py +69 -215
- lusid/models/reconciliation.py +165 -0
- lusid/models/reconciliation_break.py +105 -411
- lusid/models/reconciliation_break_id.py +88 -0
- lusid/models/reconciliation_configuration.py +84 -0
- lusid/models/reconciliation_id.py +80 -0
- lusid/models/reconciliation_left_right_address_key_pair.py +53 -160
- lusid/models/reconciliation_line.py +77 -216
- lusid/models/reconciliation_request.py +97 -246
- lusid/models/reconciliation_response.py +70 -155
- lusid/models/reconciliation_rule.py +74 -143
- lusid/models/reconciliation_rule_type.py +40 -0
- lusid/models/reconciliation_run.py +95 -0
- lusid/models/reconciliation_run_break.py +116 -0
- lusid/models/reconciliation_run_id.py +85 -0
- lusid/models/reconciliation_side_configuration.py +94 -0
- lusid/models/reconciliation_transactions.py +79 -0
- lusid/models/reference_data.py +69 -156
- lusid/models/reference_instrument.py +77 -239
- lusid/models/reference_list.py +77 -146
- lusid/models/reference_list_request.py +77 -251
- lusid/models/reference_list_response.py +98 -311
- lusid/models/reference_list_type.py +42 -0
- lusid/models/reference_portfolio_constituent.py +96 -307
- lusid/models/reference_portfolio_constituent_request.py +80 -214
- lusid/models/reference_portfolio_weight_type.py +39 -0
- lusid/models/related_entity.py +105 -349
- lusid/models/relation.py +70 -281
- lusid/models/relation_definition.py +143 -0
- lusid/models/relationship.py +76 -318
- lusid/models/relationship_definition.py +111 -448
- lusid/models/repo.py +136 -476
- lusid/models/reset_event.py +92 -262
- lusid/models/resource_id.py +53 -172
- lusid/models/resource_list_of_access_controlled_resource.py +95 -248
- lusid/models/resource_list_of_access_metadata_value_of.py +100 -248
- lusid/models/resource_list_of_address_key_definition.py +95 -248
- lusid/models/resource_list_of_aggregated_return.py +113 -0
- lusid/models/resource_list_of_aggregation_query.py +95 -248
- lusid/models/resource_list_of_allocation.py +95 -248
- lusid/models/resource_list_of_block.py +95 -248
- lusid/models/resource_list_of_calendar_date.py +95 -248
- lusid/models/resource_list_of_change.py +95 -248
- lusid/models/resource_list_of_change_history.py +95 -248
- lusid/models/resource_list_of_compliance_breached_order_info.py +113 -0
- lusid/models/resource_list_of_compliance_rule.py +113 -0
- lusid/models/resource_list_of_compliance_rule_result.py +113 -0
- lusid/models/resource_list_of_compliance_run_info.py +113 -0
- lusid/models/resource_list_of_constituents_adjustment_header.py +95 -248
- lusid/models/resource_list_of_corporate_action.py +95 -248
- lusid/models/resource_list_of_data_type.py +95 -248
- lusid/models/resource_list_of_execution.py +95 -248
- lusid/models/resource_list_of_fee_rule.py +113 -0
- lusid/models/resource_list_of_get_cds_flow_conventions_response.py +113 -0
- lusid/models/resource_list_of_get_counterparty_agreement_response.py +95 -248
- lusid/models/resource_list_of_get_credit_support_annex_response.py +95 -248
- lusid/models/resource_list_of_get_flow_conventions_response.py +113 -0
- lusid/models/resource_list_of_get_index_convention_response.py +113 -0
- lusid/models/resource_list_of_get_recipe_response.py +95 -248
- lusid/models/resource_list_of_holdings_adjustment_header.py +95 -248
- lusid/models/resource_list_of_i_unit_definition_dto.py +95 -248
- lusid/models/resource_list_of_instrument_cash_flow.py +113 -0
- lusid/models/resource_list_of_instrument_event_holder.py +113 -0
- lusid/models/resource_list_of_instrument_id_type_descriptor.py +95 -248
- lusid/models/resource_list_of_legal_entity.py +95 -248
- lusid/models/resource_list_of_list_complex_market_data_with_meta_data_response.py +113 -0
- lusid/models/resource_list_of_mapping.py +95 -248
- lusid/models/resource_list_of_order.py +95 -248
- lusid/models/resource_list_of_order_instruction.py +113 -0
- lusid/models/resource_list_of_package.py +113 -0
- lusid/models/resource_list_of_participation.py +95 -248
- lusid/models/resource_list_of_performance_return.py +95 -248
- lusid/models/resource_list_of_person.py +95 -248
- lusid/models/resource_list_of_placement.py +95 -248
- lusid/models/resource_list_of_portfolio.py +95 -248
- lusid/models/resource_list_of_portfolio_cash_flow.py +95 -248
- lusid/models/resource_list_of_portfolio_cash_ladder.py +95 -248
- lusid/models/resource_list_of_portfolio_trade_ticket.py +113 -0
- lusid/models/resource_list_of_processed_command.py +95 -248
- lusid/models/resource_list_of_property.py +95 -248
- lusid/models/resource_list_of_property_definition.py +95 -248
- lusid/models/resource_list_of_property_interval.py +95 -248
- lusid/models/resource_list_of_quote.py +95 -248
- lusid/models/resource_list_of_quote_access_metadata_rule.py +113 -0
- lusid/models/resource_list_of_reconciliation_break.py +95 -248
- lusid/models/resource_list_of_relation.py +95 -248
- lusid/models/resource_list_of_relationship.py +95 -248
- lusid/models/resource_list_of_scope_definition.py +95 -248
- lusid/models/resource_list_of_side_definition.py +95 -248
- lusid/models/resource_list_of_string.py +87 -248
- lusid/models/resource_list_of_tax_rule_set.py +113 -0
- lusid/models/resource_list_of_transaction.py +113 -0
- lusid/models/resource_list_of_transaction_type.py +95 -248
- lusid/models/resource_list_of_value_type.py +88 -248
- lusid/models/response_meta_data.py +77 -216
- lusid/models/result_data_key_rule.py +103 -389
- lusid/models/result_data_schema.py +108 -184
- lusid/models/result_key_rule.py +74 -143
- lusid/models/result_key_rule_type.py +39 -0
- lusid/models/result_value.py +80 -149
- lusid/models/result_value0_d.py +87 -225
- lusid/models/result_value_bool.py +73 -165
- lusid/models/result_value_currency.py +78 -164
- lusid/models/result_value_date_time_offset.py +81 -196
- lusid/models/result_value_decimal.py +80 -195
- lusid/models/result_value_dictionary.py +89 -163
- lusid/models/result_value_int.py +80 -195
- lusid/models/result_value_string.py +78 -164
- lusid/models/result_value_type.py +48 -0
- lusid/models/rounding_configuration.py +55 -125
- lusid/models/rounding_configuration_component.py +51 -131
- lusid/models/rounding_convention.py +67 -218
- lusid/models/scaling_methodology.py +39 -0
- lusid/models/schedule.py +77 -143
- lusid/models/schedule_type.py +43 -0
- lusid/models/scope_definition.py +51 -131
- lusid/models/sequence_definition.py +94 -376
- lusid/models/set_legal_entity_identifiers_request.py +69 -126
- lusid/models/set_legal_entity_properties_request.py +69 -126
- lusid/models/set_person_identifiers_request.py +69 -126
- lusid/models/set_person_properties_request.py +64 -128
- lusid/models/set_transaction_configuration_alias.py +84 -0
- lusid/models/set_transaction_configuration_source_request.py +107 -0
- lusid/models/side_configuration_data.py +76 -336
- lusid/models/side_configuration_data_request.py +79 -0
- lusid/models/side_definition.py +90 -390
- lusid/models/side_definition_request.py +66 -322
- lusid/models/sides_definition_request.py +64 -164
- lusid/models/simple_cash_flow_loan.py +88 -263
- lusid/models/simple_instrument.py +94 -301
- lusid/models/sort_order.py +38 -0
- lusid/models/step_schedule.py +85 -236
- lusid/models/stock_split_event.py +78 -231
- lusid/models/stream.py +70 -328
- lusid/models/string_comparison_type.py +41 -0
- lusid/models/string_compliance_parameter.py +73 -167
- lusid/models/string_list.py +73 -170
- lusid/models/string_list_compliance_parameter.py +77 -164
- lusid/models/structured_result_data.py +91 -0
- lusid/models/structured_result_data_id.py +107 -0
- lusid/models/sub_holding_key_value_equals.py +93 -0
- lusid/models/target_tax_lot.py +86 -278
- lusid/models/target_tax_lot_request.py +86 -278
- lusid/models/tax_rule.py +97 -0
- lusid/models/tax_rule_set.py +124 -0
- lusid/models/term_deposit.py +93 -323
- lusid/models/total_return_swap.py +88 -259
- lusid/models/touch.py +62 -228
- lusid/models/trade_ticket.py +76 -0
- lusid/models/trade_ticket_type.py +38 -0
- lusid/models/transaction.py +181 -782
- lusid/models/transaction_configuration_data.py +89 -190
- lusid/models/transaction_configuration_data_request.py +89 -190
- lusid/models/transaction_configuration_movement_data.py +110 -320
- lusid/models/transaction_configuration_movement_data_request.py +110 -320
- lusid/models/transaction_configuration_type_alias.py +90 -339
- lusid/models/transaction_price.py +63 -162
- lusid/models/transaction_price_type.py +39 -0
- lusid/models/transaction_property_mapping.py +65 -188
- lusid/models/transaction_property_mapping_request.py +65 -188
- lusid/models/transaction_query_mode.py +38 -0
- lusid/models/transaction_query_parameters.py +67 -234
- lusid/models/transaction_reconciliation_request.py +84 -302
- lusid/models/transaction_reconciliation_request_v2.py +115 -0
- lusid/models/transaction_request.py +143 -625
- lusid/models/transaction_roles.py +44 -0
- lusid/models/transaction_set_configuration_data.py +89 -188
- lusid/models/transaction_set_configuration_data_request.py +92 -0
- lusid/models/transaction_status.py +39 -0
- lusid/models/transaction_type.py +119 -250
- lusid/models/transaction_type_alias.py +80 -282
- lusid/models/transaction_type_calculation.py +60 -172
- lusid/models/transaction_type_movement.py +128 -366
- lusid/models/transaction_type_property_mapping.py +75 -197
- lusid/models/transaction_type_request.py +104 -220
- lusid/models/transactions_reconciliations_response.py +70 -155
- lusid/models/transition_event.py +101 -318
- lusid/models/translate_entities_inlined_request.py +72 -195
- lusid/models/translate_entities_request.py +76 -187
- lusid/models/translate_entities_response.py +104 -186
- lusid/models/translate_instrument_definitions_request.py +91 -0
- lusid/models/translate_instrument_definitions_response.py +129 -0
- lusid/models/translate_trade_ticket_request.py +91 -0
- lusid/models/translate_trade_tickets_response.py +129 -0
- lusid/models/translation_input.py +51 -134
- lusid/models/translation_result.py +66 -163
- lusid/models/translation_script.py +57 -193
- lusid/models/translation_script_id.py +76 -219
- lusid/models/trial_balance.py +103 -0
- lusid/models/trial_balance_query_parameters.py +102 -0
- lusid/models/trigger_event.py +82 -301
- lusid/models/typed_resource_id.py +76 -219
- lusid/models/underlying_leg.py +75 -0
- lusid/models/unit_schema.py +39 -0
- lusid/models/unmatched_holding_method.py +38 -0
- lusid/models/update_calendar_request.py +74 -195
- lusid/models/update_custom_entity_definition_request.py +77 -204
- lusid/models/update_custom_entity_type_request.py +77 -204
- lusid/models/update_cut_label_definition_request.py +83 -226
- lusid/models/update_data_type_request.py +105 -234
- lusid/models/update_derived_property_definition_request.py +66 -229
- lusid/models/update_instrument_identifier_request.py +65 -191
- lusid/models/update_portfolio_group_request.py +58 -161
- lusid/models/update_portfolio_request.py +58 -161
- lusid/models/update_property_definition_request.py +58 -164
- lusid/models/update_reconciliation_request.py +131 -0
- lusid/models/update_relationship_definition_request.py +76 -219
- lusid/models/update_tax_rule_set_request.py +95 -0
- lusid/models/update_unit_request.py +100 -207
- lusid/models/upsert_cds_flow_conventions_request.py +73 -0
- lusid/models/upsert_complex_market_data_request.py +61 -156
- lusid/models/upsert_compliance_rule_request.py +113 -380
- lusid/models/upsert_compliance_run_summary_request.py +72 -250
- lusid/models/upsert_corporate_action_request.py +94 -337
- lusid/models/upsert_corporate_actions_response.py +111 -216
- lusid/models/upsert_counterparty_agreement_request.py +55 -126
- lusid/models/upsert_credit_support_annex_request.py +55 -125
- lusid/models/upsert_custom_entities_response.py +111 -216
- lusid/models/upsert_custom_entity_access_metadata_request.py +64 -126
- lusid/models/upsert_flow_conventions_request.py +73 -0
- lusid/models/upsert_index_convention_request.py +73 -0
- lusid/models/upsert_instrument_event_request.py +98 -329
- lusid/models/upsert_instrument_events_response.py +111 -216
- lusid/models/upsert_instrument_properties_response.py +67 -159
- lusid/models/upsert_instrument_property_request.py +68 -196
- lusid/models/upsert_instruments_response.py +135 -246
- lusid/models/upsert_legal_entities_response.py +111 -216
- lusid/models/upsert_legal_entity_access_metadata_request.py +64 -126
- lusid/models/upsert_legal_entity_request.py +115 -267
- lusid/models/upsert_person_access_metadata_request.py +64 -126
- lusid/models/upsert_person_request.py +92 -232
- lusid/models/upsert_portfolio_access_metadata_request.py +59 -128
- lusid/models/upsert_portfolio_group_access_metadata_request.py +59 -128
- lusid/models/upsert_portfolio_transactions_response.py +101 -216
- lusid/models/upsert_quote_access_metadata_rule_request.py +92 -0
- lusid/models/upsert_quote_request.py +75 -215
- lusid/models/upsert_quotes_response.py +111 -216
- lusid/models/upsert_recipe_request.py +61 -125
- lusid/models/upsert_reconciliation_break_request.py +98 -0
- lusid/models/upsert_reconciliation_run_request.py +71 -0
- lusid/models/upsert_reference_portfolio_constituents_request.py +94 -265
- lusid/models/upsert_reference_portfolio_constituents_response.py +77 -183
- lusid/models/upsert_result_values_data_request.py +93 -0
- lusid/models/upsert_returns_response.py +100 -247
- lusid/models/upsert_single_structured_data_response.py +74 -188
- lusid/models/upsert_structured_data_response.py +99 -217
- lusid/models/upsert_structured_result_data_request.py +79 -0
- lusid/models/upsert_transaction_properties_response.py +97 -213
- lusid/models/user.py +56 -126
- lusid/models/valuation_request.py +156 -528
- lusid/models/valuation_schedule.py +86 -329
- lusid/models/valuations_reconciliation_request.py +82 -216
- lusid/models/value_type.py +34 -116
- lusid/models/vendor_dependency.py +95 -0
- lusid/models/vendor_library.py +43 -0
- lusid/models/vendor_model_rule.py +97 -335
- lusid/models/version.py +110 -371
- lusid/models/version_summary_dto.py +85 -210
- lusid/models/versioned_resource_list_of_a2_b_data_record.py +101 -278
- lusid/models/versioned_resource_list_of_a2_b_movement_record.py +101 -278
- lusid/models/versioned_resource_list_of_holding_contributor.py +101 -278
- lusid/models/versioned_resource_list_of_journal_entry_line.py +119 -0
- lusid/models/versioned_resource_list_of_output_transaction.py +101 -278
- lusid/models/versioned_resource_list_of_portfolio_holding.py +101 -278
- lusid/models/versioned_resource_list_of_transaction.py +101 -278
- lusid/models/versioned_resource_list_of_trial_balance.py +119 -0
- lusid/models/versioned_resource_list_with_warnings_of_portfolio_holding.py +134 -0
- lusid/models/virtual_document.py +88 -0
- lusid/models/virtual_document_row.py +80 -0
- lusid/models/virtual_row.py +76 -156
- lusid/models/warning.py +71 -0
- lusid/models/weekend_mask.py +61 -165
- lusid/models/weighted_instrument.py +64 -220
- lusid/models/weighted_instruments.py +59 -128
- lusid/models/yield_curve_data.py +107 -296
- lusid/py.typed +0 -0
- lusid/rest.py +171 -237
- lusid_sdk-2.0.50b0.dist-info/METADATA +1460 -0
- lusid_sdk-2.0.50b0.dist-info/RECORD +917 -0
- {lusid_sdk-1.1.118.dist-info → lusid_sdk-2.0.50b0.dist-info}/WHEEL +1 -2
- lusid/__version__.py +0 -1
- lusid/models/accumulation_event.py +0 -310
- lusid/models/accumulation_event_all_of.py +0 -310
- lusid/models/address_key_compliance_parameter_all_of.py +0 -184
- lusid/models/address_key_list_all_of.py +0 -188
- lusid/models/address_key_list_compliance_parameter_all_of.py +0 -182
- lusid/models/amortisation_event_all_of.py +0 -283
- lusid/models/asset_leg.py +0 -179
- lusid/models/basket_all_of.py +0 -247
- lusid/models/block_and_order_id_request.py +0 -174
- lusid/models/block_and_orders.py +0 -174
- lusid/models/block_and_orders_create_request.py +0 -152
- lusid/models/block_and_orders_request.py +0 -422
- lusid/models/blocked_order_request.py +0 -412
- lusid/models/bond_all_of.py +0 -581
- lusid/models/bond_coupon_event.py +0 -280
- lusid/models/bond_coupon_event_all_of.py +0 -280
- lusid/models/bond_default_event_all_of.py +0 -184
- lusid/models/bond_principal_event.py +0 -280
- lusid/models/bond_principal_event_all_of.py +0 -280
- lusid/models/bool_compliance_parameter_all_of.py +0 -182
- lusid/models/branch_step.py +0 -219
- lusid/models/branch_step_all_of.py +0 -219
- lusid/models/calendar_dependency_all_of.py +0 -184
- lusid/models/cap_floor_all_of.py +0 -313
- lusid/models/cash_dependency_all_of.py +0 -216
- lusid/models/cash_dividend_event_all_of.py +0 -308
- lusid/models/cash_election.py +0 -334
- lusid/models/cash_flow_event_all_of.py +0 -217
- lusid/models/cash_flow_value_all_of.py +0 -306
- lusid/models/cash_flow_value_set_all_of.py +0 -182
- lusid/models/cash_perpetual_all_of.py +0 -248
- lusid/models/cds_index_all_of.py +0 -399
- lusid/models/check_step.py +0 -251
- lusid/models/check_step_all_of.py +0 -251
- lusid/models/close_event_all_of.py +0 -214
- lusid/models/complex_bond_all_of.py +0 -338
- lusid/models/compliance_rule_result_v2.py +0 -267
- lusid/models/compliance_step.py +0 -167
- lusid/models/constant_volatility_surface.py +0 -285
- lusid/models/constant_volatility_surface_all_of.py +0 -285
- lusid/models/contract_for_difference_all_of.py +0 -447
- lusid/models/create_trade_tickets_response.py +0 -174
- lusid/models/credit_default_swap_all_of.py +0 -401
- lusid/models/credit_spread_curve_data_all_of.py +0 -437
- lusid/models/date_time_compliance_parameter_all_of.py +0 -182
- lusid/models/decimal_compliance_parameter_all_of.py +0 -182
- lusid/models/decimal_list_all_of.py +0 -188
- lusid/models/discount_factor_curve_data_all_of.py +0 -313
- lusid/models/discounting_dependency_all_of.py +0 -216
- lusid/models/dividend_option_event.py +0 -371
- lusid/models/dividend_option_event_all_of.py +0 -371
- lusid/models/dividend_reinvestment_event.py +0 -342
- lusid/models/dividend_reinvestment_event_all_of.py +0 -342
- lusid/models/empty_model_options_all_of.py +0 -152
- lusid/models/equity_all_of.py +0 -243
- lusid/models/equity_curve_by_prices_data_all_of.py +0 -313
- lusid/models/equity_curve_dependency_all_of.py +0 -298
- lusid/models/equity_model_options_all_of.py +0 -187
- lusid/models/equity_option_all_of.py +0 -571
- lusid/models/equity_swap_all_of.py +0 -504
- lusid/models/equity_vol_dependency_all_of.py +0 -292
- lusid/models/equity_vol_surface_data_all_of.py +0 -284
- lusid/models/exchange_traded_option_all_of.py +0 -278
- lusid/models/exercise_event_all_of.py +0 -245
- lusid/models/exotic_instrument_all_of.py +0 -217
- lusid/models/filter_predicate_compliance_parameter.py +0 -185
- lusid/models/filter_predicate_compliance_parameter_all_of.py +0 -185
- lusid/models/filter_step.py +0 -219
- lusid/models/fixed_leg_all_of.py +0 -304
- lusid/models/flexible_loan.py +0 -280
- lusid/models/flexible_loan_all_of.py +0 -280
- lusid/models/floating_leg_all_of.py +0 -366
- lusid/models/forward_rate_agreement_all_of.py +0 -373
- lusid/models/fund_share_class.py +0 -324
- lusid/models/fund_share_class_all_of.py +0 -324
- lusid/models/funding_leg_all_of.py +0 -276
- lusid/models/future_all_of.py +0 -405
- lusid/models/fx_conventions.py +0 -216
- lusid/models/fx_dependency_all_of.py +0 -248
- lusid/models/fx_forward_all_of.py +0 -498
- lusid/models/fx_forward_curve_by_quote_reference_all_of.py +0 -405
- lusid/models/fx_forward_curve_data_all_of.py +0 -377
- lusid/models/fx_forward_model_options_all_of.py +0 -260
- lusid/models/fx_forward_pips_curve_data_all_of.py +0 -377
- lusid/models/fx_forward_settlement_event.py +0 -494
- lusid/models/fx_forward_settlement_event_all_of.py +0 -494
- lusid/models/fx_forward_tenor_curve_data_all_of.py +0 -437
- lusid/models/fx_forward_tenor_pips_curve_data_all_of.py +0 -437
- lusid/models/fx_forwards_dependency_all_of.py +0 -286
- lusid/models/fx_linked_notional_schedule.py +0 -273
- lusid/models/fx_linked_notional_schedule_all_of.py +0 -273
- lusid/models/fx_option_all_of.py +0 -646
- lusid/models/fx_swap_all_of.py +0 -242
- lusid/models/fx_vol_dependency_all_of.py +0 -286
- lusid/models/group_by_selector_compliance_parameter.py +0 -185
- lusid/models/group_by_step.py +0 -219
- lusid/models/group_filter_predicate_compliance_parameter.py +0 -185
- lusid/models/group_filter_step.py +0 -251
- lusid/models/group_of_market_data_key_rules.py +0 -181
- lusid/models/index_model_options_all_of.py +0 -190
- lusid/models/index_projection_dependency_all_of.py +0 -292
- lusid/models/inflation_fixing_dependency_all_of.py +0 -254
- lusid/models/inflation_leg_all_of.py +0 -472
- lusid/models/inflation_linked_bond_all_of.py +0 -612
- lusid/models/inflation_swap_all_of.py +0 -276
- lusid/models/informational_error_event_all_of.py +0 -254
- lusid/models/informational_event_all_of.py +0 -279
- lusid/models/instrument_event_configuration.py +0 -142
- lusid/models/instrument_leg_all_of.py +0 -152
- lusid/models/instrument_list_all_of.py +0 -188
- lusid/models/interest_rate_swap_all_of.py +0 -339
- lusid/models/interest_rate_swaption_all_of.py +0 -313
- lusid/models/ir_vol_cube_data_all_of.py +0 -284
- lusid/models/ir_vol_dependency_all_of.py +0 -254
- lusid/models/life_cycle_event_value_all_of.py +0 -241
- lusid/models/lineage_member.py +0 -294
- lusid/models/look_up_pricing_model_options_all_of.py +0 -216
- lusid/models/maturity_event.py +0 -184
- lusid/models/maturity_event_all_of.py +0 -184
- lusid/models/move_orders_to_different_blocks_request.py +0 -152
- lusid/models/moved_order_to_different_block_response.py +0 -201
- lusid/models/opaque_dependency_all_of.py +0 -152
- lusid/models/opaque_market_data_all_of.py +0 -293
- lusid/models/opaque_model_options_all_of.py +0 -182
- lusid/models/open_event_all_of.py +0 -183
- lusid/models/paged_resource_list_of_property_definition.py +0 -266
- lusid/models/place_blocks_request.py +0 -152
- lusid/models/portfolio_group_id_list_all_of.py +0 -185
- lusid/models/portfolio_result_data_key_rule_all_of.py +0 -409
- lusid/models/property_key_compliance_parameter_all_of.py +0 -184
- lusid/models/quote_dependency_all_of.py +0 -257
- lusid/models/raw_vendor_event_all_of.py +0 -249
- lusid/models/recombine_step.py +0 -219
- lusid/models/reconcile_date_time_rule_all_of.py +0 -251
- lusid/models/reconcile_numeric_rule_all_of.py +0 -251
- lusid/models/reconcile_string_rule_all_of.py +0 -250
- lusid/models/reference_instrument_all_of.py +0 -257
- lusid/models/relative_date_offset.py +0 -181
- lusid/models/repo_all_of.py +0 -493
- lusid/models/reset_event_all_of.py +0 -279
- lusid/models/resource_list_of_block_and_orders.py +0 -266
- lusid/models/resource_list_of_moved_order_to_different_block_response.py +0 -266
- lusid/models/result_data_key_rule_all_of.py +0 -406
- lusid/models/result_value0_d_all_of.py +0 -243
- lusid/models/result_value_bool_all_of.py +0 -183
- lusid/models/result_value_currency_all_of.py +0 -182
- lusid/models/result_value_date_time_offset_all_of.py +0 -213
- lusid/models/result_value_decimal_all_of.py +0 -213
- lusid/models/result_value_dictionary_all_of.py +0 -182
- lusid/models/result_value_int_all_of.py +0 -213
- lusid/models/result_value_string_all_of.py +0 -182
- lusid/models/schema.py +0 -228
- lusid/models/script_map_reference.py +0 -237
- lusid/models/security_election.py +0 -270
- lusid/models/simple_cash_flow_loan_all_of.py +0 -280
- lusid/models/simple_instrument_all_of.py +0 -318
- lusid/models/step_schedule_all_of.py +0 -254
- lusid/models/stock_split_event_all_of.py +0 -248
- lusid/models/string_compliance_parameter_all_of.py +0 -185
- lusid/models/term_deposit_all_of.py +0 -340
- lusid/models/total_return_swap_all_of.py +0 -276
- lusid/models/transition_event_all_of.py +0 -335
- lusid/models/translation_context.py +0 -172
- lusid/models/trigger_event_all_of.py +0 -318
- lusid/models/units_ratio.py +0 -178
- lusid/models/upsert_compliance_run_summary_result.py +0 -267
- lusid/models/upsert_dialect_request.py +0 -174
- lusid/models/upsert_translation_script_request.py +0 -182
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +0 -433
- lusid/models/yield_curve_data_all_of.py +0 -313
- lusid/tcp/__init__.py +0 -1
- lusid/tcp/tcp_keep_alive_probes.py +0 -110
- lusid/utilities/__init__.py +0 -8
- lusid/utilities/api_client_builder.py +0 -145
- lusid/utilities/api_client_factory.py +0 -132
- lusid/utilities/api_configuration_loader.py +0 -87
- lusid/utilities/config_keys.json +0 -50
- lusid/utilities/config_keys.py +0 -13
- lusid/utilities/lusid_retry.py +0 -47
- lusid_sdk-1.1.118.dist-info/METADATA +0 -21
- lusid_sdk-1.1.118.dist-info/RECORD +0 -848
- lusid_sdk-1.1.118.dist-info/top_level.txt +0 -1
lusid/api/custom_entities_api.py
CHANGED
@@ -5,50 +5,67 @@
|
|
5
5
|
|
6
6
|
FINBOURNE Technology # noqa: E501
|
7
7
|
|
8
|
-
The version of the OpenAPI document: 1.1.118
|
9
8
|
Contact: info@finbourne.com
|
10
|
-
Generated by
|
11
|
-
"""
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
12
10
|
|
11
|
+
Do not edit the class manually.
|
12
|
+
"""
|
13
13
|
|
14
|
-
from __future__ import absolute_import
|
15
14
|
|
16
15
|
import re # noqa: F401
|
16
|
+
import io
|
17
|
+
import warnings
|
17
18
|
|
18
|
-
|
19
|
-
import
|
19
|
+
from pydantic 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 import Field, StrictStr, conint, conlist, constr, validator
|
26
|
+
|
27
|
+
from typing import Dict, List, Optional
|
20
28
|
|
21
|
-
from lusid.api_client import ApiClient
|
22
|
-
from lusid.exceptions import ( # noqa: F401
|
23
|
-
ApiTypeError,
|
24
|
-
ApiValueError
|
25
|
-
)
|
26
29
|
from lusid.models.access_metadata_operation import AccessMetadataOperation
|
27
30
|
from lusid.models.access_metadata_value import AccessMetadataValue
|
28
31
|
from lusid.models.custom_entity_request import CustomEntityRequest
|
29
32
|
from lusid.models.custom_entity_response import CustomEntityResponse
|
30
33
|
from lusid.models.deleted_entity_response import DeletedEntityResponse
|
31
|
-
from lusid.models.lusid_problem_details import LusidProblemDetails
|
32
|
-
from lusid.models.lusid_validation_problem_details import LusidValidationProblemDetails
|
33
34
|
from lusid.models.paged_resource_list_of_custom_entity_response import PagedResourceListOfCustomEntityResponse
|
34
35
|
from lusid.models.resource_list_of_relationship import ResourceListOfRelationship
|
35
36
|
from lusid.models.upsert_custom_entities_response import UpsertCustomEntitiesResponse
|
36
37
|
from lusid.models.upsert_custom_entity_access_metadata_request import UpsertCustomEntityAccessMetadataRequest
|
37
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
|
+
|
38
46
|
|
39
|
-
class CustomEntitiesApi
|
47
|
+
class CustomEntitiesApi:
|
40
48
|
"""NOTE: This class is auto generated by OpenAPI Generator
|
41
49
|
Ref: https://openapi-generator.tech
|
42
50
|
|
43
51
|
Do not edit the class manually.
|
44
52
|
"""
|
45
53
|
|
46
|
-
def __init__(self, api_client=None):
|
54
|
+
def __init__(self, api_client=None) -> None:
|
47
55
|
if api_client is None:
|
48
|
-
api_client = ApiClient()
|
56
|
+
api_client = ApiClient.get_default()
|
49
57
|
self.api_client = api_client
|
50
58
|
|
51
|
-
|
59
|
+
@overload
|
60
|
+
async def delete_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of Custom Entity to remove.")], identifier_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
61
|
+
...
|
62
|
+
|
63
|
+
@overload
|
64
|
+
def delete_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of Custom Entity to remove.")], identifier_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
65
|
+
...
|
66
|
+
|
67
|
+
@validate_arguments
|
68
|
+
def delete_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of Custom Entity to remove.")], identifier_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
52
69
|
"""[EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance. # noqa: E501
|
53
70
|
|
54
71
|
Delete a Custom Entity instance by a specific entity type. # noqa: E501
|
@@ -68,23 +85,25 @@ class CustomEntitiesApi(object):
|
|
68
85
|
:type identifier_scope: str
|
69
86
|
:param async_req: Whether to execute the request asynchronously.
|
70
87
|
:type async_req: bool, optional
|
71
|
-
:param
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
:param _request_timeout: timeout setting for this request. If one
|
76
|
-
number provided, it will be total request
|
77
|
-
timeout. It can also be a pair (tuple) of
|
78
|
-
(connection, read) timeouts.
|
88
|
+
:param _request_timeout: timeout setting for this request.
|
89
|
+
If one number provided, it will be total request
|
90
|
+
timeout. It can also be a pair (tuple) of
|
91
|
+
(connection, read) timeouts.
|
79
92
|
:return: Returns the result object.
|
80
93
|
If the method is called asynchronously,
|
81
94
|
returns the request thread.
|
82
95
|
:rtype: DeletedEntityResponse
|
83
96
|
"""
|
84
97
|
kwargs['_return_http_data_only'] = True
|
98
|
+
if '_preload_content' in kwargs:
|
99
|
+
message = "Error! Please call the delete_custom_entity_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
100
|
+
raise ValueError(message)
|
101
|
+
if async_req is not None:
|
102
|
+
kwargs['async_req'] = async_req
|
85
103
|
return self.delete_custom_entity_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, **kwargs) # noqa: E501
|
86
104
|
|
87
|
-
|
105
|
+
@validate_arguments
|
106
|
+
def delete_custom_entity_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of Custom Entity to remove.")], identifier_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], **kwargs) -> ApiResponse: # noqa: E501
|
88
107
|
"""[EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance. # noqa: E501
|
89
108
|
|
90
109
|
Delete a Custom Entity instance by a specific entity type. # noqa: E501
|
@@ -104,13 +123,14 @@ class CustomEntitiesApi(object):
|
|
104
123
|
:type identifier_scope: str
|
105
124
|
:param async_req: Whether to execute the request asynchronously.
|
106
125
|
:type async_req: bool, optional
|
107
|
-
:param
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
be returned without reading/decoding response
|
112
|
-
data. Default is True.
|
126
|
+
:param _preload_content: if False, the ApiResponse.data will
|
127
|
+
be set to none and raw_data will store the
|
128
|
+
HTTP response body without reading/decoding.
|
129
|
+
Default is True.
|
113
130
|
:type _preload_content: bool, optional
|
131
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
132
|
+
object with status code, headers, etc
|
133
|
+
:type _return_http_data_only: bool, optional
|
114
134
|
:param _request_timeout: timeout setting for this request. If one
|
115
135
|
number provided, it will be total request
|
116
136
|
timeout. It can also be a pair (tuple) of
|
@@ -119,150 +139,115 @@ class CustomEntitiesApi(object):
|
|
119
139
|
request; this effectively ignores the authentication
|
120
140
|
in the spec for a single request.
|
121
141
|
:type _request_auth: dict, optional
|
122
|
-
:
|
142
|
+
:type _content_type: string, optional: force content-type for the request
|
143
|
+
:return: Returns the result object.
|
123
144
|
If the method is called asynchronously,
|
124
145
|
returns the request thread.
|
125
|
-
:rtype: (DeletedEntityResponse, int, HTTPHeaderDict)
|
146
|
+
:rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
126
147
|
"""
|
127
148
|
|
128
|
-
|
149
|
+
_params = locals()
|
129
150
|
|
130
|
-
|
151
|
+
_all_params = [
|
131
152
|
'entity_type',
|
132
153
|
'identifier_type',
|
133
154
|
'identifier_value',
|
134
155
|
'identifier_scope'
|
135
156
|
]
|
136
|
-
|
157
|
+
_all_params.extend(
|
137
158
|
[
|
138
159
|
'async_req',
|
139
160
|
'_return_http_data_only',
|
140
161
|
'_preload_content',
|
141
162
|
'_request_timeout',
|
142
163
|
'_request_auth',
|
164
|
+
'_content_type',
|
143
165
|
'_headers'
|
144
166
|
]
|
145
167
|
)
|
146
168
|
|
147
|
-
|
148
|
-
|
169
|
+
# validate the arguments
|
170
|
+
for _key, _val in _params['kwargs'].items():
|
171
|
+
if _key not in _all_params:
|
149
172
|
raise ApiTypeError(
|
150
173
|
"Got an unexpected keyword argument '%s'"
|
151
|
-
" to method delete_custom_entity" %
|
174
|
+
" to method delete_custom_entity" % _key
|
152
175
|
)
|
153
|
-
|
154
|
-
del
|
155
|
-
|
156
|
-
|
157
|
-
local_var_params['entity_type'] is None): # noqa: E501
|
158
|
-
raise ApiValueError("Missing the required parameter `entity_type` when calling `delete_custom_entity`") # noqa: E501
|
159
|
-
# verify the required parameter 'identifier_type' is set
|
160
|
-
if self.api_client.client_side_validation and ('identifier_type' not in local_var_params or # noqa: E501
|
161
|
-
local_var_params['identifier_type'] is None): # noqa: E501
|
162
|
-
raise ApiValueError("Missing the required parameter `identifier_type` when calling `delete_custom_entity`") # noqa: E501
|
163
|
-
# verify the required parameter 'identifier_value' is set
|
164
|
-
if self.api_client.client_side_validation and ('identifier_value' not in local_var_params or # noqa: E501
|
165
|
-
local_var_params['identifier_value'] is None): # noqa: E501
|
166
|
-
raise ApiValueError("Missing the required parameter `identifier_value` when calling `delete_custom_entity`") # noqa: E501
|
167
|
-
# verify the required parameter 'identifier_scope' is set
|
168
|
-
if self.api_client.client_side_validation and ('identifier_scope' not in local_var_params or # noqa: E501
|
169
|
-
local_var_params['identifier_scope'] is None): # noqa: E501
|
170
|
-
raise ApiValueError("Missing the required parameter `identifier_scope` when calling `delete_custom_entity`") # noqa: E501
|
171
|
-
|
172
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
173
|
-
len(local_var_params['entity_type']) > 64): # noqa: E501
|
174
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `delete_custom_entity`, length must be less than or equal to `64`") # noqa: E501
|
175
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
176
|
-
len(local_var_params['entity_type']) < 1): # noqa: E501
|
177
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `delete_custom_entity`, length must be greater than or equal to `1`") # noqa: E501
|
178
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
179
|
-
len(local_var_params['identifier_type']) > 65): # noqa: E501
|
180
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `delete_custom_entity`, length must be less than or equal to `65`") # noqa: E501
|
181
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
182
|
-
len(local_var_params['identifier_type']) < 1): # noqa: E501
|
183
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `delete_custom_entity`, length must be greater than or equal to `1`") # noqa: E501
|
184
|
-
if self.api_client.client_side_validation and 'identifier_type' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_type']): # noqa: E501
|
185
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `delete_custom_entity`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
186
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
187
|
-
len(local_var_params['identifier_value']) > 1024): # noqa: E501
|
188
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `delete_custom_entity`, length must be less than or equal to `1024`") # noqa: E501
|
189
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
190
|
-
len(local_var_params['identifier_value']) < 1): # noqa: E501
|
191
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `delete_custom_entity`, length must be greater than or equal to `1`") # noqa: E501
|
192
|
-
if self.api_client.client_side_validation and 'identifier_value' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_value']): # noqa: E501
|
193
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `delete_custom_entity`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
194
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
195
|
-
len(local_var_params['identifier_scope']) > 64): # noqa: E501
|
196
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `delete_custom_entity`, length must be less than or equal to `64`") # noqa: E501
|
197
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
198
|
-
len(local_var_params['identifier_scope']) < 1): # noqa: E501
|
199
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `delete_custom_entity`, length must be greater than or equal to `1`") # noqa: E501
|
200
|
-
if self.api_client.client_side_validation and 'identifier_scope' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_scope']): # noqa: E501
|
201
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `delete_custom_entity`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
202
|
-
collection_formats = {}
|
203
|
-
|
204
|
-
path_params = {}
|
205
|
-
if 'entity_type' in local_var_params:
|
206
|
-
path_params['entityType'] = local_var_params['entity_type'] # noqa: E501
|
207
|
-
if 'identifier_type' in local_var_params:
|
208
|
-
path_params['identifierType'] = local_var_params['identifier_type'] # noqa: E501
|
209
|
-
if 'identifier_value' in local_var_params:
|
210
|
-
path_params['identifierValue'] = local_var_params['identifier_value'] # noqa: E501
|
211
|
-
|
212
|
-
query_params = []
|
213
|
-
if 'identifier_scope' in local_var_params and local_var_params['identifier_scope'] is not None: # noqa: E501
|
214
|
-
query_params.append(('identifierScope', local_var_params['identifier_scope'])) # noqa: E501
|
215
|
-
|
216
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
217
|
-
|
218
|
-
form_params = []
|
219
|
-
local_var_files = {}
|
220
|
-
|
221
|
-
body_params = None
|
222
|
-
# HTTP header `Accept`
|
223
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
224
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
176
|
+
_params[_key] = _val
|
177
|
+
del _params['kwargs']
|
178
|
+
|
179
|
+
_collection_formats = {}
|
225
180
|
|
226
|
-
|
181
|
+
# process the path parameters
|
182
|
+
_path_params = {}
|
183
|
+
if _params['entity_type']:
|
184
|
+
_path_params['entityType'] = _params['entity_type']
|
227
185
|
|
186
|
+
if _params['identifier_type']:
|
187
|
+
_path_params['identifierType'] = _params['identifier_type']
|
228
188
|
|
229
|
-
|
230
|
-
|
231
|
-
header_params['X-LUSID-SDK-Version'] = '1.1.118'
|
189
|
+
if _params['identifier_value']:
|
190
|
+
_path_params['identifierValue'] = _params['identifier_value']
|
232
191
|
|
233
|
-
# Authentication setting
|
234
|
-
auth_settings = ['oauth2'] # noqa: E501
|
235
192
|
|
236
|
-
|
237
|
-
|
238
|
-
|
193
|
+
# process the query parameters
|
194
|
+
_query_params = []
|
195
|
+
if _params.get('identifier_scope') is not None: # noqa: E501
|
196
|
+
_query_params.append(('identifierScope', _params['identifier_scope']))
|
197
|
+
|
198
|
+
# process the header parameters
|
199
|
+
_header_params = dict(_params.get('_headers', {}))
|
200
|
+
# process the form parameters
|
201
|
+
_form_params = []
|
202
|
+
_files = {}
|
203
|
+
# process the body parameter
|
204
|
+
_body_params = None
|
205
|
+
# set the HTTP header `Accept`
|
206
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
207
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
208
|
+
|
209
|
+
# authentication setting
|
210
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
211
|
+
|
212
|
+
_response_types_map = {
|
213
|
+
'200': "DeletedEntityResponse",
|
214
|
+
'400': "LusidValidationProblemDetails",
|
239
215
|
}
|
240
216
|
|
241
217
|
return self.api_client.call_api(
|
242
218
|
'/api/customentities/{entityType}/{identifierType}/{identifierValue}', 'DELETE',
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
body=
|
247
|
-
post_params=
|
248
|
-
files=
|
249
|
-
response_types_map=
|
250
|
-
auth_settings=
|
251
|
-
async_req=
|
252
|
-
_return_http_data_only=
|
253
|
-
_preload_content=
|
254
|
-
_request_timeout=
|
255
|
-
collection_formats=
|
256
|
-
_request_auth=
|
257
|
-
|
258
|
-
|
219
|
+
_path_params,
|
220
|
+
_query_params,
|
221
|
+
_header_params,
|
222
|
+
body=_body_params,
|
223
|
+
post_params=_form_params,
|
224
|
+
files=_files,
|
225
|
+
response_types_map=_response_types_map,
|
226
|
+
auth_settings=_auth_settings,
|
227
|
+
async_req=_params.get('async_req'),
|
228
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
229
|
+
_preload_content=_params.get('_preload_content', True),
|
230
|
+
_request_timeout=_params.get('_request_timeout'),
|
231
|
+
collection_formats=_collection_formats,
|
232
|
+
_request_auth=_params.get('_request_auth'))
|
233
|
+
|
234
|
+
@overload
|
235
|
+
async def delete_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to delete.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which to retrieve the Access Metadata.")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata.")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
236
|
+
...
|
237
|
+
|
238
|
+
@overload
|
239
|
+
def delete_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to delete.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which to retrieve the Access Metadata.")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
240
|
+
...
|
241
|
+
|
242
|
+
@validate_arguments
|
243
|
+
def delete_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to delete.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which to retrieve the Access Metadata.")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
259
244
|
"""[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry # noqa: E501
|
260
245
|
|
261
246
|
Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
|
262
247
|
This method makes a synchronous HTTP request by default. To make an
|
263
248
|
asynchronous HTTP request, please pass async_req=True
|
264
249
|
|
265
|
-
>>> thread = api.delete_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, async_req=True)
|
250
|
+
>>> thread = api.delete_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, effective_until, async_req=True)
|
266
251
|
>>> result = thread.get()
|
267
252
|
|
268
253
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -281,30 +266,32 @@ class CustomEntitiesApi(object):
|
|
281
266
|
:type effective_until: datetime
|
282
267
|
:param async_req: Whether to execute the request asynchronously.
|
283
268
|
:type async_req: bool, optional
|
284
|
-
:param
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
:param _request_timeout: timeout setting for this request. If one
|
289
|
-
number provided, it will be total request
|
290
|
-
timeout. It can also be a pair (tuple) of
|
291
|
-
(connection, read) timeouts.
|
269
|
+
:param _request_timeout: timeout setting for this request.
|
270
|
+
If one number provided, it will be total request
|
271
|
+
timeout. It can also be a pair (tuple) of
|
272
|
+
(connection, read) timeouts.
|
292
273
|
:return: Returns the result object.
|
293
274
|
If the method is called asynchronously,
|
294
275
|
returns the request thread.
|
295
276
|
:rtype: DeletedEntityResponse
|
296
277
|
"""
|
297
278
|
kwargs['_return_http_data_only'] = True
|
298
|
-
|
299
|
-
|
300
|
-
|
279
|
+
if '_preload_content' in kwargs:
|
280
|
+
message = "Error! Please call the delete_custom_entity_access_metadata_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
281
|
+
raise ValueError(message)
|
282
|
+
if async_req is not None:
|
283
|
+
kwargs['async_req'] = async_req
|
284
|
+
return self.delete_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, effective_until, **kwargs) # noqa: E501
|
285
|
+
|
286
|
+
@validate_arguments
|
287
|
+
def delete_custom_entity_access_metadata_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to delete.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which to retrieve the Access Metadata.")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
301
288
|
"""[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry # noqa: E501
|
302
289
|
|
303
290
|
Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
|
304
291
|
This method makes a synchronous HTTP request by default. To make an
|
305
292
|
asynchronous HTTP request, please pass async_req=True
|
306
293
|
|
307
|
-
>>> thread = api.delete_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, async_req=True)
|
294
|
+
>>> thread = api.delete_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, effective_until, async_req=True)
|
308
295
|
>>> result = thread.get()
|
309
296
|
|
310
297
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -323,13 +310,14 @@ class CustomEntitiesApi(object):
|
|
323
310
|
:type effective_until: datetime
|
324
311
|
:param async_req: Whether to execute the request asynchronously.
|
325
312
|
:type async_req: bool, optional
|
326
|
-
:param
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
be returned without reading/decoding response
|
331
|
-
data. Default is True.
|
313
|
+
:param _preload_content: if False, the ApiResponse.data will
|
314
|
+
be set to none and raw_data will store the
|
315
|
+
HTTP response body without reading/decoding.
|
316
|
+
Default is True.
|
332
317
|
:type _preload_content: bool, optional
|
318
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
319
|
+
object with status code, headers, etc
|
320
|
+
:type _return_http_data_only: bool, optional
|
333
321
|
:param _request_timeout: timeout setting for this request. If one
|
334
322
|
number provided, it will be total request
|
335
323
|
timeout. It can also be a pair (tuple) of
|
@@ -338,15 +326,16 @@ class CustomEntitiesApi(object):
|
|
338
326
|
request; this effectively ignores the authentication
|
339
327
|
in the spec for a single request.
|
340
328
|
:type _request_auth: dict, optional
|
341
|
-
:
|
329
|
+
:type _content_type: string, optional: force content-type for the request
|
330
|
+
:return: Returns the result object.
|
342
331
|
If the method is called asynchronously,
|
343
332
|
returns the request thread.
|
344
|
-
:rtype: (DeletedEntityResponse, int, HTTPHeaderDict)
|
333
|
+
:rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
345
334
|
"""
|
346
335
|
|
347
|
-
|
336
|
+
_params = locals()
|
348
337
|
|
349
|
-
|
338
|
+
_all_params = [
|
350
339
|
'entity_type',
|
351
340
|
'identifier_type',
|
352
341
|
'identifier_value',
|
@@ -355,156 +344,112 @@ class CustomEntitiesApi(object):
|
|
355
344
|
'effective_at',
|
356
345
|
'effective_until'
|
357
346
|
]
|
358
|
-
|
347
|
+
_all_params.extend(
|
359
348
|
[
|
360
349
|
'async_req',
|
361
350
|
'_return_http_data_only',
|
362
351
|
'_preload_content',
|
363
352
|
'_request_timeout',
|
364
353
|
'_request_auth',
|
354
|
+
'_content_type',
|
365
355
|
'_headers'
|
366
356
|
]
|
367
357
|
)
|
368
358
|
|
369
|
-
|
370
|
-
|
359
|
+
# validate the arguments
|
360
|
+
for _key, _val in _params['kwargs'].items():
|
361
|
+
if _key not in _all_params:
|
371
362
|
raise ApiTypeError(
|
372
363
|
"Got an unexpected keyword argument '%s'"
|
373
|
-
" to method delete_custom_entity_access_metadata" %
|
364
|
+
" to method delete_custom_entity_access_metadata" % _key
|
374
365
|
)
|
375
|
-
|
376
|
-
del
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
if
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
local_var_params['identifier_value'] is None): # noqa: E501
|
388
|
-
raise ApiValueError("Missing the required parameter `identifier_value` when calling `delete_custom_entity_access_metadata`") # noqa: E501
|
389
|
-
# verify the required parameter 'metadata_key' is set
|
390
|
-
if self.api_client.client_side_validation and ('metadata_key' not in local_var_params or # noqa: E501
|
391
|
-
local_var_params['metadata_key'] is None): # noqa: E501
|
392
|
-
raise ApiValueError("Missing the required parameter `metadata_key` when calling `delete_custom_entity_access_metadata`") # noqa: E501
|
393
|
-
# verify the required parameter 'identifier_scope' is set
|
394
|
-
if self.api_client.client_side_validation and ('identifier_scope' not in local_var_params or # noqa: E501
|
395
|
-
local_var_params['identifier_scope'] is None): # noqa: E501
|
396
|
-
raise ApiValueError("Missing the required parameter `identifier_scope` when calling `delete_custom_entity_access_metadata`") # noqa: E501
|
397
|
-
|
398
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
399
|
-
len(local_var_params['entity_type']) > 64): # noqa: E501
|
400
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `delete_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
401
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
402
|
-
len(local_var_params['entity_type']) < 1): # noqa: E501
|
403
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `delete_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
404
|
-
if self.api_client.client_side_validation and 'entity_type' in local_var_params and not re.search(r'^~[a-zA-Z0-9\-_]+$', local_var_params['entity_type']): # noqa: E501
|
405
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `delete_custom_entity_access_metadata`, must conform to the pattern `/^~[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
406
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
407
|
-
len(local_var_params['identifier_type']) > 64): # noqa: E501
|
408
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `delete_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
409
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
410
|
-
len(local_var_params['identifier_type']) < 1): # noqa: E501
|
411
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `delete_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
412
|
-
if self.api_client.client_side_validation and 'identifier_type' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_type']): # noqa: E501
|
413
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `delete_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
414
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
415
|
-
len(local_var_params['identifier_value']) > 1024): # noqa: E501
|
416
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `delete_custom_entity_access_metadata`, length must be less than or equal to `1024`") # noqa: E501
|
417
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
418
|
-
len(local_var_params['identifier_value']) < 1): # noqa: E501
|
419
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `delete_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
420
|
-
if self.api_client.client_side_validation and 'identifier_value' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_value']): # noqa: E501
|
421
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `delete_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
422
|
-
if self.api_client.client_side_validation and ('metadata_key' in local_var_params and # noqa: E501
|
423
|
-
len(local_var_params['metadata_key']) > 100): # noqa: E501
|
424
|
-
raise ApiValueError("Invalid value for parameter `metadata_key` when calling `delete_custom_entity_access_metadata`, length must be less than or equal to `100`") # noqa: E501
|
425
|
-
if self.api_client.client_side_validation and ('metadata_key' in local_var_params and # noqa: E501
|
426
|
-
len(local_var_params['metadata_key']) < 1): # noqa: E501
|
427
|
-
raise ApiValueError("Invalid value for parameter `metadata_key` when calling `delete_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
428
|
-
if self.api_client.client_side_validation and 'metadata_key' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['metadata_key']): # noqa: E501
|
429
|
-
raise ApiValueError("Invalid value for parameter `metadata_key` when calling `delete_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
430
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
431
|
-
len(local_var_params['identifier_scope']) > 64): # noqa: E501
|
432
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `delete_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
433
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
434
|
-
len(local_var_params['identifier_scope']) < 1): # noqa: E501
|
435
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `delete_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
436
|
-
if self.api_client.client_side_validation and 'identifier_scope' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_scope']): # noqa: E501
|
437
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `delete_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
438
|
-
collection_formats = {}
|
439
|
-
|
440
|
-
path_params = {}
|
441
|
-
if 'entity_type' in local_var_params:
|
442
|
-
path_params['entityType'] = local_var_params['entity_type'] # noqa: E501
|
443
|
-
if 'identifier_type' in local_var_params:
|
444
|
-
path_params['identifierType'] = local_var_params['identifier_type'] # noqa: E501
|
445
|
-
if 'identifier_value' in local_var_params:
|
446
|
-
path_params['identifierValue'] = local_var_params['identifier_value'] # noqa: E501
|
447
|
-
if 'metadata_key' in local_var_params:
|
448
|
-
path_params['metadataKey'] = local_var_params['metadata_key'] # noqa: E501
|
449
|
-
|
450
|
-
query_params = []
|
451
|
-
if 'identifier_scope' in local_var_params and local_var_params['identifier_scope'] is not None: # noqa: E501
|
452
|
-
query_params.append(('identifierScope', local_var_params['identifier_scope'])) # noqa: E501
|
453
|
-
if 'effective_at' in local_var_params and local_var_params['effective_at'] is not None: # noqa: E501
|
454
|
-
query_params.append(('effectiveAt', local_var_params['effective_at'])) # noqa: E501
|
455
|
-
if 'effective_until' in local_var_params and local_var_params['effective_until'] is not None: # noqa: E501
|
456
|
-
query_params.append(('effectiveUntil', local_var_params['effective_until'])) # noqa: E501
|
457
|
-
|
458
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
459
|
-
|
460
|
-
form_params = []
|
461
|
-
local_var_files = {}
|
462
|
-
|
463
|
-
body_params = None
|
464
|
-
# HTTP header `Accept`
|
465
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
466
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
366
|
+
_params[_key] = _val
|
367
|
+
del _params['kwargs']
|
368
|
+
|
369
|
+
_collection_formats = {}
|
370
|
+
|
371
|
+
# process the path parameters
|
372
|
+
_path_params = {}
|
373
|
+
if _params['entity_type']:
|
374
|
+
_path_params['entityType'] = _params['entity_type']
|
375
|
+
|
376
|
+
if _params['identifier_type']:
|
377
|
+
_path_params['identifierType'] = _params['identifier_type']
|
467
378
|
|
468
|
-
|
379
|
+
if _params['identifier_value']:
|
380
|
+
_path_params['identifierValue'] = _params['identifier_value']
|
469
381
|
|
382
|
+
if _params['metadata_key']:
|
383
|
+
_path_params['metadataKey'] = _params['metadata_key']
|
470
384
|
|
471
|
-
# set the LUSID header
|
472
|
-
header_params['X-LUSID-SDK-Language'] = 'Python'
|
473
|
-
header_params['X-LUSID-SDK-Version'] = '1.1.118'
|
474
385
|
|
475
|
-
#
|
476
|
-
|
386
|
+
# process the query parameters
|
387
|
+
_query_params = []
|
388
|
+
if _params.get('identifier_scope') is not None: # noqa: E501
|
389
|
+
_query_params.append(('identifierScope', _params['identifier_scope']))
|
477
390
|
|
478
|
-
|
479
|
-
|
480
|
-
|
391
|
+
if _params.get('effective_at') is not None: # noqa: E501
|
392
|
+
_query_params.append(('effectiveAt', _params['effective_at']))
|
393
|
+
|
394
|
+
if _params.get('effective_until') is not None: # noqa: E501
|
395
|
+
if isinstance(_params['effective_until'], datetime):
|
396
|
+
_query_params.append(('effectiveUntil', _params['effective_until'].strftime(self.api_client.configuration.datetime_format)))
|
397
|
+
else:
|
398
|
+
_query_params.append(('effectiveUntil', _params['effective_until']))
|
399
|
+
|
400
|
+
# process the header parameters
|
401
|
+
_header_params = dict(_params.get('_headers', {}))
|
402
|
+
# process the form parameters
|
403
|
+
_form_params = []
|
404
|
+
_files = {}
|
405
|
+
# process the body parameter
|
406
|
+
_body_params = None
|
407
|
+
# set the HTTP header `Accept`
|
408
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
409
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
410
|
+
|
411
|
+
# authentication setting
|
412
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
413
|
+
|
414
|
+
_response_types_map = {
|
415
|
+
'200': "DeletedEntityResponse",
|
416
|
+
'400': "LusidValidationProblemDetails",
|
481
417
|
}
|
482
418
|
|
483
419
|
return self.api_client.call_api(
|
484
420
|
'/api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata/{metadataKey}', 'DELETE',
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
body=
|
489
|
-
post_params=
|
490
|
-
files=
|
491
|
-
response_types_map=
|
492
|
-
auth_settings=
|
493
|
-
async_req=
|
494
|
-
_return_http_data_only=
|
495
|
-
_preload_content=
|
496
|
-
_request_timeout=
|
497
|
-
collection_formats=
|
498
|
-
_request_auth=
|
499
|
-
|
500
|
-
|
421
|
+
_path_params,
|
422
|
+
_query_params,
|
423
|
+
_header_params,
|
424
|
+
body=_body_params,
|
425
|
+
post_params=_form_params,
|
426
|
+
files=_files,
|
427
|
+
response_types_map=_response_types_map,
|
428
|
+
auth_settings=_auth_settings,
|
429
|
+
async_req=_params.get('async_req'),
|
430
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
431
|
+
_preload_content=_params.get('_preload_content', True),
|
432
|
+
_request_timeout=_params.get('_request_timeout'),
|
433
|
+
collection_formats=_collection_formats,
|
434
|
+
_request_auth=_params.get('_request_auth'))
|
435
|
+
|
436
|
+
@overload
|
437
|
+
async def get_all_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata if not specified.")] = None, **kwargs) -> Dict[str, List[AccessMetadataValue]]: # noqa: E501
|
438
|
+
...
|
439
|
+
|
440
|
+
@overload
|
441
|
+
def get_all_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> Dict[str, List[AccessMetadataValue]]: # noqa: E501
|
442
|
+
...
|
443
|
+
|
444
|
+
@validate_arguments
|
445
|
+
def get_all_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[AccessMetadataValue]], Awaitable[Dict[str, List[AccessMetadataValue]]]]: # noqa: E501
|
501
446
|
"""[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity # noqa: E501
|
502
447
|
|
503
448
|
Get all the Custom Entity access metadata for the specified identifier scope, code and value # noqa: E501
|
504
449
|
This method makes a synchronous HTTP request by default. To make an
|
505
450
|
asynchronous HTTP request, please pass async_req=True
|
506
451
|
|
507
|
-
>>> thread = api.get_all_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, identifier_scope, async_req=True)
|
452
|
+
>>> thread = api.get_all_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, identifier_scope, effective_at, as_at, async_req=True)
|
508
453
|
>>> result = thread.get()
|
509
454
|
|
510
455
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -521,30 +466,32 @@ class CustomEntitiesApi(object):
|
|
521
466
|
:type as_at: datetime
|
522
467
|
:param async_req: Whether to execute the request asynchronously.
|
523
468
|
:type async_req: bool, optional
|
524
|
-
:param
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
:param _request_timeout: timeout setting for this request. If one
|
529
|
-
number provided, it will be total request
|
530
|
-
timeout. It can also be a pair (tuple) of
|
531
|
-
(connection, read) timeouts.
|
469
|
+
:param _request_timeout: timeout setting for this request.
|
470
|
+
If one number provided, it will be total request
|
471
|
+
timeout. It can also be a pair (tuple) of
|
472
|
+
(connection, read) timeouts.
|
532
473
|
:return: Returns the result object.
|
533
474
|
If the method is called asynchronously,
|
534
475
|
returns the request thread.
|
535
|
-
:rtype:
|
476
|
+
:rtype: Dict[str, List[AccessMetadataValue]]
|
536
477
|
"""
|
537
478
|
kwargs['_return_http_data_only'] = True
|
538
|
-
|
539
|
-
|
540
|
-
|
479
|
+
if '_preload_content' in kwargs:
|
480
|
+
message = "Error! Please call the get_all_custom_entity_access_metadata_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
481
|
+
raise ValueError(message)
|
482
|
+
if async_req is not None:
|
483
|
+
kwargs['async_req'] = async_req
|
484
|
+
return self.get_all_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, effective_at, as_at, **kwargs) # noqa: E501
|
485
|
+
|
486
|
+
@validate_arguments
|
487
|
+
def get_all_custom_entity_access_metadata_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
541
488
|
"""[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity # noqa: E501
|
542
489
|
|
543
490
|
Get all the Custom Entity access metadata for the specified identifier scope, code and value # noqa: E501
|
544
491
|
This method makes a synchronous HTTP request by default. To make an
|
545
492
|
asynchronous HTTP request, please pass async_req=True
|
546
493
|
|
547
|
-
>>> thread = api.get_all_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, async_req=True)
|
494
|
+
>>> thread = api.get_all_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, effective_at, as_at, async_req=True)
|
548
495
|
>>> result = thread.get()
|
549
496
|
|
550
497
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -561,13 +508,14 @@ class CustomEntitiesApi(object):
|
|
561
508
|
:type as_at: datetime
|
562
509
|
:param async_req: Whether to execute the request asynchronously.
|
563
510
|
:type async_req: bool, optional
|
564
|
-
:param
|
565
|
-
|
566
|
-
|
567
|
-
|
568
|
-
be returned without reading/decoding response
|
569
|
-
data. Default is True.
|
511
|
+
:param _preload_content: if False, the ApiResponse.data will
|
512
|
+
be set to none and raw_data will store the
|
513
|
+
HTTP response body without reading/decoding.
|
514
|
+
Default is True.
|
570
515
|
:type _preload_content: bool, optional
|
516
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
517
|
+
object with status code, headers, etc
|
518
|
+
:type _return_http_data_only: bool, optional
|
571
519
|
:param _request_timeout: timeout setting for this request. If one
|
572
520
|
number provided, it will be total request
|
573
521
|
timeout. It can also be a pair (tuple) of
|
@@ -576,15 +524,16 @@ class CustomEntitiesApi(object):
|
|
576
524
|
request; this effectively ignores the authentication
|
577
525
|
in the spec for a single request.
|
578
526
|
:type _request_auth: dict, optional
|
579
|
-
:
|
527
|
+
:type _content_type: string, optional: force content-type for the request
|
528
|
+
:return: Returns the result object.
|
580
529
|
If the method is called asynchronously,
|
581
530
|
returns the request thread.
|
582
|
-
:rtype: (
|
531
|
+
:rtype: tuple(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))
|
583
532
|
"""
|
584
533
|
|
585
|
-
|
534
|
+
_params = locals()
|
586
535
|
|
587
|
-
|
536
|
+
_all_params = [
|
588
537
|
'entity_type',
|
589
538
|
'identifier_type',
|
590
539
|
'identifier_value',
|
@@ -592,142 +541,109 @@ class CustomEntitiesApi(object):
|
|
592
541
|
'effective_at',
|
593
542
|
'as_at'
|
594
543
|
]
|
595
|
-
|
544
|
+
_all_params.extend(
|
596
545
|
[
|
597
546
|
'async_req',
|
598
547
|
'_return_http_data_only',
|
599
548
|
'_preload_content',
|
600
549
|
'_request_timeout',
|
601
550
|
'_request_auth',
|
551
|
+
'_content_type',
|
602
552
|
'_headers'
|
603
553
|
]
|
604
554
|
)
|
605
555
|
|
606
|
-
|
607
|
-
|
556
|
+
# validate the arguments
|
557
|
+
for _key, _val in _params['kwargs'].items():
|
558
|
+
if _key not in _all_params:
|
608
559
|
raise ApiTypeError(
|
609
560
|
"Got an unexpected keyword argument '%s'"
|
610
|
-
" to method get_all_custom_entity_access_metadata" %
|
561
|
+
" to method get_all_custom_entity_access_metadata" % _key
|
611
562
|
)
|
612
|
-
|
613
|
-
del
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
if
|
620
|
-
|
621
|
-
|
622
|
-
|
623
|
-
|
624
|
-
|
625
|
-
|
626
|
-
|
627
|
-
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
if
|
632
|
-
|
633
|
-
|
634
|
-
if
|
635
|
-
|
636
|
-
|
637
|
-
if
|
638
|
-
|
639
|
-
|
640
|
-
|
641
|
-
|
642
|
-
|
643
|
-
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `get_all_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
653
|
-
if self.api_client.client_side_validation and 'identifier_value' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_value']): # noqa: E501
|
654
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `get_all_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
655
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
656
|
-
len(local_var_params['identifier_scope']) > 64): # noqa: E501
|
657
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_all_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
658
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
659
|
-
len(local_var_params['identifier_scope']) < 1): # noqa: E501
|
660
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_all_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
661
|
-
if self.api_client.client_side_validation and 'identifier_scope' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_scope']): # noqa: E501
|
662
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_all_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
663
|
-
collection_formats = {}
|
664
|
-
|
665
|
-
path_params = {}
|
666
|
-
if 'entity_type' in local_var_params:
|
667
|
-
path_params['entityType'] = local_var_params['entity_type'] # noqa: E501
|
668
|
-
if 'identifier_type' in local_var_params:
|
669
|
-
path_params['identifierType'] = local_var_params['identifier_type'] # noqa: E501
|
670
|
-
if 'identifier_value' in local_var_params:
|
671
|
-
path_params['identifierValue'] = local_var_params['identifier_value'] # noqa: E501
|
672
|
-
|
673
|
-
query_params = []
|
674
|
-
if 'identifier_scope' in local_var_params and local_var_params['identifier_scope'] is not None: # noqa: E501
|
675
|
-
query_params.append(('identifierScope', local_var_params['identifier_scope'])) # noqa: E501
|
676
|
-
if 'effective_at' in local_var_params and local_var_params['effective_at'] is not None: # noqa: E501
|
677
|
-
query_params.append(('effectiveAt', local_var_params['effective_at'])) # noqa: E501
|
678
|
-
if 'as_at' in local_var_params and local_var_params['as_at'] is not None: # noqa: E501
|
679
|
-
query_params.append(('asAt', local_var_params['as_at'])) # noqa: E501
|
680
|
-
|
681
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
682
|
-
|
683
|
-
form_params = []
|
684
|
-
local_var_files = {}
|
685
|
-
|
686
|
-
body_params = None
|
687
|
-
# HTTP header `Accept`
|
688
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
563
|
+
_params[_key] = _val
|
564
|
+
del _params['kwargs']
|
565
|
+
|
566
|
+
_collection_formats = {}
|
567
|
+
|
568
|
+
# process the path parameters
|
569
|
+
_path_params = {}
|
570
|
+
if _params['entity_type']:
|
571
|
+
_path_params['entityType'] = _params['entity_type']
|
572
|
+
|
573
|
+
if _params['identifier_type']:
|
574
|
+
_path_params['identifierType'] = _params['identifier_type']
|
575
|
+
|
576
|
+
if _params['identifier_value']:
|
577
|
+
_path_params['identifierValue'] = _params['identifier_value']
|
578
|
+
|
579
|
+
|
580
|
+
# process the query parameters
|
581
|
+
_query_params = []
|
582
|
+
if _params.get('identifier_scope') is not None: # noqa: E501
|
583
|
+
_query_params.append(('identifierScope', _params['identifier_scope']))
|
584
|
+
|
585
|
+
if _params.get('effective_at') is not None: # noqa: E501
|
586
|
+
_query_params.append(('effectiveAt', _params['effective_at']))
|
587
|
+
|
588
|
+
if _params.get('as_at') is not None: # noqa: E501
|
589
|
+
if isinstance(_params['as_at'], datetime):
|
590
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
591
|
+
else:
|
592
|
+
_query_params.append(('asAt', _params['as_at']))
|
593
|
+
|
594
|
+
# process the header parameters
|
595
|
+
_header_params = dict(_params.get('_headers', {}))
|
596
|
+
# process the form parameters
|
597
|
+
_form_params = []
|
598
|
+
_files = {}
|
599
|
+
# process the body parameter
|
600
|
+
_body_params = None
|
601
|
+
# set the HTTP header `Accept`
|
602
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
689
603
|
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
690
604
|
|
691
|
-
|
692
|
-
|
605
|
+
# authentication setting
|
606
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
693
607
|
|
694
|
-
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
# Authentication setting
|
699
|
-
auth_settings = ['oauth2'] # noqa: E501
|
700
|
-
|
701
|
-
response_types_map = {
|
702
|
-
200: "dict(str, list[AccessMetadataValue])",
|
703
|
-
400: "LusidValidationProblemDetails",
|
608
|
+
_response_types_map = {
|
609
|
+
'200': "Dict[str, List[AccessMetadataValue]]",
|
610
|
+
'400': "LusidValidationProblemDetails",
|
704
611
|
}
|
705
612
|
|
706
613
|
return self.api_client.call_api(
|
707
614
|
'/api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata', 'GET',
|
708
|
-
|
709
|
-
|
710
|
-
|
711
|
-
body=
|
712
|
-
post_params=
|
713
|
-
files=
|
714
|
-
response_types_map=
|
715
|
-
auth_settings=
|
716
|
-
async_req=
|
717
|
-
_return_http_data_only=
|
718
|
-
_preload_content=
|
719
|
-
_request_timeout=
|
720
|
-
collection_formats=
|
721
|
-
_request_auth=
|
722
|
-
|
723
|
-
|
615
|
+
_path_params,
|
616
|
+
_query_params,
|
617
|
+
_header_params,
|
618
|
+
body=_body_params,
|
619
|
+
post_params=_form_params,
|
620
|
+
files=_files,
|
621
|
+
response_types_map=_response_types_map,
|
622
|
+
auth_settings=_auth_settings,
|
623
|
+
async_req=_params.get('async_req'),
|
624
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
625
|
+
_preload_content=_params.get('_preload_content', True),
|
626
|
+
_request_timeout=_params.get('_request_timeout'),
|
627
|
+
collection_formats=_collection_formats,
|
628
|
+
_request_auth=_params.get('_request_auth'))
|
629
|
+
|
630
|
+
@overload
|
631
|
+
async def get_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> CustomEntityResponse: # noqa: E501
|
632
|
+
...
|
633
|
+
|
634
|
+
@overload
|
635
|
+
def get_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> CustomEntityResponse: # noqa: E501
|
636
|
+
...
|
637
|
+
|
638
|
+
@validate_arguments
|
639
|
+
def get_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustomEntityResponse, Awaitable[CustomEntityResponse]]: # noqa: E501
|
724
640
|
"""[EARLY ACCESS] GetCustomEntity: Get a Custom Entity instance. # noqa: E501
|
725
641
|
|
726
642
|
Retrieve a Custom Entity instance by a specific entity type at a point in AsAt time. # noqa: E501
|
727
643
|
This method makes a synchronous HTTP request by default. To make an
|
728
644
|
asynchronous HTTP request, please pass async_req=True
|
729
645
|
|
730
|
-
>>> thread = api.get_custom_entity(entity_type, identifier_type, identifier_value, identifier_scope, async_req=True)
|
646
|
+
>>> thread = api.get_custom_entity(entity_type, identifier_type, identifier_value, identifier_scope, as_at, effective_at, related_entity_property_keys, relationship_definition_ids, async_req=True)
|
731
647
|
>>> result = thread.get()
|
732
648
|
|
733
649
|
:param entity_type: The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions. (required)
|
@@ -743,35 +659,37 @@ class CustomEntitiesApi(object):
|
|
743
659
|
:param effective_at: The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.
|
744
660
|
:type effective_at: str
|
745
661
|
:param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
746
|
-
:type related_entity_property_keys:
|
662
|
+
:type related_entity_property_keys: List[str]
|
747
663
|
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
748
|
-
:type relationship_definition_ids:
|
664
|
+
:type relationship_definition_ids: List[str]
|
749
665
|
:param async_req: Whether to execute the request asynchronously.
|
750
666
|
:type async_req: bool, optional
|
751
|
-
:param
|
752
|
-
|
753
|
-
|
754
|
-
|
755
|
-
:param _request_timeout: timeout setting for this request. If one
|
756
|
-
number provided, it will be total request
|
757
|
-
timeout. It can also be a pair (tuple) of
|
758
|
-
(connection, read) timeouts.
|
667
|
+
:param _request_timeout: timeout setting for this request.
|
668
|
+
If one number provided, it will be total request
|
669
|
+
timeout. It can also be a pair (tuple) of
|
670
|
+
(connection, read) timeouts.
|
759
671
|
:return: Returns the result object.
|
760
672
|
If the method is called asynchronously,
|
761
673
|
returns the request thread.
|
762
674
|
:rtype: CustomEntityResponse
|
763
675
|
"""
|
764
676
|
kwargs['_return_http_data_only'] = True
|
765
|
-
|
766
|
-
|
767
|
-
|
677
|
+
if '_preload_content' in kwargs:
|
678
|
+
message = "Error! Please call the get_custom_entity_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
679
|
+
raise ValueError(message)
|
680
|
+
if async_req is not None:
|
681
|
+
kwargs['async_req'] = async_req
|
682
|
+
return self.get_custom_entity_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, as_at, effective_at, related_entity_property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
683
|
+
|
684
|
+
@validate_arguments
|
685
|
+
def get_custom_entity_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
768
686
|
"""[EARLY ACCESS] GetCustomEntity: Get a Custom Entity instance. # noqa: E501
|
769
687
|
|
770
688
|
Retrieve a Custom Entity instance by a specific entity type at a point in AsAt time. # noqa: E501
|
771
689
|
This method makes a synchronous HTTP request by default. To make an
|
772
690
|
asynchronous HTTP request, please pass async_req=True
|
773
691
|
|
774
|
-
>>> thread = api.get_custom_entity_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, async_req=True)
|
692
|
+
>>> thread = api.get_custom_entity_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, as_at, effective_at, related_entity_property_keys, relationship_definition_ids, async_req=True)
|
775
693
|
>>> result = thread.get()
|
776
694
|
|
777
695
|
:param entity_type: The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions. (required)
|
@@ -787,18 +705,19 @@ class CustomEntitiesApi(object):
|
|
787
705
|
:param effective_at: The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.
|
788
706
|
:type effective_at: str
|
789
707
|
:param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
790
|
-
:type related_entity_property_keys:
|
708
|
+
:type related_entity_property_keys: List[str]
|
791
709
|
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
792
|
-
:type relationship_definition_ids:
|
710
|
+
:type relationship_definition_ids: List[str]
|
793
711
|
:param async_req: Whether to execute the request asynchronously.
|
794
712
|
:type async_req: bool, optional
|
795
|
-
:param
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
be returned without reading/decoding response
|
800
|
-
data. Default is True.
|
713
|
+
:param _preload_content: if False, the ApiResponse.data will
|
714
|
+
be set to none and raw_data will store the
|
715
|
+
HTTP response body without reading/decoding.
|
716
|
+
Default is True.
|
801
717
|
:type _preload_content: bool, optional
|
718
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
719
|
+
object with status code, headers, etc
|
720
|
+
:type _return_http_data_only: bool, optional
|
802
721
|
:param _request_timeout: timeout setting for this request. If one
|
803
722
|
number provided, it will be total request
|
804
723
|
timeout. It can also be a pair (tuple) of
|
@@ -807,15 +726,16 @@ class CustomEntitiesApi(object):
|
|
807
726
|
request; this effectively ignores the authentication
|
808
727
|
in the spec for a single request.
|
809
728
|
:type _request_auth: dict, optional
|
810
|
-
:
|
729
|
+
:type _content_type: string, optional: force content-type for the request
|
730
|
+
:return: Returns the result object.
|
811
731
|
If the method is called asynchronously,
|
812
732
|
returns the request thread.
|
813
|
-
:rtype: (CustomEntityResponse, int, HTTPHeaderDict)
|
733
|
+
:rtype: tuple(CustomEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
814
734
|
"""
|
815
735
|
|
816
|
-
|
736
|
+
_params = locals()
|
817
737
|
|
818
|
-
|
738
|
+
_all_params = [
|
819
739
|
'entity_type',
|
820
740
|
'identifier_type',
|
821
741
|
'identifier_value',
|
@@ -825,146 +745,117 @@ class CustomEntitiesApi(object):
|
|
825
745
|
'related_entity_property_keys',
|
826
746
|
'relationship_definition_ids'
|
827
747
|
]
|
828
|
-
|
748
|
+
_all_params.extend(
|
829
749
|
[
|
830
750
|
'async_req',
|
831
751
|
'_return_http_data_only',
|
832
752
|
'_preload_content',
|
833
753
|
'_request_timeout',
|
834
754
|
'_request_auth',
|
755
|
+
'_content_type',
|
835
756
|
'_headers'
|
836
757
|
]
|
837
758
|
)
|
838
759
|
|
839
|
-
|
840
|
-
|
760
|
+
# validate the arguments
|
761
|
+
for _key, _val in _params['kwargs'].items():
|
762
|
+
if _key not in _all_params:
|
841
763
|
raise ApiTypeError(
|
842
764
|
"Got an unexpected keyword argument '%s'"
|
843
|
-
" to method get_custom_entity" %
|
765
|
+
" to method get_custom_entity" % _key
|
844
766
|
)
|
845
|
-
|
846
|
-
del
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
if
|
853
|
-
|
854
|
-
|
855
|
-
|
856
|
-
|
857
|
-
|
858
|
-
|
859
|
-
|
860
|
-
|
861
|
-
|
862
|
-
|
863
|
-
|
864
|
-
if
|
865
|
-
|
866
|
-
|
867
|
-
if
|
868
|
-
|
869
|
-
|
870
|
-
|
871
|
-
|
872
|
-
|
873
|
-
if
|
874
|
-
|
875
|
-
|
876
|
-
if
|
877
|
-
|
878
|
-
|
879
|
-
|
880
|
-
|
881
|
-
|
882
|
-
|
883
|
-
|
884
|
-
|
885
|
-
|
886
|
-
|
887
|
-
|
888
|
-
|
889
|
-
|
890
|
-
|
891
|
-
|
892
|
-
|
893
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_custom_entity`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
894
|
-
collection_formats = {}
|
895
|
-
|
896
|
-
path_params = {}
|
897
|
-
if 'entity_type' in local_var_params:
|
898
|
-
path_params['entityType'] = local_var_params['entity_type'] # noqa: E501
|
899
|
-
if 'identifier_type' in local_var_params:
|
900
|
-
path_params['identifierType'] = local_var_params['identifier_type'] # noqa: E501
|
901
|
-
if 'identifier_value' in local_var_params:
|
902
|
-
path_params['identifierValue'] = local_var_params['identifier_value'] # noqa: E501
|
903
|
-
|
904
|
-
query_params = []
|
905
|
-
if 'identifier_scope' in local_var_params and local_var_params['identifier_scope'] is not None: # noqa: E501
|
906
|
-
query_params.append(('identifierScope', local_var_params['identifier_scope'])) # noqa: E501
|
907
|
-
if 'as_at' in local_var_params and local_var_params['as_at'] is not None: # noqa: E501
|
908
|
-
query_params.append(('asAt', local_var_params['as_at'])) # noqa: E501
|
909
|
-
if 'effective_at' in local_var_params and local_var_params['effective_at'] is not None: # noqa: E501
|
910
|
-
query_params.append(('effectiveAt', local_var_params['effective_at'])) # noqa: E501
|
911
|
-
if 'related_entity_property_keys' in local_var_params and local_var_params['related_entity_property_keys'] is not None: # noqa: E501
|
912
|
-
query_params.append(('relatedEntityPropertyKeys', local_var_params['related_entity_property_keys'])) # noqa: E501
|
913
|
-
collection_formats['relatedEntityPropertyKeys'] = 'multi' # noqa: E501
|
914
|
-
if 'relationship_definition_ids' in local_var_params and local_var_params['relationship_definition_ids'] is not None: # noqa: E501
|
915
|
-
query_params.append(('relationshipDefinitionIds', local_var_params['relationship_definition_ids'])) # noqa: E501
|
916
|
-
collection_formats['relationshipDefinitionIds'] = 'multi' # noqa: E501
|
917
|
-
|
918
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
919
|
-
|
920
|
-
form_params = []
|
921
|
-
local_var_files = {}
|
922
|
-
|
923
|
-
body_params = None
|
924
|
-
# HTTP header `Accept`
|
925
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
767
|
+
_params[_key] = _val
|
768
|
+
del _params['kwargs']
|
769
|
+
|
770
|
+
_collection_formats = {}
|
771
|
+
|
772
|
+
# process the path parameters
|
773
|
+
_path_params = {}
|
774
|
+
if _params['entity_type']:
|
775
|
+
_path_params['entityType'] = _params['entity_type']
|
776
|
+
|
777
|
+
if _params['identifier_type']:
|
778
|
+
_path_params['identifierType'] = _params['identifier_type']
|
779
|
+
|
780
|
+
if _params['identifier_value']:
|
781
|
+
_path_params['identifierValue'] = _params['identifier_value']
|
782
|
+
|
783
|
+
|
784
|
+
# process the query parameters
|
785
|
+
_query_params = []
|
786
|
+
if _params.get('identifier_scope') is not None: # noqa: E501
|
787
|
+
_query_params.append(('identifierScope', _params['identifier_scope']))
|
788
|
+
|
789
|
+
if _params.get('as_at') is not None: # noqa: E501
|
790
|
+
if isinstance(_params['as_at'], datetime):
|
791
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
792
|
+
else:
|
793
|
+
_query_params.append(('asAt', _params['as_at']))
|
794
|
+
|
795
|
+
if _params.get('effective_at') is not None: # noqa: E501
|
796
|
+
_query_params.append(('effectiveAt', _params['effective_at']))
|
797
|
+
|
798
|
+
if _params.get('related_entity_property_keys') is not None: # noqa: E501
|
799
|
+
_query_params.append(('relatedEntityPropertyKeys', _params['related_entity_property_keys']))
|
800
|
+
_collection_formats['relatedEntityPropertyKeys'] = 'multi'
|
801
|
+
|
802
|
+
if _params.get('relationship_definition_ids') is not None: # noqa: E501
|
803
|
+
_query_params.append(('relationshipDefinitionIds', _params['relationship_definition_ids']))
|
804
|
+
_collection_formats['relationshipDefinitionIds'] = 'multi'
|
805
|
+
|
806
|
+
# process the header parameters
|
807
|
+
_header_params = dict(_params.get('_headers', {}))
|
808
|
+
# process the form parameters
|
809
|
+
_form_params = []
|
810
|
+
_files = {}
|
811
|
+
# process the body parameter
|
812
|
+
_body_params = None
|
813
|
+
# set the HTTP header `Accept`
|
814
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
926
815
|
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
927
816
|
|
928
|
-
|
929
|
-
|
930
|
-
|
931
|
-
# set the LUSID header
|
932
|
-
header_params['X-LUSID-SDK-Language'] = 'Python'
|
933
|
-
header_params['X-LUSID-SDK-Version'] = '1.1.118'
|
934
|
-
|
935
|
-
# Authentication setting
|
936
|
-
auth_settings = ['oauth2'] # noqa: E501
|
817
|
+
# authentication setting
|
818
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
937
819
|
|
938
|
-
|
939
|
-
200: "CustomEntityResponse",
|
940
|
-
400: "LusidValidationProblemDetails",
|
820
|
+
_response_types_map = {
|
821
|
+
'200': "CustomEntityResponse",
|
822
|
+
'400': "LusidValidationProblemDetails",
|
941
823
|
}
|
942
824
|
|
943
825
|
return self.api_client.call_api(
|
944
826
|
'/api/customentities/{entityType}/{identifierType}/{identifierValue}', 'GET',
|
945
|
-
|
946
|
-
|
947
|
-
|
948
|
-
body=
|
949
|
-
post_params=
|
950
|
-
files=
|
951
|
-
response_types_map=
|
952
|
-
auth_settings=
|
953
|
-
async_req=
|
954
|
-
_return_http_data_only=
|
955
|
-
_preload_content=
|
956
|
-
_request_timeout=
|
957
|
-
collection_formats=
|
958
|
-
_request_auth=
|
959
|
-
|
960
|
-
|
827
|
+
_path_params,
|
828
|
+
_query_params,
|
829
|
+
_header_params,
|
830
|
+
body=_body_params,
|
831
|
+
post_params=_form_params,
|
832
|
+
files=_files,
|
833
|
+
response_types_map=_response_types_map,
|
834
|
+
auth_settings=_auth_settings,
|
835
|
+
async_req=_params.get('async_req'),
|
836
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
837
|
+
_preload_content=_params.get('_preload_content', True),
|
838
|
+
_request_timeout=_params.get('_request_timeout'),
|
839
|
+
collection_formats=_collection_formats,
|
840
|
+
_request_auth=_params.get('_request_auth'))
|
841
|
+
|
842
|
+
@overload
|
843
|
+
async def get_custom_entity_access_metadata_by_key(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata if not specified.")] = None, **kwargs) -> List[AccessMetadataValue]: # noqa: E501
|
844
|
+
...
|
845
|
+
|
846
|
+
@overload
|
847
|
+
def get_custom_entity_access_metadata_by_key(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> List[AccessMetadataValue]: # noqa: E501
|
848
|
+
...
|
849
|
+
|
850
|
+
@validate_arguments
|
851
|
+
def get_custom_entity_access_metadata_by_key(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[List[AccessMetadataValue], Awaitable[List[AccessMetadataValue]]]: # noqa: E501
|
961
852
|
"""[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity # noqa: E501
|
962
853
|
|
963
854
|
Get Custom Entity access metadata for the specified metadata key # noqa: E501
|
964
855
|
This method makes a synchronous HTTP request by default. To make an
|
965
856
|
asynchronous HTTP request, please pass async_req=True
|
966
857
|
|
967
|
-
>>> thread = api.get_custom_entity_access_metadata_by_key(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, async_req=True)
|
858
|
+
>>> thread = api.get_custom_entity_access_metadata_by_key(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, as_at, async_req=True)
|
968
859
|
>>> result = thread.get()
|
969
860
|
|
970
861
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -983,30 +874,32 @@ class CustomEntitiesApi(object):
|
|
983
874
|
:type as_at: datetime
|
984
875
|
:param async_req: Whether to execute the request asynchronously.
|
985
876
|
:type async_req: bool, optional
|
986
|
-
:param
|
987
|
-
|
988
|
-
|
989
|
-
|
990
|
-
:param _request_timeout: timeout setting for this request. If one
|
991
|
-
number provided, it will be total request
|
992
|
-
timeout. It can also be a pair (tuple) of
|
993
|
-
(connection, read) timeouts.
|
877
|
+
:param _request_timeout: timeout setting for this request.
|
878
|
+
If one number provided, it will be total request
|
879
|
+
timeout. It can also be a pair (tuple) of
|
880
|
+
(connection, read) timeouts.
|
994
881
|
:return: Returns the result object.
|
995
882
|
If the method is called asynchronously,
|
996
883
|
returns the request thread.
|
997
|
-
:rtype:
|
884
|
+
:rtype: List[AccessMetadataValue]
|
998
885
|
"""
|
999
886
|
kwargs['_return_http_data_only'] = True
|
1000
|
-
|
1001
|
-
|
1002
|
-
|
887
|
+
if '_preload_content' in kwargs:
|
888
|
+
message = "Error! Please call the get_custom_entity_access_metadata_by_key_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
889
|
+
raise ValueError(message)
|
890
|
+
if async_req is not None:
|
891
|
+
kwargs['async_req'] = async_req
|
892
|
+
return self.get_custom_entity_access_metadata_by_key_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, as_at, **kwargs) # noqa: E501
|
893
|
+
|
894
|
+
@validate_arguments
|
895
|
+
def get_custom_entity_access_metadata_by_key_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1003
896
|
"""[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity # noqa: E501
|
1004
897
|
|
1005
898
|
Get Custom Entity access metadata for the specified metadata key # noqa: E501
|
1006
899
|
This method makes a synchronous HTTP request by default. To make an
|
1007
900
|
asynchronous HTTP request, please pass async_req=True
|
1008
901
|
|
1009
|
-
>>> thread = api.get_custom_entity_access_metadata_by_key_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, async_req=True)
|
902
|
+
>>> thread = api.get_custom_entity_access_metadata_by_key_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, as_at, async_req=True)
|
1010
903
|
>>> result = thread.get()
|
1011
904
|
|
1012
905
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -1025,13 +918,14 @@ class CustomEntitiesApi(object):
|
|
1025
918
|
:type as_at: datetime
|
1026
919
|
:param async_req: Whether to execute the request asynchronously.
|
1027
920
|
:type async_req: bool, optional
|
1028
|
-
:param
|
1029
|
-
|
1030
|
-
|
1031
|
-
|
1032
|
-
be returned without reading/decoding response
|
1033
|
-
data. Default is True.
|
921
|
+
:param _preload_content: if False, the ApiResponse.data will
|
922
|
+
be set to none and raw_data will store the
|
923
|
+
HTTP response body without reading/decoding.
|
924
|
+
Default is True.
|
1034
925
|
:type _preload_content: bool, optional
|
926
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
927
|
+
object with status code, headers, etc
|
928
|
+
:type _return_http_data_only: bool, optional
|
1035
929
|
:param _request_timeout: timeout setting for this request. If one
|
1036
930
|
number provided, it will be total request
|
1037
931
|
timeout. It can also be a pair (tuple) of
|
@@ -1040,15 +934,16 @@ class CustomEntitiesApi(object):
|
|
1040
934
|
request; this effectively ignores the authentication
|
1041
935
|
in the spec for a single request.
|
1042
936
|
:type _request_auth: dict, optional
|
1043
|
-
:
|
937
|
+
:type _content_type: string, optional: force content-type for the request
|
938
|
+
:return: Returns the result object.
|
1044
939
|
If the method is called asynchronously,
|
1045
940
|
returns the request thread.
|
1046
|
-
:rtype: (
|
941
|
+
:rtype: tuple(List[AccessMetadataValue], status_code(int), headers(HTTPHeaderDict))
|
1047
942
|
"""
|
1048
943
|
|
1049
|
-
|
944
|
+
_params = locals()
|
1050
945
|
|
1051
|
-
|
946
|
+
_all_params = [
|
1052
947
|
'entity_type',
|
1053
948
|
'identifier_type',
|
1054
949
|
'identifier_value',
|
@@ -1057,156 +952,112 @@ class CustomEntitiesApi(object):
|
|
1057
952
|
'effective_at',
|
1058
953
|
'as_at'
|
1059
954
|
]
|
1060
|
-
|
955
|
+
_all_params.extend(
|
1061
956
|
[
|
1062
957
|
'async_req',
|
1063
958
|
'_return_http_data_only',
|
1064
959
|
'_preload_content',
|
1065
960
|
'_request_timeout',
|
1066
961
|
'_request_auth',
|
962
|
+
'_content_type',
|
1067
963
|
'_headers'
|
1068
964
|
]
|
1069
965
|
)
|
1070
966
|
|
1071
|
-
|
1072
|
-
|
967
|
+
# validate the arguments
|
968
|
+
for _key, _val in _params['kwargs'].items():
|
969
|
+
if _key not in _all_params:
|
1073
970
|
raise ApiTypeError(
|
1074
971
|
"Got an unexpected keyword argument '%s'"
|
1075
|
-
" to method get_custom_entity_access_metadata_by_key" %
|
972
|
+
" to method get_custom_entity_access_metadata_by_key" % _key
|
1076
973
|
)
|
1077
|
-
|
1078
|
-
del
|
1079
|
-
|
1080
|
-
|
1081
|
-
|
1082
|
-
|
1083
|
-
|
1084
|
-
if
|
1085
|
-
|
1086
|
-
raise ApiValueError("Missing the required parameter `identifier_type` when calling `get_custom_entity_access_metadata_by_key`") # noqa: E501
|
1087
|
-
# verify the required parameter 'identifier_value' is set
|
1088
|
-
if self.api_client.client_side_validation and ('identifier_value' not in local_var_params or # noqa: E501
|
1089
|
-
local_var_params['identifier_value'] is None): # noqa: E501
|
1090
|
-
raise ApiValueError("Missing the required parameter `identifier_value` when calling `get_custom_entity_access_metadata_by_key`") # noqa: E501
|
1091
|
-
# verify the required parameter 'metadata_key' is set
|
1092
|
-
if self.api_client.client_side_validation and ('metadata_key' not in local_var_params or # noqa: E501
|
1093
|
-
local_var_params['metadata_key'] is None): # noqa: E501
|
1094
|
-
raise ApiValueError("Missing the required parameter `metadata_key` when calling `get_custom_entity_access_metadata_by_key`") # noqa: E501
|
1095
|
-
# verify the required parameter 'identifier_scope' is set
|
1096
|
-
if self.api_client.client_side_validation and ('identifier_scope' not in local_var_params or # noqa: E501
|
1097
|
-
local_var_params['identifier_scope'] is None): # noqa: E501
|
1098
|
-
raise ApiValueError("Missing the required parameter `identifier_scope` when calling `get_custom_entity_access_metadata_by_key`") # noqa: E501
|
1099
|
-
|
1100
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
1101
|
-
len(local_var_params['entity_type']) > 64): # noqa: E501
|
1102
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `get_custom_entity_access_metadata_by_key`, length must be less than or equal to `64`") # noqa: E501
|
1103
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
1104
|
-
len(local_var_params['entity_type']) < 1): # noqa: E501
|
1105
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `get_custom_entity_access_metadata_by_key`, length must be greater than or equal to `1`") # noqa: E501
|
1106
|
-
if self.api_client.client_side_validation and 'entity_type' in local_var_params and not re.search(r'^~[a-zA-Z0-9\-_]+$', local_var_params['entity_type']): # noqa: E501
|
1107
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `get_custom_entity_access_metadata_by_key`, must conform to the pattern `/^~[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1108
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
1109
|
-
len(local_var_params['identifier_type']) > 64): # noqa: E501
|
1110
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `get_custom_entity_access_metadata_by_key`, length must be less than or equal to `64`") # noqa: E501
|
1111
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
1112
|
-
len(local_var_params['identifier_type']) < 1): # noqa: E501
|
1113
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `get_custom_entity_access_metadata_by_key`, length must be greater than or equal to `1`") # noqa: E501
|
1114
|
-
if self.api_client.client_side_validation and 'identifier_type' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_type']): # noqa: E501
|
1115
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `get_custom_entity_access_metadata_by_key`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1116
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
1117
|
-
len(local_var_params['identifier_value']) > 1024): # noqa: E501
|
1118
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `get_custom_entity_access_metadata_by_key`, length must be less than or equal to `1024`") # noqa: E501
|
1119
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
1120
|
-
len(local_var_params['identifier_value']) < 1): # noqa: E501
|
1121
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `get_custom_entity_access_metadata_by_key`, length must be greater than or equal to `1`") # noqa: E501
|
1122
|
-
if self.api_client.client_side_validation and 'identifier_value' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_value']): # noqa: E501
|
1123
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `get_custom_entity_access_metadata_by_key`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1124
|
-
if self.api_client.client_side_validation and ('metadata_key' in local_var_params and # noqa: E501
|
1125
|
-
len(local_var_params['metadata_key']) > 100): # noqa: E501
|
1126
|
-
raise ApiValueError("Invalid value for parameter `metadata_key` when calling `get_custom_entity_access_metadata_by_key`, length must be less than or equal to `100`") # noqa: E501
|
1127
|
-
if self.api_client.client_side_validation and ('metadata_key' in local_var_params and # noqa: E501
|
1128
|
-
len(local_var_params['metadata_key']) < 1): # noqa: E501
|
1129
|
-
raise ApiValueError("Invalid value for parameter `metadata_key` when calling `get_custom_entity_access_metadata_by_key`, length must be greater than or equal to `1`") # noqa: E501
|
1130
|
-
if self.api_client.client_side_validation and 'metadata_key' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['metadata_key']): # noqa: E501
|
1131
|
-
raise ApiValueError("Invalid value for parameter `metadata_key` when calling `get_custom_entity_access_metadata_by_key`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1132
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
1133
|
-
len(local_var_params['identifier_scope']) > 64): # noqa: E501
|
1134
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_custom_entity_access_metadata_by_key`, length must be less than or equal to `64`") # noqa: E501
|
1135
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
1136
|
-
len(local_var_params['identifier_scope']) < 1): # noqa: E501
|
1137
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_custom_entity_access_metadata_by_key`, length must be greater than or equal to `1`") # noqa: E501
|
1138
|
-
if self.api_client.client_side_validation and 'identifier_scope' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_scope']): # noqa: E501
|
1139
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_custom_entity_access_metadata_by_key`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1140
|
-
collection_formats = {}
|
1141
|
-
|
1142
|
-
path_params = {}
|
1143
|
-
if 'entity_type' in local_var_params:
|
1144
|
-
path_params['entityType'] = local_var_params['entity_type'] # noqa: E501
|
1145
|
-
if 'identifier_type' in local_var_params:
|
1146
|
-
path_params['identifierType'] = local_var_params['identifier_type'] # noqa: E501
|
1147
|
-
if 'identifier_value' in local_var_params:
|
1148
|
-
path_params['identifierValue'] = local_var_params['identifier_value'] # noqa: E501
|
1149
|
-
if 'metadata_key' in local_var_params:
|
1150
|
-
path_params['metadataKey'] = local_var_params['metadata_key'] # noqa: E501
|
1151
|
-
|
1152
|
-
query_params = []
|
1153
|
-
if 'identifier_scope' in local_var_params and local_var_params['identifier_scope'] is not None: # noqa: E501
|
1154
|
-
query_params.append(('identifierScope', local_var_params['identifier_scope'])) # noqa: E501
|
1155
|
-
if 'effective_at' in local_var_params and local_var_params['effective_at'] is not None: # noqa: E501
|
1156
|
-
query_params.append(('effectiveAt', local_var_params['effective_at'])) # noqa: E501
|
1157
|
-
if 'as_at' in local_var_params and local_var_params['as_at'] is not None: # noqa: E501
|
1158
|
-
query_params.append(('asAt', local_var_params['as_at'])) # noqa: E501
|
1159
|
-
|
1160
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
1161
|
-
|
1162
|
-
form_params = []
|
1163
|
-
local_var_files = {}
|
1164
|
-
|
1165
|
-
body_params = None
|
1166
|
-
# HTTP header `Accept`
|
1167
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
1168
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
974
|
+
_params[_key] = _val
|
975
|
+
del _params['kwargs']
|
976
|
+
|
977
|
+
_collection_formats = {}
|
978
|
+
|
979
|
+
# process the path parameters
|
980
|
+
_path_params = {}
|
981
|
+
if _params['entity_type']:
|
982
|
+
_path_params['entityType'] = _params['entity_type']
|
1169
983
|
|
1170
|
-
|
984
|
+
if _params['identifier_type']:
|
985
|
+
_path_params['identifierType'] = _params['identifier_type']
|
1171
986
|
|
987
|
+
if _params['identifier_value']:
|
988
|
+
_path_params['identifierValue'] = _params['identifier_value']
|
1172
989
|
|
1173
|
-
|
1174
|
-
|
1175
|
-
header_params['X-LUSID-SDK-Version'] = '1.1.118'
|
990
|
+
if _params['metadata_key']:
|
991
|
+
_path_params['metadataKey'] = _params['metadata_key']
|
1176
992
|
|
1177
|
-
# Authentication setting
|
1178
|
-
auth_settings = ['oauth2'] # noqa: E501
|
1179
993
|
|
1180
|
-
|
1181
|
-
|
1182
|
-
|
994
|
+
# process the query parameters
|
995
|
+
_query_params = []
|
996
|
+
if _params.get('identifier_scope') is not None: # noqa: E501
|
997
|
+
_query_params.append(('identifierScope', _params['identifier_scope']))
|
998
|
+
|
999
|
+
if _params.get('effective_at') is not None: # noqa: E501
|
1000
|
+
_query_params.append(('effectiveAt', _params['effective_at']))
|
1001
|
+
|
1002
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1003
|
+
if isinstance(_params['as_at'], datetime):
|
1004
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1005
|
+
else:
|
1006
|
+
_query_params.append(('asAt', _params['as_at']))
|
1007
|
+
|
1008
|
+
# process the header parameters
|
1009
|
+
_header_params = dict(_params.get('_headers', {}))
|
1010
|
+
# process the form parameters
|
1011
|
+
_form_params = []
|
1012
|
+
_files = {}
|
1013
|
+
# process the body parameter
|
1014
|
+
_body_params = None
|
1015
|
+
# set the HTTP header `Accept`
|
1016
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1017
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1018
|
+
|
1019
|
+
# authentication setting
|
1020
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1021
|
+
|
1022
|
+
_response_types_map = {
|
1023
|
+
'200': "List[AccessMetadataValue]",
|
1024
|
+
'400': "LusidValidationProblemDetails",
|
1183
1025
|
}
|
1184
1026
|
|
1185
1027
|
return self.api_client.call_api(
|
1186
1028
|
'/api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata/{metadataKey}', 'GET',
|
1187
|
-
|
1188
|
-
|
1189
|
-
|
1190
|
-
body=
|
1191
|
-
post_params=
|
1192
|
-
files=
|
1193
|
-
response_types_map=
|
1194
|
-
auth_settings=
|
1195
|
-
async_req=
|
1196
|
-
_return_http_data_only=
|
1197
|
-
_preload_content=
|
1198
|
-
_request_timeout=
|
1199
|
-
collection_formats=
|
1200
|
-
_request_auth=
|
1201
|
-
|
1202
|
-
|
1029
|
+
_path_params,
|
1030
|
+
_query_params,
|
1031
|
+
_header_params,
|
1032
|
+
body=_body_params,
|
1033
|
+
post_params=_form_params,
|
1034
|
+
files=_files,
|
1035
|
+
response_types_map=_response_types_map,
|
1036
|
+
auth_settings=_auth_settings,
|
1037
|
+
async_req=_params.get('async_req'),
|
1038
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1039
|
+
_preload_content=_params.get('_preload_content', True),
|
1040
|
+
_request_timeout=_params.get('_request_timeout'),
|
1041
|
+
collection_formats=_collection_formats,
|
1042
|
+
_request_auth=_params.get('_request_auth'))
|
1043
|
+
|
1044
|
+
@overload
|
1045
|
+
async def get_custom_entity_relationships(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, **kwargs) -> ResourceListOfRelationship: # noqa: E501
|
1046
|
+
...
|
1047
|
+
|
1048
|
+
@overload
|
1049
|
+
def get_custom_entity_relationships(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelationship: # noqa: E501
|
1050
|
+
...
|
1051
|
+
|
1052
|
+
@validate_arguments
|
1053
|
+
def get_custom_entity_relationships(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
|
1203
1054
|
"""[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity # noqa: E501
|
1204
1055
|
|
1205
1056
|
Get relationships for the specified Custom Entity. # noqa: E501
|
1206
1057
|
This method makes a synchronous HTTP request by default. To make an
|
1207
1058
|
asynchronous HTTP request, please pass async_req=True
|
1208
1059
|
|
1209
|
-
>>> thread = api.get_custom_entity_relationships(entity_type, identifier_scope, identifier_type, identifier_value, async_req=True)
|
1060
|
+
>>> thread = api.get_custom_entity_relationships(entity_type, identifier_scope, identifier_type, identifier_value, effective_at, as_at, filter, identifier_types, async_req=True)
|
1210
1061
|
>>> result = thread.get()
|
1211
1062
|
|
1212
1063
|
:param entity_type: The type of entity get relationships for. (required)
|
@@ -1224,33 +1075,35 @@ class CustomEntitiesApi(object):
|
|
1224
1075
|
:param filter: Expression to filter relationships. Users should provide null or empty string for this field until further notice.
|
1225
1076
|
:type filter: str
|
1226
1077
|
:param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.
|
1227
|
-
:type identifier_types:
|
1078
|
+
:type identifier_types: List[str]
|
1228
1079
|
:param async_req: Whether to execute the request asynchronously.
|
1229
1080
|
:type async_req: bool, optional
|
1230
|
-
:param
|
1231
|
-
|
1232
|
-
|
1233
|
-
|
1234
|
-
:param _request_timeout: timeout setting for this request. If one
|
1235
|
-
number provided, it will be total request
|
1236
|
-
timeout. It can also be a pair (tuple) of
|
1237
|
-
(connection, read) timeouts.
|
1081
|
+
:param _request_timeout: timeout setting for this request.
|
1082
|
+
If one number provided, it will be total request
|
1083
|
+
timeout. It can also be a pair (tuple) of
|
1084
|
+
(connection, read) timeouts.
|
1238
1085
|
:return: Returns the result object.
|
1239
1086
|
If the method is called asynchronously,
|
1240
1087
|
returns the request thread.
|
1241
1088
|
:rtype: ResourceListOfRelationship
|
1242
1089
|
"""
|
1243
1090
|
kwargs['_return_http_data_only'] = True
|
1244
|
-
|
1245
|
-
|
1246
|
-
|
1091
|
+
if '_preload_content' in kwargs:
|
1092
|
+
message = "Error! Please call the get_custom_entity_relationships_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1093
|
+
raise ValueError(message)
|
1094
|
+
if async_req is not None:
|
1095
|
+
kwargs['async_req'] = async_req
|
1096
|
+
return self.get_custom_entity_relationships_with_http_info(entity_type, identifier_scope, identifier_type, identifier_value, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
|
1097
|
+
|
1098
|
+
@validate_arguments
|
1099
|
+
def get_custom_entity_relationships_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1247
1100
|
"""[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity # noqa: E501
|
1248
1101
|
|
1249
1102
|
Get relationships for the specified Custom Entity. # noqa: E501
|
1250
1103
|
This method makes a synchronous HTTP request by default. To make an
|
1251
1104
|
asynchronous HTTP request, please pass async_req=True
|
1252
1105
|
|
1253
|
-
>>> thread = api.get_custom_entity_relationships_with_http_info(entity_type, identifier_scope, identifier_type, identifier_value, async_req=True)
|
1106
|
+
>>> thread = api.get_custom_entity_relationships_with_http_info(entity_type, identifier_scope, identifier_type, identifier_value, effective_at, as_at, filter, identifier_types, async_req=True)
|
1254
1107
|
>>> result = thread.get()
|
1255
1108
|
|
1256
1109
|
:param entity_type: The type of entity get relationships for. (required)
|
@@ -1268,16 +1121,17 @@ class CustomEntitiesApi(object):
|
|
1268
1121
|
:param filter: Expression to filter relationships. Users should provide null or empty string for this field until further notice.
|
1269
1122
|
:type filter: str
|
1270
1123
|
:param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.
|
1271
|
-
:type identifier_types:
|
1124
|
+
:type identifier_types: List[str]
|
1272
1125
|
:param async_req: Whether to execute the request asynchronously.
|
1273
1126
|
:type async_req: bool, optional
|
1274
|
-
:param
|
1275
|
-
|
1276
|
-
|
1277
|
-
|
1278
|
-
be returned without reading/decoding response
|
1279
|
-
data. Default is True.
|
1127
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1128
|
+
be set to none and raw_data will store the
|
1129
|
+
HTTP response body without reading/decoding.
|
1130
|
+
Default is True.
|
1280
1131
|
:type _preload_content: bool, optional
|
1132
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1133
|
+
object with status code, headers, etc
|
1134
|
+
:type _return_http_data_only: bool, optional
|
1281
1135
|
:param _request_timeout: timeout setting for this request. If one
|
1282
1136
|
number provided, it will be total request
|
1283
1137
|
timeout. It can also be a pair (tuple) of
|
@@ -1286,15 +1140,16 @@ class CustomEntitiesApi(object):
|
|
1286
1140
|
request; this effectively ignores the authentication
|
1287
1141
|
in the spec for a single request.
|
1288
1142
|
:type _request_auth: dict, optional
|
1289
|
-
:
|
1143
|
+
:type _content_type: string, optional: force content-type for the request
|
1144
|
+
:return: Returns the result object.
|
1290
1145
|
If the method is called asynchronously,
|
1291
1146
|
returns the request thread.
|
1292
|
-
:rtype: (ResourceListOfRelationship, int, HTTPHeaderDict)
|
1147
|
+
:rtype: tuple(ResourceListOfRelationship, status_code(int), headers(HTTPHeaderDict))
|
1293
1148
|
"""
|
1294
1149
|
|
1295
|
-
|
1150
|
+
_params = locals()
|
1296
1151
|
|
1297
|
-
|
1152
|
+
_all_params = [
|
1298
1153
|
'entity_type',
|
1299
1154
|
'identifier_scope',
|
1300
1155
|
'identifier_type',
|
@@ -1304,161 +1159,116 @@ class CustomEntitiesApi(object):
|
|
1304
1159
|
'filter',
|
1305
1160
|
'identifier_types'
|
1306
1161
|
]
|
1307
|
-
|
1162
|
+
_all_params.extend(
|
1308
1163
|
[
|
1309
1164
|
'async_req',
|
1310
1165
|
'_return_http_data_only',
|
1311
1166
|
'_preload_content',
|
1312
1167
|
'_request_timeout',
|
1313
1168
|
'_request_auth',
|
1169
|
+
'_content_type',
|
1314
1170
|
'_headers'
|
1315
1171
|
]
|
1316
1172
|
)
|
1317
1173
|
|
1318
|
-
|
1319
|
-
|
1174
|
+
# validate the arguments
|
1175
|
+
for _key, _val in _params['kwargs'].items():
|
1176
|
+
if _key not in _all_params:
|
1320
1177
|
raise ApiTypeError(
|
1321
1178
|
"Got an unexpected keyword argument '%s'"
|
1322
|
-
" to method get_custom_entity_relationships" %
|
1179
|
+
" to method get_custom_entity_relationships" % _key
|
1323
1180
|
)
|
1324
|
-
|
1325
|
-
del
|
1326
|
-
|
1327
|
-
|
1328
|
-
local_var_params['entity_type'] is None): # noqa: E501
|
1329
|
-
raise ApiValueError("Missing the required parameter `entity_type` when calling `get_custom_entity_relationships`") # noqa: E501
|
1330
|
-
# verify the required parameter 'identifier_scope' is set
|
1331
|
-
if self.api_client.client_side_validation and ('identifier_scope' not in local_var_params or # noqa: E501
|
1332
|
-
local_var_params['identifier_scope'] is None): # noqa: E501
|
1333
|
-
raise ApiValueError("Missing the required parameter `identifier_scope` when calling `get_custom_entity_relationships`") # noqa: E501
|
1334
|
-
# verify the required parameter 'identifier_type' is set
|
1335
|
-
if self.api_client.client_side_validation and ('identifier_type' not in local_var_params or # noqa: E501
|
1336
|
-
local_var_params['identifier_type'] is None): # noqa: E501
|
1337
|
-
raise ApiValueError("Missing the required parameter `identifier_type` when calling `get_custom_entity_relationships`") # noqa: E501
|
1338
|
-
# verify the required parameter 'identifier_value' is set
|
1339
|
-
if self.api_client.client_side_validation and ('identifier_value' not in local_var_params or # noqa: E501
|
1340
|
-
local_var_params['identifier_value'] is None): # noqa: E501
|
1341
|
-
raise ApiValueError("Missing the required parameter `identifier_value` when calling `get_custom_entity_relationships`") # noqa: E501
|
1342
|
-
|
1343
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
1344
|
-
len(local_var_params['entity_type']) > 65): # noqa: E501
|
1345
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `get_custom_entity_relationships`, length must be less than or equal to `65`") # noqa: E501
|
1346
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
1347
|
-
len(local_var_params['entity_type']) < 1): # noqa: E501
|
1348
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `get_custom_entity_relationships`, length must be greater than or equal to `1`") # noqa: E501
|
1349
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
1350
|
-
len(local_var_params['identifier_scope']) > 64): # noqa: E501
|
1351
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_custom_entity_relationships`, length must be less than or equal to `64`") # noqa: E501
|
1352
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
1353
|
-
len(local_var_params['identifier_scope']) < 1): # noqa: E501
|
1354
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_custom_entity_relationships`, length must be greater than or equal to `1`") # noqa: E501
|
1355
|
-
if self.api_client.client_side_validation and 'identifier_scope' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_scope']): # noqa: E501
|
1356
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `get_custom_entity_relationships`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1357
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
1358
|
-
len(local_var_params['identifier_type']) > 64): # noqa: E501
|
1359
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `get_custom_entity_relationships`, length must be less than or equal to `64`") # noqa: E501
|
1360
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
1361
|
-
len(local_var_params['identifier_type']) < 1): # noqa: E501
|
1362
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `get_custom_entity_relationships`, length must be greater than or equal to `1`") # noqa: E501
|
1363
|
-
if self.api_client.client_side_validation and 'identifier_type' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_type']): # noqa: E501
|
1364
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `get_custom_entity_relationships`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1365
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
1366
|
-
len(local_var_params['identifier_value']) > 1024): # noqa: E501
|
1367
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `get_custom_entity_relationships`, length must be less than or equal to `1024`") # noqa: E501
|
1368
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
1369
|
-
len(local_var_params['identifier_value']) < 1): # noqa: E501
|
1370
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `get_custom_entity_relationships`, length must be greater than or equal to `1`") # noqa: E501
|
1371
|
-
if self.api_client.client_side_validation and 'identifier_value' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_value']): # noqa: E501
|
1372
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `get_custom_entity_relationships`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1373
|
-
if self.api_client.client_side_validation and ('effective_at' in local_var_params and # noqa: E501
|
1374
|
-
len(local_var_params['effective_at']) > 256): # noqa: E501
|
1375
|
-
raise ApiValueError("Invalid value for parameter `effective_at` when calling `get_custom_entity_relationships`, length must be less than or equal to `256`") # noqa: E501
|
1376
|
-
if self.api_client.client_side_validation and ('effective_at' in local_var_params and # noqa: E501
|
1377
|
-
len(local_var_params['effective_at']) < 0): # noqa: E501
|
1378
|
-
raise ApiValueError("Invalid value for parameter `effective_at` when calling `get_custom_entity_relationships`, length must be greater than or equal to `0`") # noqa: E501
|
1379
|
-
if self.api_client.client_side_validation and 'effective_at' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_\+:\.]+$', local_var_params['effective_at']): # noqa: E501
|
1380
|
-
raise ApiValueError("Invalid value for parameter `effective_at` when calling `get_custom_entity_relationships`, must conform to the pattern `/^[a-zA-Z0-9\-_\+:\.]+$/`") # noqa: E501
|
1381
|
-
if self.api_client.client_side_validation and ('filter' in local_var_params and # noqa: E501
|
1382
|
-
len(local_var_params['filter']) > 16384): # noqa: E501
|
1383
|
-
raise ApiValueError("Invalid value for parameter `filter` when calling `get_custom_entity_relationships`, length must be less than or equal to `16384`") # noqa: E501
|
1384
|
-
if self.api_client.client_side_validation and ('filter' in local_var_params and # noqa: E501
|
1385
|
-
len(local_var_params['filter']) < 0): # noqa: E501
|
1386
|
-
raise ApiValueError("Invalid value for parameter `filter` when calling `get_custom_entity_relationships`, length must be greater than or equal to `0`") # noqa: E501
|
1387
|
-
if self.api_client.client_side_validation and 'filter' in local_var_params and not re.search(r'^[\s\S]*$', local_var_params['filter']): # noqa: E501
|
1388
|
-
raise ApiValueError("Invalid value for parameter `filter` when calling `get_custom_entity_relationships`, must conform to the pattern `/^[\s\S]*$/`") # noqa: E501
|
1389
|
-
collection_formats = {}
|
1390
|
-
|
1391
|
-
path_params = {}
|
1392
|
-
if 'entity_type' in local_var_params:
|
1393
|
-
path_params['entityType'] = local_var_params['entity_type'] # noqa: E501
|
1394
|
-
if 'identifier_type' in local_var_params:
|
1395
|
-
path_params['identifierType'] = local_var_params['identifier_type'] # noqa: E501
|
1396
|
-
if 'identifier_value' in local_var_params:
|
1397
|
-
path_params['identifierValue'] = local_var_params['identifier_value'] # noqa: E501
|
1398
|
-
|
1399
|
-
query_params = []
|
1400
|
-
if 'identifier_scope' in local_var_params and local_var_params['identifier_scope'] is not None: # noqa: E501
|
1401
|
-
query_params.append(('identifierScope', local_var_params['identifier_scope'])) # noqa: E501
|
1402
|
-
if 'effective_at' in local_var_params and local_var_params['effective_at'] is not None: # noqa: E501
|
1403
|
-
query_params.append(('effectiveAt', local_var_params['effective_at'])) # noqa: E501
|
1404
|
-
if 'as_at' in local_var_params and local_var_params['as_at'] is not None: # noqa: E501
|
1405
|
-
query_params.append(('asAt', local_var_params['as_at'])) # noqa: E501
|
1406
|
-
if 'filter' in local_var_params and local_var_params['filter'] is not None: # noqa: E501
|
1407
|
-
query_params.append(('filter', local_var_params['filter'])) # noqa: E501
|
1408
|
-
if 'identifier_types' in local_var_params and local_var_params['identifier_types'] is not None: # noqa: E501
|
1409
|
-
query_params.append(('identifierTypes', local_var_params['identifier_types'])) # noqa: E501
|
1410
|
-
collection_formats['identifierTypes'] = 'multi' # noqa: E501
|
1411
|
-
|
1412
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
1413
|
-
|
1414
|
-
form_params = []
|
1415
|
-
local_var_files = {}
|
1416
|
-
|
1417
|
-
body_params = None
|
1418
|
-
# HTTP header `Accept`
|
1419
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
1420
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1181
|
+
_params[_key] = _val
|
1182
|
+
del _params['kwargs']
|
1183
|
+
|
1184
|
+
_collection_formats = {}
|
1421
1185
|
|
1422
|
-
|
1186
|
+
# process the path parameters
|
1187
|
+
_path_params = {}
|
1188
|
+
if _params['entity_type']:
|
1189
|
+
_path_params['entityType'] = _params['entity_type']
|
1423
1190
|
|
1191
|
+
if _params['identifier_type']:
|
1192
|
+
_path_params['identifierType'] = _params['identifier_type']
|
1424
1193
|
|
1425
|
-
|
1426
|
-
|
1427
|
-
header_params['X-LUSID-SDK-Version'] = '1.1.118'
|
1194
|
+
if _params['identifier_value']:
|
1195
|
+
_path_params['identifierValue'] = _params['identifier_value']
|
1428
1196
|
|
1429
|
-
# Authentication setting
|
1430
|
-
auth_settings = ['oauth2'] # noqa: E501
|
1431
1197
|
|
1432
|
-
|
1433
|
-
|
1434
|
-
|
1198
|
+
# process the query parameters
|
1199
|
+
_query_params = []
|
1200
|
+
if _params.get('identifier_scope') is not None: # noqa: E501
|
1201
|
+
_query_params.append(('identifierScope', _params['identifier_scope']))
|
1202
|
+
|
1203
|
+
if _params.get('effective_at') is not None: # noqa: E501
|
1204
|
+
_query_params.append(('effectiveAt', _params['effective_at']))
|
1205
|
+
|
1206
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1207
|
+
if isinstance(_params['as_at'], datetime):
|
1208
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1209
|
+
else:
|
1210
|
+
_query_params.append(('asAt', _params['as_at']))
|
1211
|
+
|
1212
|
+
if _params.get('filter') is not None: # noqa: E501
|
1213
|
+
_query_params.append(('filter', _params['filter']))
|
1214
|
+
|
1215
|
+
if _params.get('identifier_types') is not None: # noqa: E501
|
1216
|
+
_query_params.append(('identifierTypes', _params['identifier_types']))
|
1217
|
+
_collection_formats['identifierTypes'] = 'multi'
|
1218
|
+
|
1219
|
+
# process the header parameters
|
1220
|
+
_header_params = dict(_params.get('_headers', {}))
|
1221
|
+
# process the form parameters
|
1222
|
+
_form_params = []
|
1223
|
+
_files = {}
|
1224
|
+
# process the body parameter
|
1225
|
+
_body_params = None
|
1226
|
+
# set the HTTP header `Accept`
|
1227
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1228
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1229
|
+
|
1230
|
+
# authentication setting
|
1231
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1232
|
+
|
1233
|
+
_response_types_map = {
|
1234
|
+
'200': "ResourceListOfRelationship",
|
1235
|
+
'400': "LusidValidationProblemDetails",
|
1435
1236
|
}
|
1436
1237
|
|
1437
1238
|
return self.api_client.call_api(
|
1438
1239
|
'/api/customentities/{entityType}/{identifierType}/{identifierValue}/relationships', 'GET',
|
1439
|
-
|
1440
|
-
|
1441
|
-
|
1442
|
-
body=
|
1443
|
-
post_params=
|
1444
|
-
files=
|
1445
|
-
response_types_map=
|
1446
|
-
auth_settings=
|
1447
|
-
async_req=
|
1448
|
-
_return_http_data_only=
|
1449
|
-
_preload_content=
|
1450
|
-
_request_timeout=
|
1451
|
-
collection_formats=
|
1452
|
-
_request_auth=
|
1453
|
-
|
1454
|
-
|
1240
|
+
_path_params,
|
1241
|
+
_query_params,
|
1242
|
+
_header_params,
|
1243
|
+
body=_body_params,
|
1244
|
+
post_params=_form_params,
|
1245
|
+
files=_files,
|
1246
|
+
response_types_map=_response_types_map,
|
1247
|
+
auth_settings=_auth_settings,
|
1248
|
+
async_req=_params.get('async_req'),
|
1249
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1250
|
+
_preload_content=_params.get('_preload_content', True),
|
1251
|
+
_request_timeout=_params.get('_request_timeout'),
|
1252
|
+
collection_formats=_collection_formats,
|
1253
|
+
_request_auth=_params.get('_request_auth'))
|
1254
|
+
|
1255
|
+
@overload
|
1256
|
+
async def list_custom_entities(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> PagedResourceListOfCustomEntityResponse: # noqa: E501
|
1257
|
+
...
|
1258
|
+
|
1259
|
+
@overload
|
1260
|
+
def list_custom_entities(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfCustomEntityResponse: # noqa: E501
|
1261
|
+
...
|
1262
|
+
|
1263
|
+
@validate_arguments
|
1264
|
+
def list_custom_entities(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCustomEntityResponse, Awaitable[PagedResourceListOfCustomEntityResponse]]: # noqa: E501
|
1455
1265
|
"""[EARLY ACCESS] ListCustomEntities: List Custom Entities of the specified entityType. # noqa: E501
|
1456
1266
|
|
1457
1267
|
List all the Custom Entities matching particular criteria. # noqa: E501
|
1458
1268
|
This method makes a synchronous HTTP request by default. To make an
|
1459
1269
|
asynchronous HTTP request, please pass async_req=True
|
1460
1270
|
|
1461
|
-
>>> thread = api.list_custom_entities(entity_type, async_req=True)
|
1271
|
+
>>> thread = api.list_custom_entities(entity_type, effective_at, as_at, limit, filter, sort_by, page, related_entity_property_keys, relationship_definition_ids, async_req=True)
|
1462
1272
|
>>> result = thread.get()
|
1463
1273
|
|
1464
1274
|
:param entity_type: The type of Custom Entity to list. (required)
|
@@ -1471,40 +1281,42 @@ class CustomEntitiesApi(object):
|
|
1471
1281
|
:type limit: int
|
1472
1282
|
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
1473
1283
|
:type filter: str
|
1474
|
-
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1475
|
-
:type sort_by:
|
1284
|
+
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1285
|
+
:type sort_by: List[str]
|
1476
1286
|
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
1477
1287
|
:type page: str
|
1478
1288
|
:param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
1479
|
-
:type related_entity_property_keys:
|
1289
|
+
:type related_entity_property_keys: List[str]
|
1480
1290
|
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
1481
|
-
:type relationship_definition_ids:
|
1291
|
+
:type relationship_definition_ids: List[str]
|
1482
1292
|
:param async_req: Whether to execute the request asynchronously.
|
1483
1293
|
:type async_req: bool, optional
|
1484
|
-
:param
|
1485
|
-
|
1486
|
-
|
1487
|
-
|
1488
|
-
:param _request_timeout: timeout setting for this request. If one
|
1489
|
-
number provided, it will be total request
|
1490
|
-
timeout. It can also be a pair (tuple) of
|
1491
|
-
(connection, read) timeouts.
|
1294
|
+
:param _request_timeout: timeout setting for this request.
|
1295
|
+
If one number provided, it will be total request
|
1296
|
+
timeout. It can also be a pair (tuple) of
|
1297
|
+
(connection, read) timeouts.
|
1492
1298
|
:return: Returns the result object.
|
1493
1299
|
If the method is called asynchronously,
|
1494
1300
|
returns the request thread.
|
1495
1301
|
:rtype: PagedResourceListOfCustomEntityResponse
|
1496
1302
|
"""
|
1497
1303
|
kwargs['_return_http_data_only'] = True
|
1498
|
-
|
1499
|
-
|
1500
|
-
|
1304
|
+
if '_preload_content' in kwargs:
|
1305
|
+
message = "Error! Please call the list_custom_entities_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1306
|
+
raise ValueError(message)
|
1307
|
+
if async_req is not None:
|
1308
|
+
kwargs['async_req'] = async_req
|
1309
|
+
return self.list_custom_entities_with_http_info(entity_type, effective_at, as_at, limit, filter, sort_by, page, related_entity_property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
1310
|
+
|
1311
|
+
@validate_arguments
|
1312
|
+
def list_custom_entities_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1501
1313
|
"""[EARLY ACCESS] ListCustomEntities: List Custom Entities of the specified entityType. # noqa: E501
|
1502
1314
|
|
1503
1315
|
List all the Custom Entities matching particular criteria. # noqa: E501
|
1504
1316
|
This method makes a synchronous HTTP request by default. To make an
|
1505
1317
|
asynchronous HTTP request, please pass async_req=True
|
1506
1318
|
|
1507
|
-
>>> thread = api.list_custom_entities_with_http_info(entity_type, async_req=True)
|
1319
|
+
>>> thread = api.list_custom_entities_with_http_info(entity_type, effective_at, as_at, limit, filter, sort_by, page, related_entity_property_keys, relationship_definition_ids, async_req=True)
|
1508
1320
|
>>> result = thread.get()
|
1509
1321
|
|
1510
1322
|
:param entity_type: The type of Custom Entity to list. (required)
|
@@ -1517,23 +1329,24 @@ class CustomEntitiesApi(object):
|
|
1517
1329
|
:type limit: int
|
1518
1330
|
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
1519
1331
|
:type filter: str
|
1520
|
-
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1521
|
-
:type sort_by:
|
1332
|
+
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1333
|
+
:type sort_by: List[str]
|
1522
1334
|
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
1523
1335
|
:type page: str
|
1524
1336
|
:param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
1525
|
-
:type related_entity_property_keys:
|
1337
|
+
:type related_entity_property_keys: List[str]
|
1526
1338
|
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
1527
|
-
:type relationship_definition_ids:
|
1339
|
+
:type relationship_definition_ids: List[str]
|
1528
1340
|
:param async_req: Whether to execute the request asynchronously.
|
1529
1341
|
:type async_req: bool, optional
|
1530
|
-
:param
|
1531
|
-
|
1532
|
-
|
1533
|
-
|
1534
|
-
be returned without reading/decoding response
|
1535
|
-
data. Default is True.
|
1342
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1343
|
+
be set to none and raw_data will store the
|
1344
|
+
HTTP response body without reading/decoding.
|
1345
|
+
Default is True.
|
1536
1346
|
:type _preload_content: bool, optional
|
1347
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1348
|
+
object with status code, headers, etc
|
1349
|
+
:type _return_http_data_only: bool, optional
|
1537
1350
|
:param _request_timeout: timeout setting for this request. If one
|
1538
1351
|
number provided, it will be total request
|
1539
1352
|
timeout. It can also be a pair (tuple) of
|
@@ -1542,15 +1355,16 @@ class CustomEntitiesApi(object):
|
|
1542
1355
|
request; this effectively ignores the authentication
|
1543
1356
|
in the spec for a single request.
|
1544
1357
|
:type _request_auth: dict, optional
|
1545
|
-
:
|
1358
|
+
:type _content_type: string, optional: force content-type for the request
|
1359
|
+
:return: Returns the result object.
|
1546
1360
|
If the method is called asynchronously,
|
1547
1361
|
returns the request thread.
|
1548
|
-
:rtype: (PagedResourceListOfCustomEntityResponse, int, HTTPHeaderDict)
|
1362
|
+
:rtype: tuple(PagedResourceListOfCustomEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
1549
1363
|
"""
|
1550
1364
|
|
1551
|
-
|
1365
|
+
_params = locals()
|
1552
1366
|
|
1553
|
-
|
1367
|
+
_all_params = [
|
1554
1368
|
'entity_type',
|
1555
1369
|
'effective_at',
|
1556
1370
|
'as_at',
|
@@ -1561,133 +1375,121 @@ class CustomEntitiesApi(object):
|
|
1561
1375
|
'related_entity_property_keys',
|
1562
1376
|
'relationship_definition_ids'
|
1563
1377
|
]
|
1564
|
-
|
1378
|
+
_all_params.extend(
|
1565
1379
|
[
|
1566
1380
|
'async_req',
|
1567
1381
|
'_return_http_data_only',
|
1568
1382
|
'_preload_content',
|
1569
1383
|
'_request_timeout',
|
1570
1384
|
'_request_auth',
|
1385
|
+
'_content_type',
|
1571
1386
|
'_headers'
|
1572
1387
|
]
|
1573
1388
|
)
|
1574
1389
|
|
1575
|
-
|
1576
|
-
|
1390
|
+
# validate the arguments
|
1391
|
+
for _key, _val in _params['kwargs'].items():
|
1392
|
+
if _key not in _all_params:
|
1577
1393
|
raise ApiTypeError(
|
1578
1394
|
"Got an unexpected keyword argument '%s'"
|
1579
|
-
" to method list_custom_entities" %
|
1395
|
+
" to method list_custom_entities" % _key
|
1580
1396
|
)
|
1581
|
-
|
1582
|
-
del
|
1583
|
-
|
1584
|
-
|
1585
|
-
|
1586
|
-
|
1587
|
-
|
1588
|
-
if
|
1589
|
-
|
1590
|
-
|
1591
|
-
|
1592
|
-
|
1593
|
-
|
1594
|
-
if
|
1595
|
-
|
1596
|
-
|
1597
|
-
|
1598
|
-
|
1599
|
-
|
1600
|
-
|
1601
|
-
|
1602
|
-
|
1603
|
-
|
1604
|
-
|
1605
|
-
|
1606
|
-
if
|
1607
|
-
|
1608
|
-
|
1609
|
-
if
|
1610
|
-
|
1611
|
-
|
1612
|
-
|
1613
|
-
|
1614
|
-
|
1615
|
-
|
1616
|
-
|
1617
|
-
|
1618
|
-
|
1619
|
-
|
1620
|
-
|
1621
|
-
|
1622
|
-
|
1623
|
-
|
1624
|
-
|
1625
|
-
|
1626
|
-
|
1627
|
-
|
1628
|
-
|
1629
|
-
|
1630
|
-
|
1631
|
-
|
1632
|
-
|
1633
|
-
query_params.append(('page', local_var_params['page'])) # noqa: E501
|
1634
|
-
if 'related_entity_property_keys' in local_var_params and local_var_params['related_entity_property_keys'] is not None: # noqa: E501
|
1635
|
-
query_params.append(('relatedEntityPropertyKeys', local_var_params['related_entity_property_keys'])) # noqa: E501
|
1636
|
-
collection_formats['relatedEntityPropertyKeys'] = 'multi' # noqa: E501
|
1637
|
-
if 'relationship_definition_ids' in local_var_params and local_var_params['relationship_definition_ids'] is not None: # noqa: E501
|
1638
|
-
query_params.append(('relationshipDefinitionIds', local_var_params['relationship_definition_ids'])) # noqa: E501
|
1639
|
-
collection_formats['relationshipDefinitionIds'] = 'multi' # noqa: E501
|
1640
|
-
|
1641
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
1642
|
-
|
1643
|
-
form_params = []
|
1644
|
-
local_var_files = {}
|
1645
|
-
|
1646
|
-
body_params = None
|
1647
|
-
# HTTP header `Accept`
|
1648
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
1397
|
+
_params[_key] = _val
|
1398
|
+
del _params['kwargs']
|
1399
|
+
|
1400
|
+
_collection_formats = {}
|
1401
|
+
|
1402
|
+
# process the path parameters
|
1403
|
+
_path_params = {}
|
1404
|
+
if _params['entity_type']:
|
1405
|
+
_path_params['entityType'] = _params['entity_type']
|
1406
|
+
|
1407
|
+
|
1408
|
+
# process the query parameters
|
1409
|
+
_query_params = []
|
1410
|
+
if _params.get('effective_at') is not None: # noqa: E501
|
1411
|
+
_query_params.append(('effectiveAt', _params['effective_at']))
|
1412
|
+
|
1413
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1414
|
+
if isinstance(_params['as_at'], datetime):
|
1415
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1416
|
+
else:
|
1417
|
+
_query_params.append(('asAt', _params['as_at']))
|
1418
|
+
|
1419
|
+
if _params.get('limit') is not None: # noqa: E501
|
1420
|
+
_query_params.append(('limit', _params['limit']))
|
1421
|
+
|
1422
|
+
if _params.get('filter') is not None: # noqa: E501
|
1423
|
+
_query_params.append(('filter', _params['filter']))
|
1424
|
+
|
1425
|
+
if _params.get('sort_by') is not None: # noqa: E501
|
1426
|
+
_query_params.append(('sortBy', _params['sort_by']))
|
1427
|
+
_collection_formats['sortBy'] = 'multi'
|
1428
|
+
|
1429
|
+
if _params.get('page') is not None: # noqa: E501
|
1430
|
+
_query_params.append(('page', _params['page']))
|
1431
|
+
|
1432
|
+
if _params.get('related_entity_property_keys') is not None: # noqa: E501
|
1433
|
+
_query_params.append(('relatedEntityPropertyKeys', _params['related_entity_property_keys']))
|
1434
|
+
_collection_formats['relatedEntityPropertyKeys'] = 'multi'
|
1435
|
+
|
1436
|
+
if _params.get('relationship_definition_ids') is not None: # noqa: E501
|
1437
|
+
_query_params.append(('relationshipDefinitionIds', _params['relationship_definition_ids']))
|
1438
|
+
_collection_formats['relationshipDefinitionIds'] = 'multi'
|
1439
|
+
|
1440
|
+
# process the header parameters
|
1441
|
+
_header_params = dict(_params.get('_headers', {}))
|
1442
|
+
# process the form parameters
|
1443
|
+
_form_params = []
|
1444
|
+
_files = {}
|
1445
|
+
# process the body parameter
|
1446
|
+
_body_params = None
|
1447
|
+
# set the HTTP header `Accept`
|
1448
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1649
1449
|
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1650
1450
|
|
1651
|
-
|
1451
|
+
# authentication setting
|
1452
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1652
1453
|
|
1653
|
-
|
1654
|
-
|
1655
|
-
|
1656
|
-
header_params['X-LUSID-SDK-Version'] = '1.1.118'
|
1657
|
-
|
1658
|
-
# Authentication setting
|
1659
|
-
auth_settings = ['oauth2'] # noqa: E501
|
1660
|
-
|
1661
|
-
response_types_map = {
|
1662
|
-
200: "PagedResourceListOfCustomEntityResponse",
|
1663
|
-
400: "LusidValidationProblemDetails",
|
1454
|
+
_response_types_map = {
|
1455
|
+
'200': "PagedResourceListOfCustomEntityResponse",
|
1456
|
+
'400': "LusidValidationProblemDetails",
|
1664
1457
|
}
|
1665
1458
|
|
1666
1459
|
return self.api_client.call_api(
|
1667
1460
|
'/api/customentities/{entityType}', 'GET',
|
1668
|
-
|
1669
|
-
|
1670
|
-
|
1671
|
-
body=
|
1672
|
-
post_params=
|
1673
|
-
files=
|
1674
|
-
response_types_map=
|
1675
|
-
auth_settings=
|
1676
|
-
async_req=
|
1677
|
-
_return_http_data_only=
|
1678
|
-
_preload_content=
|
1679
|
-
_request_timeout=
|
1680
|
-
collection_formats=
|
1681
|
-
_request_auth=
|
1682
|
-
|
1683
|
-
|
1461
|
+
_path_params,
|
1462
|
+
_query_params,
|
1463
|
+
_header_params,
|
1464
|
+
body=_body_params,
|
1465
|
+
post_params=_form_params,
|
1466
|
+
files=_files,
|
1467
|
+
response_types_map=_response_types_map,
|
1468
|
+
auth_settings=_auth_settings,
|
1469
|
+
async_req=_params.get('async_req'),
|
1470
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1471
|
+
_preload_content=_params.get('_preload_content', True),
|
1472
|
+
_request_timeout=_params.get('_request_timeout'),
|
1473
|
+
collection_formats=_collection_formats,
|
1474
|
+
_request_auth=_params.get('_request_auth'))
|
1475
|
+
|
1476
|
+
@overload
|
1477
|
+
async def patch_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, **kwargs) -> Dict[str, List[AccessMetadataValue]]: # noqa: E501
|
1478
|
+
...
|
1479
|
+
|
1480
|
+
@overload
|
1481
|
+
def patch_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, async_req: Optional[bool]=True, **kwargs) -> Dict[str, List[AccessMetadataValue]]: # noqa: E501
|
1482
|
+
...
|
1483
|
+
|
1484
|
+
@validate_arguments
|
1485
|
+
def patch_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[AccessMetadataValue]], Awaitable[Dict[str, List[AccessMetadataValue]]]]: # noqa: E501
|
1684
1486
|
"""[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. # noqa: E501
|
1685
1487
|
|
1686
1488
|
Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
1687
1489
|
This method makes a synchronous HTTP request by default. To make an
|
1688
1490
|
asynchronous HTTP request, please pass async_req=True
|
1689
1491
|
|
1690
|
-
>>> thread = api.patch_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, identifier_scope, access_metadata_operation, async_req=True)
|
1492
|
+
>>> thread = api.patch_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, identifier_scope, access_metadata_operation, effective_at, effective_until, async_req=True)
|
1691
1493
|
>>> result = thread.get()
|
1692
1494
|
|
1693
1495
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -1699,37 +1501,39 @@ class CustomEntitiesApi(object):
|
|
1699
1501
|
:param identifier_scope: The identifier scope. (required)
|
1700
1502
|
:type identifier_scope: str
|
1701
1503
|
:param access_metadata_operation: The Json Patch document (required)
|
1702
|
-
:type access_metadata_operation:
|
1504
|
+
:type access_metadata_operation: List[AccessMetadataOperation]
|
1703
1505
|
:param effective_at: The effectiveAt datetime at which the Access Metadata will be effective from
|
1704
1506
|
:type effective_at: str
|
1705
1507
|
:param effective_until: The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata
|
1706
1508
|
:type effective_until: datetime
|
1707
1509
|
:param async_req: Whether to execute the request asynchronously.
|
1708
1510
|
:type async_req: bool, optional
|
1709
|
-
:param
|
1710
|
-
|
1711
|
-
|
1712
|
-
|
1713
|
-
:param _request_timeout: timeout setting for this request. If one
|
1714
|
-
number provided, it will be total request
|
1715
|
-
timeout. It can also be a pair (tuple) of
|
1716
|
-
(connection, read) timeouts.
|
1511
|
+
:param _request_timeout: timeout setting for this request.
|
1512
|
+
If one number provided, it will be total request
|
1513
|
+
timeout. It can also be a pair (tuple) of
|
1514
|
+
(connection, read) timeouts.
|
1717
1515
|
:return: Returns the result object.
|
1718
1516
|
If the method is called asynchronously,
|
1719
1517
|
returns the request thread.
|
1720
|
-
:rtype:
|
1518
|
+
:rtype: Dict[str, List[AccessMetadataValue]]
|
1721
1519
|
"""
|
1722
1520
|
kwargs['_return_http_data_only'] = True
|
1723
|
-
|
1724
|
-
|
1725
|
-
|
1521
|
+
if '_preload_content' in kwargs:
|
1522
|
+
message = "Error! Please call the patch_custom_entity_access_metadata_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1523
|
+
raise ValueError(message)
|
1524
|
+
if async_req is not None:
|
1525
|
+
kwargs['async_req'] = async_req
|
1526
|
+
return self.patch_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, access_metadata_operation, effective_at, effective_until, **kwargs) # noqa: E501
|
1527
|
+
|
1528
|
+
@validate_arguments
|
1529
|
+
def patch_custom_entity_access_metadata_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1726
1530
|
"""[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. # noqa: E501
|
1727
1531
|
|
1728
1532
|
Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
1729
1533
|
This method makes a synchronous HTTP request by default. To make an
|
1730
1534
|
asynchronous HTTP request, please pass async_req=True
|
1731
1535
|
|
1732
|
-
>>> thread = api.patch_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, access_metadata_operation, async_req=True)
|
1536
|
+
>>> thread = api.patch_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, access_metadata_operation, effective_at, effective_until, async_req=True)
|
1733
1537
|
>>> result = thread.get()
|
1734
1538
|
|
1735
1539
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -1741,20 +1545,21 @@ class CustomEntitiesApi(object):
|
|
1741
1545
|
:param identifier_scope: The identifier scope. (required)
|
1742
1546
|
:type identifier_scope: str
|
1743
1547
|
:param access_metadata_operation: The Json Patch document (required)
|
1744
|
-
:type access_metadata_operation:
|
1548
|
+
:type access_metadata_operation: List[AccessMetadataOperation]
|
1745
1549
|
:param effective_at: The effectiveAt datetime at which the Access Metadata will be effective from
|
1746
1550
|
:type effective_at: str
|
1747
1551
|
:param effective_until: The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata
|
1748
1552
|
:type effective_until: datetime
|
1749
1553
|
:param async_req: Whether to execute the request asynchronously.
|
1750
1554
|
:type async_req: bool, optional
|
1751
|
-
:param
|
1752
|
-
|
1753
|
-
|
1754
|
-
|
1755
|
-
be returned without reading/decoding response
|
1756
|
-
data. Default is True.
|
1555
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1556
|
+
be set to none and raw_data will store the
|
1557
|
+
HTTP response body without reading/decoding.
|
1558
|
+
Default is True.
|
1757
1559
|
:type _preload_content: bool, optional
|
1560
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1561
|
+
object with status code, headers, etc
|
1562
|
+
:type _return_http_data_only: bool, optional
|
1758
1563
|
:param _request_timeout: timeout setting for this request. If one
|
1759
1564
|
number provided, it will be total request
|
1760
1565
|
timeout. It can also be a pair (tuple) of
|
@@ -1763,15 +1568,16 @@ class CustomEntitiesApi(object):
|
|
1763
1568
|
request; this effectively ignores the authentication
|
1764
1569
|
in the spec for a single request.
|
1765
1570
|
:type _request_auth: dict, optional
|
1766
|
-
:
|
1571
|
+
:type _content_type: string, optional: force content-type for the request
|
1572
|
+
:return: Returns the result object.
|
1767
1573
|
If the method is called asynchronously,
|
1768
1574
|
returns the request thread.
|
1769
|
-
:rtype: (
|
1575
|
+
:rtype: tuple(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))
|
1770
1576
|
"""
|
1771
1577
|
|
1772
|
-
|
1578
|
+
_params = locals()
|
1773
1579
|
|
1774
|
-
|
1580
|
+
_all_params = [
|
1775
1581
|
'entity_type',
|
1776
1582
|
'identifier_type',
|
1777
1583
|
'identifier_value',
|
@@ -1780,144 +1586,112 @@ class CustomEntitiesApi(object):
|
|
1780
1586
|
'effective_at',
|
1781
1587
|
'effective_until'
|
1782
1588
|
]
|
1783
|
-
|
1589
|
+
_all_params.extend(
|
1784
1590
|
[
|
1785
1591
|
'async_req',
|
1786
1592
|
'_return_http_data_only',
|
1787
1593
|
'_preload_content',
|
1788
1594
|
'_request_timeout',
|
1789
1595
|
'_request_auth',
|
1596
|
+
'_content_type',
|
1790
1597
|
'_headers'
|
1791
1598
|
]
|
1792
1599
|
)
|
1793
1600
|
|
1794
|
-
|
1795
|
-
|
1601
|
+
# validate the arguments
|
1602
|
+
for _key, _val in _params['kwargs'].items():
|
1603
|
+
if _key not in _all_params:
|
1796
1604
|
raise ApiTypeError(
|
1797
1605
|
"Got an unexpected keyword argument '%s'"
|
1798
|
-
" to method patch_custom_entity_access_metadata" %
|
1606
|
+
" to method patch_custom_entity_access_metadata" % _key
|
1799
1607
|
)
|
1800
|
-
|
1801
|
-
del
|
1802
|
-
|
1803
|
-
|
1804
|
-
|
1805
|
-
|
1806
|
-
|
1807
|
-
if
|
1808
|
-
|
1809
|
-
|
1810
|
-
|
1811
|
-
|
1812
|
-
|
1813
|
-
|
1814
|
-
|
1815
|
-
if self.api_client.client_side_validation and ('identifier_scope' not in local_var_params or # noqa: E501
|
1816
|
-
local_var_params['identifier_scope'] is None): # noqa: E501
|
1817
|
-
raise ApiValueError("Missing the required parameter `identifier_scope` when calling `patch_custom_entity_access_metadata`") # noqa: E501
|
1818
|
-
# verify the required parameter 'access_metadata_operation' is set
|
1819
|
-
if self.api_client.client_side_validation and ('access_metadata_operation' not in local_var_params or # noqa: E501
|
1820
|
-
local_var_params['access_metadata_operation'] is None): # noqa: E501
|
1821
|
-
raise ApiValueError("Missing the required parameter `access_metadata_operation` when calling `patch_custom_entity_access_metadata`") # noqa: E501
|
1822
|
-
|
1823
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
1824
|
-
len(local_var_params['entity_type']) > 64): # noqa: E501
|
1825
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `patch_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
1826
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
1827
|
-
len(local_var_params['entity_type']) < 1): # noqa: E501
|
1828
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `patch_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
1829
|
-
if self.api_client.client_side_validation and 'entity_type' in local_var_params and not re.search(r'^~[a-zA-Z0-9\-_]+$', local_var_params['entity_type']): # noqa: E501
|
1830
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `patch_custom_entity_access_metadata`, must conform to the pattern `/^~[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1831
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
1832
|
-
len(local_var_params['identifier_type']) > 64): # noqa: E501
|
1833
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `patch_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
1834
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
1835
|
-
len(local_var_params['identifier_type']) < 1): # noqa: E501
|
1836
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `patch_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
1837
|
-
if self.api_client.client_side_validation and 'identifier_type' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_type']): # noqa: E501
|
1838
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `patch_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1839
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
1840
|
-
len(local_var_params['identifier_value']) > 1024): # noqa: E501
|
1841
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `patch_custom_entity_access_metadata`, length must be less than or equal to `1024`") # noqa: E501
|
1842
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
1843
|
-
len(local_var_params['identifier_value']) < 1): # noqa: E501
|
1844
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `patch_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
1845
|
-
if self.api_client.client_side_validation and 'identifier_value' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_value']): # noqa: E501
|
1846
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `patch_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1847
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
1848
|
-
len(local_var_params['identifier_scope']) > 64): # noqa: E501
|
1849
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `patch_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
1850
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
1851
|
-
len(local_var_params['identifier_scope']) < 1): # noqa: E501
|
1852
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `patch_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
1853
|
-
if self.api_client.client_side_validation and 'identifier_scope' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_scope']): # noqa: E501
|
1854
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `patch_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
1855
|
-
collection_formats = {}
|
1856
|
-
|
1857
|
-
path_params = {}
|
1858
|
-
if 'entity_type' in local_var_params:
|
1859
|
-
path_params['entityType'] = local_var_params['entity_type'] # noqa: E501
|
1860
|
-
if 'identifier_type' in local_var_params:
|
1861
|
-
path_params['identifierType'] = local_var_params['identifier_type'] # noqa: E501
|
1862
|
-
if 'identifier_value' in local_var_params:
|
1863
|
-
path_params['identifierValue'] = local_var_params['identifier_value'] # noqa: E501
|
1864
|
-
|
1865
|
-
query_params = []
|
1866
|
-
if 'identifier_scope' in local_var_params and local_var_params['identifier_scope'] is not None: # noqa: E501
|
1867
|
-
query_params.append(('identifierScope', local_var_params['identifier_scope'])) # noqa: E501
|
1868
|
-
if 'effective_at' in local_var_params and local_var_params['effective_at'] is not None: # noqa: E501
|
1869
|
-
query_params.append(('effectiveAt', local_var_params['effective_at'])) # noqa: E501
|
1870
|
-
if 'effective_until' in local_var_params and local_var_params['effective_until'] is not None: # noqa: E501
|
1871
|
-
query_params.append(('effectiveUntil', local_var_params['effective_until'])) # noqa: E501
|
1872
|
-
|
1873
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
1874
|
-
|
1875
|
-
form_params = []
|
1876
|
-
local_var_files = {}
|
1877
|
-
|
1878
|
-
body_params = None
|
1879
|
-
if 'access_metadata_operation' in local_var_params:
|
1880
|
-
body_params = local_var_params['access_metadata_operation']
|
1881
|
-
# HTTP header `Accept`
|
1882
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
1883
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1608
|
+
_params[_key] = _val
|
1609
|
+
del _params['kwargs']
|
1610
|
+
|
1611
|
+
_collection_formats = {}
|
1612
|
+
|
1613
|
+
# process the path parameters
|
1614
|
+
_path_params = {}
|
1615
|
+
if _params['entity_type']:
|
1616
|
+
_path_params['entityType'] = _params['entity_type']
|
1617
|
+
|
1618
|
+
if _params['identifier_type']:
|
1619
|
+
_path_params['identifierType'] = _params['identifier_type']
|
1620
|
+
|
1621
|
+
if _params['identifier_value']:
|
1622
|
+
_path_params['identifierValue'] = _params['identifier_value']
|
1884
1623
|
|
1885
|
-
header_params['Accept-Encoding'] = "gzip, deflate, br"
|
1886
1624
|
|
1887
|
-
#
|
1888
|
-
|
1889
|
-
|
1625
|
+
# process the query parameters
|
1626
|
+
_query_params = []
|
1627
|
+
if _params.get('identifier_scope') is not None: # noqa: E501
|
1628
|
+
_query_params.append(('identifierScope', _params['identifier_scope']))
|
1890
1629
|
|
1891
|
-
|
1892
|
-
|
1893
|
-
header_params['X-LUSID-SDK-Version'] = '1.1.118'
|
1630
|
+
if _params.get('effective_at') is not None: # noqa: E501
|
1631
|
+
_query_params.append(('effectiveAt', _params['effective_at']))
|
1894
1632
|
|
1895
|
-
#
|
1896
|
-
|
1633
|
+
if _params.get('effective_until') is not None: # noqa: E501
|
1634
|
+
if isinstance(_params['effective_until'], datetime):
|
1635
|
+
_query_params.append(('effectiveUntil', _params['effective_until'].strftime(self.api_client.configuration.datetime_format)))
|
1636
|
+
else:
|
1637
|
+
_query_params.append(('effectiveUntil', _params['effective_until']))
|
1897
1638
|
|
1898
|
-
|
1899
|
-
|
1900
|
-
|
1639
|
+
# process the header parameters
|
1640
|
+
_header_params = dict(_params.get('_headers', {}))
|
1641
|
+
# process the form parameters
|
1642
|
+
_form_params = []
|
1643
|
+
_files = {}
|
1644
|
+
# process the body parameter
|
1645
|
+
_body_params = None
|
1646
|
+
if _params['access_metadata_operation'] is not None:
|
1647
|
+
_body_params = _params['access_metadata_operation']
|
1648
|
+
|
1649
|
+
# set the HTTP header `Accept`
|
1650
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1651
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1652
|
+
|
1653
|
+
# set the HTTP header `Content-Type`
|
1654
|
+
_content_types_list = _params.get('_content_type',
|
1655
|
+
self.api_client.select_header_content_type(
|
1656
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
1657
|
+
if _content_types_list:
|
1658
|
+
_header_params['Content-Type'] = _content_types_list
|
1659
|
+
|
1660
|
+
# authentication setting
|
1661
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1662
|
+
|
1663
|
+
_response_types_map = {
|
1664
|
+
'200': "Dict[str, List[AccessMetadataValue]]",
|
1665
|
+
'400': "LusidValidationProblemDetails",
|
1901
1666
|
}
|
1902
1667
|
|
1903
1668
|
return self.api_client.call_api(
|
1904
1669
|
'/api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata', 'PATCH',
|
1905
|
-
|
1906
|
-
|
1907
|
-
|
1908
|
-
body=
|
1909
|
-
post_params=
|
1910
|
-
files=
|
1911
|
-
response_types_map=
|
1912
|
-
auth_settings=
|
1913
|
-
async_req=
|
1914
|
-
_return_http_data_only=
|
1915
|
-
_preload_content=
|
1916
|
-
_request_timeout=
|
1917
|
-
collection_formats=
|
1918
|
-
_request_auth=
|
1919
|
-
|
1920
|
-
|
1670
|
+
_path_params,
|
1671
|
+
_query_params,
|
1672
|
+
_header_params,
|
1673
|
+
body=_body_params,
|
1674
|
+
post_params=_form_params,
|
1675
|
+
files=_files,
|
1676
|
+
response_types_map=_response_types_map,
|
1677
|
+
auth_settings=_auth_settings,
|
1678
|
+
async_req=_params.get('async_req'),
|
1679
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1680
|
+
_preload_content=_params.get('_preload_content', True),
|
1681
|
+
_request_timeout=_params.get('_request_timeout'),
|
1682
|
+
collection_formats=_collection_formats,
|
1683
|
+
_request_auth=_params.get('_request_auth'))
|
1684
|
+
|
1685
|
+
@overload
|
1686
|
+
async def upsert_custom_entities(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], success_mode : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, CustomEntityRequest], Field(..., description="The payload describing the Custom Entity instances")], **kwargs) -> UpsertCustomEntitiesResponse: # noqa: E501
|
1687
|
+
...
|
1688
|
+
|
1689
|
+
@overload
|
1690
|
+
def upsert_custom_entities(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], success_mode : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, CustomEntityRequest], Field(..., description="The payload describing the Custom Entity instances")], async_req: Optional[bool]=True, **kwargs) -> UpsertCustomEntitiesResponse: # noqa: E501
|
1691
|
+
...
|
1692
|
+
|
1693
|
+
@validate_arguments
|
1694
|
+
def upsert_custom_entities(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], success_mode : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, CustomEntityRequest], Field(..., description="The payload describing the Custom Entity instances")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertCustomEntitiesResponse, Awaitable[UpsertCustomEntitiesResponse]]: # noqa: E501
|
1921
1695
|
"""[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities # noqa: E501
|
1922
1696
|
|
1923
1697
|
Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # noqa: E501
|
@@ -1932,26 +1706,28 @@ class CustomEntitiesApi(object):
|
|
1932
1706
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
|
1933
1707
|
:type success_mode: str
|
1934
1708
|
:param request_body: The payload describing the Custom Entity instances (required)
|
1935
|
-
:type request_body:
|
1709
|
+
:type request_body: Dict[str, CustomEntityRequest]
|
1936
1710
|
:param async_req: Whether to execute the request asynchronously.
|
1937
1711
|
:type async_req: bool, optional
|
1938
|
-
:param
|
1939
|
-
|
1940
|
-
|
1941
|
-
|
1942
|
-
:param _request_timeout: timeout setting for this request. If one
|
1943
|
-
number provided, it will be total request
|
1944
|
-
timeout. It can also be a pair (tuple) of
|
1945
|
-
(connection, read) timeouts.
|
1712
|
+
:param _request_timeout: timeout setting for this request.
|
1713
|
+
If one number provided, it will be total request
|
1714
|
+
timeout. It can also be a pair (tuple) of
|
1715
|
+
(connection, read) timeouts.
|
1946
1716
|
:return: Returns the result object.
|
1947
1717
|
If the method is called asynchronously,
|
1948
1718
|
returns the request thread.
|
1949
1719
|
:rtype: UpsertCustomEntitiesResponse
|
1950
1720
|
"""
|
1951
1721
|
kwargs['_return_http_data_only'] = True
|
1722
|
+
if '_preload_content' in kwargs:
|
1723
|
+
message = "Error! Please call the upsert_custom_entities_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
|
1952
1727
|
return self.upsert_custom_entities_with_http_info(entity_type, success_mode, request_body, **kwargs) # noqa: E501
|
1953
1728
|
|
1954
|
-
|
1729
|
+
@validate_arguments
|
1730
|
+
def upsert_custom_entities_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], success_mode : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial")], request_body : Annotated[Dict[str, CustomEntityRequest], Field(..., description="The payload describing the Custom Entity instances")], **kwargs) -> ApiResponse: # noqa: E501
|
1955
1731
|
"""[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities # noqa: E501
|
1956
1732
|
|
1957
1733
|
Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # noqa: E501
|
@@ -1966,16 +1742,17 @@ class CustomEntitiesApi(object):
|
|
1966
1742
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
|
1967
1743
|
:type success_mode: str
|
1968
1744
|
:param request_body: The payload describing the Custom Entity instances (required)
|
1969
|
-
:type request_body:
|
1745
|
+
:type request_body: Dict[str, CustomEntityRequest]
|
1970
1746
|
:param async_req: Whether to execute the request asynchronously.
|
1971
1747
|
:type async_req: bool, optional
|
1972
|
-
:param
|
1973
|
-
|
1974
|
-
|
1975
|
-
|
1976
|
-
be returned without reading/decoding response
|
1977
|
-
data. Default is True.
|
1748
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1749
|
+
be set to none and raw_data will store the
|
1750
|
+
HTTP response body without reading/decoding.
|
1751
|
+
Default is True.
|
1978
1752
|
:type _preload_content: bool, optional
|
1753
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1754
|
+
object with status code, headers, etc
|
1755
|
+
:type _return_http_data_only: bool, optional
|
1979
1756
|
:param _request_timeout: timeout setting for this request. If one
|
1980
1757
|
number provided, it will be total request
|
1981
1758
|
timeout. It can also be a pair (tuple) of
|
@@ -1984,121 +1761,111 @@ class CustomEntitiesApi(object):
|
|
1984
1761
|
request; this effectively ignores the authentication
|
1985
1762
|
in the spec for a single request.
|
1986
1763
|
:type _request_auth: dict, optional
|
1987
|
-
:
|
1764
|
+
:type _content_type: string, optional: force content-type for the request
|
1765
|
+
:return: Returns the result object.
|
1988
1766
|
If the method is called asynchronously,
|
1989
1767
|
returns the request thread.
|
1990
|
-
:rtype: (UpsertCustomEntitiesResponse, int, HTTPHeaderDict)
|
1768
|
+
:rtype: tuple(UpsertCustomEntitiesResponse, status_code(int), headers(HTTPHeaderDict))
|
1991
1769
|
"""
|
1992
1770
|
|
1993
|
-
|
1771
|
+
_params = locals()
|
1994
1772
|
|
1995
|
-
|
1773
|
+
_all_params = [
|
1996
1774
|
'entity_type',
|
1997
1775
|
'success_mode',
|
1998
1776
|
'request_body'
|
1999
1777
|
]
|
2000
|
-
|
1778
|
+
_all_params.extend(
|
2001
1779
|
[
|
2002
1780
|
'async_req',
|
2003
1781
|
'_return_http_data_only',
|
2004
1782
|
'_preload_content',
|
2005
1783
|
'_request_timeout',
|
2006
1784
|
'_request_auth',
|
1785
|
+
'_content_type',
|
2007
1786
|
'_headers'
|
2008
1787
|
]
|
2009
1788
|
)
|
2010
1789
|
|
2011
|
-
|
2012
|
-
|
1790
|
+
# validate the arguments
|
1791
|
+
for _key, _val in _params['kwargs'].items():
|
1792
|
+
if _key not in _all_params:
|
2013
1793
|
raise ApiTypeError(
|
2014
1794
|
"Got an unexpected keyword argument '%s'"
|
2015
|
-
" to method upsert_custom_entities" %
|
1795
|
+
" to method upsert_custom_entities" % _key
|
2016
1796
|
)
|
2017
|
-
|
2018
|
-
del
|
2019
|
-
|
2020
|
-
|
2021
|
-
|
2022
|
-
|
2023
|
-
|
2024
|
-
if
|
2025
|
-
|
2026
|
-
|
2027
|
-
|
2028
|
-
|
2029
|
-
|
2030
|
-
|
2031
|
-
|
2032
|
-
|
2033
|
-
|
2034
|
-
|
2035
|
-
|
2036
|
-
|
2037
|
-
|
2038
|
-
|
2039
|
-
|
2040
|
-
|
2041
|
-
|
2042
|
-
|
2043
|
-
|
2044
|
-
|
2045
|
-
|
2046
|
-
path_params = {}
|
2047
|
-
if 'entity_type' in local_var_params:
|
2048
|
-
path_params['entityType'] = local_var_params['entity_type'] # noqa: E501
|
2049
|
-
|
2050
|
-
query_params = []
|
2051
|
-
if 'success_mode' in local_var_params and local_var_params['success_mode'] is not None: # noqa: E501
|
2052
|
-
query_params.append(('successMode', local_var_params['success_mode'])) # noqa: E501
|
2053
|
-
|
2054
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
2055
|
-
|
2056
|
-
form_params = []
|
2057
|
-
local_var_files = {}
|
2058
|
-
|
2059
|
-
body_params = None
|
2060
|
-
if 'request_body' in local_var_params:
|
2061
|
-
body_params = local_var_params['request_body']
|
2062
|
-
# HTTP header `Accept`
|
2063
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
1797
|
+
_params[_key] = _val
|
1798
|
+
del _params['kwargs']
|
1799
|
+
|
1800
|
+
_collection_formats = {}
|
1801
|
+
|
1802
|
+
# process the path parameters
|
1803
|
+
_path_params = {}
|
1804
|
+
if _params['entity_type']:
|
1805
|
+
_path_params['entityType'] = _params['entity_type']
|
1806
|
+
|
1807
|
+
|
1808
|
+
# process the query parameters
|
1809
|
+
_query_params = []
|
1810
|
+
if _params.get('success_mode') is not None: # noqa: E501
|
1811
|
+
_query_params.append(('successMode', _params['success_mode']))
|
1812
|
+
|
1813
|
+
# process the header parameters
|
1814
|
+
_header_params = dict(_params.get('_headers', {}))
|
1815
|
+
# process the form parameters
|
1816
|
+
_form_params = []
|
1817
|
+
_files = {}
|
1818
|
+
# process the body parameter
|
1819
|
+
_body_params = None
|
1820
|
+
if _params['request_body'] is not None:
|
1821
|
+
_body_params = _params['request_body']
|
1822
|
+
|
1823
|
+
# set the HTTP header `Accept`
|
1824
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
2064
1825
|
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2065
1826
|
|
2066
|
-
|
2067
|
-
|
2068
|
-
|
2069
|
-
|
2070
|
-
|
2071
|
-
|
2072
|
-
# set the LUSID header
|
2073
|
-
header_params['X-LUSID-SDK-Language'] = 'Python'
|
2074
|
-
header_params['X-LUSID-SDK-Version'] = '1.1.118'
|
1827
|
+
# set the HTTP header `Content-Type`
|
1828
|
+
_content_types_list = _params.get('_content_type',
|
1829
|
+
self.api_client.select_header_content_type(
|
1830
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
1831
|
+
if _content_types_list:
|
1832
|
+
_header_params['Content-Type'] = _content_types_list
|
2075
1833
|
|
2076
|
-
#
|
2077
|
-
|
1834
|
+
# authentication setting
|
1835
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2078
1836
|
|
2079
|
-
|
2080
|
-
200: "UpsertCustomEntitiesResponse",
|
2081
|
-
400: "LusidValidationProblemDetails",
|
1837
|
+
_response_types_map = {
|
1838
|
+
'200': "UpsertCustomEntitiesResponse",
|
1839
|
+
'400': "LusidValidationProblemDetails",
|
2082
1840
|
}
|
2083
1841
|
|
2084
1842
|
return self.api_client.call_api(
|
2085
1843
|
'/api/customentities/{entityType}/$batchUpsert', 'POST',
|
2086
|
-
|
2087
|
-
|
2088
|
-
|
2089
|
-
body=
|
2090
|
-
post_params=
|
2091
|
-
files=
|
2092
|
-
response_types_map=
|
2093
|
-
auth_settings=
|
2094
|
-
async_req=
|
2095
|
-
_return_http_data_only=
|
2096
|
-
_preload_content=
|
2097
|
-
_request_timeout=
|
2098
|
-
collection_formats=
|
2099
|
-
_request_auth=
|
2100
|
-
|
2101
|
-
|
1844
|
+
_path_params,
|
1845
|
+
_query_params,
|
1846
|
+
_header_params,
|
1847
|
+
body=_body_params,
|
1848
|
+
post_params=_form_params,
|
1849
|
+
files=_files,
|
1850
|
+
response_types_map=_response_types_map,
|
1851
|
+
auth_settings=_auth_settings,
|
1852
|
+
async_req=_params.get('async_req'),
|
1853
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1854
|
+
_preload_content=_params.get('_preload_content', True),
|
1855
|
+
_request_timeout=_params.get('_request_timeout'),
|
1856
|
+
collection_formats=_collection_formats,
|
1857
|
+
_request_auth=_params.get('_request_auth'))
|
1858
|
+
|
1859
|
+
@overload
|
1860
|
+
async def upsert_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], custom_entity_request : Annotated[CustomEntityRequest, Field(..., description="The payload describing the Custom Entity instance.")], **kwargs) -> CustomEntityResponse: # noqa: E501
|
1861
|
+
...
|
1862
|
+
|
1863
|
+
@overload
|
1864
|
+
def upsert_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], custom_entity_request : Annotated[CustomEntityRequest, Field(..., description="The payload describing the Custom Entity instance.")], async_req: Optional[bool]=True, **kwargs) -> CustomEntityResponse: # noqa: E501
|
1865
|
+
...
|
1866
|
+
|
1867
|
+
@validate_arguments
|
1868
|
+
def upsert_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], custom_entity_request : Annotated[CustomEntityRequest, Field(..., description="The payload describing the Custom Entity instance.")], async_req: Optional[bool]=None, **kwargs) -> Union[CustomEntityResponse, Awaitable[CustomEntityResponse]]: # noqa: E501
|
2102
1869
|
"""[EARLY ACCESS] UpsertCustomEntity: Upsert a Custom Entity instance # noqa: E501
|
2103
1870
|
|
2104
1871
|
Insert the Custom Entity if it does not exist or update the Custom Entity with the supplied state if it does exist. # noqa: E501
|
@@ -2114,23 +1881,25 @@ class CustomEntitiesApi(object):
|
|
2114
1881
|
:type custom_entity_request: CustomEntityRequest
|
2115
1882
|
:param async_req: Whether to execute the request asynchronously.
|
2116
1883
|
:type async_req: bool, optional
|
2117
|
-
:param
|
2118
|
-
|
2119
|
-
|
2120
|
-
|
2121
|
-
:param _request_timeout: timeout setting for this request. If one
|
2122
|
-
number provided, it will be total request
|
2123
|
-
timeout. It can also be a pair (tuple) of
|
2124
|
-
(connection, read) timeouts.
|
1884
|
+
:param _request_timeout: timeout setting for this request.
|
1885
|
+
If one number provided, it will be total request
|
1886
|
+
timeout. It can also be a pair (tuple) of
|
1887
|
+
(connection, read) timeouts.
|
2125
1888
|
:return: Returns the result object.
|
2126
1889
|
If the method is called asynchronously,
|
2127
1890
|
returns the request thread.
|
2128
1891
|
:rtype: CustomEntityResponse
|
2129
1892
|
"""
|
2130
1893
|
kwargs['_return_http_data_only'] = True
|
1894
|
+
if '_preload_content' in kwargs:
|
1895
|
+
message = "Error! Please call the upsert_custom_entity_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1896
|
+
raise ValueError(message)
|
1897
|
+
if async_req is not None:
|
1898
|
+
kwargs['async_req'] = async_req
|
2131
1899
|
return self.upsert_custom_entity_with_http_info(entity_type, custom_entity_request, **kwargs) # noqa: E501
|
2132
1900
|
|
2133
|
-
|
1901
|
+
@validate_arguments
|
1902
|
+
def upsert_custom_entity_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], custom_entity_request : Annotated[CustomEntityRequest, Field(..., description="The payload describing the Custom Entity instance.")], **kwargs) -> ApiResponse: # noqa: E501
|
2134
1903
|
"""[EARLY ACCESS] UpsertCustomEntity: Upsert a Custom Entity instance # noqa: E501
|
2135
1904
|
|
2136
1905
|
Insert the Custom Entity if it does not exist or update the Custom Entity with the supplied state if it does exist. # noqa: E501
|
@@ -2146,13 +1915,14 @@ class CustomEntitiesApi(object):
|
|
2146
1915
|
:type custom_entity_request: CustomEntityRequest
|
2147
1916
|
:param async_req: Whether to execute the request asynchronously.
|
2148
1917
|
:type async_req: bool, optional
|
2149
|
-
:param
|
2150
|
-
|
2151
|
-
|
2152
|
-
|
2153
|
-
be returned without reading/decoding response
|
2154
|
-
data. Default is True.
|
1918
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1919
|
+
be set to none and raw_data will store the
|
1920
|
+
HTTP response body without reading/decoding.
|
1921
|
+
Default is True.
|
2155
1922
|
:type _preload_content: bool, optional
|
1923
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1924
|
+
object with status code, headers, etc
|
1925
|
+
:type _return_http_data_only: bool, optional
|
2156
1926
|
:param _request_timeout: timeout setting for this request. If one
|
2157
1927
|
number provided, it will be total request
|
2158
1928
|
timeout. It can also be a pair (tuple) of
|
@@ -2161,115 +1931,114 @@ class CustomEntitiesApi(object):
|
|
2161
1931
|
request; this effectively ignores the authentication
|
2162
1932
|
in the spec for a single request.
|
2163
1933
|
:type _request_auth: dict, optional
|
2164
|
-
:
|
1934
|
+
:type _content_type: string, optional: force content-type for the request
|
1935
|
+
:return: Returns the result object.
|
2165
1936
|
If the method is called asynchronously,
|
2166
1937
|
returns the request thread.
|
2167
|
-
:rtype: (CustomEntityResponse, int, HTTPHeaderDict)
|
1938
|
+
:rtype: tuple(CustomEntityResponse, status_code(int), headers(HTTPHeaderDict))
|
2168
1939
|
"""
|
2169
1940
|
|
2170
|
-
|
1941
|
+
_params = locals()
|
2171
1942
|
|
2172
|
-
|
1943
|
+
_all_params = [
|
2173
1944
|
'entity_type',
|
2174
1945
|
'custom_entity_request'
|
2175
1946
|
]
|
2176
|
-
|
1947
|
+
_all_params.extend(
|
2177
1948
|
[
|
2178
1949
|
'async_req',
|
2179
1950
|
'_return_http_data_only',
|
2180
1951
|
'_preload_content',
|
2181
1952
|
'_request_timeout',
|
2182
1953
|
'_request_auth',
|
1954
|
+
'_content_type',
|
2183
1955
|
'_headers'
|
2184
1956
|
]
|
2185
1957
|
)
|
2186
1958
|
|
2187
|
-
|
2188
|
-
|
1959
|
+
# validate the arguments
|
1960
|
+
for _key, _val in _params['kwargs'].items():
|
1961
|
+
if _key not in _all_params:
|
2189
1962
|
raise ApiTypeError(
|
2190
1963
|
"Got an unexpected keyword argument '%s'"
|
2191
|
-
" to method upsert_custom_entity" %
|
1964
|
+
" to method upsert_custom_entity" % _key
|
2192
1965
|
)
|
2193
|
-
|
2194
|
-
del
|
2195
|
-
|
2196
|
-
|
2197
|
-
|
2198
|
-
|
2199
|
-
|
2200
|
-
if
|
2201
|
-
|
2202
|
-
|
2203
|
-
|
2204
|
-
|
2205
|
-
|
2206
|
-
|
2207
|
-
|
2208
|
-
|
2209
|
-
|
2210
|
-
|
2211
|
-
|
2212
|
-
|
2213
|
-
if '
|
2214
|
-
|
2215
|
-
|
2216
|
-
|
2217
|
-
|
2218
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
2219
|
-
|
2220
|
-
form_params = []
|
2221
|
-
local_var_files = {}
|
2222
|
-
|
2223
|
-
body_params = None
|
2224
|
-
if 'custom_entity_request' in local_var_params:
|
2225
|
-
body_params = local_var_params['custom_entity_request']
|
2226
|
-
# HTTP header `Accept`
|
2227
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
1966
|
+
_params[_key] = _val
|
1967
|
+
del _params['kwargs']
|
1968
|
+
|
1969
|
+
_collection_formats = {}
|
1970
|
+
|
1971
|
+
# process the path parameters
|
1972
|
+
_path_params = {}
|
1973
|
+
if _params['entity_type']:
|
1974
|
+
_path_params['entityType'] = _params['entity_type']
|
1975
|
+
|
1976
|
+
|
1977
|
+
# process the query parameters
|
1978
|
+
_query_params = []
|
1979
|
+
# process the header parameters
|
1980
|
+
_header_params = dict(_params.get('_headers', {}))
|
1981
|
+
# process the form parameters
|
1982
|
+
_form_params = []
|
1983
|
+
_files = {}
|
1984
|
+
# process the body parameter
|
1985
|
+
_body_params = None
|
1986
|
+
if _params['custom_entity_request'] is not None:
|
1987
|
+
_body_params = _params['custom_entity_request']
|
1988
|
+
|
1989
|
+
# set the HTTP header `Accept`
|
1990
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
2228
1991
|
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2229
1992
|
|
2230
|
-
|
1993
|
+
# set the HTTP header `Content-Type`
|
1994
|
+
_content_types_list = _params.get('_content_type',
|
1995
|
+
self.api_client.select_header_content_type(
|
1996
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
1997
|
+
if _content_types_list:
|
1998
|
+
_header_params['Content-Type'] = _content_types_list
|
2231
1999
|
|
2232
|
-
#
|
2233
|
-
|
2234
|
-
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']) # noqa: E501
|
2000
|
+
# authentication setting
|
2001
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2235
2002
|
|
2236
|
-
|
2237
|
-
|
2238
|
-
|
2239
|
-
|
2240
|
-
# Authentication setting
|
2241
|
-
auth_settings = ['oauth2'] # noqa: E501
|
2242
|
-
|
2243
|
-
response_types_map = {
|
2244
|
-
200: "CustomEntityResponse",
|
2245
|
-
400: "LusidValidationProblemDetails",
|
2003
|
+
_response_types_map = {
|
2004
|
+
'200': "CustomEntityResponse",
|
2005
|
+
'400': "LusidValidationProblemDetails",
|
2246
2006
|
}
|
2247
2007
|
|
2248
2008
|
return self.api_client.call_api(
|
2249
2009
|
'/api/customentities/{entityType}', 'POST',
|
2250
|
-
|
2251
|
-
|
2252
|
-
|
2253
|
-
body=
|
2254
|
-
post_params=
|
2255
|
-
files=
|
2256
|
-
response_types_map=
|
2257
|
-
auth_settings=
|
2258
|
-
async_req=
|
2259
|
-
_return_http_data_only=
|
2260
|
-
_preload_content=
|
2261
|
-
_request_timeout=
|
2262
|
-
collection_formats=
|
2263
|
-
_request_auth=
|
2264
|
-
|
2265
|
-
|
2010
|
+
_path_params,
|
2011
|
+
_query_params,
|
2012
|
+
_header_params,
|
2013
|
+
body=_body_params,
|
2014
|
+
post_params=_form_params,
|
2015
|
+
files=_files,
|
2016
|
+
response_types_map=_response_types_map,
|
2017
|
+
auth_settings=_auth_settings,
|
2018
|
+
async_req=_params.get('async_req'),
|
2019
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2020
|
+
_preload_content=_params.get('_preload_content', True),
|
2021
|
+
_request_timeout=_params.get('_request_timeout'),
|
2022
|
+
collection_formats=_collection_formats,
|
2023
|
+
_request_auth=_params.get('_request_auth'))
|
2024
|
+
|
2025
|
+
@overload
|
2026
|
+
async def upsert_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], upsert_custom_entity_access_metadata_request : Annotated[UpsertCustomEntityAccessMetadataRequest, Field(..., description="The Custom Entity Access Metadata entry to upsert")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, **kwargs) -> List[AccessMetadataValue]: # noqa: E501
|
2027
|
+
...
|
2028
|
+
|
2029
|
+
@overload
|
2030
|
+
def upsert_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], upsert_custom_entity_access_metadata_request : Annotated[UpsertCustomEntityAccessMetadataRequest, Field(..., description="The Custom Entity Access Metadata entry to upsert")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, async_req: Optional[bool]=True, **kwargs) -> List[AccessMetadataValue]: # noqa: E501
|
2031
|
+
...
|
2032
|
+
|
2033
|
+
@validate_arguments
|
2034
|
+
def upsert_custom_entity_access_metadata(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], upsert_custom_entity_access_metadata_request : Annotated[UpsertCustomEntityAccessMetadataRequest, Field(..., description="The Custom Entity Access Metadata entry to upsert")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[List[AccessMetadataValue], Awaitable[List[AccessMetadataValue]]]: # noqa: E501
|
2266
2035
|
"""[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
2267
2036
|
|
2268
2037
|
Update or insert one Custom Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
2269
2038
|
This method makes a synchronous HTTP request by default. To make an
|
2270
2039
|
asynchronous HTTP request, please pass async_req=True
|
2271
2040
|
|
2272
|
-
>>> thread = api.upsert_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, upsert_custom_entity_access_metadata_request, async_req=True)
|
2041
|
+
>>> thread = api.upsert_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, upsert_custom_entity_access_metadata_request, effective_at, effective_until, async_req=True)
|
2273
2042
|
>>> result = thread.get()
|
2274
2043
|
|
2275
2044
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -2290,30 +2059,32 @@ class CustomEntitiesApi(object):
|
|
2290
2059
|
:type effective_until: datetime
|
2291
2060
|
:param async_req: Whether to execute the request asynchronously.
|
2292
2061
|
:type async_req: bool, optional
|
2293
|
-
:param
|
2294
|
-
|
2295
|
-
|
2296
|
-
|
2297
|
-
:param _request_timeout: timeout setting for this request. If one
|
2298
|
-
number provided, it will be total request
|
2299
|
-
timeout. It can also be a pair (tuple) of
|
2300
|
-
(connection, read) timeouts.
|
2062
|
+
:param _request_timeout: timeout setting for this request.
|
2063
|
+
If one number provided, it will be total request
|
2064
|
+
timeout. It can also be a pair (tuple) of
|
2065
|
+
(connection, read) timeouts.
|
2301
2066
|
:return: Returns the result object.
|
2302
2067
|
If the method is called asynchronously,
|
2303
2068
|
returns the request thread.
|
2304
|
-
:rtype:
|
2069
|
+
:rtype: List[AccessMetadataValue]
|
2305
2070
|
"""
|
2306
2071
|
kwargs['_return_http_data_only'] = True
|
2307
|
-
|
2308
|
-
|
2309
|
-
|
2072
|
+
if '_preload_content' in kwargs:
|
2073
|
+
message = "Error! Please call the upsert_custom_entity_access_metadata_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2074
|
+
raise ValueError(message)
|
2075
|
+
if async_req is not None:
|
2076
|
+
kwargs['async_req'] = async_req
|
2077
|
+
return self.upsert_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, upsert_custom_entity_access_metadata_request, effective_at, effective_until, **kwargs) # noqa: E501
|
2078
|
+
|
2079
|
+
@validate_arguments
|
2080
|
+
def upsert_custom_entity_access_metadata_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], metadata_key : Annotated[constr(strict=True, max_length=100, min_length=1), Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], upsert_custom_entity_access_metadata_request : Annotated[UpsertCustomEntityAccessMetadataRequest, Field(..., description="The Custom Entity Access Metadata entry to upsert")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2310
2081
|
"""[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
2311
2082
|
|
2312
2083
|
Update or insert one Custom Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
2313
2084
|
This method makes a synchronous HTTP request by default. To make an
|
2314
2085
|
asynchronous HTTP request, please pass async_req=True
|
2315
2086
|
|
2316
|
-
>>> thread = api.upsert_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, upsert_custom_entity_access_metadata_request, async_req=True)
|
2087
|
+
>>> thread = api.upsert_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, upsert_custom_entity_access_metadata_request, effective_at, effective_until, async_req=True)
|
2317
2088
|
>>> result = thread.get()
|
2318
2089
|
|
2319
2090
|
:param entity_type: The type of the Custom Entity. (required)
|
@@ -2334,13 +2105,14 @@ class CustomEntitiesApi(object):
|
|
2334
2105
|
:type effective_until: datetime
|
2335
2106
|
:param async_req: Whether to execute the request asynchronously.
|
2336
2107
|
:type async_req: bool, optional
|
2337
|
-
:param
|
2338
|
-
|
2339
|
-
|
2340
|
-
|
2341
|
-
be returned without reading/decoding response
|
2342
|
-
data. Default is True.
|
2108
|
+
:param _preload_content: if False, the ApiResponse.data will
|
2109
|
+
be set to none and raw_data will store the
|
2110
|
+
HTTP response body without reading/decoding.
|
2111
|
+
Default is True.
|
2343
2112
|
:type _preload_content: bool, optional
|
2113
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
2114
|
+
object with status code, headers, etc
|
2115
|
+
:type _return_http_data_only: bool, optional
|
2344
2116
|
:param _request_timeout: timeout setting for this request. If one
|
2345
2117
|
number provided, it will be total request
|
2346
2118
|
timeout. It can also be a pair (tuple) of
|
@@ -2349,15 +2121,16 @@ class CustomEntitiesApi(object):
|
|
2349
2121
|
request; this effectively ignores the authentication
|
2350
2122
|
in the spec for a single request.
|
2351
2123
|
:type _request_auth: dict, optional
|
2352
|
-
:
|
2124
|
+
:type _content_type: string, optional: force content-type for the request
|
2125
|
+
:return: Returns the result object.
|
2353
2126
|
If the method is called asynchronously,
|
2354
2127
|
returns the request thread.
|
2355
|
-
:rtype: (
|
2128
|
+
:rtype: tuple(List[AccessMetadataValue], status_code(int), headers(HTTPHeaderDict))
|
2356
2129
|
"""
|
2357
2130
|
|
2358
|
-
|
2131
|
+
_params = locals()
|
2359
2132
|
|
2360
|
-
|
2133
|
+
_all_params = [
|
2361
2134
|
'entity_type',
|
2362
2135
|
'identifier_type',
|
2363
2136
|
'identifier_value',
|
@@ -2367,153 +2140,101 @@ class CustomEntitiesApi(object):
|
|
2367
2140
|
'effective_at',
|
2368
2141
|
'effective_until'
|
2369
2142
|
]
|
2370
|
-
|
2143
|
+
_all_params.extend(
|
2371
2144
|
[
|
2372
2145
|
'async_req',
|
2373
2146
|
'_return_http_data_only',
|
2374
2147
|
'_preload_content',
|
2375
2148
|
'_request_timeout',
|
2376
2149
|
'_request_auth',
|
2150
|
+
'_content_type',
|
2377
2151
|
'_headers'
|
2378
2152
|
]
|
2379
2153
|
)
|
2380
2154
|
|
2381
|
-
|
2382
|
-
|
2155
|
+
# validate the arguments
|
2156
|
+
for _key, _val in _params['kwargs'].items():
|
2157
|
+
if _key not in _all_params:
|
2383
2158
|
raise ApiTypeError(
|
2384
2159
|
"Got an unexpected keyword argument '%s'"
|
2385
|
-
" to method upsert_custom_entity_access_metadata" %
|
2160
|
+
" to method upsert_custom_entity_access_metadata" % _key
|
2386
2161
|
)
|
2387
|
-
|
2388
|
-
del
|
2389
|
-
|
2390
|
-
|
2391
|
-
|
2392
|
-
|
2393
|
-
|
2394
|
-
if
|
2395
|
-
|
2396
|
-
|
2397
|
-
|
2398
|
-
|
2399
|
-
|
2400
|
-
|
2401
|
-
|
2402
|
-
|
2403
|
-
|
2404
|
-
|
2405
|
-
# verify the required parameter 'identifier_scope' is set
|
2406
|
-
if self.api_client.client_side_validation and ('identifier_scope' not in local_var_params or # noqa: E501
|
2407
|
-
local_var_params['identifier_scope'] is None): # noqa: E501
|
2408
|
-
raise ApiValueError("Missing the required parameter `identifier_scope` when calling `upsert_custom_entity_access_metadata`") # noqa: E501
|
2409
|
-
# verify the required parameter 'upsert_custom_entity_access_metadata_request' is set
|
2410
|
-
if self.api_client.client_side_validation and ('upsert_custom_entity_access_metadata_request' not in local_var_params or # noqa: E501
|
2411
|
-
local_var_params['upsert_custom_entity_access_metadata_request'] is None): # noqa: E501
|
2412
|
-
raise ApiValueError("Missing the required parameter `upsert_custom_entity_access_metadata_request` when calling `upsert_custom_entity_access_metadata`") # noqa: E501
|
2413
|
-
|
2414
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
2415
|
-
len(local_var_params['entity_type']) > 64): # noqa: E501
|
2416
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `upsert_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
2417
|
-
if self.api_client.client_side_validation and ('entity_type' in local_var_params and # noqa: E501
|
2418
|
-
len(local_var_params['entity_type']) < 1): # noqa: E501
|
2419
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `upsert_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
2420
|
-
if self.api_client.client_side_validation and 'entity_type' in local_var_params and not re.search(r'^~[a-zA-Z0-9\-_]+$', local_var_params['entity_type']): # noqa: E501
|
2421
|
-
raise ApiValueError("Invalid value for parameter `entity_type` when calling `upsert_custom_entity_access_metadata`, must conform to the pattern `/^~[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
2422
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
2423
|
-
len(local_var_params['identifier_type']) > 64): # noqa: E501
|
2424
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `upsert_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
2425
|
-
if self.api_client.client_side_validation and ('identifier_type' in local_var_params and # noqa: E501
|
2426
|
-
len(local_var_params['identifier_type']) < 1): # noqa: E501
|
2427
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `upsert_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
2428
|
-
if self.api_client.client_side_validation and 'identifier_type' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_type']): # noqa: E501
|
2429
|
-
raise ApiValueError("Invalid value for parameter `identifier_type` when calling `upsert_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
2430
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
2431
|
-
len(local_var_params['identifier_value']) > 1024): # noqa: E501
|
2432
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `upsert_custom_entity_access_metadata`, length must be less than or equal to `1024`") # noqa: E501
|
2433
|
-
if self.api_client.client_side_validation and ('identifier_value' in local_var_params and # noqa: E501
|
2434
|
-
len(local_var_params['identifier_value']) < 1): # noqa: E501
|
2435
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `upsert_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
2436
|
-
if self.api_client.client_side_validation and 'identifier_value' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_value']): # noqa: E501
|
2437
|
-
raise ApiValueError("Invalid value for parameter `identifier_value` when calling `upsert_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
2438
|
-
if self.api_client.client_side_validation and ('metadata_key' in local_var_params and # noqa: E501
|
2439
|
-
len(local_var_params['metadata_key']) > 100): # noqa: E501
|
2440
|
-
raise ApiValueError("Invalid value for parameter `metadata_key` when calling `upsert_custom_entity_access_metadata`, length must be less than or equal to `100`") # noqa: E501
|
2441
|
-
if self.api_client.client_side_validation and ('metadata_key' in local_var_params and # noqa: E501
|
2442
|
-
len(local_var_params['metadata_key']) < 1): # noqa: E501
|
2443
|
-
raise ApiValueError("Invalid value for parameter `metadata_key` when calling `upsert_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
2444
|
-
if self.api_client.client_side_validation and 'metadata_key' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['metadata_key']): # noqa: E501
|
2445
|
-
raise ApiValueError("Invalid value for parameter `metadata_key` when calling `upsert_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
2446
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
2447
|
-
len(local_var_params['identifier_scope']) > 64): # noqa: E501
|
2448
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `upsert_custom_entity_access_metadata`, length must be less than or equal to `64`") # noqa: E501
|
2449
|
-
if self.api_client.client_side_validation and ('identifier_scope' in local_var_params and # noqa: E501
|
2450
|
-
len(local_var_params['identifier_scope']) < 1): # noqa: E501
|
2451
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `upsert_custom_entity_access_metadata`, length must be greater than or equal to `1`") # noqa: E501
|
2452
|
-
if self.api_client.client_side_validation and 'identifier_scope' in local_var_params and not re.search(r'^[a-zA-Z0-9\-_]+$', local_var_params['identifier_scope']): # noqa: E501
|
2453
|
-
raise ApiValueError("Invalid value for parameter `identifier_scope` when calling `upsert_custom_entity_access_metadata`, must conform to the pattern `/^[a-zA-Z0-9\-_]+$/`") # noqa: E501
|
2454
|
-
collection_formats = {}
|
2455
|
-
|
2456
|
-
path_params = {}
|
2457
|
-
if 'entity_type' in local_var_params:
|
2458
|
-
path_params['entityType'] = local_var_params['entity_type'] # noqa: E501
|
2459
|
-
if 'identifier_type' in local_var_params:
|
2460
|
-
path_params['identifierType'] = local_var_params['identifier_type'] # noqa: E501
|
2461
|
-
if 'identifier_value' in local_var_params:
|
2462
|
-
path_params['identifierValue'] = local_var_params['identifier_value'] # noqa: E501
|
2463
|
-
if 'metadata_key' in local_var_params:
|
2464
|
-
path_params['metadataKey'] = local_var_params['metadata_key'] # noqa: E501
|
2465
|
-
|
2466
|
-
query_params = []
|
2467
|
-
if 'identifier_scope' in local_var_params and local_var_params['identifier_scope'] is not None: # noqa: E501
|
2468
|
-
query_params.append(('identifierScope', local_var_params['identifier_scope'])) # noqa: E501
|
2469
|
-
if 'effective_at' in local_var_params and local_var_params['effective_at'] is not None: # noqa: E501
|
2470
|
-
query_params.append(('effectiveAt', local_var_params['effective_at'])) # noqa: E501
|
2471
|
-
if 'effective_until' in local_var_params and local_var_params['effective_until'] is not None: # noqa: E501
|
2472
|
-
query_params.append(('effectiveUntil', local_var_params['effective_until'])) # noqa: E501
|
2473
|
-
|
2474
|
-
header_params = dict(local_var_params.get('_headers', {}))
|
2475
|
-
|
2476
|
-
form_params = []
|
2477
|
-
local_var_files = {}
|
2478
|
-
|
2479
|
-
body_params = None
|
2480
|
-
if 'upsert_custom_entity_access_metadata_request' in local_var_params:
|
2481
|
-
body_params = local_var_params['upsert_custom_entity_access_metadata_request']
|
2482
|
-
# HTTP header `Accept`
|
2483
|
-
header_params['Accept'] = self.api_client.select_header_accept(
|
2484
|
-
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2162
|
+
_params[_key] = _val
|
2163
|
+
del _params['kwargs']
|
2164
|
+
|
2165
|
+
_collection_formats = {}
|
2166
|
+
|
2167
|
+
# process the path parameters
|
2168
|
+
_path_params = {}
|
2169
|
+
if _params['entity_type']:
|
2170
|
+
_path_params['entityType'] = _params['entity_type']
|
2171
|
+
|
2172
|
+
if _params['identifier_type']:
|
2173
|
+
_path_params['identifierType'] = _params['identifier_type']
|
2174
|
+
|
2175
|
+
if _params['identifier_value']:
|
2176
|
+
_path_params['identifierValue'] = _params['identifier_value']
|
2177
|
+
|
2178
|
+
if _params['metadata_key']:
|
2179
|
+
_path_params['metadataKey'] = _params['metadata_key']
|
2485
2180
|
|
2486
|
-
header_params['Accept-Encoding'] = "gzip, deflate, br"
|
2487
2181
|
|
2488
|
-
#
|
2489
|
-
|
2490
|
-
|
2182
|
+
# process the query parameters
|
2183
|
+
_query_params = []
|
2184
|
+
if _params.get('identifier_scope') is not None: # noqa: E501
|
2185
|
+
_query_params.append(('identifierScope', _params['identifier_scope']))
|
2186
|
+
|
2187
|
+
if _params.get('effective_at') is not None: # noqa: E501
|
2188
|
+
_query_params.append(('effectiveAt', _params['effective_at']))
|
2189
|
+
|
2190
|
+
if _params.get('effective_until') is not None: # noqa: E501
|
2191
|
+
if isinstance(_params['effective_until'], datetime):
|
2192
|
+
_query_params.append(('effectiveUntil', _params['effective_until'].strftime(self.api_client.configuration.datetime_format)))
|
2193
|
+
else:
|
2194
|
+
_query_params.append(('effectiveUntil', _params['effective_until']))
|
2195
|
+
|
2196
|
+
# process the header parameters
|
2197
|
+
_header_params = dict(_params.get('_headers', {}))
|
2198
|
+
# process the form parameters
|
2199
|
+
_form_params = []
|
2200
|
+
_files = {}
|
2201
|
+
# process the body parameter
|
2202
|
+
_body_params = None
|
2203
|
+
if _params['upsert_custom_entity_access_metadata_request'] is not None:
|
2204
|
+
_body_params = _params['upsert_custom_entity_access_metadata_request']
|
2205
|
+
|
2206
|
+
# set the HTTP header `Accept`
|
2207
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
2208
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2491
2209
|
|
2492
|
-
# set the
|
2493
|
-
|
2494
|
-
|
2210
|
+
# set the HTTP header `Content-Type`
|
2211
|
+
_content_types_list = _params.get('_content_type',
|
2212
|
+
self.api_client.select_header_content_type(
|
2213
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
2214
|
+
if _content_types_list:
|
2215
|
+
_header_params['Content-Type'] = _content_types_list
|
2495
2216
|
|
2496
|
-
#
|
2497
|
-
|
2217
|
+
# authentication setting
|
2218
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2498
2219
|
|
2499
|
-
|
2500
|
-
200: "
|
2501
|
-
400: "LusidValidationProblemDetails",
|
2220
|
+
_response_types_map = {
|
2221
|
+
'200': "List[AccessMetadataValue]",
|
2222
|
+
'400': "LusidValidationProblemDetails",
|
2502
2223
|
}
|
2503
2224
|
|
2504
2225
|
return self.api_client.call_api(
|
2505
2226
|
'/api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata/{metadataKey}', 'PUT',
|
2506
|
-
|
2507
|
-
|
2508
|
-
|
2509
|
-
body=
|
2510
|
-
post_params=
|
2511
|
-
files=
|
2512
|
-
response_types_map=
|
2513
|
-
auth_settings=
|
2514
|
-
async_req=
|
2515
|
-
_return_http_data_only=
|
2516
|
-
_preload_content=
|
2517
|
-
_request_timeout=
|
2518
|
-
collection_formats=
|
2519
|
-
_request_auth=
|
2227
|
+
_path_params,
|
2228
|
+
_query_params,
|
2229
|
+
_header_params,
|
2230
|
+
body=_body_params,
|
2231
|
+
post_params=_form_params,
|
2232
|
+
files=_files,
|
2233
|
+
response_types_map=_response_types_map,
|
2234
|
+
auth_settings=_auth_settings,
|
2235
|
+
async_req=_params.get('async_req'),
|
2236
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2237
|
+
_preload_content=_params.get('_preload_content', True),
|
2238
|
+
_request_timeout=_params.get('_request_timeout'),
|
2239
|
+
collection_formats=_collection_formats,
|
2240
|
+
_request_auth=_params.get('_request_auth'))
|