lusid-sdk 2.1.242__py3-none-any.whl → 2.1.320__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. lusid/__init__.py +66 -0
  2. lusid/api/__init__.py +2 -0
  3. lusid/api/compliance_api.py +191 -0
  4. lusid/api/entities_api.py +360 -0
  5. lusid/api/fee_types_api.py +143 -0
  6. lusid/api/fund_configurations_api.py +944 -0
  7. lusid/api/funds_api.py +1 -1
  8. lusid/api/order_management_api.py +479 -1
  9. lusid/api/scopes_api.py +38 -9
  10. lusid/configuration.py +1 -1
  11. lusid/extensions/configuration_loaders.py +9 -1
  12. lusid/models/__init__.py +64 -0
  13. lusid/models/accounting_method.py +3 -0
  14. lusid/models/accumulation_event.py +3 -3
  15. lusid/models/amortisation_event.py +3 -3
  16. lusid/models/bond_coupon_event.py +3 -3
  17. lusid/models/bond_default_event.py +3 -3
  18. lusid/models/bond_principal_event.py +3 -3
  19. lusid/models/cancel_orders_response.py +153 -0
  20. lusid/models/cancel_placements_response.py +153 -0
  21. lusid/models/cancelled_order_result.py +73 -0
  22. lusid/models/cancelled_placement_result.py +83 -0
  23. lusid/models/capital_distribution_event.py +3 -3
  24. lusid/models/cash.py +93 -0
  25. lusid/models/cash_dividend_event.py +3 -3
  26. lusid/models/cash_flow_event.py +3 -3
  27. lusid/models/close_event.py +3 -3
  28. lusid/models/compliance_run_configuration.py +73 -0
  29. lusid/models/component_filter.py +85 -0
  30. lusid/models/component_rule.py +77 -0
  31. lusid/models/contract_for_difference.py +4 -2
  32. lusid/models/create_derived_transaction_portfolio_request.py +3 -3
  33. lusid/models/create_transaction_portfolio_request.py +3 -3
  34. lusid/models/dependency_source_filter.py +9 -2
  35. lusid/models/dividend_option_event.py +3 -3
  36. lusid/models/dividend_reinvestment_event.py +3 -3
  37. lusid/models/exercise_event.py +3 -3
  38. lusid/models/expiry_event.py +3 -3
  39. lusid/models/fee_transaction_template_specification.py +79 -0
  40. lusid/models/fund.py +6 -1
  41. lusid/models/fund_amount.py +69 -0
  42. lusid/models/fund_configuration.py +151 -0
  43. lusid/models/fund_configuration_properties.py +115 -0
  44. lusid/models/fund_configuration_request.py +136 -0
  45. lusid/models/fund_pnl_breakdown.py +110 -0
  46. lusid/models/fund_previous_nav.py +69 -0
  47. lusid/models/fund_request.py +6 -1
  48. lusid/models/fund_valuation_point_data.py +152 -0
  49. lusid/models/future_expiry_event.py +100 -0
  50. lusid/models/futures_contract_details.py +9 -2
  51. lusid/models/fx_forward_settlement_event.py +3 -3
  52. lusid/models/informational_error_event.py +3 -3
  53. lusid/models/informational_event.py +3 -3
  54. lusid/models/instrument_entity.py +146 -0
  55. lusid/models/instrument_event.py +6 -5
  56. lusid/models/instrument_event_type.py +1 -0
  57. lusid/models/lusid_instrument.py +3 -2
  58. lusid/models/market_data_key_rule.py +3 -3
  59. lusid/models/market_data_specific_rule.py +3 -3
  60. lusid/models/market_quote.py +3 -3
  61. lusid/models/maturity_event.py +3 -3
  62. lusid/models/merger_event.py +3 -3
  63. lusid/models/model_selection.py +3 -3
  64. lusid/models/open_event.py +3 -3
  65. lusid/models/paged_resource_list_of_fund_configuration.py +113 -0
  66. lusid/models/placement_update_request.py +116 -0
  67. lusid/models/portfolio.py +3 -3
  68. lusid/models/portfolio_details.py +3 -3
  69. lusid/models/portfolio_without_href.py +3 -3
  70. lusid/models/pre_trade_configuration.py +69 -0
  71. lusid/models/previous_fund_valuation_point_data.py +79 -0
  72. lusid/models/previous_nav.py +73 -0
  73. lusid/models/previous_share_class_breakdown.py +81 -0
  74. lusid/models/pricing_model.py +1 -0
  75. lusid/models/property_definition.py +7 -1
  76. lusid/models/property_definition_entity.py +146 -0
  77. lusid/models/quote_series_id.py +4 -20
  78. lusid/models/quote_type.py +3 -0
  79. lusid/models/raw_vendor_event.py +3 -3
  80. lusid/models/reset_event.py +3 -3
  81. lusid/models/reverse_stock_split_event.py +3 -3
  82. lusid/models/scrip_dividend_event.py +3 -3
  83. lusid/models/share_class_amount.py +73 -0
  84. lusid/models/share_class_breakdown.py +163 -0
  85. lusid/models/share_class_data.py +79 -0
  86. lusid/models/share_class_details.py +108 -0
  87. lusid/models/share_class_pnl_breakdown.py +110 -0
  88. lusid/models/spin_off_event.py +3 -3
  89. lusid/models/staged_modification.py +8 -1
  90. lusid/models/stock_dividend_event.py +3 -3
  91. lusid/models/stock_split_event.py +3 -3
  92. lusid/models/template_field.py +3 -1
  93. lusid/models/transaction_configuration_movement_data.py +2 -2
  94. lusid/models/transaction_configuration_movement_data_request.py +1 -1
  95. lusid/models/transaction_field_map.py +8 -3
  96. lusid/models/transaction_type_movement.py +2 -2
  97. lusid/models/transition_event.py +3 -3
  98. lusid/models/trigger_event.py +3 -3
  99. lusid/models/unitisation_data.py +73 -0
  100. lusid/models/update_placements_response.py +153 -0
  101. lusid/models/valuation_point_data_response.py +30 -9
  102. {lusid_sdk-2.1.242.dist-info → lusid_sdk-2.1.320.dist-info}/METADATA +53 -215
  103. {lusid_sdk-2.1.242.dist-info → lusid_sdk-2.1.320.dist-info}/RECORD +104 -71
  104. {lusid_sdk-2.1.242.dist-info → lusid_sdk-2.1.320.dist-info}/WHEEL +0 -0
