tableauserverclient 0.38__py3-none-any.whl → 0.40__py3-none-any.whl

tableauserverclient/models/interval_item.py

@@ -305,6 +305,7 @@ class MonthlyInterval:
             "Fourth",
             "Fifth",
             "Last",
+            "Customized Monthly",
         ]
         for value in range(1, 32):
             VALID_INTERVALS.append(str(value))
@@ -318,4 +319,4 @@ class MonthlyInterval:
         self._interval = interval_values
 
     def _interval_type_pairs(self):
-        return [(IntervalItem.Occurrence.MonthDay, self.interval)]
+        return [(IntervalItem.Occurrence.MonthDay, str(day)) for day in self.interval]

tableauserverclient/models/oidc_item.py

@@ -0,0 +1,82 @@
+from typing import Optional
+from defusedxml.ElementTree import fromstring
+
+
+class SiteOIDCConfiguration:
+    def __init__(self) -> None:
+        self.enabled: bool = False
+        self.test_login_url: Optional[str] = None
+        self.known_provider_alias: Optional[str] = None
+        self.allow_embedded_authentication: bool = False
+        self.use_full_name: bool = False
+        self.idp_configuration_name: Optional[str] = None
+        self.idp_configuration_id: Optional[str] = None
+        self.client_id: Optional[str] = None
+        self.client_secret: Optional[str] = None
+        self.authorization_endpoint: Optional[str] = None
+        self.token_endpoint: Optional[str] = None
+        self.userinfo_endpoint: Optional[str] = None
+        self.jwks_uri: Optional[str] = None
+        self.end_session_endpoint: Optional[str] = None
+        self.custom_scope: Optional[str] = None
+        self.essential_acr_values: Optional[str] = None
+        self.email_mapping: Optional[str] = None
+        self.first_name_mapping: Optional[str] = None
+        self.last_name_mapping: Optional[str] = None
+        self.full_name_mapping: Optional[str] = None
+        self.prompt: Optional[str] = None
+        self.client_authentication: Optional[str] = None
+        self.voluntary_acr_values: Optional[str] = None
+
+    def __str__(self) -> str:
+        return (
+            f"{self.__class__.__qualname__}(enabled={self.enabled}, "
+            f"test_login_url={self.test_login_url}, "
+            f"idp_configuration_name={self.idp_configuration_name}, "
+            f"idp_configuration_id={self.idp_configuration_id}, "
+            f"client_id={self.client_id})"
+        )
+
+    def __repr__(self) -> str:
+        return f"<{str(self)}>"
+
+    @classmethod
+    def from_response(cls, raw_xml: bytes, ns) -> "SiteOIDCConfiguration":
+        """
+        Parses the raw XML bytes and returns a SiteOIDCConfiguration object.
+        """
+        root = fromstring(raw_xml)
+        elem = root.find("t:siteOIDCConfiguration", namespaces=ns)
+        if elem is None:
+            raise ValueError("No siteOIDCConfiguration element found in the XML.")
+        config = cls()
+
+        config.enabled = str_to_bool(elem.get("enabled", "false"))
+        config.test_login_url = elem.get("testLoginUrl")
+        config.known_provider_alias = elem.get("knownProviderAlias")
+        config.allow_embedded_authentication = str_to_bool(elem.get("allowEmbeddedAuthentication", "false").lower())
+        config.use_full_name = str_to_bool(elem.get("useFullName", "false").lower())
+        config.idp_configuration_name = elem.get("idpConfigurationName")
+        config.idp_configuration_id = elem.get("idpConfigurationId")
+        config.client_id = elem.get("clientId")
+        config.client_secret = elem.get("clientSecret")
+        config.authorization_endpoint = elem.get("authorizationEndpoint")
+        config.token_endpoint = elem.get("tokenEndpoint")
+        config.userinfo_endpoint = elem.get("userinfoEndpoint")
+        config.jwks_uri = elem.get("jwksUri")
+        config.end_session_endpoint = elem.get("endSessionEndpoint")
+        config.custom_scope = elem.get("customScope")
+        config.essential_acr_values = elem.get("essentialAcrValues")
+        config.email_mapping = elem.get("emailMapping")
+        config.first_name_mapping = elem.get("firstNameMapping")
+        config.last_name_mapping = elem.get("lastNameMapping")
+        config.full_name_mapping = elem.get("fullNameMapping")
+        config.prompt = elem.get("prompt")
+        config.client_authentication = elem.get("clientAuthentication")
+        config.voluntary_acr_values = elem.get("voluntaryAcrValues")
+
+        return config
+
+
+def str_to_bool(s: str) -> bool:
+    return s == "true"

