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

seeq/sdk/api/formulas_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
 """
@@ -43,7 +43,7 @@ class FormulasApi(object):
     @deprecated(reason="Use the DELETE /items/{id}/cache (itemsApi clearCache) instead")
     def clear_cache(self, **kwargs):
         """
-        Clear all formula caches. This method is deprecated
+        Clear all formula caches. This method is deprecated.
         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.
@@ -69,7 +69,7 @@ class FormulasApi(object):
     @deprecated(reason="Use the DELETE /items/{id}/cache (itemsApi clearCache) instead")
     def clear_cache_with_http_info(self, **kwargs):
         """
-        Clear all formula caches. This method is deprecated
+        Clear all formula caches. This method is deprecated.
         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.
@@ -941,9 +941,10 @@ class FormulasApi(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 experimental(self, **kwargs):
         """
-        Run an experimental Seeq Formula
+        Run an experimental Seeq Formula. 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.
@@ -969,9 +970,10 @@ class FormulasApi(object):
             (data) = self.experimental_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 experimental_with_http_info(self, **kwargs):
         """
-        Run an experimental Seeq Formula
+        Run an experimental Seeq Formula. 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.
@@ -1060,20 +1062,21 @@ class FormulasApi(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 formula_explainer(self, **kwargs):
         """
-        Compile a Seeq Formula and show details about the execution plan.
+        Compile a Seeq Formula and show details about the execution plan. 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.formula_explainer(body=body_value, callback=callback_function)
+        >>> thread = api.formula_explainer(id=id_value, callback=callback_function)
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :param FormulaCompileInputV1 body: Seeq Formula to compile and its parameters (required)
+        :param str id: ID of the item to explain. (required)
         :return: FormulaGenericOutputV1
                  If the method is called asynchronously,
                  returns the request thread.
@@ -1086,27 +1089,28 @@ class FormulasApi(object):
             (data) = self.formula_explainer_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 formula_explainer_with_http_info(self, **kwargs):
         """
-        Compile a Seeq Formula and show details about the execution plan.
+        Compile a Seeq Formula and show details about the execution plan. 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.formula_explainer_with_http_info(body=body_value, callback=callback_function)
+        >>> thread = api.formula_explainer_with_http_info(id=id_value, callback=callback_function)
 
         :param callback function: The callback function
             for asynchronous request. (optional)
-        :param FormulaCompileInputV1 body: Seeq Formula to compile and its parameters (required)
+        :param str id: ID of the item to explain. (required)
         :return: FormulaGenericOutputV1
                  If the method is called asynchronously,
                  returns the request thread.
         :rtype: FormulaGenericOutputV1
         """
 
-        all_params = ['body']
+        all_params = ['id']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -1123,14 +1127,16 @@ class FormulasApi(object):
                 )
             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 `formula_explainer`")
+        # 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 `formula_explainer`")
 
 
         collection_formats = {}
 
         path_params = {}
+        if 'id' in params:
+            path_params['id'] = params['id']
 
         query_params = []
 
@@ -1144,8 +1150,6 @@ class FormulasApi(object):
         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'])
@@ -1157,7 +1161,7 @@ class FormulasApi(object):
         # Authentication setting
         auth_settings = ['api_key']
 