lusid/__init__.py CHANGED
@@ -42,6 +42,7 @@ from lusid.api.derived_transaction_portfolios_api import DerivedTransactionPortf
42
42
  from lusid.api.entities_api import EntitiesApi
43
43
  from lusid.api.executions_api import ExecutionsApi
44
44
  from lusid.api.fee_types_api import FeeTypesApi
45
+ from lusid.api.fund_configurations_api import FundConfigurationsApi
45
46
  from lusid.api.funds_api import FundsApi
46
47
  from lusid.api.instrument_event_types_api import InstrumentEventTypesApi
47
48
  from lusid.api.instrument_events_api import InstrumentEventsApi
@@ -184,8 +185,13 @@ from lusid.models.calculation_info import CalculationInfo
184
185
  from lusid.models.calendar import Calendar
185
186
  from lusid.models.calendar_date import CalendarDate
186
187
  from lusid.models.calendar_dependency import CalendarDependency
188
+ from lusid.models.cancel_orders_response import CancelOrdersResponse
189
+ from lusid.models.cancel_placements_response import CancelPlacementsResponse
190
+ from lusid.models.cancelled_order_result import CancelledOrderResult
191
+ from lusid.models.cancelled_placement_result import CancelledPlacementResult
187
192
  from lusid.models.cap_floor import CapFloor
188
193
  from lusid.models.capital_distribution_event import CapitalDistributionEvent
194
+ from lusid.models.cash import Cash
189
195
  from lusid.models.cash_and_security_offer_election import CashAndSecurityOfferElection
190
196
  from lusid.models.cash_dependency import CashDependency
191
197
  from lusid.models.cash_dividend_event import CashDividendEvent
@@ -237,6 +243,7 @@ from lusid.models.compliance_rule_result_v2 import ComplianceRuleResultV2
237
243
  from lusid.models.compliance_rule_template import ComplianceRuleTemplate
238
244
  from lusid.models.compliance_rule_upsert_request import ComplianceRuleUpsertRequest
239
245
  from lusid.models.compliance_rule_upsert_response import ComplianceRuleUpsertResponse
246
+ from lusid.models.compliance_run_configuration import ComplianceRunConfiguration
240
247
  from lusid.models.compliance_run_info import ComplianceRunInfo
241
248
  from lusid.models.compliance_run_info_v2 import ComplianceRunInfoV2
242
249
  from lusid.models.compliance_step import ComplianceStep
@@ -250,6 +257,8 @@ from lusid.models.compliance_template_parameter import ComplianceTemplateParamet
250
257
  from lusid.models.compliance_template_variation import ComplianceTemplateVariation
251
258
  from lusid.models.compliance_template_variation_dto import ComplianceTemplateVariationDto
252
259
  from lusid.models.compliance_template_variation_request import ComplianceTemplateVariationRequest
