office365-rest-python-client 3.0.0__py3-none-any.whl

office365/sharepoint/agreements/reportfilter.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class AgreementReportFilter(ClientValue):
+    Category: str | None = None
+    FirstParty: str | None = None
+    Language: str | None = None
+    Location: str | None = None
+    Owner: str | None = None
+    SecondParty: str | None = None
+    State: str | None = None

office365/sharepoint/agreements/searchparameters.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class AgreementSearchParameters(ClientValue):
+    AgreementNumber: str | None = None
+    Category: str | None = None
+    Owner: str | None = None
+    RowLimit: int | None = None
+    StartRow: int | None = None
+    State: str | None = None

office365/sharepoint/agreements/site.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from datetime import datetime
+from typing import Optional
+
+from office365.runtime.client_value import ClientValue
+from office365.sharepoint.publishing.sharepointids import SharePointIds
+from office365.sharepoint.sites.template import SiteTemplate
+from office365.sharepoint.viva.resourcevisualization import ResourceVisualization
+
+
+@dataclass
+class SPAgreementsSite(ClientValue):
+    CreatedDateTime: datetime = datetime.min
+    Description: Optional[str] = None
+    GroupId: Optional[str] = None
+    LastModifiedDateTime: datetime = datetime.min
+    ResourceVisualization: ResourceVisualization = field(default_factory=ResourceVisualization)
+    SharePointIds: SharePointIds = field(default_factory=SharePointIds)
+    Template: SiteTemplate = field(default_factory=SiteTemplate)
+    Title: Optional[str] = None
+    WebUrl: Optional[str] = None

office365/sharepoint/agreements/ssolutionenabledsitesresponse.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.agreements.site import SPAgreementsSite
+
+
+@dataclass
+class AgreementsSolutionEnabledSitesResponse(ClientValue):
+    Sites: ClientValueCollection[SPAgreementsSite] = field(
+        default_factory=lambda: ClientValueCollection(SPAgreementsSite)
+    )
+    SkipToken: str | None = None

office365/sharepoint/agreements/summarydata.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Optional
+
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.agreements.datapair import AgreementDataPair
+
+
+@dataclass
+class AgreementSummaryData(ClientValue):
+    by_category: Optional[ClientValueCollection[AgreementDataPair]] = None
+    by_expiration_year: Optional[ClientValueCollection[AgreementDataPair]] = None
+    by_first_party: Optional[ClientValueCollection[AgreementDataPair]] = None
+    by_renewal_year: Optional[ClientValueCollection[AgreementDataPair]] = None
+    by_second_party: Optional[ClientValueCollection[AgreementDataPair]] = None
+    evergreen: Optional[int] = None
+    ByCategory: ClientValueCollection[AgreementDataPair] = field(
+        default_factory=lambda: ClientValueCollection(AgreementDataPair)
+    )
+    ByExpirationYear: ClientValueCollection[AgreementDataPair] = field(
+        default_factory=lambda: ClientValueCollection(AgreementDataPair)
+    )
+    ByFirstParty: ClientValueCollection[AgreementDataPair] = field(
+        default_factory=lambda: ClientValueCollection(AgreementDataPair)
+    )
+    ByRenewalYear: ClientValueCollection[AgreementDataPair] = field(
+        default_factory=lambda: ClientValueCollection(AgreementDataPair)
+    )
+    BySecondParty: ClientValueCollection[AgreementDataPair] = field(
+        default_factory=lambda: ClientValueCollection(AgreementDataPair)
+    )
+    Evergreen: int | None = None

office365/sharepoint/agreements/templatecreationparameters.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class TemplateCreationParameters(ClientValue):
+    SourceFileUniqueId: Optional[str] = None
+    SourceLibraryId: Optional[str] = None
+    TemplateName: Optional[str] = None
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Agreements.Models.TemplateCreationParameters"