tableauserverclient/models/permissions_item.py

@@ -43,6 +43,8 @@ class Permission:
         CreateRefreshMetrics = "CreateRefreshMetrics"
         SaveAs = "SaveAs"
         PulseMetricDefine = "PulseMetricDefine"
+        ExtractRefresh = "ExtractRefresh"
+        WebAuthoringForFlows = "WebAuthoringForFlows"
 
         def __repr__(self):
             return "<Enum Capability: AddComment | ChangeHierarchy | ChangePermission ... (17 more) >"

tableauserverclient/models/project_item.py

@@ -86,9 +86,10 @@ class ProjectItem:
         content_permissions: Optional[str] = None,
         parent_id: Optional[str] = None,
         samples: Optional[bool] = None,
+        id: Optional[str] = None,
     ) -> None:
         self._content_permissions = None
-        self._id: Optional[str] = None
+        self._id: Optional[str] = id
         self.description: Optional[str] = description
         self.name: str = name
         self.content_permissions: Optional[str] = content_permissions
@@ -194,7 +195,7 @@ class ProjectItem:
         return self._name
 
     @name.setter
-    def name(self, value: str) -> None:
+    def name(self, value: Optional[str]) -> None:
         self._name = value
 
     @property

tableauserverclient/models/property_decorators.py

@@ -1,7 +1,7 @@
 import datetime
 import re
 from functools import wraps
-from typing import Any, Optional
+from typing import Any
 from collections.abc import Container
 
 from tableauserverclient.datetime_helpers import parse_datetime
@@ -67,7 +67,7 @@ def property_is_valid_time(func):
     return wrapper
 
 
-def property_is_int(range: tuple[int, int], allowed: Optional[Container[Any]] = None):
+def property_is_int(range: tuple[int, int], allowed: Container[Any] | None = None):
     """Takes a range of ints and a list of exemptions to check against
     when setting a property on a model. The range is a tuple of (min, max) and the
     allowed list (empty by default) allows values outside that range.

tableauserverclient/models/reference_item.py

@@ -1,9 +1,12 @@
+from typing_extensions import Self
+
+
 class ResourceReference:
-    def __init__(self, id_, tag_name):
+    def __init__(self, id_: str | None, tag_name: str) -> None:
         self.id = id_
         self.tag_name = tag_name
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"<ResourceReference id={self._id} tag={self._tag_name}>"
 
     __repr__ = __str__
@@ -13,18 +16,21 @@ class ResourceReference:
             return False
         return (self.id == other.id) and (self.tag_name == other.tag_name)
 
+    def __hash__(self: Self) -> int:
+        return hash((self.id, self.tag_name))
+
     @property
-    def id(self):
+    def id(self) -> str | None:
         return self._id
 
     @id.setter
-    def id(self, value):
+    def id(self, value: str | None) -> None:
         self._id = value
 
     @property
-    def tag_name(self):
+    def tag_name(self) -> str:
         return self._tag_name
 
     @tag_name.setter
-    def tag_name(self, value):
+    def tag_name(self, value: str) -> None:
         self._tag_name = value

tableauserverclient/models/schedule_item.py

@@ -1,6 +1,6 @@
 import xml.etree.ElementTree as ET
 from datetime import datetime
-from typing import Optional, Union
+from typing import Optional, Union, TYPE_CHECKING
 
 from defusedxml.ElementTree import fromstring
 
@@ -16,6 +16,10 @@ from .property_decorators import (
     property_is_enum,
 )
 
+if TYPE_CHECKING:
+    from requests import Response
+
+
 Interval = Union[HourlyInterval, DailyInterval, WeeklyInterval, MonthlyInterval]
 
 
@@ -407,3 +411,8 @@ class ScheduleItem:
         for warning_xml in all_warning_xml:
             warnings.append(warning_xml.get("message", None))
         return warnings
+
+
+def parse_batch_schedule_state(response: "Response", ns) -> list[str]:
+    xml = fromstring(response.content)
+    return [text for tag in xml.findall(".//t:scheduleLuid", namespaces=ns) if (text := tag.text)]

tableauserverclient/models/site_item.py

@@ -85,6 +85,9 @@ class SiteItem:
     state: str
         Shows the current state of the site (Active or Suspended).
 
+    attribute_capture_enabled: Optional[str]
+        Enables user attributes for all Tableau Server embedding workflows.
+
     """
 
     _user_quota: Optional[int] = None
