seeq 66.54.1.20250922__py3-none-any.whl → 66.90.0.20251219__py3-none-any.whl

seeq/sdk/api/datafiles_api.py

@@ -5,7 +5,7 @@
 
     No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
 
-    OpenAPI spec version: 66.54.1-v202509220904-CD
+    OpenAPI spec version: 66.90.0-v202512190926-CD
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

seeq/sdk/api/datasources_api.py

@@ -5,7 +5,7 @@
 
     No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
 
-    OpenAPI spec version: 66.54.1-v202509220904-CD
+    OpenAPI spec version: 66.90.0-v202512190926-CD
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

seeq/sdk/api/display_templates_api.py

@@ -5,7 +5,7 @@
 
     No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
 
-    OpenAPI spec version: 66.54.1-v202509220904-CD
+    OpenAPI spec version: 66.90.0-v202512190926-CD
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

seeq/sdk/api/displays_api.py

@@ -5,7 +5,7 @@
 
     No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
 
-    OpenAPI spec version: 66.54.1-v202509220904-CD
+    OpenAPI spec version: 66.90.0-v202512190926-CD
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

seeq/sdk/api/export_api.py

@@ -5,7 +5,7 @@
 
     No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
 
-    OpenAPI spec version: 66.54.1-v202509220904-CD
+    OpenAPI spec version: 66.90.0-v202512190926-CD
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

seeq/sdk/api/folders_api.py

@@ -5,7 +5,7 @@
 
     No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
 
-    OpenAPI spec version: 66.54.1-v202509220904-CD
+    OpenAPI spec version: 66.90.0-v202512190926-CD
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -393,7 +393,7 @@ class FoldersApi(object):
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :param str folder_id: ID of the folder to retrieve. Special values of 'mine', 'corporate', or 'users' (admins only) fetch the authenticated user's home folder, the corporate folder, or the folder of all home folders, respectively. (required)
+        :param str folder_id: ID of the folder to retrieve. Special values: 'mine' for the authenticated user's Home folder; 'corporate' for the Corporate folder; 'externallyShared' for the Externally Shared folder; 'users' (admins only) for the folder that contains the home folders of all users. (required)
         :param bool full_ancestry: If true, the full ancestry  will be returned, which includes the home folder of the relevant user. Otherwise, the home folder is not returned. Requires admin privileges.
         :return: FolderOutputV1
                  If the method is called asynchronously,
@@ -420,7 +420,7 @@ class FoldersApi(object):
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :param str folder_id: ID of the folder to retrieve. Special values of 'mine', 'corporate', or 'users' (admins only) fetch the authenticated user's home folder, the corporate folder, or the folder of all home folders, respectively. (required)
+        :param str folder_id: ID of the folder to retrieve. Special values: 'mine' for the authenticated user's Home folder; 'corporate' for the Corporate folder; 'externallyShared' for the Externally Shared folder; 'users' (admins only) for the folder that contains the home folders of all users. (required)
         :param bool full_ancestry: If true, the full ancestry  will be returned, which includes the home folder of the relevant user. Otherwise, the home folder is not returned. Requires admin privileges.
         :return: FolderOutputV1
                  If the method is called asynchronously,