260
+ from lusid.models.component_filter import ComponentFilter
261
+ from lusid.models.component_rule import ComponentRule
253
262
  from lusid.models.component_transaction import ComponentTransaction
254
263
  from lusid.models.composite_breakdown import CompositeBreakdown
255
264
  from lusid.models.composite_breakdown_request import CompositeBreakdownRequest
@@ -395,6 +404,7 @@ from lusid.models.fee_request import FeeRequest
395
404
  from lusid.models.fee_rule import FeeRule
396
405
  from lusid.models.fee_rule_upsert_request import FeeRuleUpsertRequest
397
406
  from lusid.models.fee_rule_upsert_response import FeeRuleUpsertResponse
407
+ from lusid.models.fee_transaction_template_specification import FeeTransactionTemplateSpecification
398
408
  from lusid.models.fee_type import FeeType
399
409
  from lusid.models.fee_type_request import FeeTypeRequest
400
410
  from lusid.models.field_definition import FieldDefinition
@@ -415,12 +425,20 @@ from lusid.models.flow_conventions import FlowConventions
415
425
  from lusid.models.forward_rate_agreement import ForwardRateAgreement
416
426
  from lusid.models.from_recipe import FromRecipe
417
427
  from lusid.models.fund import Fund
428
+ from lusid.models.fund_amount import FundAmount
429
+ from lusid.models.fund_configuration import FundConfiguration
430
+ from lusid.models.fund_configuration_properties import FundConfigurationProperties
431
+ from lusid.models.fund_configuration_request import FundConfigurationRequest
432
+ from lusid.models.fund_pnl_breakdown import FundPnlBreakdown
433
+ from lusid.models.fund_previous_nav import FundPreviousNAV
418
434
  from lusid.models.fund_properties import FundProperties
419
435
  from lusid.models.fund_request import FundRequest
420
436
  from lusid.models.fund_share_class import FundShareClass
437
+ from lusid.models.fund_valuation_point_data import FundValuationPointData
421
438
  from lusid.models.funding_leg import FundingLeg
422
439
  from lusid.models.funding_leg_options import FundingLegOptions
423
440
  from lusid.models.future import Future
441
+ from lusid.models.future_expiry_event import FutureExpiryEvent
424
442
  from lusid.models.futures_contract_details import FuturesContractDetails
425
443
  from lusid.models.fx_conventions import FxConventions
426
444
  from lusid.models.fx_dependency import FxDependency
@@ -495,6 +513,7 @@ from lusid.models.instrument_cash_flow import InstrumentCashFlow
495
513
  from lusid.models.instrument_definition import InstrumentDefinition
496
514
  from lusid.models.instrument_definition_format import InstrumentDefinitionFormat
497
515
  from lusid.models.instrument_delete_modes import InstrumentDeleteModes
516
+ from lusid.models.instrument_entity import InstrumentEntity
498
517
  from lusid.models.instrument_event import InstrumentEvent
499
518
  from lusid.models.instrument_event_configuration import InstrumentEventConfiguration
500
519
  from lusid.models.instrument_event_holder import InstrumentEventHolder
@@ -644,6 +663,7 @@ from lusid.models.paged_resource_list_of_execution import PagedResourceListOfExe
644
663
  from lusid.models.paged_resource_list_of_fee import PagedResourceListOfFee
645
664
  from lusid.models.paged_resource_list_of_fee_type import PagedResourceListOfFeeType
646
665
  from lusid.models.paged_resource_list_of_fund import PagedResourceListOfFund
666
+ from lusid.models.paged_resource_list_of_fund_configuration import PagedResourceListOfFundConfiguration
647
667
  from lusid.models.paged_resource_list_of_general_ledger_profile_response import PagedResourceListOfGeneralLedgerProfileResponse
648
668
  from lusid.models.paged_resource_list_of_instrument import PagedResourceListOfInstrument
649
669
  from lusid.models.paged_resource_list_of_instrument_event_holder import PagedResourceListOfInstrumentEventHolder
@@ -691,6 +711,7 @@ from lusid.models.place_blocks_request import PlaceBlocksRequest
691
711
  from lusid.models.placement import Placement
692
712
  from lusid.models.placement_request import PlacementRequest
693
713
  from lusid.models.placement_set_request import PlacementSetRequest
714
+ from lusid.models.placement_update_request import PlacementUpdateRequest
694
715
  from lusid.models.portfolio import Portfolio
695
716
  from lusid.models.portfolio_cash_flow import PortfolioCashFlow
696
717
  from lusid.models.portfolio_cash_ladder import PortfolioCashLadder
@@ -721,12 +742,17 @@ from lusid.models.posting_module_request import PostingModuleRequest
721
742
  from lusid.models.posting_module_response import PostingModuleResponse
