Office365-REST-Python-Client 2.5.14__py3-none-any.whl → 2.6.0__py3-none-any.whl

office365/onedrive/workbooks/charts/series/format.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookChartSeriesFormat(Entity):
+    """Encapsulates the format properties for the chart series"""

office365/onedrive/workbooks/charts/series/series.py

@@ -0,0 +1,31 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.workbooks.charts.point import WorkbookChartPoint
+from office365.onedrive.workbooks.charts.series.format import WorkbookChartSeriesFormat
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class WorkbookChartSeries(Entity):
+    """Represents a series in a chart."""
+
+    @property
+    def format(self):
+        """The formatting of a chart series, which includes fill and line formatting."""
+        return self.properties.get(
+            "format",
+            WorkbookChartSeriesFormat(
+                self.context, ResourcePath("format", self.resource_path)
+            ),
+        )
+
+    @property
+    def points(self):
+        """A collection of all points in the series."""
+        return self.properties.get(
+            "points",
+            EntityCollection(
+                self.context,
+                WorkbookChartPoint,
+                ResourcePath("points", self.resource_path),
+            ),
+        )

office365/onedrive/workbooks/charts/title.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookChartTitle(Entity):
+    """Represents a chart title object of a chart."""

office365/onedrive/workbooks/filter.py

@@ -8,6 +8,16 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 class WorkbookFilter(Entity):
     """Manages the filtering of a table's column."""
 
+    def apply_bottom_items_filter(self, count=None):
+        """Perform a sort operation.
+
+        :param str count: The number of items to apply the filter to.
+        """
+        payload = {"count": count}
+        qry = ServiceOperationQuery(self, "applyBottomItemsFilter", None, payload)
+        self.context.add_query(qry)
+        return self
+
     def clear(self):
         """Clear the filter on the given column."""
         qry = ServiceOperationQuery(self, "clear")

office365/onedrive/workbooks/filter_criteria.py

@@ -4,14 +4,14 @@ from office365.runtime.client_value import ClientValue
 class WorkbookFilterCriteria(ClientValue):
     """Represents the filtering criteria applied to a column."""
 
-    def __init__(self, color=None, dynamicCriteria=None, operator=None, values=None):
+    def __init__(self, color=None, dynamic_criteria=None, operator=None, values=None):
         """
         :param str color:  The color applied to the cell.
-        :param str dynamicCriteria:  A dynamic formula specified in a custom filter.
+        :param str dynamic_criteria:  A dynamic formula specified in a custom filter.
         :param str operator: An operator in a cell; for example, =, >, <, <=, or <>.
         :param list values: The values that appear in the cell.
         """
         self.color = color
-        self.dynamicCriteria = dynamicCriteria
+        self.dynamicCriteria = dynamic_criteria
         self.operator = operator
         self.values = values

office365/onedrive/workbooks/ranges/fill.py

@@ -1,5 +1,15 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
 class WorkbookRangeFill(Entity):
-    """Represents the background of a range object."""
+    """HTML color code representing the color of the border line. Can either be of the form #RRGGBB,
+    for example "FFA500", or be a named HTML color, for example "orange"."""
+
+    @property
+    def color(self):
+        # type: () -> Optional[str]
+        """Gets or sets the width of all columns within the range. If the column widths aren't uniform,
+        null will be returned."""
+        return self.properties.get("color", None)

office365/onedrive/workbooks/ranges/range.py

@@ -12,6 +12,12 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 class WorkbookRange(Entity):
     """Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc."""
 