@@ -680,6 +680,219 @@ class FoldersApi(object):
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
+    def get_pinned(self, **kwargs):
+        """
+        Get pinned home screen items for the current user.
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.get_pinned(callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :return: FolderSearchResultsV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: FolderSearchResultsV1
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.get_pinned_with_http_info(**kwargs)
+        else:
+            (data) = self.get_pinned_with_http_info(**kwargs)
+            return data
+
+    def get_pinned_with_http_info(self, **kwargs):
+        """
+        Get pinned home screen items for the current user.
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.get_pinned_with_http_info(callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :return: FolderSearchResultsV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: FolderSearchResultsV1
+        """
+
+        all_params = []
+        all_params.append('callback')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+        all_params.append('_response_type')
+        all_params.append('_custom_headers')
+
+        params = locals()
+        for key, val in iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_pinned" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        for key, value in params.get('_custom_headers', {}).items():
+            header_params[key] = value
+
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/vnd.seeq.v1+json'])
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.\
+            select_header_content_type(['application/vnd.seeq.v1+json', ])
+
+        # Authentication setting
+        auth_settings = ['api_key']
+
+        return self.api_client.call_api('/folders/pinned', 'GET',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type=params.get('_response_type', 'FolderSearchResultsV1'),
+                                        auth_settings=auth_settings,
+                                        callback=params.get('callback'),
+                                        _return_http_data_only=params.get('_return_http_data_only'),
+                                        _preload_content=params.get('_preload_content', True),
+                                        _request_timeout=params.get('_request_timeout'),
+                                        collection_formats=collection_formats)
+
+    def get_recently_used(self, **kwargs):
+        """
+        Get recently used home screen items for the current user. The results will be ordered in descending order (most recently used first, least recently used last).
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.get_recently_used(callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param int limit: The maximum number of recently used home screen items to return. Default is 10, maximum is 100.
+        :return: FolderSearchResultsV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: FolderSearchResultsV1
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.get_recently_used_with_http_info(**kwargs)
+        else:
+            (data) = self.get_recently_used_with_http_info(**kwargs)
+            return data
+
+    def get_recently_used_with_http_info(self, **kwargs):
+        """
+        Get recently used home screen items for the current user. The results will be ordered in descending order (most recently used first, least recently used last).
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.get_recently_used_with_http_info(callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param int limit: The maximum number of recently used home screen items to return. Default is 10, maximum is 100.
+        :return: FolderSearchResultsV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: FolderSearchResultsV1
+        """
+
+        all_params = ['limit']
+        all_params.append('callback')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+        all_params.append('_response_type')
+        all_params.append('_custom_headers')
+
+        params = locals()
+        for key, val in iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_recently_used" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'limit' in params:
+            query_params.append(('limit', params['limit']))
+
+        header_params = {}
+
+        for key, value in params.get('_custom_headers', {}).items():
+            header_params[key] = value
+
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/vnd.seeq.v1+json'])
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.\
+            select_header_content_type(['application/vnd.seeq.v1+json', ])
+
+        # Authentication setting
+        auth_settings = ['api_key']
+
+        return self.api_client.call_api('/folders/recentlyUsed', 'GET',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type=params.get('_response_type', 'FolderSearchResultsV1'),
+                                        auth_settings=auth_settings,
+                                        callback=params.get('callback'),
+                                        _return_http_data_only=params.get('_return_http_data_only'),
+                                        _preload_content=params.get('_preload_content', True),
+                                        _request_timeout=params.get('_request_timeout'),
+                                        collection_formats=collection_formats)
+
     def get_subfolders(self, **kwargs):
         """
         Get subfolders of a folder. 
@@ -693,7 +906,7 @@ class FoldersApi(object):
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :param str folder_id: ID of the folder to retrieve. Special values of 'mine', 'corporate', 'sharedOrPublic', or 'users' can be used to fetch the top level categories. (required)
+        :param str folder_id: ID of the folder to retrieve. Special values of 'mine', 'corporate', 'sharedOrPublic', 'externallyShared', or 'users' can be used to fetch the top level categories. (required)
         :param str root: What sharing category results should be returned for
         :return: FolderNavigationOutputV1
                  If the method is called asynchronously,
@@ -720,7 +933,7 @@ class FoldersApi(object):
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :param str folder_id: ID of the folder to retrieve. Special values of 'mine', 'corporate', 'sharedOrPublic', or 'users' can be used to fetch the top level categories. (required)
+        :param str folder_id: ID of the folder to retrieve. Special values of 'mine', 'corporate', 'sharedOrPublic', 'externallyShared', or 'users' can be used to fetch the top level categories. (required)
         :param str root: What sharing category results should be returned for
         :return: FolderNavigationOutputV1
                  If the method is called asynchronously,
@@ -1033,3 +1246,144 @@ class FoldersApi(object):
                                         _preload_content=params.get('_preload_content', True),
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
+
+    def search(self, **kwargs):
+        """
+        Search for folder content using string fragments and filters. This search is FAST, but it is also 'eventually consistent,' meaning that data that was written to the database may take some time to propagate to this search facility. Results will be returned based on read access to the content. If you are an admin, all results will be returned. 
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.search(callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str query: String fragment to search for. Text will be matched against the content of the folder(s). If the 'query' argument is not supplied, all items are returned (that match the 'filter', 'location' and 'parentFolderId' arguments, if provided). 
+        :param str filter: The filter string to apply to the search.<br> <br> Examples: <pre>'Type' = 'Analysis' AND Owner = '768C213D-F50E-40AC-AA68-D7D6BB09916E'</pre><br> You can use 'AND', 'OR', and 'NOT' to combine multiple filters, using parentheses to group them if necessary.<br> <br> For the <strong>Created At</strong> and <strong>Updated At</strong> fields, which are millisecond-based UNIX timestamps, you can use &gt; and &lt; operators.<br> <br> For the <strong>Ancestors</strong> and <strong>ACL</strong> fields, which are lists of IDs, hits will be returned if any members of the list match the filter.<br> <br> You can only filter on indexed fields, which are:<br> <ul>     <li><strong>Type</strong> ('Folder', 'Analysis', 'Topic' etc)</li>     <li><strong>Created At</strong> (nanosecond-based UNIX timestamp)</li>     <li><strong>Updated At</strong> (nanosecond-based UNIX timestamp)</li>     <li><strong>Owner</strong> (user ID)</li>     <li><strong>Archived</strong> (true/false)</li>     <li><strong>Ancestors</strong> (list of folder IDs in ascending order from top, with top-level of __Users__ or __Corporate__)</li>     <li><strong>ACL</strong> (list of identity IDs that have read access to the content)</li> </ul> 
+        :param str location: Determines the location(s) to search for items. It acts as a convenient shortcut for applying multiple filters. The following locations are supported: <br> <ul>     <li><strong>ALL</strong> (Searches all locations)</li>     <li><strong>MINE</strong> (Searches for non-archived items in the current users home folder)</li>     <li><strong>SHARED</strong> (Searches for non-archived items shared with the current user)</li>     <li><strong>CORPORATE</strong> (Searches for non-archived items in the corporate folder)</li>     <li><strong>USERS</strong> (Searches for non-archived items in the users folder)</li>     <li><strong>TRASH</strong> (Searches for archived items/items in the trash)</li> </ul> Leaving the parameter empty searches all locations (similar to 'ALL'). 
+        :param str parent_folder_id: ID of a folder to limit the search to. If supplied, only items within this folder (and its subfolders) will be searched. 
+        :param str sort_field: Field to sort the results by. Supported fields are:<br> <ul>     <li><strong>Name</strong></li>     <li><strong>Created At</strong></li>     <li><strong>Updated At</strong></li>     <li><strong>Creator</strong></li>     <li><strong>Owner</strong></li> </ul> Leave this parameter empty to use the default sorting (relevance). 
+        :param str sort_order: Sort order for the results. Supported values are:<br> <ul>     <li><strong>ASC</strong> for ascending</li>     <li><strong>DESC</strong> for descending</li> </ul> 
+        :param str hit_highlight_format: If supplied, this turns on <em>hit highlighting</em> for the search results, which identifies the words that were matched in the content. The value is a string in the following format: <pre>&lt;strong&gt;%s&lt;/strong&gt;</pre> In this example, we're putting the hit highlight (the placeholder is <strong>%s</strong>) in a &lt;strong&gt; HTML tag. You can replace this string with whatever makes sense for your purposes.<br> <br> If you do not specify this parameter, then no hit highlighting is performed.<br> <br> Highlights are returned in the \"Highlights\" key of each hit. 
+        :param int hits_per_page: Number of hits to return per page. Defaults to 40.
+        :param int page: One-based page number to retrieve. If zero is specified, then no hits are returned -- only the hit counts. 
+        :return: FolderSearchResultsV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: FolderSearchResultsV1
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.search_with_http_info(**kwargs)
+        else:
+            (data) = self.search_with_http_info(**kwargs)
+            return data
+
+    def search_with_http_info(self, **kwargs):
+        """
+        Search for folder content using string fragments and filters. This search is FAST, but it is also 'eventually consistent,' meaning that data that was written to the database may take some time to propagate to this search facility. Results will be returned based on read access to the content. If you are an admin, all results will be returned. 
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.search_with_http_info(callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str query: String fragment to search for. Text will be matched against the content of the folder(s). If the 'query' argument is not supplied, all items are returned (that match the 'filter', 'location' and 'parentFolderId' arguments, if provided). 
+        :param str filter: The filter string to apply to the search.<br> <br> Examples: <pre>'Type' = 'Analysis' AND Owner = '768C213D-F50E-40AC-AA68-D7D6BB09916E'</pre><br> You can use 'AND', 'OR', and 'NOT' to combine multiple filters, using parentheses to group them if necessary.<br> <br> For the <strong>Created At</strong> and <strong>Updated At</strong> fields, which are millisecond-based UNIX timestamps, you can use &gt; and &lt; operators.<br> <br> For the <strong>Ancestors</strong> and <strong>ACL</strong> fields, which are lists of IDs, hits will be returned if any members of the list match the filter.<br> <br> You can only filter on indexed fields, which are:<br> <ul>     <li><strong>Type</strong> ('Folder', 'Analysis', 'Topic' etc)</li>     <li><strong>Created At</strong> (nanosecond-based UNIX timestamp)</li>     <li><strong>Updated At</strong> (nanosecond-based UNIX timestamp)</li>     <li><strong>Owner</strong> (user ID)</li>     <li><strong>Archived</strong> (true/false)</li>     <li><strong>Ancestors</strong> (list of folder IDs in ascending order from top, with top-level of __Users__ or __Corporate__)</li>     <li><strong>ACL</strong> (list of identity IDs that have read access to the content)</li> </ul> 
+        :param str location: Determines the location(s) to search for items. It acts as a convenient shortcut for applying multiple filters. The following locations are supported: <br> <ul>     <li><strong>ALL</strong> (Searches all locations)</li>     <li><strong>MINE</strong> (Searches for non-archived items in the current users home folder)</li>     <li><strong>SHARED</strong> (Searches for non-archived items shared with the current user)</li>     <li><strong>CORPORATE</strong> (Searches for non-archived items in the corporate folder)</li>     <li><strong>USERS</strong> (Searches for non-archived items in the users folder)</li>     <li><strong>TRASH</strong> (Searches for archived items/items in the trash)</li> </ul> Leaving the parameter empty searches all locations (similar to 'ALL'). 
+        :param str parent_folder_id: ID of a folder to limit the search to. If supplied, only items within this folder (and its subfolders) will be searched. 
+        :param str sort_field: Field to sort the results by. Supported fields are:<br> <ul>     <li><strong>Name</strong></li>     <li><strong>Created At</strong></li>     <li><strong>Updated At</strong></li>     <li><strong>Creator</strong></li>     <li><strong>Owner</strong></li> </ul> Leave this parameter empty to use the default sorting (relevance). 
+        :param str sort_order: Sort order for the results. Supported values are:<br> <ul>     <li><strong>ASC</strong> for ascending</li>     <li><strong>DESC</strong> for descending</li> </ul> 
+        :param str hit_highlight_format: If supplied, this turns on <em>hit highlighting</em> for the search results, which identifies the words that were matched in the content. The value is a string in the following format: <pre>&lt;strong&gt;%s&lt;/strong&gt;</pre> In this example, we're putting the hit highlight (the placeholder is <strong>%s</strong>) in a &lt;strong&gt; HTML tag. You can replace this string with whatever makes sense for your purposes.<br> <br> If you do not specify this parameter, then no hit highlighting is performed.<br> <br> Highlights are returned in the \"Highlights\" key of each hit. 
+        :param int hits_per_page: Number of hits to return per page. Defaults to 40.
+        :param int page: One-based page number to retrieve. If zero is specified, then no hits are returned -- only the hit counts. 
+        :return: FolderSearchResultsV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: FolderSearchResultsV1
+        """
+
+        all_params = ['query', 'filter', 'location', 'parent_folder_id', 'sort_field', 'sort_order', 'hit_highlight_format', 'hits_per_page', 'page']
+        all_params.append('callback')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+        all_params.append('_response_type')
+        all_params.append('_custom_headers')
+
+        params = locals()
+        for key, val in iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method search" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'query' in params:
+            query_params.append(('query', params['query']))
+        if 'filter' in params:
+            query_params.append(('filter', params['filter']))
+        if 'location' in params:
+            query_params.append(('location', params['location']))
+        if 'parent_folder_id' in params:
+            query_params.append(('parentFolderId', params['parent_folder_id']))
+        if 'sort_field' in params:
+            query_params.append(('sortField', params['sort_field']))
+        if 'sort_order' in params:
+            query_params.append(('sortOrder', params['sort_order']))
+        if 'hit_highlight_format' in params:
+            query_params.append(('hitHighlightFormat', params['hit_highlight_format']))
+        if 'hits_per_page' in params:
+            query_params.append(('hitsPerPage', params['hits_per_page']))
+        if 'page' in params:
+            query_params.append(('page', params['page']))
+
+        header_params = {}
+
+        for key, value in params.get('_custom_headers', {}).items():
+            header_params[key] = value
+
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/vnd.seeq.v1+json'])
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.\
+            select_header_content_type(['application/vnd.seeq.v1+json', ])
+
+        # Authentication setting
+        auth_settings = ['api_key']
+
+        return self.api_client.call_api('/folders/search', 'GET',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type=params.get('_response_type', 'FolderSearchResultsV1'),
+                                        auth_settings=auth_settings,
+                                        callback=params.get('callback'),
+                                        _return_http_data_only=params.get('_return_http_data_only'),
+                                        _preload_content=params.get('_preload_content', True),
+                                        _request_timeout=params.get('_request_timeout'),
+                                        collection_formats=collection_formats)