fix: assert target_user.id before passing to get_user_by_id for type safety

Author: vgrem

examples/sharepoint/lists/read_items_with_filter.py

@@ -12,9 +12,9 @@
 list_title = "Site Pages"
 site_pages = ctx.web.lists.get_by_title(list_title)
 from_datetime = datetime.datetime(2022, 1, 20, 0, 0)
-filter_text = "Created gt datetime'{0}'".format(from_datetime.isoformat())
+filter_text = f"Created gt datetime'{from_datetime.isoformat()}'"
 include_fields = ["Created", "EncodedAbsUrl"]
 items = site_pages.items.filter(filter_text).select(include_fields).get().execute_query()
-print("Loaded items count: {0}".format(len(items)))
+print(f"Loaded items count: {len(items)}")
 for item in items:
     print(item.properties["EncodedAbsUrl"])

generator/.checkpoints/SharePoint.xml.json

@@ -1 +1 @@
-["SP.FileCreationInformation", "SP.ListDataValidationFailure", "SP.CoAuthConfiguration", "SP.FieldGeolocationValue", "SP.ItemOrderUpdateValue", "SP.AgreementWorkFlowResponse", "SP.AccessRequestResponse", "SP.FieldUrlValue", "SP.CustomerKeyInfo", "SP.DashboardItemInfo", "SP.GridInitInfoType", "SP.AutoLabellingWorkInformation", "SP.CustomizedFormsPage", "SP.AgreementMetaData", "SP.KnowledgeHubSiteReference", "SP.CurrencyInformationCollection", "SP.OwnedByMeParams", "SP.SPMoveAndShareFileInfo", "SP.RequestedTranslation", "SP.RecipientLimitsInfo", "SP.HomeSitesDetails", "SP.DestinationLibraryInfo", "SP.ActionSubmit", "SP.SPTeamChannelCapabilities", "SP.ContentTypeEntityData", "SP.AgreementCountryResponse", "SP.CreatableItemInfo", "SP.CreateTemplateResponse", "SP.AgreementSummaryData", "SP.AdaptiveCard", "SP.PortalAndOrgNewsSiteReference", "SP.SiteSuggestionResponse", "SP.ActionSet", "SP.DocumentGenerationInfo", "SP.ListItemComplianceInfo", "SP.MultiGeoCopyParameters", "SP.AttachmentCreationInformation", "SP.CustomerKeyVaultInfo", "SP.ContentTypeId", "SP.ClassificationResult", "SP.AgreementsSolutionEnabledSitesResponse", "SP.SharePointIds", "SP.AgreementPermissionsData", "SP.AgreementLocationData", "SP.DesktopSettings", "SP.ColumnSet", "SP.FieldCalculatedErrorValue", "SP.VivaHomeTitleRegion", "SP.EngageDistributionInfo", "SP.Snippet", "SP.BaseRequestParams", "SP.ApprovalsProperties", "SP.CAAESnippetElement", "SP.BasePermissions", "SP.PublishModernTemplatePayload", "SP.SharedWithUser", "SP.SiteSuggestionItem", "SP.NgspRequestParams", "SP.CreateAgreementFolderInfo", "SP.OrganizationNewsSiteReference", "SP.ActionToggleVisibility", "SP.FontOption", "SP.AppLicense", "SP.SharingLinkData", "SP.EffectiveBasePermissions", "SP.FollowedSitesParams", "SP.SimpleDataRow", "SP.AdaptiveCardColumn", "SP.CustomerKeyStatusInfo", "SP.ChangeToken", "SP.SPAgreementsSite", "SP.CopyMigrationOptions", "SP.ManageChannelCapabilitiesRequest", "SP.SPHSiteReference", "SP.AgreementDocumentsInfo", "SP.BrandCenterConfiguration", "SP.CAFieldValue", "SP.AgreementImportData", "SP.AdaptiveCardAction", "SP.EnqueueJobInformation", "SP.DocumentLocation", "SP.FieldLookupValue", "SP.RestrictAccessControlUpdate", "SP.InputChoiceSet", "SP.PlaceholderV2", "SP.ActionShowCard", "SP.ConfigurationData", "SP.Container", "SP.TargetedSiteDetails", "SP.RelatedItem", "SP.CreatableItemInfoCollection", "SP.SimpleDataTable", "SP.SemanticSearchCrawlerEnqueueItem", "SP.ScriptSafeDomainEntityData", "SP.SiteAISettings", "SP.VivaConnectionsLicense", "SP.CurrencyInformation", "SP.CustomizedFormsPageCollection", "SP.SharingLinkInfo", "SP.FieldUserValue", "SP.TabItem", "SP.InsertFieldResponse", "SP.MobileSettings", "SP.CardElement", "SP.Placeholder", "SP.PublishTemplateV2Payload", "SP.CAAEFieldElement", "SP.CustomActionElement", "SP.AgreementLocation", "SP.FieldValuesWithUrl", "SP.AdaptiveCardImage", "SP.LockFileData", "SP.AgreementDataPair", "SP.FieldRatingScaleQuestionAnswer", "SP.ContentAssemblyModernTemplateColumnsMappingInfo", "SP.AppViewCreationInfo", "SP.CopyMigrationInfo", "SP.AgreementDocument", "SP.UserIdInfo", "SP.CustomActionElementCollection", "SP.ApprovalsCreateRequestParameters", "SP.ActionOpenUrl", "SP.ContentControlInfo", "SP.SiteAISettingsRequest", "SP.GetNextAgreementWorkFlowRequest", "SP.RestrictContentOrgWidePolicyUpdate", "SP.ChangeLogItemQuery", "SP.ContentAssemblyFileInfo", "SP.CreateHVCSItemApprovalRequestParameters", "SP.HomeSiteReference", "SP.AgreementReportBaseData", "SP.CountByDate", "SP.AgreementSearchParameters", "SP.IngestionTaskKey", "SP.PivotItem", "SP.SmartTemplateContentType", "SP.PowerPlatformEnvironment", "SP.ExceptionDetails", "SP.AppSiteContext", "SP.EventReceiverDefinitionCreationInformation", "SP.DashboardItem", "SP.VivaConnectionsUrlConfiguration", "SP.HTMLFieldSecuritySetting", "SP.FieldCreationInformation", "SP.ContentAssemblyFormAnswer", "SP.AppLicenseCollection", "SP.AgreementsSolutionFileContext", "SP.AdditionalAccessStatusResponse", "SP.ActionHttp", "SP.AsyncReadJobInfo", "SP.SiteTemplate", "SP.ContextWebInformation", "SP.Audience", "SP.InputChoice", "SP.DocumentLibraryInformation", "SP.AsyncReadOptions", "SP.ChannelCapabilities", "SP.ContentTypeCreationInformation", "SP.HomeSiteNavConfiguration", "SP.SPAgreementResults", "SP.ChangeQuery", "SP.SharedWithUserCollection", "SP.InputText", "SP.RecentSitesParams", "SP.LibraryDetails", "SP.SuggestedSitesParams", "SP.AppProperties", "SP.FavoritedItemsParams", "SP.RecentFilesParams", "SP.Padding", "SP.AgreementReportFilter", "SP.AppSettingsInTeams", "SP.PublishSnippetPayload", "SP.ResourceVisualization", "SP.ColumnTypeInfo", "SP.MainLinkDetails", "SP.CopyJobProgress", "SP.EncryptionOption", "SP.AlertCreationInformation"]
+["SP.AsyncReadJobInfo", "SP.CustomerKeyVaultInfo", "SP.BasePermissions", "SP.FileCollectionAddParameters", "SP.EffectiveBasePermissions", "SP.CustomerKeyStatusInfo", "SP.MainLinkDetails", "SP.ContextWebInformation", "SP.FileVersionBatchDeleteParameters", "SP.PortalAndOrgNewsSiteReference", "SP.ActionShowCard", "SP.MobileSettings", "SP.AdditionalAccessStatusResponse", "SP.ListItemDeleteParameters", "SP.FieldUrlValue", "SP.SPInvitationCreationResult", "SP.CardElement", "SP.UserIdInfo", "SP.VivaHomeTitleRegion", "SP.AgreementSummaryData", "SP.ScriptSafeDomainEntityData", "SP.CurrencyInformationCollection", "SP.RecentFilesParams", "SP.FollowedSitesParams", "SP.ActionSubmit", "SP.ActionOpenUrl", "SP.FontOption", "SP.EventReceiverDefinitionCreationInformation", "SP.AppSiteContext", "SP.DashboardItemInfo", "SP.FieldRatingScaleQuestionAnswer", "SP.LabelAccessControlData", "SP.SiteAISettingsRequest", "SP.FieldGeolocationValue", "SP.ActionToggleVisibility", "SP.PublishTemplateV2Payload", "SP.AgreementDataPair", "SP.FieldCalculatedErrorValue", "SP.CustomerKeyInfo", "SP.CopyMigrationOptions", "SP.CreatableItemInfoCollection", "SP.SPListItemVersionChange", "SP.ChangeLogItemQuery", "SP.DocumentGenerationInfo", "SP.ChangeQuery", "SP.SharePointIds", "SP.GetListItemVersionsParameters", "SP.ActionSet", "SP.InputChoice", "SP.RestrictContentOrgWidePolicyUpdate", "SP.NgspRequestParams", "SP.SharingLinkData", "SP.DocumentLocation", "SP.AgreementReportFilter", "SP.TargetedSiteDetails", "SP.Container", "SP.ListItemCreationInformationUsingPath", "SP.ListDataValidationFailure", "SP.CAFieldValue", "SP.FieldValuesWithUrl", "SP.FontPackageCreationParameters", "SP.IngestionTaskKey", "SP.RequestedTranslation", "SP.SPHSiteReference", "SP.ListItemComplianceInfo", "SP.FolderDeleteParameters", "SP.AdaptiveCardColumn", "SP.ClassificationResult", "SP.AppLicense", "SP.EngageDistributionInfo", "SP.ColumnSet", "SP.SmartTemplateContentType", "SP.Language", "SP.CustomizedFormsPageCollection", "SP.AgreementMetaData", "SP.ContentTypeEntityData", "SP.AgreementLocationData", "SP.DesktopSettings", "SP.ExceptionDetails", "SP.FolderCollectionAddParameters", "SP.ListItemCreationInformation", "SP.LibraryDetails", "SP.ListCreationInformation", "SP.FavoritedItemsParams", "SP.Padding", "SP.CreatableItemInfo", "SP.AgreementDocument", "SP.ApprovalsCreateRequestParameters", "SP.OwnedByMeParams", "SP.CAAEFieldElement", "SP.FileCreationInformation", "SP.AgreementsSolutionFileContext", "SP.PivotItem", "SP.AgreementLocation", "SP.CreateHVCSItemApprovalRequestParameters", "SP.BrandCenterConfiguration", "SP.AgreementDocumentsInfo", "SP.ListItemFormUpdateValue", "SP.CustomizedFormsPage", "SP.SPMoveAndShareFileInfo", "SP.Snippet", "SP.ListItemCollectionPosition", "SP.SemanticSearchCrawlerEnqueueItem", "SP.HomeSiteNavConfiguration", "SP.SPImageItem", "SP.FieldCreationInformation", "SP.ListCollectionPosition", "SP.GetListsParameters", "SP.ResourceVisualization", "SP.ContentAssemblyFileInfo", "SP.ActionHttp", "SP.ColumnTypeInfo", "SP.FieldUserValue", "SP.AppLicenseCollection", "SP.SPAgreementResults", "SP.BaseRequestParams", "SP.SharedWithUser", "SP.AgreementReportBaseData", "SP.AgreementPermissionsData", "SP.CountByDate", "SP.ContentAssemblyModernTemplateColumnsMappingInfo", "SP.EnqueueJobInformation", "SP.Audience", "SP.ListItemUpdateResults", "SP.AlertCreationInformation", "SP.ChangeToken", "SP.ListDataValidationExceptionValue", "SP.HTMLFieldSecuritySetting", "SP.SPAgreementsSite", "SP.DashboardItem", "SP.TabItem", "SP.AsyncReadOptions", "SP.ListForm", "SP.ListDataSource", "SP.PlaceholderV2", "SP.CopyMigrationInfo", "SP.FolderColoringInformation", "SP.CreateAgreementFolderInfo", "SP.ManageChannelCapabilitiesRequest", "SP.RelatedItem", "SP.InputText", "SP.SPRuleUserInfo", "SP.EncryptionOption", "SP.ConfigurationData", "SP.SharingLinkInfo", "SP.CustomActionElementCollection", "SP.PublishModernTemplatePayload", "SP.OrganizationNewsSiteReference", "SP.AgreementCountryResponse", "SP.AppViewCreationInfo", "SP.ContentControlInfo", "SP.AgreementSearchParameters", "SP.VivaConnectionsUrlConfiguration", "SP.SiteSuggestionItem", "SP.FileDeleteParameters", "SP.DestinationLibraryInfo", "SP.CoAuthConfiguration", "SP.DocumentLibraryInformation", "SP.FieldLookupValue", "SP.ContentTypeId", "SP.HomeSitesDetails", "SP.AdaptiveCardImage", "SP.GetNextAgreementWorkFlowRequest", "SP.CurrencyInformation", "SP.RestrictAccessControlUpdate", "SP.ChannelCapabilities", "SP.CopyJobProgress", "SP.AgreementsSolutionEnabledSitesResponse", "SP.ListItemUpdateParameters", "SP.AttachmentCreationInformation", "SP.InsertFieldResponse", "SP.ItemOrderUpdateValue", "SP.Placeholder", "SP.GroupCreationInformation", "SP.SPFocalPoint", "SP.AdaptiveCard", "SP.AutoLabellingWorkInformation", "SP.SimpleDataRow", "SP.SharedWithUserCollection", "SP.SPTeamChannelCapabilities", "SP.CAAESnippetElement", "SP.CreateTemplateResponse", "SP.InputChoiceSet", "SP.SiteTemplate", "SP.SuggestedSitesParams", "SP.MachineLearningSampleMeta", "SP.AgreementWorkFlowResponse", "SP.SPListRule", "SP.PowerPlatformEnvironment", "SP.SiteSuggestionResponse", "SP.MultiGeoCopyParameters", "SP.ListItemVersionCollectionPosition", "SP.KnowledgeHubSiteReference", "SP.HubSiteCreationInformation", "SP.RecipientLimitsInfo", "SP.GridInitInfoType", "SP.LockFileData", "SP.RecentSitesParams", "SP.AccessRequestResponse", "SP.Hashtag", "SP.PublishSnippetPayload", "SP.CustomActionElement", "SP.ApprovalsProperties", "SP.SiteAISettings", "SP.AdaptiveCardAction", "SP.HomeSiteReference", "SP.ContentAssemblyFormAnswer", "SP.VersionPolicySelectionParameters", "SP.ContentTypeCreationInformation", "SP.VivaConnectionsLicense", "SP.AgreementImportData", "SP.AppProperties", "SP.AppSettingsInTeams", "SP.SimpleDataTable"]