@@ -164,6 +167,7 @@ class SiteItem:
         time_zone=None,
         auto_suspend_refresh_enabled: bool = True,
         auto_suspend_refresh_inactivity_window: int = 30,
+        attribute_capture_enabled: Optional[bool] = None,
     ):
         self._admin_mode = None
         self._id: Optional[str] = None
@@ -217,6 +221,7 @@ class SiteItem:
         self.time_zone = time_zone
         self.auto_suspend_refresh_enabled = auto_suspend_refresh_enabled
         self.auto_suspend_refresh_inactivity_window = auto_suspend_refresh_inactivity_window
+        self.attribute_capture_enabled = attribute_capture_enabled
 
     @property
     def admin_mode(self) -> Optional[str]:
@@ -720,6 +725,7 @@ class SiteItem:
                 time_zone,
                 auto_suspend_refresh_enabled,
                 auto_suspend_refresh_inactivity_window,
+                attribute_capture_enabled,
             ) = self._parse_element(site_xml, ns)
 
             self._set_values(
@@ -774,6 +780,7 @@ class SiteItem:
                 time_zone,
                 auto_suspend_refresh_enabled,
                 auto_suspend_refresh_inactivity_window,
+                attribute_capture_enabled,
             )
         return self
 
@@ -830,6 +837,7 @@ class SiteItem:
         time_zone,
         auto_suspend_refresh_enabled,
         auto_suspend_refresh_inactivity_window,
+        attribute_capture_enabled,
     ):
         if id is not None:
             self._id = id
@@ -937,6 +945,7 @@ class SiteItem:
             self.auto_suspend_refresh_enabled = auto_suspend_refresh_enabled
         if auto_suspend_refresh_inactivity_window is not None:
             self.auto_suspend_refresh_inactivity_window = auto_suspend_refresh_inactivity_window
+        self.attribute_capture_enabled = attribute_capture_enabled
 
     @classmethod
     def from_response(cls, resp, ns) -> list["SiteItem"]:
@@ -996,6 +1005,7 @@ class SiteItem:
                 time_zone,
                 auto_suspend_refresh_enabled,
                 auto_suspend_refresh_inactivity_window,
+                attribute_capture_enabled,
             ) = cls._parse_element(site_xml, ns)
 
             site_item = cls(name, content_url)
@@ -1051,6 +1061,7 @@ class SiteItem:
                 time_zone,
                 auto_suspend_refresh_enabled,
                 auto_suspend_refresh_inactivity_window,
+                attribute_capture_enabled,
             )
             all_site_items.append(site_item)
         return all_site_items
@@ -1132,6 +1143,9 @@ class SiteItem:
 
         flows_enabled = string_to_bool(site_xml.get("flowsEnabled", ""))
         cataloging_enabled = string_to_bool(site_xml.get("catalogingEnabled", ""))