-        return self.api_client.call_api('/formulas/explainer', 'POST',
+        return self.api_client.call_api('/formulas/explainer/{id}', 'GET',
                                         path_params,
                                         query_params,
                                         header_params,
@@ -1172,6 +1176,120 @@ class FormulasApi(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 formula_explainer_markdown(self, **kwargs):
+        """
+        A simple summary of Seeq Formula item that shows details about the execution plan. 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.formula_explainer_markdown(id=id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str id: ID of the item to explain. (required)
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: None
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.formula_explainer_markdown_with_http_info(**kwargs)
+        else:
+            (data) = self.formula_explainer_markdown_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 formula_explainer_markdown_with_http_info(self, **kwargs):
+        """
+        A simple summary of Seeq Formula item that shows details about the execution plan. 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.formula_explainer_markdown_with_http_info(id=id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str id: ID of the item to explain. (required)
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: None
+        """
+
+        all_params = ['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 formula_explainer_markdown" % 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 `formula_explainer_markdown`")
+
+
+        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
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/vnd.seeq.v1+json', 'text/markdown'])
+
+        # 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('/formulas/explainer/{id}/markdown', 'GET',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type=params.get('_response_type', None),
+                                        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_constant_name_list(self, **kwargs):
         """
         Get a list of the constants available for use in a calculation

seeq/sdk/api/graph_ql_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/hierarchies_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
 """
@@ -40,9 +40,10 @@ class HierarchiesApi(object):
                 config.api_client = ApiClient()
             self.api_client = config.api_client
 
+    @deprecated(reason="This API is experimental and may change or be removed in future releases without prior notice.")
     def create_hierarchy(self, **kwargs):
         """
-        Create a new hierarchy from an Item Table
+        Create a new hierarchy from an Item Table. 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.
@@ -66,9 +67,10 @@ class HierarchiesApi(object):
             (data) = self.create_hierarchy_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 create_hierarchy_with_http_info(self, **kwargs):
         """
-        Create a new hierarchy from an Item Table
+        Create a new hierarchy from an Item Table. 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.
@@ -152,9 +154,10 @@ class HierarchiesApi(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 get_hierarchies(self, **kwargs):
         """
-        Get a list of hierarchies
+        Get a list of hierarchies. 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.
@@ -180,9 +183,10 @@ class HierarchiesApi(object):
             (data) = self.get_hierarchies_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 get_hierarchies_with_http_info(self, **kwargs):
         """
-        Get a list of hierarchies
+        Get a list of hierarchies. 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.
@@ -269,9 +273,10 @@ class HierarchiesApi(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 get_hierarchy(self, **kwargs):
         """
-        Get a hierarchy by ID
+        Get a hierarchy by ID. 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.
@@ -295,9 +300,10 @@ class HierarchiesApi(object):
             (data) = self.get_hierarchy_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 get_hierarchy_with_http_info(self, **kwargs):
         """
-        Get a hierarchy by ID
+        Get a hierarchy by ID. 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.
@@ -381,9 +387,10 @@ class HierarchiesApi(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 get_hierarchy_nodes(self, **kwargs):
         """
-        Get nodes in a hierarchy by ID
+        Get nodes in a hierarchy by ID. 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.
@@ -409,9 +416,10 @@ class HierarchiesApi(object):
             (data) = self.get_hierarchy_nodes_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 get_hierarchy_nodes_with_http_info(self, **kwargs):
         """
-        Get nodes in a hierarchy by ID
+        Get nodes in a hierarchy by ID. 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.
@@ -503,9 +511,142 @@ class HierarchiesApi(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 search_hierarchy_node(self, **kwargs):
+        """
+        Search for a hierarchy node with path nodes from a scaling table row reference. 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.search_hierarchy_node(scaling_table_id=scaling_table_id_value, item_id=item_id_value, row_item_id=row_item_id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str scaling_table_id: The ID of the Scaling Table being searched (required)
+        :param str item_id: The ID of the item being searched for (required)
+        :param str row_item_id: The ID the item that identifies the row of a Scaling Table (required)
+        :param str row_datum_id: The datum ID that along with 'rowItemId' identifies the row of a Scaling Table
+        :return: HierarchyNodeWithPathOutputV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: HierarchyNodeWithPathOutputV1
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.search_hierarchy_node_with_http_info(**kwargs)
+        else:
+            (data) = self.search_hierarchy_node_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 search_hierarchy_node_with_http_info(self, **kwargs):
+        """
+        Search for a hierarchy node with path nodes from a scaling table row reference. 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.search_hierarchy_node_with_http_info(scaling_table_id=scaling_table_id_value, item_id=item_id_value, row_item_id=row_item_id_value, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str scaling_table_id: The ID of the Scaling Table being searched (required)
+        :param str item_id: The ID of the item being searched for (required)
+        :param str row_item_id: The ID the item that identifies the row of a Scaling Table (required)
+        :param str row_datum_id: The datum ID that along with 'rowItemId' identifies the row of a Scaling Table
+        :return: HierarchyNodeWithPathOutputV1
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: HierarchyNodeWithPathOutputV1
+        """
+
+        all_params = ['scaling_table_id', 'item_id', 'row_item_id', 'row_datum_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 search_hierarchy_node" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'scaling_table_id' is set
+        if ('scaling_table_id' not in params) or (params['scaling_table_id'] is None):
+            raise ValueError("Missing the required parameter `scaling_table_id` when calling `search_hierarchy_node`")
+        # verify the required parameter 'item_id' is set
+        if ('item_id' not in params) or (params['item_id'] is None):
+            raise ValueError("Missing the required parameter `item_id` when calling `search_hierarchy_node`")
+        # verify the required parameter 'row_item_id' is set
+        if ('row_item_id' not in params) or (params['row_item_id'] is None):
+            raise ValueError("Missing the required parameter `row_item_id` when calling `search_hierarchy_node`")
+
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'scaling_table_id' in params:
+            query_params.append(('scalingTableId', params['scaling_table_id']))
+        if 'item_id' in params:
+            query_params.append(('itemId', params['item_id']))
+        if 'row_item_id' in params:
+            query_params.append(('rowItemId', params['row_item_id']))
+        if 'row_datum_id' in params:
+            query_params.append(('rowDatumId', params['row_datum_id']))
+
+        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('/hierarchies/node/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', 'HierarchyNodeWithPathOutputV1'),
+                                        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)
+
+    @deprecated(reason="This API is experimental and may change or be removed in future releases without prior notice.")
     def update_hierarchy(self, **kwargs):
         """
-        Update a hierarchy
+        Update a hierarchy. 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.
@@ -530,9 +671,10 @@ class HierarchiesApi(object):
             (data) = self.update_hierarchy_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 update_hierarchy_with_http_info(self, **kwargs):
         """
-        Update a hierarchy
+        Update a hierarchy. 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.
@@ -622,9 +764,10 @@ class HierarchiesApi(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 validate_hierarchy(self, **kwargs):
         """
-        Validate a hierarchy by ID
+        Validate a hierarchy by ID. 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.
@@ -648,9 +791,10 @@ class HierarchiesApi(object):
             (data) = self.validate_hierarchy_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 validate_hierarchy_with_http_info(self, **kwargs):
         """
-        Validate a hierarchy by ID
+        Validate a hierarchy by ID. 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.