+    def __repr__(self):
+        return self.address or self.entity_type_name
+
+    def __str__(self):
+        return self.address or self.entity_type_name
+
     def cell(self, row, column):
         """
         Gets the range object containing the single cell based on row and column numbers. The cell can be outside
@@ -48,6 +54,15 @@ class WorkbookRange(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def last_row(self):
+        """
+        Get the last row within the range. For example, the last row of B2:D5 is B5:D5.
+        """
+        return_type = WorkbookRange(self.context)
+        qry = FunctionQuery(self, "lastRow", return_type=return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def visible_view(self):
         """Get the range visible from a filtered range."""
         return_type = WorkbookRangeView(self.context)
@@ -55,6 +70,17 @@ class WorkbookRange(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def used_range(self, values_only=False):
+        """Return the used range of the given range object.
+
+        :param bool values_only: Optional. Considers only cells with values as used cells.
+        """
+        return_type = WorkbookRange(self.context)
+        params = {"valuesOnly": values_only}
+        qry = FunctionQuery(self, "usedRange", params, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def address(self):
         # type: () -> Optional[str]

office365/onedrive/workbooks/ranges/view.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -6,6 +8,18 @@ from office365.runtime.paths.resource_path import ResourcePath
 class WorkbookRangeView(Entity):
     """Represents a set of visible cells of the parent range."""
 
+    @property
+    def cell_addresses(self):
+        # type: () -> Optional[dict]
+        """The cell addresses."""
+        return self.properties.get("cellAddresses", None)
+
+    @property
+    def column_count(self):
+        # type: () -> Optional[int]
+        """The number of visible columns."""
+        return self.properties.get("columnCount", None)
+
     @property
     def rows(self):
         # type: () -> EntityCollection[WorkbookRangeView]

office365/onedrive/workbooks/sort_field.py

@@ -6,13 +6,18 @@ class WorkbookSortField(ClientValue):
     """Represents a condition in a sorting operation."""
 
     def __init__(
-        self, ascending=None, color=None, dataOption=None, icon=WorkbookIcon(), key=None
+        self,
+        ascending=None,
+        color=None,
+        data_option=None,
+        icon=WorkbookIcon(),
+        key=None,
     ):
         """
         :param bool ascending: Represents whether the sorting is done in an ascending fashion.
         :param str color: Represents the color that is the target of the condition if the sorting is on font
              or cell color.
-        :param str dataOption: Represents additional sorting options for this field.
+        :param str data_option: Represents additional sorting options for this field.
              Possible values are: Normal, TextAsNumber.
         :param WorkbookIcon icon: Represents the icon that is the target of the condition if the sorting
              is on the cell's icon.