office365/sharepoint/agreements/updateesignconfigpayload.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from office365.runtime.client_value import ClientValue
+from office365.runtime.types.collections import StringCollection
+
+
+@dataclass
+class UpdateAgreementESignConfigPayload(ClientValue):
+    AgreementId: str | None = None
+    AgreementUrl: str | None = None
+    DocumentId: str | None = None
+    eSignStatus: str | None = None
+    MoveStateToInESign: bool | None = None
+    RequestorEmail: str | None = None
+    SignersEmail: StringCollection = field(default_factory=StringCollection)

office365/sharepoint/agreements/updatemetadatapayload.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class UpdateAgreementMetaDataPayload(ClientValue):
+    FileUrl: str | None = None
+    MarkAsTerminationLetter: bool | None = None

office365/sharepoint/agreements/updatestatepayload.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class UpdateAgreementStatePayload(ClientValue):
+    AgreementUrl: str | None = None
+    CurrentState: int | None = None
+    NextState: int | None = None

office365/sharepoint/alerts/alert.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Optional
+
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+
+if TYPE_CHECKING:
+    from office365.sharepoint.listitems.listitem import ListItem
+
+
+class Alert(Entity):
+    """
+    Represents an alert, which generates periodic e-mail notifications sent to a user about the list, list item,
+    document, or document library to which the alert applies. SP.Alert provides information about the alert,
+    such as which alert template is used, the alert frequency, and the UserID of the user who created the alert.
+
+    The AlertTime, ItemID, ListID and ListUrl properties are not included in the default scalar property
+    set for this type.
+    """
+
+    @property
+    def alert_frequency(self) -> Optional[int]:
+        """Gets the time interval for sending the alert."""
+        return self.properties.get("AlertFrequency", None)
+
+    @property
+    def alert_template_name(self) -> Optional[int]:
+        """Gets the string representing the alert template name."""
+        return self.properties.get("AlertTemplateName", None)
+
+    @property
+    def always_notify(self) -> Optional[bool]:
+        """Gets a Boolean value that causes daily and weekly alerts to trigger, even if there is no matching event."""
+        return self.properties.get("AlwaysNotify", None)
+
+    @property
+    def item(self) -> ListItem:
+        """Gets the list item or document to which the alert applies."""
+        from office365.sharepoint.listitems.listitem import ListItem
+
+        return self.properties.get("Item", ListItem(self.context, ResourcePath("item", self.resource_path)))
+
+    @property
+    def user(self):
+        """Gets user object that represents User for the alert."""
+        from office365.sharepoint.principal.users.user import User
+
+        return self.properties.get("User", User(self.context, ResourcePath("user", self.resource_path)))
+
+    @property
+    def list(self):
+        """Gets list object that represents List for the alert."""
+        from office365.sharepoint.lists.list import List
+
+        return self.properties.get("List", List(self.context, ResourcePath("list", self.resource_path)))

office365/sharepoint/alerts/collection.py