office365/directory/audit/directory.py

@@ -5,6 +5,7 @@
 from office365.directory.audit.target_resource import TargetResource
 from office365.entity import Entity
 from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.types.odata_property import odata
 
 
 class DirectoryAudit(Entity):
@@ -13,6 +14,7 @@ class DirectoryAudit(Entity):
     def __repr__(self):
         return self.activity_display_name or self.entity_type_name
 
+    @odata(name="activityDateTime")
     @property
     def activity_datetime(self) -> datetime:
         """Indicates the date and time the activity was performed."""
@@ -49,6 +51,7 @@ def correlation_id(self) -> Optional[str]:
         """
         return self.properties.get("correlationId", None)
 
+    @odata(name="initiatedBy")
     @property
     def initiated_by(self):
         """
@@ -87,6 +90,7 @@ def result_reason(self) -> Optional[str]:
         """
         return self.properties.get("resultReason", None)
 
+    @odata(name="targetResources")
     @property
     def target_resources(self) -> ClientValueCollection[TargetResource]:
         """
@@ -95,13 +99,3 @@ def target_resources(self) -> ClientValueCollection[TargetResource]:
         and $filter (startswith) for displayName.
         """
         return self.properties.get("targetResources", ClientValueCollection(TargetResource))
-
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "activityDateTime": self.activity_datetime,
-                "initiatedBy": self.initiated_by,
-                "targetResources": self.target_resources,
-            }
-            default_value = property_mapping.get(name, None)
-        return super().get_property(name, default_value)

office365/directory/audit/log_root.py

@@ -6,13 +6,15 @@
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.types.odata_property import odata
 
 
 class AuditLogRoot(Entity):
     """Contains different types of audit logs. This resources returns a singleton auditLog resource.
     It doesn't contain any usable properties.
     """
 
+    @odata(name="directoryAudits")
     @property
     def directory_audits(self) -> EntityCollection[DirectoryAudit]:
         """
