tableauserverclient 0.34__py3-none-any.whl → 0.36__py3-none-any.whl

tableauserverclient/__init__.py

@@ -1,4 +1,4 @@
-from tableauserverclient._version import get_versions
+from tableauserverclient.bin._version import get_versions
 from tableauserverclient.namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
 from tableauserverclient.models import (
     BackgroundJobItem,
@@ -133,3 +133,7 @@ __all__ = [
     "WeeklyInterval",
     "WorkbookItem",
 ]
+
+from .bin import _version
+
+__version__ = _version.get_versions()["version"]

tableauserverclient/{_version.py → bin/_version.py}

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-10-25T16:34:58-0700",
+ "date": "2025-01-10T10:20:30-0800",
  "dirty": false,
  "error": null,
- "full-revisionid": "1d98fdad189ebed130fb904e8fa5dca2207f9011",
- "version": "0.34"
+ "full-revisionid": "42cecfe268d494284ca74b49aa4e9bfb6cfa197a",
+ "version": "0.36"
 }
 '''  # END VERSION_JSON
 

tableauserverclient/models/connection_credentials.py

@@ -2,11 +2,27 @@ from .property_decorators import property_is_boolean
 
 
 class ConnectionCredentials:
-    """Connection Credentials for Workbooks and Datasources publish request.
+    """
+    Connection Credentials for Workbooks and Datasources publish request.
 
     Consider removing this object and other variables holding secrets
     as soon as possible after use to avoid them hanging around in memory.
 
+    Parameters
+    ----------
+    name: str
+        The username for the connection.
+
+    password: str
+        The password used for the connection.
+
+    embed: bool, default True
+        Determines whether to embed the password (True) for the workbook or data source connection or not (False).
+
+    oauth: bool, default False
+        Determines whether to use OAuth for the connection (True) or not (False).
+        For more information see: https://help.tableau.com/current/server/en-us/protected_auth.htm
+
     """
 
     def __init__(self, name, password, embed=True, oauth=False):

tableauserverclient/models/connection_item.py

@@ -9,6 +9,44 @@ from tableauserverclient.helpers.logging import logger
 
 
 class ConnectionItem:
+    """
+    Corresponds to workbook and data source connections.
+
+    Attributes
+    ----------
+    datasource_id: str
+        The identifier of the data source.
+
+    datasource_name: str
+        The name of the data source.
+
+    id: str
+        The identifier of the connection.
+
+    connection_type: str
+        The type of connection.
+
+    username: str
+        The username for the connection. (see ConnectionCredentials)
+
+    password: str
+        The password used for the connection. (see ConnectionCredentials)
+
+    embed_password: bool
+        Determines whether to embed the password (True) for the workbook or data source connection or not (False). (see ConnectionCredentials)
+
+    server_address: str
+        The server address for the connection.
+
+    server_port: str
+        The port used for the connection.
+
+    connection_credentials: ConnectionCredentials
+        The Connection Credentials object containing authentication details for
+        the connection. Replaces username/password/embed_password when
+        publishing a flow, document or workbook file in the request body.
+    """
+
     def __init__(self):
         self._datasource_id: Optional[str] = None
         self._datasource_name: Optional[str] = None

tableauserverclient/models/custom_view_item.py

@@ -5,14 +5,58 @@ from defusedxml.ElementTree import fromstring, tostring
 from typing import Callable, Optional
 from collections.abc import Iterator
 
-from .exceptions import UnpopulatedPropertyError
-from .user_item import UserItem
-from .view_item import ViewItem
-from .workbook_item import WorkbookItem
-from ..datetime_helpers import parse_datetime
+from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.user_item import UserItem
+from tableauserverclient.models.view_item import ViewItem
+from tableauserverclient.models.workbook_item import WorkbookItem
+from tableauserverclient.datetime_helpers import parse_datetime
 
 
 class CustomViewItem:
+    """
+    Represents a Custom View item on Tableau Server.
+
+    Parameters
+    ----------
+    id : Optional[str]
+        The ID of the Custom View item.
+
+    name : Optional[str]
+        The name of the Custom View item.
+
+    Attributes
+    ----------
+    content_url : Optional[str]
+        The content URL of the Custom View item.
+
+    created_at : Optional[datetime]
+        The date and time the Custom View item was created.
+
+    image: bytes
+        The image of the Custom View item. Must be populated first.
+
+    pdf: bytes
+        The PDF of the Custom View item. Must be populated first.
+
+    csv: Iterator[bytes]
+        The CSV of the Custom View item. Must be populated first.
+
+    shared : Optional[bool]
+        Whether the Custom View item is shared.
+
+    updated_at : Optional[datetime]
+        The date and time the Custom View item was last updated.
+
+    owner : Optional[UserItem]
+        The id of the owner of the Custom View item.
+
+    workbook : Optional[WorkbookItem]
+        The id of the workbook the Custom View item belongs to.
+
+    view : Optional[ViewItem]
+        The id of the view the Custom View item belongs to.
+    """
+
     def __init__(self, id: Optional[str] = None, name: Optional[str] = None) -> None:
         self._content_url: Optional[str] = None  # ?
         self._created_at: Optional["datetime"] = None

tableauserverclient/models/flow_item.py

@@ -1,7 +1,7 @@
 import copy
 import datetime
 import xml.etree.ElementTree as ET
-from typing import Optional
+from typing import Iterable, Optional
 
 from defusedxml.ElementTree import fromstring
 
@@ -15,6 +15,51 @@ from tableauserverclient.models.tag_item import TagItem
 
 
 class FlowItem:
+    """
+    Represents a Tableau Flow item.
+
+    Parameters
+    ----------
+    project_id: str
+        The ID of the project that the flow belongs to.
+
+    name: Optional[str]
+        The name of the flow.
+
+    Attributes
+    ----------
+    connections: Iterable[ConnectionItem]
+        The connections associated with the flow. This property is not populated
+        by default and must be populated by calling the `populate_connections`
+        method.
+
+    created_at: Optional[datetime.datetime]
+        The date and time when the flow was created.
+
+    description: Optional[str]
+        The description of the flow.
+
+    dqws: Iterable[DQWItem]
+        The data quality warnings associated with the flow. This property is not
+        populated by default and must be populated by calling the `populate_dqws`
+        method.
+
+    id: Optional[str]
+        The ID of the flow.
+
+    name: Optional[str]
+        The name of the flow.
+
+    owner_id: Optional[str]
+        The ID of the user who owns the flow.
+
+    project_name: Optional[str]
+        The name of the project that the flow belongs to.
+
+    tags: set[str]
+        The tags associated with the flow.
+    """
+
     def __repr__(self):
         return "<Flow {} '{}' ({}) Project={} createdAt={}".format(
             self._id, self.name, self.description, self.project_id, self.created_at
@@ -33,9 +78,9 @@ class FlowItem:
         self.tags: set[str] = set()
         self.description: Optional[str] = None
 
-        self._connections: Optional[ConnectionItem] = None
-        self._permissions: Optional[Permission] = None
-        self._data_quality_warnings: Optional[DQWItem] = None
+        self._connections: Optional[Iterable[ConnectionItem]] = None
+        self._permissions: Optional[Iterable[Permission]] = None
+        self._data_quality_warnings: Optional[Iterable[DQWItem]] = None
 
     @property
     def connections(self):

tableauserverclient/models/group_item.py

@@ -12,6 +12,46 @@ if TYPE_CHECKING:
 
 
 class GroupItem:
+    """
+    The GroupItem class contains the attributes for the group resources on
+    Tableau Server. The GroupItem class defines the information you can request
+    or query from Tableau Server. The class members correspond to the attributes
+    of a server request or response payload.
+
+    Parameters
+    ----------
+    name: str
+        The name of the group.
+
+    domain_name: str
+        The name of the Active Directory domain ("local" if local authentication is used).
+
+    Properties
+    ----------
+    users: Pager[UserItem]
+        The users in the group. Must be populated with a call to `populate_users()`.
+
+    id: str
+        The unique identifier for the group.
+
+    minimum_site_role: str
+        The minimum site role for users in the group. Use the `UserItem.Roles` enum.
+        Users in the group cannot have their site role set lower than this value.
+
+    license_mode: str
+        The mode defining when to apply licenses for group members. When the
+        mode is onLogin, a license is granted for each group member when they
+        login to a site. When the mode is onSync, a license is granted for group
+        members each time the domain is synced.
+
+    Examples
+    --------
+    >>> # Create a new group item
+    >>>  newgroup = TSC.GroupItem('My Group')
+
+
+    """
+
     tag_name: str = "group"
 
     class LicenseMode:

tableauserverclient/models/job_item.py

@@ -8,6 +8,71 @@ from tableauserverclient.models.flow_run_item import FlowRunItem
 
 
 class JobItem:
+    """
+    Using the TSC library, you can get information about an asynchronous process
+    (or job) on the server. These jobs can be created when Tableau runs certain
+    tasks that could be long running, such as importing or synchronizing users
+    from Active Directory, or running an extract refresh. For example, the REST
+    API methods to create or update groups, to run an extract refresh task, or
+    to publish workbooks can take an asJob parameter (asJob-true) that creates a
+    background process (the job) to complete the call. Information about the
+    asynchronous job is returned from the method.
+
+    If you have the identifier of the job, you can use the TSC library to find
+    out the status of the asynchronous job.
+
+    The job properties are defined in the JobItem class. The class corresponds
+    to the properties for jobs you can access using the Tableau Server REST API.
+    The job methods are based upon the endpoints for jobs in the REST API and
+    operate on the JobItem class.
+
+    Parameters
+    ----------
+    id_ : str
+        The identifier of the job.
+
+    job_type : str
+        The type of job.
+
+    progress : str
+        The progress of the job.
+
+    created_at : datetime.datetime
+        The date and time the job was created.
+
+    started_at : Optional[datetime.datetime]
+        The date and time the job was started.
+
+    completed_at : Optional[datetime.datetime]
+        The date and time the job was completed.
+
+    finish_code : int
+        The finish code of the job. 0 for success, 1 for failure, 2 for cancelled.
+
+    notes : Optional[list[str]]
+        Contains detailed notes about the job.
+
+    mode : Optional[str]
+
+    workbook_id : Optional[str]
+        The identifier of the workbook associated with the job.
+
+    datasource_id : Optional[str]
+        The identifier of the datasource associated with the job.
+
+    flow_run : Optional[FlowRunItem]
+        The flow run associated with the job.
+
+    updated_at : Optional[datetime.datetime]
+        The date and time the job was last updated.
+
+    workbook_name : Optional[str]
+        The name of the workbook associated with the job.
+
+    datasource_name : Optional[str]
+        The name of the datasource associated with the job.
+    """
+
     class FinishCode:
         """
         Status codes as documented on

tableauserverclient/models/project_item.py

@@ -9,6 +9,44 @@ from tableauserverclient.models.property_decorators import property_is_enum, pro
 
 
 class ProjectItem:
+    """
+    The project resources for Tableau are defined in the ProjectItem class. The
+    class corresponds to the project resources you can access using the Tableau
+    Server REST API.
+
+    Parameters
+    ----------
+    name : str
+        Name of the project.
+
+    description : str
+        Description of the project.
+
+    content_permissions : str
+        Sets or shows the permissions for the content in the project. The
+        options are either LockedToProject, ManagedByOwner or
+        LockedToProjectWithoutNested.
+
+    parent_id : str
+        The id of the parent project. Use this option to create project
+        hierarchies. For information about managing projects, project
+        hierarchies, and permissions, see
+        https://help.tableau.com/current/server/en-us/projects.htm
+
+    samples : bool
+        Set to True to include sample workbooks and data sources in the
+        project. The default is False.
+
+    Attributes
+    ----------
+    id : str
+        The unique identifier for the project.
+
+    owner_id : str
+        The unique identifier for the UserItem owner of the project.
+
+    """
+
     ERROR_MSG = "Project item must be populated with permissions first."
 
     class ContentPermissions:
@@ -174,7 +212,7 @@ class ProjectItem:
         self._permissions = permissions
 
     def _set_default_permissions(self, permissions, content_type):
-        attr = f"_default_{content_type}_permissions"
+        attr = f"_default_{content_type}_permissions".lower()
         setattr(
             self,
             attr,

tableauserverclient/models/task_item.py

@@ -9,6 +9,36 @@ from tableauserverclient.models.target import Target
 
 
 class TaskItem:
+    """
+    Represents a task item in Tableau Server. To create new tasks, see Schedules.
+
+    Parameters
+    ----------
+    id_ : str
+        The ID of the task.
+
+    task_type : str
+        Type of task. See TaskItem.Type for possible values.
+
+    priority : int
+        The priority of the task on the server.
+
+    consecutive_failed_count : int
+        The number of consecutive times the task has failed.
+
+    schedule_id : str, optional
+        The ID of the schedule that the task is associated with.
+
+    schedule_item : ScheduleItem, optional
+        The schedule item that the task is associated with.
+
+    last_run_at : datetime, optional
+        The last time the task was run.
+
+    target : Target, optional
+        The target of the task. This can be a workbook or a datasource.
+    """
+
     class Type:
         ExtractRefresh = "extractRefresh"
         DataAcceleration = "dataAcceleration"

tableauserverclient/models/view_item.py

@@ -7,12 +7,64 @@ from collections.abc import Iterator
 from defusedxml.ElementTree import fromstring
 
 from tableauserverclient.datetime_helpers import parse_datetime
-from .exceptions import UnpopulatedPropertyError
-from .permissions_item import PermissionsRule
-from .tag_item import TagItem
+from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.permissions_item import PermissionsRule
+from tableauserverclient.models.tag_item import TagItem
 
 
 class ViewItem:
+    """
+    Contains the members or attributes for the view resources on Tableau Server.
+    The ViewItem class defines the information you can request or query from
+    Tableau Server. The class members correspond to the attributes of a server
+    request or response payload.
+
+    Attributes
+    ----------
+    content_url: Optional[str], default None
+        The name of the view as it would appear in a URL.
+
+    created_at: Optional[datetime], default None
+        The date and time when the view was created.
+
+    id: Optional[str], default None
+        The unique identifier for the view.
+
+    image: Optional[Callable[[], bytes]], default None
+        The image of the view. You must first call the `views.populate_image`
+        method to access the image.
+
+    name: Optional[str], default None
+        The name of the view.
+
+    owner_id: Optional[str], default None
+        The ID for the owner of the view.
+
+    pdf: Optional[Callable[[], bytes]], default None
+        The PDF of the view. You must first call the `views.populate_pdf`
+        method to access the PDF.
+
+    preview_image: Optional[Callable[[], bytes]], default None
+        The preview image of the view. You must first call the
+        `views.populate_preview_image` method to access the preview image.
+
+    project_id: Optional[str], default None
+        The ID for the project that contains the view.
+
+    tags: set[str], default set()
+        The tags associated with the view.
+
+    total_views: Optional[int], default None
+        The total number of views for the view.
+
+    updated_at: Optional[datetime], default None
+        The date and time when the view was last updated.
+
+    workbook_id: Optional[str], default None
+        The ID for the workbook that contains the view.
+
+    """
+
     def __init__(self) -> None:
         self._content_url: Optional[str] = None
         self._created_at: Optional[datetime] = None

tableauserverclient/models/webhook_item.py

@@ -14,6 +14,39 @@ def _parse_event(events):
 
 
 class WebhookItem:
+    """
+    The WebhookItem represents the webhook resources on Tableau Server or
+    Tableau Cloud. This is the information that can be sent or returned in
+    response to a REST API request for webhooks.
+
+    Attributes
+    ----------
+    id : Optional[str]
+        The identifier (luid) for the webhook. You need this value to query a
+        specific webhook with the get_by_id method or to delete a webhook with
+        the delete method.
+
+    name : Optional[str]
+        The name of the webhook. You must specify this when you create an
+        instance of the WebhookItem.
+
+    url : Optional[str]
+        The destination URL for the webhook. The webhook destination URL must
+        be https and have a valid certificate. You must specify this when you
+        create an instance of the WebhookItem.
+
+    event : Optional[str]
+        The name of the Tableau event that triggers your webhook.This is either
+        api-event-name or webhook-source-api-event-name: one of these is
+        required to create an instance of the WebhookItem. We recommend using
+        the api-event-name. The event name must be one of the supported events
+        listed in the Trigger Events table.
+        https://help.tableau.com/current/developer/webhooks/en-us/docs/webhooks-events-payload.html
+
+    owner_id : Optional[str]
+        The identifier (luid) of the user who owns the webhook.
+    """
+
     def __init__(self):
         self._id: Optional[str] = None
         self.name: Optional[str] = None

tableauserverclient/models/workbook_item.py

@@ -99,7 +99,14 @@ class WorkbookItem:
     >>> new_workbook = TSC.WorkbookItem('3a8b6148-493c-11e6-a621-6f3499394a39')
     """
 
-    def __init__(self, project_id: Optional[str] = None, name: Optional[str] = None, show_tabs: bool = False) -> None:
+    def __init__(
+        self,
+        project_id: Optional[str] = None,
+        name: Optional[str] = None,
+        show_tabs: bool = False,
+        thumbnails_user_id: Optional[str] = None,
+        thumbnails_group_id: Optional[str] = None,
+    ) -> None:
         self._connections = None
         self._content_url = None
         self._webpage_url = None
@@ -130,6 +137,8 @@ class WorkbookItem:
         }
         self.data_freshness_policy = None
         self._permissions = None
+        self.thumbnails_user_id = thumbnails_user_id
+        self.thumbnails_group_id = thumbnails_group_id
 
         return None
 
@@ -275,6 +284,22 @@ class WorkbookItem:
             raise UnpopulatedPropertyError(error)
         return self._revisions()
 
+    @property
+    def thumbnails_user_id(self) -> Optional[str]:
+        return self._thumbnails_user_id
+
+    @thumbnails_user_id.setter
+    def thumbnails_user_id(self, value: str):
+        self._thumbnails_user_id = value
+
+    @property
+    def thumbnails_group_id(self) -> Optional[str]:
+        return self._thumbnails_group_id
+
+    @thumbnails_group_id.setter
+    def thumbnails_group_id(self, value: str):
+        self._thumbnails_group_id = value
+
     def _set_connections(self, connections):
         self._connections = connections
 

tableauserverclient/server/endpoint/auth_endpoint.py

@@ -84,9 +84,10 @@ class Auth(Endpoint):
         self._check_status(server_response, url)
         parsed_response = fromstring(server_response.content)
         site_id = parsed_response.find(".//t:site", namespaces=self.parent_srv.namespace).get("id", None)
+        site_url = parsed_response.find(".//t:site", namespaces=self.parent_srv.namespace).get("contentUrl", None)
         user_id = parsed_response.find(".//t:user", namespaces=self.parent_srv.namespace).get("id", None)
         auth_token = parsed_response.find("t:credentials", namespaces=self.parent_srv.namespace).get("token", None)
-        self.parent_srv._set_auth(site_id, user_id, auth_token)
+        self.parent_srv._set_auth(site_id, user_id, auth_token, site_url)
         logger.info(f"Signed into {self.parent_srv.server_address} as user with id {user_id}")
         return Auth.contextmgr(self.sign_out)
 
@@ -155,9 +156,10 @@ class Auth(Endpoint):
         self._check_status(server_response, url)
         parsed_response = fromstring(server_response.content)
         site_id = parsed_response.find(".//t:site", namespaces=self.parent_srv.namespace).get("id", None)
+        site_url = parsed_response.find(".//t:site", namespaces=self.parent_srv.namespace).get("contentUrl", None)
         user_id = parsed_response.find(".//t:user", namespaces=self.parent_srv.namespace).get("id", None)
         auth_token = parsed_response.find("t:credentials", namespaces=self.parent_srv.namespace).get("token", None)
-        self.parent_srv._set_auth(site_id, user_id, auth_token)
+        self.parent_srv._set_auth(site_id, user_id, auth_token, site_url)
         logger.info(f"Signed into {self.parent_srv.server_address} as user with id {user_id}")
         return Auth.contextmgr(self.sign_out)