@@ -21,6 +26,6 @@ class WorkbookSortField(ClientValue):
         """
         self.ascending = ascending
         self.color = color
-        self.dataOption = dataOption
+        self.dataOption = data_option
         self.icon = icon
         self.key = key

office365/onedrive/workbooks/tables/sort.py

@@ -1,5 +1,25 @@
 from office365.entity import Entity
+from office365.onedrive.workbooks.sort_field import WorkbookSortField
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class WorkbookTableSort(Entity):
     """Manages sorting operations on Table objects."""
+
+    def apply(self, fields, match_case=None, method=None):
+        """Perform a sort operation.
+
+        :param list[WorkbookSortField] fields: The list of conditions to sort on.
+        :param bool match_case: Indicates whether to match the case of the items being sorted.
+        :param str method: The ordering method used for Chinese characters.
+             The possible values are: PinYin, StrokeCount.
+        """
+        payload = {
+            "fields": ClientValueCollection(WorkbookSortField, fields),
+            "matchCase": match_case,
+            "method": method,
+        }
+        qry = ServiceOperationQuery(self, "apply", None, payload)
+        self.context.add_query(qry)
+        return self

office365/onedrive/workbooks/worksheets/worksheet.py

@@ -53,6 +53,17 @@ class WorkbookWorksheet(Entity):
         self.context.add_query(qry)
         return return_type
 
+    def used_range(self, values_only=False):
+        """Return the used range of the given range object.
+
+        :param bool values_only: Optional. Considers only cells with values as used cells.
+        """
+        return_type = WorkbookRange(self.context)
+        params = {"valuesOnly": values_only}
+        qry = FunctionQuery(self, "usedRange", params, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def charts(self):
         # type: () -> EntityCollection[WorkbookChart]

office365/partners/billing/azure_usage.py

@@ -0,0 +1,17 @@
+from office365.entity import Entity
+from office365.partners.billing.billed_usage import BilledUsage
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class AzureUsage(Entity):
+    """Represents details for billed and unbilled Azure usage data."""
+
+    @property
+    def billed(self):
+        """
+        Represents details for billed Azure usage data.
+        """
+        return self.properties.get(
+            "billed",
+            BilledUsage(self.context, ResourcePath("billed", self.resource_path)),
+        )

office365/partners/billing/billed_usage.py

@@ -0,0 +1,21 @@
+from office365.entity import Entity
+from office365.partners.billing.operation import Operation
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+
+
+class BilledUsage(Entity):
+    """Represents details for billed Azure usage data."""
+
+    def export(self, invoice_id, attribute_set=None):
+        # type: (str, str) -> Operation
+        """Export the billed Azure usage data.
+
+        :param invoice_id: 	The invoice ID for which the partner requested to export data. Required.
+        :param attribute_set: Attributes that should be exported. Possible values are: full, basic, unknownFutureValue.
+           The default value is full. Choose full for a complete response or basic for a subset of attributes.
+        """
+        payload = {"invoiceId": invoice_id, "attributeSet": attribute_set}
+        return_type = Operation(self.context)
+        qry = ServiceOperationQuery(self, "export", None, payload, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/partners/billing/billing.py

@@ -0,0 +1,17 @@
+from office365.entity import Entity
+from office365.partners.billing.azure_usage import AzureUsage
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class Billing(Entity):
+    """Represents billing details for billed and unbilled data."""
+
+    @property
+    def usage(self):
+        """
+        Represents details for billed and unbilled Azure usage data.
+        """
+        return self.properties.get(
+            "usage",
+            AzureUsage(self.context, ResourcePath("usage", self.resource_path)),
+        )

office365/partners/billing/operation.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class Operation(Entity):
+    """"""

office365/partners/partners.py

@@ -0,0 +1,17 @@
+from office365.entity import Entity
+from office365.partners.billing.billing import Billing
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class Partners(Entity):
+    """Represents billing details for a Microsoft direct partner."""
+
+    @property
+    def billing(self):
+        """
+        Represents billing details for billed and unbilled data.
+        """
+        return self.properties.get(
+            "billing",
+            Billing(self.context, ResourcePath("billing", self.resource_path)),
+        )

office365/reports/root.py

@@ -1,5 +1,6 @@
 from office365.directory.authentication.methods.root import AuthenticationMethodsRoot
 from office365.entity import Entity
+from office365.partners.partners import Partners
 from office365.reports.internal.queries.create_report_query import create_report_query
 from office365.reports.report import Report
 from office365.reports.security.root import SecurityReportsRoot
@@ -292,6 +293,14 @@ class ReportRoot(Entity):
             ),
         )
 
+    @property
+    def partners(self):
+        """Represents billing details for a Microsoft direct partner."""
+        return self.properties.get(
+            "partners",
+            Partners(self.context, ResourcePath("partners", self.resource_path)),
+        )
+
     @property
     def security(self):
         """Container for navigation properties for Azure AD authentication methods resources."""

office365/reports/userregistration/feature_summary.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class UserRegistrationFeatureSummary(ClientValue):
+    """"""

office365/runtime/auth/auth_cookies.py

@@ -0,0 +1,48 @@
+import json
+from typing import Dict, Optional
+
+
+class AuthCookies:
+    def __init__(self, cookies):
+        # type: (Dict) -> None
+        self._cookies = cookies
+
+    @property
+    def is_valid(self) -> bool:
+        """Validates authorization cookies."""
+        return bool(self._cookies) and (
+            self.fed_auth is not None or self.spo_idcrl is not None
+        )
+
+    @property
+    def cookie_header(self):
+        """Converts stored cookies into an HTTP Cookie header string."""
+        return "; ".join(f"{key}={val}" for key, val in self._cookies.items())
+
+    @property
+    def fed_auth(self):
+        # type: () -> Optional[str]
+        """Returns the Primary authentication token."""
+        return self._cookies.get("FedAuth", None)
+
+    @property
+    def spo_idcrl(self):
+        # type: () -> Optional[str]
+        """Returns the secondary authentication token. (SharePoint Online Identity CRL)"""
+        return self._cookies.get("SPOIDCRL", None)
+
+    @property
+    def rt_fa(self):
+        # type: () -> Optional[str]
+        """Returns the refresh token for Federated Authentication."""
+        return self._cookies.get("rtFa", None)
+
+    def to_json(self):
+        """Serializes cookies to JSON format."""
+        return json.dumps(self._cookies, indent=2)
+
+    @classmethod
+    def from_json(cls, json_data):
+        """Deserializes cookies from JSON format."""
+        cookies_dict = json.loads(json_data)
+        return cls(cookies_dict)

office365/runtime/auth/authentication_context.py

@@ -2,8 +2,9 @@ import json
 import sys
 from typing import Any, Callable
 
-from typing_extensions import Required, TypedDict
+from typing_extensions import Required, Self, TypedDict
 
+from office365.azure_env import AzureEnvironment
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.providers.acs_token_provider import ACSTokenProvider
 from office365.runtime.auth.providers.saml_token_provider import SamlTokenProvider
@@ -31,13 +32,20 @@ def _get_authorization_header(token):
 class AuthenticationContext(object):
     """Authentication context for SharePoint Online/OneDrive For Business"""
 
-    def __init__(self, url):
+    def __init__(self, url, environment=None, allow_ntlm=False, browser_mode=False):
         """
         :param str url: SharePoint absolute web or site Url