@@ -57,9 +59,3 @@ def provisioning(self) -> EntityCollection[ProvisioningObjectSummary]:
                 ResourcePath("provisioning", self.resource_path),
             ),
         )
-
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {"directoryAudits": self.directory_audits}
-            default_value = property_mapping.get(name, None)
-        return super().get_property(name, default_value)

office365/directory/extensions/logicapptriggerendpointconfiguration.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
-from office365.directory.extensions.custom.customextensionendpointconfiguration import CustomExtensionEndpointConfiguration
+from office365.directory.extensions.custom.customextensionendpointconfiguration import (
+    CustomExtensionEndpointConfiguration,
+)
 
 
 class LogicAppTriggerEndpointConfiguration(CustomExtensionEndpointConfiguration):

office365/directory/identities/userflows/b2x/user_flow.py

@@ -10,6 +10,7 @@
 from office365.directory.identities.userflows.user_flow import IdentityUserFlow
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.types.odata_property import odata
 
 
 class B2XIdentityUserFlow(IdentityUserFlow):
@@ -21,6 +22,7 @@ class B2XIdentityUserFlow(IdentityUserFlow):
     use to authenticate, along with which attributes are collected as part of the sign up process.
     """
 
+    @odata(name="identityProviders")
     @property
     def identity_providers(self) -> EntityCollection[IdentityProvider]:
         """TThe identity providers included in the user flow."""
@@ -47,6 +49,7 @@ def languages(self) -> EntityCollection[UserFlowLanguageConfiguration]:
             ),
         )
 
+    @odata(name="userAttributeAssignments")
     @property
     def user_attribute_assignments(
         self,
@@ -67,12 +70,3 @@ def user_flow_type(self) -> Optional[str]:
         the value can only be signUpOrSignIn and cannot be modified after creation.
         """
         return self.properties.get("userFlowType", None)