722
743
  from lusid.models.posting_module_rule import PostingModuleRule
723
744
  from lusid.models.posting_module_rules_updated_response import PostingModuleRulesUpdatedResponse
745
+ from lusid.models.pre_trade_configuration import PreTradeConfiguration
724
746
  from lusid.models.premium import Premium
747
+ from lusid.models.previous_fund_valuation_point_data import PreviousFundValuationPointData
748
+ from lusid.models.previous_nav import PreviousNAV
749
+ from lusid.models.previous_share_class_breakdown import PreviousShareClassBreakdown
725
750
  from lusid.models.pricing_context import PricingContext
726
751
  from lusid.models.pricing_model import PricingModel
727
752
  from lusid.models.pricing_options import PricingOptions
728
753
  from lusid.models.processed_command import ProcessedCommand
729
754
  from lusid.models.property_definition import PropertyDefinition
755
+ from lusid.models.property_definition_entity import PropertyDefinitionEntity
730
756
  from lusid.models.property_definition_search_result import PropertyDefinitionSearchResult
731
757
  from lusid.models.property_definition_type import PropertyDefinitionType
732
758
  from lusid.models.property_domain import PropertyDomain
@@ -901,6 +927,11 @@ from lusid.models.set_share_class_instruments_request import SetShareClassInstru
901
927
  from lusid.models.set_transaction_configuration_alias import SetTransactionConfigurationAlias
902
928
  from lusid.models.set_transaction_configuration_source_request import SetTransactionConfigurationSourceRequest
903
929
  from lusid.models.settlement_schedule import SettlementSchedule
930
+ from lusid.models.share_class_amount import ShareClassAmount
931
+ from lusid.models.share_class_breakdown import ShareClassBreakdown
932
+ from lusid.models.share_class_data import ShareClassData
933
+ from lusid.models.share_class_details import ShareClassDetails
934
+ from lusid.models.share_class_pnl_breakdown import ShareClassPnlBreakdown
904
935
  from lusid.models.side_configuration_data import SideConfigurationData
905
936
  from lusid.models.side_configuration_data_request import SideConfigurationDataRequest
906
937
  from lusid.models.side_definition import SideDefinition
@@ -994,6 +1025,7 @@ from lusid.models.trial_balance_query_parameters import TrialBalanceQueryParamet
994
1025
  from lusid.models.trigger_event import TriggerEvent
995
1026
  from lusid.models.typed_resource_id import TypedResourceId
996
1027
  from lusid.models.unit_schema import UnitSchema
1028
+ from lusid.models.unitisation_data import UnitisationData
997
1029
  from lusid.models.units_ratio import UnitsRatio
998
1030
  from lusid.models.unmatched_holding_method import UnmatchedHoldingMethod
999
1031
  from lusid.models.update_amortisation_rule_set_details_request import UpdateAmortisationRuleSetDetailsRequest
@@ -1006,6 +1038,7 @@ from lusid.models.update_data_type_request import UpdateDataTypeRequest
1006
1038
  from lusid.models.update_derived_property_definition_request import UpdateDerivedPropertyDefinitionRequest
1007
1039
  from lusid.models.update_fee_type_request import UpdateFeeTypeRequest
1008
1040
  from lusid.models.update_instrument_identifier_request import UpdateInstrumentIdentifierRequest
1041
+ from lusid.models.update_placements_response import UpdatePlacementsResponse
1009
1042
  from lusid.models.update_portfolio_group_request import UpdatePortfolioGroupRequest
1010
1043
  from lusid.models.update_portfolio_request import UpdatePortfolioRequest
1011
1044
  from lusid.models.update_property_definition_request import UpdatePropertyDefinitionRequest