+        :param str environment: The Office 365 Cloud Environment endpoint used for authentication
+            defaults to 'Azure Global'.
+        :param bool allow_ntlm: Flag indicates whether NTLM scheme is enabled. Disabled by default
+        :param bool browser_mode: Allow browser authentication
         """
         self.url = url.rstrip("/")
         self._authenticate = None
         self._cached_token = None
+        self._environment = environment
+        self._allow_ntlm = allow_ntlm
+        self._browser_mode = browser_mode
 
     def with_client_certificate(
         self,
@@ -71,7 +79,9 @@ class AuthenticationContext(object):
                 private_key = f.read()
 
         def _acquire_token():
-            authority_url = "https://login.microsoftonline.com/{0}".format(tenant)
+            authority_url = "{0}/{1}".format(
+                AzureEnvironment.get_login_authority(self._environment), tenant
+            )
             credentials = {
                 "thumbprint": thumbprint,
                 "private_key": private_key,
@@ -110,7 +120,9 @@ class AuthenticationContext(object):
 
             app = msal.PublicClientApplication(
                 client_id,
-                authority="https://login.microsoftonline.com/{0}".format(tenant),
+                authority="{0}/{1}".format(
+                    AzureEnvironment.get_login_authority(self._environment), tenant
+                ),
                 client_credential=None,
             )
             result = app.acquire_token_interactive(scopes=scopes)
@@ -136,7 +148,9 @@ class AuthenticationContext(object):
 
             app = msal.PublicClientApplication(
                 client_id,
-                authority="https://login.microsoftonline.com/{0}".format(tenant),
+                authority="{0}/{1}".format(
+                    AzureEnvironment.get_login_authority(self._environment), tenant
+                ),
                 client_credential=None,
             )
 
@@ -171,54 +185,56 @@ class AuthenticationContext(object):
             )
 
         self._authenticate = _authenticate
+        return self
 
-    def with_credentials(self, credentials, **kwargs):
+    def with_credentials(self, credentials):
+        # type: (UserCredential | ClientCredential) -> "AuthenticationContext"
         """
         Initializes a client to acquire a token via user or client credentials
-
-        :param UserCredential or ClientCredential credentials:
         """
         if isinstance(credentials, ClientCredential):
-            environment = kwargs.get("environment")
             provider = ACSTokenProvider(
-                self.url, credentials.clientId, credentials.clientSecret, environment
+                self.url,
+                credentials.clientId,
+                credentials.clientSecret,
+                self._environment,
             )
         elif isinstance(credentials, UserCredential):
-            allow_ntlm = kwargs.get("allow_ntlm", False)
-            if allow_ntlm:
+            if self._allow_ntlm:
                 from office365.runtime.auth.providers.ntlm_provider import NtlmProvider
 
                 provider = NtlmProvider(credentials.userName, credentials.password)
             else:
-                browser_mode = kwargs.get("browser_mode", False)
-                environment = kwargs.get("environment")
                 provider = SamlTokenProvider(
                     self.url,
                     credentials.userName,
                     credentials.password,
-                    browser_mode,
-                    environment,
+                    self._browser_mode,
+                    self._environment,
                 )
         else:
             raise ValueError("Unknown credential type")
 
         def _authenticate(request):
+            # type: (RequestOptions) -> None
             provider.authenticate_request(request)
 
         self._authenticate = _authenticate
+        return self
 
-    def acquire_token_for_user(self, username, password, browser_mode=False):
+    def acquire_token_for_user(self, username, password):
+        # type: (str, str) -> Self
         """
         Initializes a client to acquire a token via user credentials
         Status: deprecated!
 
         :param str password: The user password
         :param str username: Typically a UPN in the form of an email address
-        :param bool browser_mode:
         """
-        provider = SamlTokenProvider(self.url, username, password, browser_mode)
+        provider = SamlTokenProvider(self.url, username, password, self._browser_mode)
 
         def _authenticate(request):
+            # type: (RequestOptions) -> None
             provider.authenticate_request(request)
 
         self._authenticate = _authenticate
@@ -236,6 +252,7 @@ class AuthenticationContext(object):
         provider = ACSTokenProvider(self.url, client_id, client_secret)
 
         def _authenticate(request):
+            # type: (RequestOptions) -> None
             provider.authenticate_request(request)
 
         self._authenticate = _authenticate