-
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "identityProviders": self.identity_providers,
-                "userAttributeAssignments": self.user_attribute_assignments,
-            }
-            default_value = property_mapping.get(name, None)
-        return super().get_property(name, default_value)

office365/directory/identitygovernance/workflow/custom_callout_extension.py

@@ -1,7 +1,9 @@
 from typing import Optional
 
 from office365.directory.extensions.custom.clientconfiguration import CustomExtensionClientConfiguration
-from office365.directory.extensions.custom.customextensionendpointconfiguration import CustomExtensionEndpointConfiguration
+from office365.directory.extensions.custom.customextensionendpointconfiguration import (
+    CustomExtensionEndpointConfiguration,
+)
 from office365.directory.identitygovernance.customextensionauthenticationconfiguration import (
     CustomExtensionAuthenticationConfiguration,
 )

office365/directory/security/security.py

@@ -19,6 +19,7 @@
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.runtime.types.odata_property import odata
 
 
 class Security(Entity):
@@ -47,6 +48,7 @@ def alerts(self) -> AlertCollection:
             AlertCollection(self.context, ResourcePath("alerts", self.resource_path)),
         )
 
+    @odata(name="alerts_v2")
     @property
     def alerts_v2(self) -> EntityCollection[Alert]:
         """A collection of alerts in Microsoft 365 Defender."""
