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

seeq/sdk/api/users_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
 """
@@ -392,6 +392,252 @@ class UsersApi(object):
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
+    def get_items_shared_with_identity(self, **kwargs):
+        """
+        Search for items shared with an identity. Items shared with groups the identity is a member of are also included. This endpoint will only return items explicitly shared with the identity and their groups. It does not return items an administrator has access to, by virtue of their administrator role, items an identity owns, or items that inherit their permissions
+        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_items_shared_with_identity(id=id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str id: A list of one or more case-sensitive item types which will restrict results to only those items that exactly match, or are children of, one of the specified types (required)
+        :param list[str] types:
+        :param int offset: The pagination offset, the index of the first collection item that will be returned in this page of results
+        :param int limit: The pagination limit, the total number of collection items that will be returned in this page of results
+        :return: ItemPreviewListV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: ItemPreviewListV1
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.get_items_shared_with_identity_with_http_info(**kwargs)
+        else:
+            (data) = self.get_items_shared_with_identity_with_http_info(**kwargs)
+            return data
+
+    def get_items_shared_with_identity_with_http_info(self, **kwargs):
+        """
+        Search for items shared with an identity. Items shared with groups the identity is a member of are also included. This endpoint will only return items explicitly shared with the identity and their groups. It does not return items an administrator has access to, by virtue of their administrator role, items an identity owns, or items that inherit their permissions
+        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_items_shared_with_identity_with_http_info(id=id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str id: A list of one or more case-sensitive item types which will restrict results to only those items that exactly match, or are children of, one of the specified types (required)
+        :param list[str] types:
+        :param int offset: The pagination offset, the index of the first collection item that will be returned in this page of results
+        :param int limit: The pagination limit, the total number of collection items that will be returned in this page of results
+        :return: ItemPreviewListV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: ItemPreviewListV1
+        """
+
+        all_params = ['id', 'types', 'offset', '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_items_shared_with_identity" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'id' is set
+        if ('id' not in params) or (params['id'] is None):
+            raise ValueError("Missing the required parameter `id` when calling `get_items_shared_with_identity`")
+
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'id' in params:
+            path_params['id'] = params['id']
+
+        query_params = []
+        if 'types' in params:
+            query_params.append(('types', params['types']))
+            collection_formats['types'] = 'multi'
+        if 'offset' in params:
+            query_params.append(('offset', params['offset']))
+        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('/users/items/{id}/sharedWithIdentity', 'GET',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type=params.get('_response_type', 'ItemPreviewListV1'),
+                                        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_items_shared_with_me(self, **kwargs):
+        """
+        Search for items shared with the current user. Items shared with groups the user is a member of are also included. This endpoint will only return items explicitly shared with the user and their groups. It does not return items an administrator has access to, by virtue of their administrator role, items a user owns, or items that inherit their permissions
+        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_items_shared_with_me(types=types_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param list[str] types: A list of one or more case-sensitive item types which will restrict results to only those items that exactly match, or are children of, one of the specified types (required)
+        :param int offset: The pagination offset, the index of the first collection item that will be returned in this page of results
+        :param int limit: The pagination limit, the total number of collection items that will be returned in this page of results
+        :return: ItemPreviewListV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: ItemPreviewListV1
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.get_items_shared_with_me_with_http_info(**kwargs)
+        else:
+            (data) = self.get_items_shared_with_me_with_http_info(**kwargs)
+            return data
+
+    def get_items_shared_with_me_with_http_info(self, **kwargs):
+        """
+        Search for items shared with the current user. Items shared with groups the user is a member of are also included. This endpoint will only return items explicitly shared with the user and their groups. It does not return items an administrator has access to, by virtue of their administrator role, items a user owns, or items that inherit their permissions
+        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_items_shared_with_me_with_http_info(types=types_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param list[str] types: A list of one or more case-sensitive item types which will restrict results to only those items that exactly match, or are children of, one of the specified types (required)
+        :param int offset: The pagination offset, the index of the first collection item that will be returned in this page of results
+        :param int limit: The pagination limit, the total number of collection items that will be returned in this page of results
+        :return: ItemPreviewListV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: ItemPreviewListV1
+        """
+
+        all_params = ['types', 'offset', '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_items_shared_with_me" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'types' is set
+        if ('types' not in params) or (params['types'] is None):
+            raise ValueError("Missing the required parameter `types` when calling `get_items_shared_with_me`")
+
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'types' in params:
+            query_params.append(('types', params['types']))
+            collection_formats['types'] = 'multi'
+        if 'offset' in params:
+            query_params.append(('offset', params['offset']))
+        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('/users/items/sharedWithMe', 'GET',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type=params.get('_response_type', 'ItemPreviewListV1'),
+                                        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_me(self, **kwargs):
         """
         Get the user that belongs to this authentication session
@@ -777,7 +1023,7 @@ class UsersApi(object):
         :param bool is_enabled: Whether to filter users to only users who are enabled.
         :param bool is_logged_in: Whether to filter users to only users who are logged in.
         :param bool is_created: Whether to filter users to only users who are not system managed.
-        :param str sort_order: A field by which to order the users followed by a space and 'asc' or 'desc'. Field name can be one of: username, email, firstName, lastName, directory
+        :param str sort_order: A field by which to order the users followed by a space and 'asc' or 'desc'. Field name can be one of: username, email, firstName, lastName, datasourceName
         :param int offset: The pagination offset, the index of the first collection item that will be returned in this page of results
         :param int limit: The pagination limit, the total number of collection items that will be returned in this page of results
         :param bool is_password_reset_requested: Whether to filter users to only users who are required to change their password on next login.
@@ -818,7 +1064,7 @@ class UsersApi(object):
         :param bool is_enabled: Whether to filter users to only users who are enabled.
         :param bool is_logged_in: Whether to filter users to only users who are logged in.
         :param bool is_created: Whether to filter users to only users who are not system managed.
-        :param str sort_order: A field by which to order the users followed by a space and 'asc' or 'desc'. Field name can be one of: username, email, firstName, lastName, directory
+        :param str sort_order: A field by which to order the users followed by a space and 'asc' or 'desc'. Field name can be one of: username, email, firstName, lastName, datasourceName
         :param int offset: The pagination offset, the index of the first collection item that will be returned in this page of results
         :param int limit: The pagination limit, the total number of collection items that will be returned in this page of results
         :param bool is_password_reset_requested: Whether to filter users to only users who are required to change their password on next login.
@@ -924,6 +1170,127 @@ class UsersApi(object):
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
+    @deprecated(reason="This API is experimental and may change or be removed in future releases without prior notice.")
+    def set_trust(self, **kwargs):
+        """
+        Make a user trusted or untrusted. This endpoint is experimental and may change in future releases.
+        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.set_trust(body=body_value, id=id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param SetTrustInputV1 body: User Update information (required)
+        :param str id: ID of the user (required)
+        :return: UserOutputV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: UserOutputV1
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.set_trust_with_http_info(**kwargs)
+        else:
+            (data) = self.set_trust_with_http_info(**kwargs)
+            return data
+
+    @deprecated(reason="This API is experimental and may change or be removed in future releases without prior notice.")
+    def set_trust_with_http_info(self, **kwargs):
+        """
+        Make a user trusted or untrusted. This endpoint is experimental and may change in future releases.
+        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.set_trust_with_http_info(body=body_value, id=id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param SetTrustInputV1 body: User Update information (required)
+        :param str id: ID of the user (required)
+        :return: UserOutputV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: UserOutputV1
+        """
+
+        all_params = ['body', 'id']
+        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 set_trust" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'body' is set
+        if ('body' not in params) or (params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `set_trust`")
+        # verify the required parameter 'id' is set
+        if ('id' not in params) or (params['id'] is None):
+            raise ValueError("Missing the required parameter `id` when calling `set_trust`")
+
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'id' in params:
+            path_params['id'] = params['id']
+
+        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
+        if 'body' in params:
+            body_params = params['body']
+        # 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('/users/{id}/setTrust', 'POST',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type=params.get('_response_type', 'UserOutputV1'),
+                                        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 update_password(self, **kwargs):
         """
         Update password for a user authenticating through Seeq

seeq/sdk/api/workbooks_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
 """
@@ -390,6 +390,132 @@ class WorkbooksApi(object):
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
+    def create_sandbox(self, **kwargs):
+        """
+        Create a sandboxed copy of a Topic document. The new document will be placed in a new Topic in the personal folder of the user making the request. The Topic will be automatically archived and will not be visible in the user's list of Topics.
+        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.create_sandbox(body=body_value, workbook_id=workbook_id_value, worksheet_id=worksheet_id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param TopicSandboxInputV1 body: Sandbox information (required)
+        :param str workbook_id: The ID of the original workbook (required)
+        :param str worksheet_id: The ID of the original worksheet (required)
+        :return: WorksheetOutputV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: WorksheetOutputV1
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.create_sandbox_with_http_info(**kwargs)
+        else:
+            (data) = self.create_sandbox_with_http_info(**kwargs)
+            return data
+
+    def create_sandbox_with_http_info(self, **kwargs):
+        """
+        Create a sandboxed copy of a Topic document. The new document will be placed in a new Topic in the personal folder of the user making the request. The Topic will be automatically archived and will not be visible in the user's list of Topics.
+        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.create_sandbox_with_http_info(body=body_value, workbook_id=workbook_id_value, worksheet_id=worksheet_id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param TopicSandboxInputV1 body: Sandbox information (required)
+        :param str workbook_id: The ID of the original workbook (required)
+        :param str worksheet_id: The ID of the original worksheet (required)
+        :return: WorksheetOutputV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: WorksheetOutputV1
+        """
+
+        all_params = ['body', 'workbook_id', 'worksheet_id']
+        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 create_sandbox" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'body' is set
+        if ('body' not in params) or (params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `create_sandbox`")
+        # verify the required parameter 'workbook_id' is set
+        if ('workbook_id' not in params) or (params['workbook_id'] is None):
+            raise ValueError("Missing the required parameter `workbook_id` when calling `create_sandbox`")
+        # verify the required parameter 'worksheet_id' is set
+        if ('worksheet_id' not in params) or (params['worksheet_id'] is None):
+            raise ValueError("Missing the required parameter `worksheet_id` when calling `create_sandbox`")
+
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'workbook_id' in params:
+            path_params['workbookId'] = params['workbook_id']
+        if 'worksheet_id' in params:
+            path_params['worksheetId'] = params['worksheet_id']
+
+        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
+        if 'body' in params:
+            body_params = params['body']
+        # 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('/workbooks/{workbookId}/worksheets/{worksheetId}/sandbox', 'POST',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type=params.get('_response_type', 'WorksheetOutputV1'),
+                                        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 create_workbook(self, **kwargs):
         """
         Create a workbook
@@ -2069,6 +2195,118 @@ class WorkbooksApi(object):
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
+    def get_workstep_by_id(self, **kwargs):
+        """
+        Get a workstep by its ID
+        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_workstep_by_id(workstep_id=workstep_id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str workstep_id: ID of the workstep to retrieve (required)
+        :return: WorkstepOutputV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: WorkstepOutputV1
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.get_workstep_by_id_with_http_info(**kwargs)
+        else:
+            (data) = self.get_workstep_by_id_with_http_info(**kwargs)
+            return data
+
+    def get_workstep_by_id_with_http_info(self, **kwargs):
+        """
+        Get a workstep by its ID
+        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_workstep_by_id_with_http_info(workstep_id=workstep_id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str workstep_id: ID of the workstep to retrieve (required)
+        :return: WorkstepOutputV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: WorkstepOutputV1
+        """
+
+        all_params = ['workstep_id']
+        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_workstep_by_id" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'workstep_id' is set
+        if ('workstep_id' not in params) or (params['workstep_id'] is None):
+            raise ValueError("Missing the required parameter `workstep_id` when calling `get_workstep_by_id`")
+
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'workstep_id' in params:
+            path_params['workstepId'] = params['workstep_id']
+
+        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('/workbooks/worksteps/{workstepId}', 'GET',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type=params.get('_response_type', 'WorkstepOutputV1'),
+                                        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_worksteps(self, **kwargs):
         """
         Get a list of worksteps starting from the given workstep, searching in the given direction.