+        attribute_capture_enabled = (
+            string_to_bool(ace) if (ace := site_xml.get("attributeCaptureEnabled")) is not None else None
+        )
 
         return (
             id,
@@ -1185,6 +1199,7 @@ class SiteItem:
             time_zone,
             auto_suspend_refresh_enabled,
             auto_suspend_refresh_inactivity_window,
+            attribute_capture_enabled,
         )
 
 
@@ -1215,6 +1230,17 @@ class SiteAuthConfiguration:
             all_auth_configs.append(auth_config)
         return all_auth_configs
 
+    def __str__(self):
+        return (
+            f"{self.__class__.__qualname__}(auth_setting={self.auth_setting}, "
+            f"enabled={self.enabled}, "
+            f"idp_configuration_id={self.idp_configuration_id}, "
+            f"idp_configuration_name={self.idp_configuration_name})"
+        )
+
+    def __repr__(self):
+        return f"<{str(self)}>"
+
 
 # Used to convert string represented boolean to a boolean type
 def string_to_bool(s: str) -> bool:

tableauserverclient/models/tableau_auth.py

@@ -87,7 +87,7 @@ class TableauAuth(Credentials):
             uid = f", user_id_to_impersonate=f{self.user_id_to_impersonate}"
         else:
             uid = ""
-        return f"<Credentials username={self.username} password=redacted (site={self.site_id}{uid})>"
+        return f"<{self.__class__.__qualname__} username={self.username} password=redacted (site={self.site_id}{uid})>"
 
 
 # A Tableau-generated Personal Access Token
@@ -155,8 +155,8 @@ class PersonalAccessTokenAuth(Credentials):
         else:
             uid = ""
         return (
-            f"<PersonalAccessToken name={self.token_name} token={self.personal_access_token[:2]}..."
-            f"(site={self.site_id}{uid} >"
+            f"<{self.__class__.__qualname__}(name={self.token_name} token={self.personal_access_token[:2]}..."
+            f"site={self.site_id}{uid}) >"
         )
 
 