@@ -60,6 +62,7 @@ def cases(self) -> CasesRoot:
         """"""
         return self.properties.get("cases", CasesRoot(self.context, ResourcePath("cases", self.resource_path)))
 
+    @odata(name="attackSimulation")
     @property
     def attack_simulation(self) -> AttackSimulationRoot:
         """"""
@@ -85,6 +88,7 @@ def labels(self) -> LabelsRoot:
             LabelsRoot(self.context, ResourcePath("labels", self.resource_path)),
         )
 
+    @odata(name="subjectRightsRequests")
     @property
     def subject_rights_requests(self) -> EntityCollection[SubjectRightsRequest]:
         """Get a list of the subjectRightsRequest objects and their properties."""
@@ -97,6 +101,7 @@ def subject_rights_requests(self) -> EntityCollection[SubjectRightsRequest]:
             ),
         )
 
+    @odata(name="secureScoreControlProfiles")
     @property
     def secure_score_control_profiles(
         self,
@@ -119,6 +124,7 @@ def triggers(self) -> TriggersRoot:
             TriggersRoot(self.context, ResourcePath("triggers", self.resource_path)),
         )
 
+    @odata(name="triggerTypes")
     @property
     def trigger_types(self) -> TriggerTypesRoot:
         """"""
@@ -127,6 +133,7 @@ def trigger_types(self) -> TriggerTypesRoot:
             TriggerTypesRoot(self.context, ResourcePath("triggerTypes", self.resource_path)),
         )
 
+    @odata(name="threatIntelligence")
     @property
     def threat_intelligence(self) -> ThreatIntelligence:
         """"""
@@ -135,19 +142,6 @@ def threat_intelligence(self) -> ThreatIntelligence:
             ThreatIntelligence(self.context, ResourcePath("threatIntelligence", self.resource_path)),
         )
 
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "alerts_v2": self.alerts_v2,
-                "attackSimulation": self.attack_simulation,
-                "subjectRightsRequests": self.subject_rights_requests,
-                "secureScoreControlProfiles": self.secure_score_control_profiles,
-                "triggerTypes": self.trigger_types,
-                "threatIntelligence": self.threat_intelligence,
-            }
-            default_value = property_mapping.get(name, None)
-        return super().get_property(name, default_value)
-
     @property
     def entity_type_name(self) -> str:
         return "microsoft.graph.security.alert"