@@ -0,0 +1,60 @@
+from typing_extensions import Self
+
+from office365.runtime.client_result import ClientResult
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.alerts.alert import Alert
+from office365.sharepoint.alerts.creation_information import AlertCreationInformation
+from office365.sharepoint.entity_collection import EntityCollection
+
+
+class AlertCollection(EntityCollection[Alert]):
+    """Content Type resource collection"""
+
+    def __init__(self, context, resource_path=None):
+        super().__init__(context, Alert, resource_path)
+
+    def add(self, parameters: AlertCreationInformation) -> Alert:
+        """Add an SP.Alert to SP.AlertCollection based on the given alertCreationInformation
+
+        Args:
+            parameters (office365.sharepoint.alerts.creation_information.AlertCreationInformation):
+        """
+        return_type = Alert(self.context)
+        self.add_child(return_type)
+        qry = ServiceOperationQuery(self, "Add", None, parameters, "alertCreationInformation", return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def contains(self, id_alert: str) -> ClientResult[bool]:
+        """Returns true if the given alert exists in the alert collection. False otherwise.
+
+        Args:
+            id_alert (str): The Id of the alert to search.
+        """
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "Contains", {"idAlert": id_alert}, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def delete_alert_at_index(self, index: int) -> Self:
+        """Deletes the alert based on the given index.
+
+        Args:
+            index (int): A 32-bit integer that is greater than or equal to 0 and less than the count of the alert in the
+                collection. Specifies the index of the alert in the collection.
+        """
+        qry = ServiceOperationQuery(self, "DeleteAlertAtIndex", {"index": index}, None, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def get_by_id(self, id_alert: str) -> Alert:
+        """Gets an alert based on the Id.
+
+        Args:
+            id_alert (str): The Id of the alert to get.
+        """
+        return Alert(
+            self.context,
+            ServiceOperationPath("GetById", [id_alert], self.resource_path),
+        )

office365/sharepoint/alerts/creation_information.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Optional
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class AlertCreationInformation(ClientValue):
+    """An object that contain the properties used to create a new SP.Alert"""
+
+    AlertFrequency: Optional[int] = None
+    AlertTemplateName: Optional[str] = None
+    AlertType: Optional[int] = None
+    AlertTime: datetime = datetime.min
+    AlwaysNotify: Optional[bool] = None
+    DeliveryChannels: Optional[int] = None
+    EventType: Optional[int] = None
+    EventTypeBitmask: Optional[int] = None
+    Filter: Optional[str] = None
+    List: Optional[str] = None
+    Properties: Optional[dict] = None
+    Status: Optional[int] = None
+    Title: Optional[str] = None

office365/sharepoint/analytics/usage_entry.py

@@ -0,0 +1,55 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+
+
+class AnalyticsUsageEntry(Entity):
+    """Specifies an analytics usage entry to log user or system events"""
+
+    @staticmethod
+    def log_analytics_event(context, event_type_id, item_id):
+        """Creates and logs an analytics event into the analytics pipeline.
+
+        Args:
+            context (office365.sharepoint.client_context.ClientContext):
+            event_type_id (str): The event type identifier of the analytics event to create.
+            item_id (str): The identifier of the item for which the event is being logged.
+        """
+        payload = {
+            "eventTypeId": event_type_id,
+            "itemId": item_id,
+        }
+        binding_type = AnalyticsUsageEntry(context)
+        qry = ServiceOperationQuery(binding_type, "LogAnalyticsEvent", None, payload, is_static=True)
+        context.add_query(qry)
+        return binding_type
+
+    @staticmethod
+    def log_analytics_app_event2(context, app_event_type_id, item_id, rollup_scope_id, site_id, user_id):
+        """Creates and logs an analytics event into the analytics pipeline with additional parameters.
+
+        Args:
+            context (office365.sharepoint.client_context.ClientContext):
+            app_event_type_id (str): The event type identifier of the analytics event to be created.
+            item_id (str): The identifier of the item for which the event is being logged.
+            rollup_scope_id (str): The identifier of a rollup scope.
+                Events for different items with the same rollup scope can be aggregated together at that rollup scope in
+                    addition to being counted just at the item scope.
+            site_id (str): The identifier of the item's site.
+            user_id (str): The identifier of the user generating the event.
+        """
+        payload = {
+            "appEventTypeId": app_event_type_id,
+            "itemId": item_id,
+            "rollupScopeId": rollup_scope_id,
+            "site_id": site_id,
+            "userId": user_id,
+        }
+        binding_type = AnalyticsUsageEntry(context)
+        qry = ServiceOperationQuery(binding_type, "LogAnalyticsAppEvent2", None, payload)
+        qry.static = True
+        context.add_query(qry)
+        return binding_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.Analytics.AnalyticsUsageEntry"

office365/sharepoint/appprincipal/credential.py

@@ -0,0 +1,42 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+
+
+class AppPrincipalCredential(Entity):
+    """Represents a credential belonging to an app principal."""
+
+    @staticmethod
+    def create_from_symmetric_key(context, symmetric_key, not_before, not_after=None):
+        """Create an instance of SP.AppPrincipalCredential that wraps a symmetric key.
+
+        Args:
+            context (office365.sharepoint.client_context.ClientContext):
+            symmetric_key (str): The symmetric key of the app principal credential.
+            not_before (datetime.datetime): The earliest time when the key is valid.
+            not_after (datetime.datetime): The time when the key expires.
+        """
+        return_type = AppPrincipalCredential(context)
+        payload = {
+            "symmetricKey": symmetric_key,
+            "notBefore": not_before.isoformat(),
+            "notAfter": not_after.isoformat() if not_after else None,
+        }
+        qry = ServiceOperationQuery(return_type, "CreateFromSymmetricKey", None, payload, None, return_type)
+        qry.static = True
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def create_from_key_group(context, key_group_identifier):
+        """Create an instance of SP.AppPrincipalCredential that wraps a key group identifier.
+
+        Args:
+            context (office365.sharepoint.client_context.ClientContext):
+            key_group_identifier (str): The key group identifier.
+        """
+        return_type = AppPrincipalCredential(context)
+        payload = {"keyGroupIdentifier": key_group_identifier}
+        qry = ServiceOperationQuery(return_type, "CreateFromKeyGroup", None, payload, None, return_type)
+        qry.static = True
+        context.add_query(qry)
+        return return_type

office365/sharepoint/appprincipal/identity_provider.py

@@ -0,0 +1,13 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+
+
+class AppPrincipalIdentityProvider(Entity):
+    """Represents an identity provider for app principals."""
+
+    @staticmethod
+    def external(context) -> "AppPrincipalIdentityProvider":
+        return_type = AppPrincipalIdentityProvider(context)
+        qry = ServiceOperationQuery(return_type, "External", None, None, None, return_type, True)
+        context.add_query(qry)
+        return return_type

office365/sharepoint/appprincipal/manager.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class AppPrincipalManager(Entity):
+    """Represents a top level object used to manage app principals."""

office365/sharepoint/appprincipal/name.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class AppPrincipalName(Entity):
+    """Represents the name of an app principal."""

office365/sharepoint/approvals/accessrequestresponse.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+from uuid import UUID
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class AccessRequestResponse(ClientValue):
+    result: Optional[bool] = None
+    requestedObjectId: UUID | None = None

office365/sharepoint/approvals/additionalaccessstatusresponse.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class AdditionalAccessStatusResponse(ClientValue):
+    AdditionalAccessRequestStatus: int | None = None
+    ErrorMessage: str | None = None
+    RoleValue: int | None = None
+    StatusCode: int | None = None

office365/sharepoint/approvals/agreementworkflowresponse.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class AgreementWorkFlowResponse(ClientValue):
+    NextWorkFlow: str | None = None

office365/sharepoint/approvals/approvals.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.entity import Entity
+
+
+class Approvals(Entity):
+    pass

office365/sharepoint/approvals/createrequestparameters.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class ApprovalsCreateRequestParameters(ClientValue):
+    approvers: Optional[str] = None
+    details: Optional[str] = None
+    item_id: Optional[str] = None
+    item_url_type: Optional[int] = None
+    title: Optional[str] = None
+    url: Optional[str] = None
+    version: Optional[str] = None
+    awaitAll: bool | None = None
+    itemId: str | None = None
+    itemUrlType: int | None = None
+    listId: str | None = None
+    markDocAsFinal: bool | None = None

office365/sharepoint/approvals/createtemplateresponse.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class CreateTemplateResponse(ClientValue):
+    ServerRelativeUrl: Optional[str] = None
+    Title: Optional[str] = None
+    UniqueID: Optional[str] = None
+    Url: Optional[str] = None

office365/sharepoint/approvals/mediaserviceupdateparameters.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from office365.runtime.client_value import ClientValue
+from office365.sharepoint.approvals.spagreementresults import SPAgreementResults
+from office365.sharepoint.compliance.classification.result import ClassificationResult
+from office365.sharepoint.contentcenter.machinelearning.samples.meta import MachineLearningSampleMeta
+
+
+@dataclass
+class MediaServiceUpdateParameters(ClientValue):
+    AgreementClauses: str | None = None
+    AgreementResults: SPAgreementResults = field(default_factory=SPAgreementResults)
+    AIPLabelExtractionStatus: int | None = None
+    ChiSquareDistribution: str | None = None
+    ClassificationResult: ClassificationResult = field(default_factory=ClassificationResult)
+    ContentVersion: int | None = None
+    DigitalSignatureProvider: str | None = None
+    Entropy: str | None = None
+    ETag: str | None = None
+    FieldValues: dict | None = field(default_factory=dict)
+    GeneratedSnippetShortInstructions: str | None = None
+    HasDigitalSignature: str | None = None
+    IsLowPriorityRequest: bool | None = None
+    IsMediaServiceRequest: bool | None = None
+    MachineLearningSampleMeta: MachineLearningSampleMeta = field(default_factory=MachineLearningSampleMeta)
+    MediaLengthInSeconds: int | None = None
+    MediaServiceAutoKeyPoints: str | None = None
+    MediaServiceAutoTags: str | None = None
+    MediaServiceBillingMetadata: str | None = None
+    MediaServiceDateTaken: str | None = None
+    MediaServiceDocTags: str | None = None
+    MediaServiceEventHashCode: str | None = None
+    MediaServiceFastMetadata: str | None = None
+    MediaServiceGenerationTime: str | None = None
+    MediaServiceImageHeight: int | None = None
+    MediaServiceImageTags: str | None = None
+    MediaServiceImageWidth: int | None = None
+    MediaServiceKeyPoints: str | None = None
+    MediaServiceLocation: str | None = None
+    MediaServiceMetadata: str | None = None
+    MediaServiceObjectDetectorVersions: str | None = None
+    MediaServiceOCR: str | None = None
+    MediaServicePhotoCategory: str | None = None
+    MediaServiceProtectionKey: str | None = None
+    MediaServiceSearchProperties: str | None = None
+    MediaServiceSystemTags: str | None = None
+    MediaServiceTranscript: str | None = None
+    MonteCarloApproximation: str | None = None
+    SensitivityLabel: str | None = None
+    SensitivityLabelAssignmentMethod: int | None = None
+    SkipSearchReindex: bool | None = None
+    TranslatedLang: str | None = None
+    VirusInfo: str | None = None
+    VirusStatus: str | None = None
+    XTenantLabelInfo: str | None = None

office365/sharepoint/approvals/properties.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+from office365.runtime.client_value import ClientValue
+
+
+@dataclass
+class ApprovalsProperties(ClientValue):
+    ApproversAwaitAll: Optional[bool] = None
+    ApproversAwaitAllFixed: Optional[bool] = None
+    ApproversFixed: Optional[bool] = None
+    ApproverSourceType: Optional[int] = None
+    ApproverSourceValue: Optional[str] = None
+    ProvisioningError: Optional[str] = None
+    ProvisioningStatus: Optional[int] = None
+    NotificationsEnabled: Optional[bool] = None

office365/sharepoint/approvals/reviewconfigurationpayload.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Optional
+
+from office365.runtime.client_value import ClientValue
+from office365.runtime.types.collections import StringCollection
+
+
+@dataclass
+class ReviewConfigurationPayload(ClientValue):
+    category_id: Optional[str] = None
+    reviewers: StringCollection = field(default_factory=StringCollection)
+    review_type: Optional[str] = None

office365/sharepoint/approvals/reviewconfigurationresponse.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Optional
+
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.approvals.user import UserDTO
+
+
+@dataclass
+class ReviewConfigurationResponse(ClientValue):
+    action: Optional[str] = None
+    contract_category: Optional[str] = None
+    contract_category_id: Optional[str] = None
+    reviewers: ClientValueCollection[UserDTO] = field(default_factory=lambda: ClientValueCollection(UserDTO))
+    review_type: Optional[str] = None