@@ -198,19 +198,26 @@ class JWTAuth(Credentials):
 
     """
 
-    def __init__(self, jwt: str, site_id: Optional[str] = None, user_id_to_impersonate: Optional[str] = None) -> None:
+    def __init__(
+        self,
+        jwt: str,
+        isUat: bool = False,
+        site_id: Optional[str] = None,
+        user_id_to_impersonate: Optional[str] = None,
+    ) -> None:
         if jwt is None:
             raise TabError("Must provide a JWT token when using JWT authentication")
         super().__init__(site_id, user_id_to_impersonate)
         self.jwt = jwt
+        self.isUat = isUat
 
     @property
     def credentials(self) -> dict[str, str]:
-        return {"jwt": self.jwt}
+        return {"jwt": self.jwt, "isUat": str(self.isUat).lower()}
 
     def __repr__(self):
         if self.user_id_to_impersonate:
             uid = f", user_id_to_impersonate=f{self.user_id_to_impersonate}"
         else:
             uid = ""
-        return f"<{self.__class__.__qualname__} jwt={self.jwt[:5]}... (site={self.site_id}{uid})>"
+        return f"<{self.__class__.__qualname__} jwt={self.jwt[:5]}... isUat={self.isUat} (site={self.site_id}{uid})>"

tableauserverclient/models/user_item.py

@@ -5,6 +5,7 @@ from enum import IntEnum
 from typing import Optional, TYPE_CHECKING
 
 from defusedxml.ElementTree import fromstring
+from typing_extensions import Self
 
 from tableauserverclient.datetime_helpers import parse_datetime
 from tableauserverclient.models.site_item import SiteAuthConfiguration
@@ -17,6 +18,7 @@ from .reference_item import ResourceReference
 
 if TYPE_CHECKING:
     from tableauserverclient.server import Pager
+    from tableauserverclient.models.favorites_item import FavoriteType
 
 
 class UserItem:
@@ -131,7 +133,7 @@ class UserItem:
         self._id: Optional[str] = None
         self._last_login: Optional[datetime] = None
         self._workbooks = None
-        self._favorites: Optional[dict[str, list]] = None
+        self._favorites: Optional["FavoriteType"] = None
         self._groups = None
         self.email: Optional[str] = None
         self.fullname: Optional[str] = None
@@ -185,7 +187,7 @@ class UserItem:
         return self._name
 
     @name.setter
-    def name(self, value: str):
+    def name(self, value: Optional[str]):
         self._name = value
 
     # valid: username, domain/username, username@domain, domain/username@email
@@ -218,7 +220,7 @@ class UserItem:
         return self._workbooks()
 
     @property
-    def favorites(self) -> dict[str, list]:
+    def favorites(self) -> "FavoriteType":
         if self._favorites is None:
             error = "User item must be populated with favorites first."
             raise UnpopulatedPropertyError(error)
@@ -376,6 +378,11 @@ class UserItem:
     def as_reference(id_) -> ResourceReference:
         return ResourceReference(id_, UserItem.tag_name)
 
+    def to_reference(self: Self) -> ResourceReference:
+        if self.id is None:
+            raise ValueError(f"{self.__class__.__qualname__} must have id to be converted to reference")
+        return ResourceReference(self.id, self.tag_name)
+
     @staticmethod
     def _parse_element(user_xml, ns):
         id = user_xml.get("id", None)

tableauserverclient/models/workbook_item.py

@@ -330,7 +330,7 @@ class WorkbookItem:
         return self._thumbnails_user_id
 
     @thumbnails_user_id.setter
-    def thumbnails_user_id(self, value: str):
+    def thumbnails_user_id(self, value: Optional[str]):
         self._thumbnails_user_id = value
 
     @property
@@ -338,7 +338,7 @@ class WorkbookItem:
         return self._thumbnails_group_id
 
     @thumbnails_group_id.setter
-    def thumbnails_group_id(self, value: str):
+    def thumbnails_group_id(self, value: Optional[str]):
         self._thumbnails_group_id = value
 
     @property

tableauserverclient/server/endpoint/__init__.py

@@ -6,6 +6,7 @@ from tableauserverclient.server.endpoint.databases_endpoint import Databases
 from tableauserverclient.server.endpoint.datasources_endpoint import Datasources
 from tableauserverclient.server.endpoint.endpoint import Endpoint, QuerysetEndpoint
 from tableauserverclient.server.endpoint.exceptions import ServerResponseError, MissingRequiredFieldError
+from tableauserverclient.server.endpoint.extensions_endpoint import Extensions
 from tableauserverclient.server.endpoint.favorites_endpoint import Favorites
 from tableauserverclient.server.endpoint.fileuploads_endpoint import Fileuploads
 from tableauserverclient.server.endpoint.flow_runs_endpoint import FlowRuns
@@ -17,6 +18,7 @@ from tableauserverclient.server.endpoint.jobs_endpoint import Jobs
 from tableauserverclient.server.endpoint.linked_tasks_endpoint import LinkedTasks
 from tableauserverclient.server.endpoint.metadata_endpoint import Metadata
 from tableauserverclient.server.endpoint.metrics_endpoint import Metrics
+from tableauserverclient.server.endpoint.oidc_endpoint import OIDC
 from tableauserverclient.server.endpoint.projects_endpoint import Projects
 from tableauserverclient.server.endpoint.schedules_endpoint import Schedules
 from tableauserverclient.server.endpoint.server_info_endpoint import ServerInfo
@@ -41,6 +43,7 @@ __all__ = [
     "QuerysetEndpoint",
     "MissingRequiredFieldError",
     "Endpoint",
+    "Extensions",
     "Favorites",
     "Fileuploads",
     "FlowRuns",
@@ -52,6 +55,7 @@ __all__ = [
     "LinkedTasks",
     "Metadata",
     "Metrics",
+    "OIDC",
     "Projects",
     "Schedules",
     "ServerInfo",