@@ -1128,6 +1161,7 @@ __all__ = [
1128
1161
  "EntitiesApi",
1129
1162
  "ExecutionsApi",
1130
1163
  "FeeTypesApi",
1164
+ "FundConfigurationsApi",
1131
1165
  "FundsApi",
1132
1166
  "InstrumentEventTypesApi",
1133
1167
  "InstrumentEventsApi",
@@ -1260,8 +1294,13 @@ __all__ = [
1260
1294
  "Calendar",
1261
1295
  "CalendarDate",
1262
1296
  "CalendarDependency",
1297
+ "CancelOrdersResponse",
1298
+ "CancelPlacementsResponse",
1299
+ "CancelledOrderResult",
1300
+ "CancelledPlacementResult",
1263
1301
  "CapFloor",
1264
1302
  "CapitalDistributionEvent",
1303
+ "Cash",
1265
1304
  "CashAndSecurityOfferElection",
1266
1305
  "CashDependency",
1267
1306
  "CashDividendEvent",
@@ -1313,6 +1352,7 @@ __all__ = [
1313
1352
  "ComplianceRuleTemplate",
1314
1353
  "ComplianceRuleUpsertRequest",
1315
1354
  "ComplianceRuleUpsertResponse",
1355
+ "ComplianceRunConfiguration",
1316
1356
  "ComplianceRunInfo",
1317
1357
  "ComplianceRunInfoV2",
1318
1358
  "ComplianceStep",
@@ -1326,6 +1366,8 @@ __all__ = [
1326
1366
  "ComplianceTemplateVariation",
1327
1367
  "ComplianceTemplateVariationDto",
1328
1368
  "ComplianceTemplateVariationRequest",
1369
+ "ComponentFilter",
1370
+ "ComponentRule",
1329
1371
  "ComponentTransaction",
1330
1372
  "CompositeBreakdown",
1331
1373
  "CompositeBreakdownRequest",
@@ -1471,6 +1513,7 @@ __all__ = [
1471
1513
  "FeeRule",
1472
1514
  "FeeRuleUpsertRequest",
1473
1515
  "FeeRuleUpsertResponse",
1516
+ "FeeTransactionTemplateSpecification",
1474
1517
  "FeeType",
1475
1518
  "FeeTypeRequest",
1476
1519
  "FieldDefinition",
@@ -1491,12 +1534,20 @@ __all__ = [
1491
1534
  "ForwardRateAgreement",
1492
1535
  "FromRecipe",
1493
1536
  "Fund",
1537
+ "FundAmount",
1538
+ "FundConfiguration",
1539
+ "FundConfigurationProperties",
1540
+ "FundConfigurationRequest",
1541
+ "FundPnlBreakdown",
1542
+ "FundPreviousNAV",
1494
1543
  "FundProperties",
1495
1544
  "FundRequest",
1496
1545
  "FundShareClass",
1546
+ "FundValuationPointData",
1497
1547
  "FundingLeg",
1498
1548
  "FundingLegOptions",
1499
1549
  "Future",
1550
+ "FutureExpiryEvent",
1500
1551
  "FuturesContractDetails",
1501
1552
  "FxConventions",
1502
1553
  "FxDependency",
@@ -1571,6 +1622,7 @@ __all__ = [
1571
1622
  "InstrumentDefinition",
1572
1623
  "InstrumentDefinitionFormat",
1573
1624
  "InstrumentDeleteModes",
1625
+ "InstrumentEntity",
1574
1626
  "InstrumentEvent",
1575
1627
  "InstrumentEventConfiguration",
1576
1628
  "InstrumentEventHolder",
@@ -1720,6 +1772,7 @@ __all__ = [
1720
1772
  "PagedResourceListOfFee",
1721
1773
  "PagedResourceListOfFeeType",
1722
1774
  "PagedResourceListOfFund",
1775
+ "PagedResourceListOfFundConfiguration",
1723
1776
  "PagedResourceListOfGeneralLedgerProfileResponse",
1724
1777
  "PagedResourceListOfInstrument",
1725
1778
  "PagedResourceListOfInstrumentEventHolder",
@@ -1767,6 +1820,7 @@ __all__ = [
1767
1820
  "Placement",
1768
1821
  "PlacementRequest",
1769
1822
  "PlacementSetRequest",
1823
+ "PlacementUpdateRequest",
1770
1824
  "Portfolio",
1771
1825
  "PortfolioCashFlow",
1772
1826
  "PortfolioCashLadder",
@@ -1797,12 +1851,17 @@ __all__ = [
1797
1851
  "PostingModuleResponse",
1798
1852
  "PostingModuleRule",
1799
1853
  "PostingModuleRulesUpdatedResponse",
1854
+ "PreTradeConfiguration",
1800
1855
  "Premium",
1856
+ "PreviousFundValuationPointData",
1857
+ "PreviousNAV",
1858
+ "PreviousShareClassBreakdown",
1801
1859
  "PricingContext",
1802
1860
  "PricingModel",
1803
1861
  "PricingOptions",
1804
1862
  "ProcessedCommand",
1805
1863
  "PropertyDefinition",
1864
+ "PropertyDefinitionEntity",
1806
1865
  "PropertyDefinitionSearchResult",
1807
1866
  "PropertyDefinitionType",
1808
1867
  "PropertyDomain",
@@ -1977,6 +2036,11 @@ __all__ = [
1977
2036
  "SetTransactionConfigurationAlias",
1978
2037
  "SetTransactionConfigurationSourceRequest",
1979
2038
  "SettlementSchedule",
2039
+ "ShareClassAmount",
2040
+ "ShareClassBreakdown",
2041
+ "ShareClassData",
2042
+ "ShareClassDetails",
2043
+ "ShareClassPnlBreakdown",
1980
2044
  "SideConfigurationData",
1981
2045
  "SideConfigurationDataRequest",
1982
2046
  "SideDefinition",
@@ -2070,6 +2134,7 @@ __all__ = [
2070
2134
  "TriggerEvent",
2071
2135
  "TypedResourceId",
2072
2136
  "UnitSchema",
2137
+ "UnitisationData",
2073
2138
  "UnitsRatio",
2074
2139
  "UnmatchedHoldingMethod",
2075
2140
  "UpdateAmortisationRuleSetDetailsRequest",
@@ -2082,6 +2147,7 @@ __all__ = [
2082
2147
  "UpdateDerivedPropertyDefinitionRequest",
2083
2148
  "UpdateFeeTypeRequest",
2084
2149
  "UpdateInstrumentIdentifierRequest",
2150
+ "UpdatePlacementsResponse",
2085
2151
  "UpdatePortfolioGroupRequest",
2086
2152
  "UpdatePortfolioRequest",
2087
2153
  "UpdatePropertyDefinitionRequest",
lusid/api/__init__.py CHANGED
@@ -26,6 +26,7 @@ from lusid.api.derived_transaction_portfolios_api import DerivedTransactionPortf
26
26
  from lusid.api.entities_api import EntitiesApi
27
27
  from lusid.api.executions_api import ExecutionsApi
28
28
  from lusid.api.fee_types_api import FeeTypesApi
29
+ from lusid.api.fund_configurations_api import FundConfigurationsApi
29
30
  from lusid.api.funds_api import FundsApi
30
31
  from lusid.api.instrument_event_types_api import InstrumentEventTypesApi
31
32
  from lusid.api.instrument_events_api import InstrumentEventsApi
@@ -94,6 +95,7 @@ __all__ = [
94
95
  "EntitiesApi",
95
96
  "ExecutionsApi",
96
97
  "FeeTypesApi",
98
+ "FundConfigurationsApi",
97
99
  "FundsApi",
98
100
  "InstrumentEventTypesApi",
99
101
  "InstrumentEventsApi",
@@ -29,6 +29,7 @@ from typing import Optional
29
29
  from lusid.models.compliance_rule_response import ComplianceRuleResponse
30
30
  from lusid.models.compliance_rule_result_v2 import ComplianceRuleResultV2
31
31
  from lusid.models.compliance_rule_template import ComplianceRuleTemplate
32
+ from lusid.models.compliance_run_configuration import ComplianceRunConfiguration
32
33
  from lusid.models.compliance_run_info_v2 import ComplianceRunInfoV2
33
34
  from lusid.models.compliance_template import ComplianceTemplate
34
35
  from lusid.models.create_compliance_template_request import CreateComplianceTemplateRequest
@@ -1964,6 +1965,196 @@ class ComplianceApi:
1964
1965
  collection_formats=_collection_formats,
1965
1966
  _request_auth=_params.get('_request_auth'))
1966
1967
 
1968
+ @overload
1969
+ async def run_compliance_preview(self, run_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope to save the run results in.")], rule_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope from which to select rules to be run.")], recipe_id_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: the scope of the recipe to be used")], recipe_id_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: The code of the recipe to be used. If left blank, the default recipe will be used.")], compliance_run_configuration : Annotated[Optional[ComplianceRunConfiguration], Field(description="Configuration options for the compliance run.")] = None, **kwargs) -> ComplianceRunInfoV2: # noqa: E501
1970
+ ...
1971
+
1972
+ @overload
1973
+ def run_compliance_preview(self, run_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope to save the run results in.")], rule_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope from which to select rules to be run.")], recipe_id_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: the scope of the recipe to be used")], recipe_id_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: The code of the recipe to be used. If left blank, the default recipe will be used.")], compliance_run_configuration : Annotated[Optional[ComplianceRunConfiguration], Field(description="Configuration options for the compliance run.")] = None, async_req: Optional[bool]=True, **kwargs) -> ComplianceRunInfoV2: # noqa: E501
1974
+ ...
1975
+
1976
+ @validate_arguments
1977
+ def run_compliance_preview(self, run_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope to save the run results in.")], rule_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope from which to select rules to be run.")], recipe_id_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: the scope of the recipe to be used")], recipe_id_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: The code of the recipe to be used. If left blank, the default recipe will be used.")], compliance_run_configuration : Annotated[Optional[ComplianceRunConfiguration], Field(description="Configuration options for the compliance run.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ComplianceRunInfoV2, Awaitable[ComplianceRunInfoV2]]: # noqa: E501
1978
+ """[EARLY ACCESS] RunCompliancePreview: Run a compliance check. # noqa: E501
1979
+
1980
+ Use this endpoint to run a compliance check using rules from a specific scope. # noqa: E501
1981
+ This method makes a synchronous HTTP request by default. To make an
1982
+ asynchronous HTTP request, please pass async_req=True
1983
+
1984
+ >>> thread = api.run_compliance_preview(run_scope, rule_scope, recipe_id_scope, recipe_id_code, compliance_run_configuration, async_req=True)
1985
+ >>> result = thread.get()
1986
+
1987
+ :param run_scope: Required: Scope to save the run results in. (required)
1988
+ :type run_scope: str
1989
+ :param rule_scope: Required: Scope from which to select rules to be run. (required)
1990
+ :type rule_scope: str
1991
+ :param recipe_id_scope: Required: the scope of the recipe to be used (required)
1992
+ :type recipe_id_scope: str
1993
+ :param recipe_id_code: Required: The code of the recipe to be used. If left blank, the default recipe will be used. (required)
1994
+ :type recipe_id_code: str
1995
+ :param compliance_run_configuration: Configuration options for the compliance run.
1996
+ :type compliance_run_configuration: ComplianceRunConfiguration
1997
+ :param async_req: Whether to execute the request asynchronously.
1998
+ :type async_req: bool, optional
1999
+ :param _request_timeout: timeout setting for this request.
2000
+ If one number provided, it will be total request
2001
+ timeout. It can also be a pair (tuple) of
2002
+ (connection, read) timeouts.
2003
+ :return: Returns the result object.
2004
+ If the method is called asynchronously,
2005
+ returns the request thread.
2006
+ :rtype: ComplianceRunInfoV2
2007
+ """
2008
+ kwargs['_return_http_data_only'] = True
2009
+ if '_preload_content' in kwargs:
2010
+ message = "Error! Please call the run_compliance_preview_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
2011
+ raise ValueError(message)
2012
+ if async_req is not None:
2013
+ kwargs['async_req'] = async_req
2014
+ return self.run_compliance_preview_with_http_info(run_scope, rule_scope, recipe_id_scope, recipe_id_code, compliance_run_configuration, **kwargs) # noqa: E501
2015
+
2016
+ @validate_arguments
2017
+ def run_compliance_preview_with_http_info(self, run_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope to save the run results in.")], rule_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope from which to select rules to be run.")], recipe_id_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: the scope of the recipe to be used")], recipe_id_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: The code of the recipe to be used. If left blank, the default recipe will be used.")], compliance_run_configuration : Annotated[Optional[ComplianceRunConfiguration], Field(description="Configuration options for the compliance run.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2018
+ """[EARLY ACCESS] RunCompliancePreview: Run a compliance check. # noqa: E501
2019
+
2020
+ Use this endpoint to run a compliance check using rules from a specific scope. # noqa: E501
2021
+ This method makes a synchronous HTTP request by default. To make an
2022
+ asynchronous HTTP request, please pass async_req=True
2023
+
2024
+ >>> thread = api.run_compliance_preview_with_http_info(run_scope, rule_scope, recipe_id_scope, recipe_id_code, compliance_run_configuration, async_req=True)
2025
+ >>> result = thread.get()
2026
+
2027
+ :param run_scope: Required: Scope to save the run results in. (required)
2028
+ :type run_scope: str
2029
+ :param rule_scope: Required: Scope from which to select rules to be run. (required)
2030
+ :type rule_scope: str
2031
+ :param recipe_id_scope: Required: the scope of the recipe to be used (required)
2032
+ :type recipe_id_scope: str
2033
+ :param recipe_id_code: Required: The code of the recipe to be used. If left blank, the default recipe will be used. (required)
2034
+ :type recipe_id_code: str
2035
+ :param compliance_run_configuration: Configuration options for the compliance run.
2036
+ :type compliance_run_configuration: ComplianceRunConfiguration
2037
+ :param async_req: Whether to execute the request asynchronously.
2038
+ :type async_req: bool, optional
2039
+ :param _preload_content: if False, the ApiResponse.data will
2040
+ be set to none and raw_data will store the
2041
+ HTTP response body without reading/decoding.
2042
+ Default is True.
2043
+ :type _preload_content: bool, optional
2044
+ :param _return_http_data_only: response data instead of ApiResponse
2045
+ object with status code, headers, etc
2046
+ :type _return_http_data_only: bool, optional
2047
+ :param _request_timeout: timeout setting for this request. If one
2048
+ number provided, it will be total request
2049
+ timeout. It can also be a pair (tuple) of
2050
+ (connection, read) timeouts.
2051
+ :param _request_auth: set to override the auth_settings for an a single
2052
+ request; this effectively ignores the authentication
2053
+ in the spec for a single request.
2054
+ :type _request_auth: dict, optional
2055
+ :type _content_type: string, optional: force content-type for the request
2056
+ :return: Returns the result object.
2057
+ If the method is called asynchronously,
2058
+ returns the request thread.
2059
+ :rtype: tuple(ComplianceRunInfoV2, status_code(int), headers(HTTPHeaderDict))
2060
+ """
2061
+
2062
+ _params = locals()
2063
+
2064
+ _all_params = [
2065
+ 'run_scope',
2066
+ 'rule_scope',
2067
+ 'recipe_id_scope',
2068
+ 'recipe_id_code',
2069
+ 'compliance_run_configuration'
2070
+ ]
2071
+ _all_params.extend(
2072
+ [
2073
+ 'async_req',
2074
+ '_return_http_data_only',
2075
+ '_preload_content',
2076
+ '_request_timeout',
2077
+ '_request_auth',
2078
+ '_content_type',
2079
+ '_headers'
2080
+ ]
2081
+ )
2082
+
2083
+ # validate the arguments
2084
+ for _key, _val in _params['kwargs'].items():
2085
+ if _key not in _all_params:
2086
+ raise ApiTypeError(
2087
+ "Got an unexpected keyword argument '%s'"
2088
+ " to method run_compliance_preview" % _key
2089
+ )
2090
+ _params[_key] = _val
2091
+ del _params['kwargs']
2092
+
2093
+ _collection_formats = {}
2094
+
2095
+ # process the path parameters
2096
+ _path_params = {}
2097
+
2098
+ # process the query parameters
2099
+ _query_params = []
2100
+ if _params.get('run_scope') is not None: # noqa: E501
2101
+ _query_params.append(('runScope', _params['run_scope']))
2102
+
2103
+ if _params.get('rule_scope') is not None: # noqa: E501
2104
+ _query_params.append(('ruleScope', _params['rule_scope']))
2105
+
2106
+ if _params.get('recipe_id_scope') is not None: # noqa: E501
2107
+ _query_params.append(('recipeIdScope', _params['recipe_id_scope']))
2108
+
2109
+ if _params.get('recipe_id_code') is not None: # noqa: E501
2110
+ _query_params.append(('recipeIdCode', _params['recipe_id_code']))
2111
+
2112
+ # process the header parameters
2113
+ _header_params = dict(_params.get('_headers', {}))
2114
+ # process the form parameters
2115
+ _form_params = []
2116
+ _files = {}
2117
+ # process the body parameter
2118
+ _body_params = None
2119
+ if _params['compliance_run_configuration'] is not None:
2120
+ _body_params = _params['compliance_run_configuration']
2121
+
2122
+ # set the HTTP header `Accept`
2123
+ _header_params['Accept'] = self.api_client.select_header_accept(
2124
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
2125
+
2126
+ # set the HTTP header `Content-Type`
2127
+ _content_types_list = _params.get('_content_type',
2128
+ self.api_client.select_header_content_type(
2129
+ ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
2130
+ if _content_types_list:
2131
+ _header_params['Content-Type'] = _content_types_list
2132
+
2133
+ # authentication setting
2134
+ _auth_settings = ['oauth2'] # noqa: E501
2135
+
2136
+ _response_types_map = {
2137
+ '200': "ComplianceRunInfoV2",
2138
+ '400': "LusidValidationProblemDetails",
2139
+ }
2140
+
2141
+ return self.api_client.call_api(
2142
+ '/api/compliance/preview/runs', 'POST',
2143
+ _path_params,
2144
+ _query_params,
2145
+ _header_params,
2146
+ body=_body_params,
2147
+ post_params=_form_params,
2148
+ files=_files,
2149
+ response_types_map=_response_types_map,
2150
+ auth_settings=_auth_settings,
2151
+ async_req=_params.get('async_req'),
2152
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
2153
+ _preload_content=_params.get('_preload_content', True),
2154
+ _request_timeout=_params.get('_request_timeout'),
2155
+ collection_formats=_collection_formats,
2156
+ _request_auth=_params.get('_request_auth'))
2157
+
1967
2158
  @overload
1968
2159
  async def update_compliance_template(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Compliance Rule Template.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Compliance Rule Template.")], update_compliance_template_request : Annotated[UpdateComplianceTemplateRequest, Field(..., description="Request to update a compliance rule template.")], **kwargs) -> ComplianceRuleTemplate: # noqa: E501
1969
2160
  ...