visier-platform-sdk 22222222.99201.1914b1__py3-none-any.whl → 22222222.99201.1925__py3-none-any.whl

visier_platform_sdk/api/vee_api.py

@@ -5,7 +5,7 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.1914
+    The version of the OpenAPI document: 22222222.99201.1925
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -20,12 +20,12 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictStr
 from typing import Optional
 from typing_extensions import Annotated
-from visier_platform_sdk.models.analysis_common_vee_feedback_dto import AnalysisCommonVeeFeedbackDTO
-from visier_platform_sdk.models.analysis_common_vee_question_dto import AnalysisCommonVeeQuestionDTO
-from visier_platform_sdk.models.analysis_common_vee_response_dto import AnalysisCommonVeeResponseDTO
-from visier_platform_sdk.models.analysis_common_vee_sample_question_library_dto import AnalysisCommonVeeSampleQuestionLibraryDTO
-from visier_platform_sdk.models.analysis_common_vee_status_code_dto import AnalysisCommonVeeStatusCodeDTO
-from visier_platform_sdk.models.systemstatus_vee_status_dto import SystemstatusVeeStatusDTO
+from visier_platform_sdk.models.vee_feedback_dto import VeeFeedbackDTO
+from visier_platform_sdk.models.vee_question_dto import VeeQuestionDTO
+from visier_platform_sdk.models.vee_response_dto import VeeResponseDTO
+from visier_platform_sdk.models.vee_sample_question_library_dto import VeeSampleQuestionLibraryDTO
+from visier_platform_sdk.models.vee_status_code_dto import VeeStatusCodeDTO
+from visier_platform_sdk.models.vee_status_dto import VeeStatusDTO
 
 from visier_platform_sdk.api_client import ApiClient, RequestSerialized
 from visier_platform_sdk.api_response import ApiResponse
@@ -48,7 +48,7 @@ class VeeApi:
     @validate_call
     def vee_feedback(
         self,
-        analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO,
+        vee_feedback_dto: VeeFeedbackDTO,
         target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
         _request_timeout: Union[
             None,
@@ -62,13 +62,13 @@ class VeeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> AnalysisCommonVeeStatusCodeDTO:
+    ) -> VeeStatusCodeDTO:
         """Submit Vee feedback
 
         Give Vee feedback for a previous answer. To submit feedback, include:  * The conversation details from the `/question` response.  * A rating of Vee's answer. If `isApproved` is `true`, Vee answered the question correctly. If `isApproved` is `false`, Vee's answer was incorrect or lacked details.  * A description of how Vee should have answered the question or how Vee can improve the answer, such as \"Expected Headcount metric, but Vee returned Average Headcount\".   <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.  If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
 
-        :param analysis_common_vee_feedback_dto: (required)
-        :type analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO
+        :param vee_feedback_dto: (required)
+        :type vee_feedback_dto: VeeFeedbackDTO
         :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
         :type target_tenant_id: str
         :param _request_timeout: timeout setting for this request. If one
@@ -94,7 +94,7 @@ class VeeApi:
         """ # noqa: E501
 
         _param = self._vee_feedback_serialize(
-            analysis_common_vee_feedback_dto=analysis_common_vee_feedback_dto,
+            vee_feedback_dto=vee_feedback_dto,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -103,7 +103,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AnalysisCommonVeeStatusCodeDTO",
+            '200': "VeeStatusCodeDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -119,7 +119,7 @@ class VeeApi:
     @validate_call
     def vee_feedback_with_http_info(
         self,
-        analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO,
+        vee_feedback_dto: VeeFeedbackDTO,
         target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
         _request_timeout: Union[
             None,
@@ -133,13 +133,13 @@ class VeeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[AnalysisCommonVeeStatusCodeDTO]:
+    ) -> ApiResponse[VeeStatusCodeDTO]:
         """Submit Vee feedback
 
         Give Vee feedback for a previous answer. To submit feedback, include:  * The conversation details from the `/question` response.  * A rating of Vee's answer. If `isApproved` is `true`, Vee answered the question correctly. If `isApproved` is `false`, Vee's answer was incorrect or lacked details.  * A description of how Vee should have answered the question or how Vee can improve the answer, such as \"Expected Headcount metric, but Vee returned Average Headcount\".   <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.  If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
 
-        :param analysis_common_vee_feedback_dto: (required)
-        :type analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO
+        :param vee_feedback_dto: (required)
+        :type vee_feedback_dto: VeeFeedbackDTO
         :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
         :type target_tenant_id: str
         :param _request_timeout: timeout setting for this request. If one
@@ -165,7 +165,7 @@ class VeeApi:
         """ # noqa: E501
 
         _param = self._vee_feedback_serialize(
-            analysis_common_vee_feedback_dto=analysis_common_vee_feedback_dto,
+            vee_feedback_dto=vee_feedback_dto,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -174,7 +174,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AnalysisCommonVeeStatusCodeDTO",
+            '200': "VeeStatusCodeDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -190,7 +190,7 @@ class VeeApi:
     @validate_call
     def vee_feedback_without_preload_content(
         self,
-        analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO,
+        vee_feedback_dto: VeeFeedbackDTO,
         target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
         _request_timeout: Union[
             None,
@@ -209,8 +209,8 @@ class VeeApi:
 
         Give Vee feedback for a previous answer. To submit feedback, include:  * The conversation details from the `/question` response.  * A rating of Vee's answer. If `isApproved` is `true`, Vee answered the question correctly. If `isApproved` is `false`, Vee's answer was incorrect or lacked details.  * A description of how Vee should have answered the question or how Vee can improve the answer, such as \"Expected Headcount metric, but Vee returned Average Headcount\".   <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.  If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
 
-        :param analysis_common_vee_feedback_dto: (required)
-        :type analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO
+        :param vee_feedback_dto: (required)
+        :type vee_feedback_dto: VeeFeedbackDTO
         :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
         :type target_tenant_id: str
         :param _request_timeout: timeout setting for this request. If one
@@ -236,7 +236,7 @@ class VeeApi:
         """ # noqa: E501
 
         _param = self._vee_feedback_serialize(
-            analysis_common_vee_feedback_dto=analysis_common_vee_feedback_dto,
+            vee_feedback_dto=vee_feedback_dto,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -245,7 +245,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AnalysisCommonVeeStatusCodeDTO",
+            '200': "VeeStatusCodeDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -256,7 +256,7 @@ class VeeApi:
 
     def _vee_feedback_serialize(
         self,
-        analysis_common_vee_feedback_dto,
+        vee_feedback_dto,
         target_tenant_id,
         _request_auth,
         _content_type,
@@ -285,8 +285,8 @@ class VeeApi:
             _header_params['TargetTenantID'] = target_tenant_id
         # process the form parameters
         # process the body parameter
-        if analysis_common_vee_feedback_dto is not None:
-            _body_params = analysis_common_vee_feedback_dto
+        if vee_feedback_dto is not None:
+            _body_params = vee_feedback_dto
 
 
         # set the HTTP header `Accept`
@@ -341,7 +341,7 @@ class VeeApi:
     @validate_call
     def vee_question_request(
         self,
-        analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO,
+        vee_question_dto: VeeQuestionDTO,
         target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
         _request_timeout: Union[
             None,
@@ -355,13 +355,13 @@ class VeeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> AnalysisCommonVeeResponseDTO:
+    ) -> VeeResponseDTO:
         """Ask Vee a question
 
         Use plain language to ask Vee a people question. Use body parameters to specify how Vee should respond, such as returning a visualization, data, or rewording the question.   The response always returns a `conversationState` object containing a unique ID for the conversation. To ask a follow-up question or continue the conversation with Vee, include the `conversationState` from the response in your next `/question` call. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call.   <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.  If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
 
-        :param analysis_common_vee_question_dto: (required)
-        :type analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO
+        :param vee_question_dto: (required)
+        :type vee_question_dto: VeeQuestionDTO
         :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
         :type target_tenant_id: str
         :param _request_timeout: timeout setting for this request. If one
@@ -387,7 +387,7 @@ class VeeApi:
         """ # noqa: E501
 
         _param = self._vee_question_request_serialize(
-            analysis_common_vee_question_dto=analysis_common_vee_question_dto,
+            vee_question_dto=vee_question_dto,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -396,7 +396,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AnalysisCommonVeeResponseDTO",
+            '200': "VeeResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -412,7 +412,7 @@ class VeeApi:
     @validate_call
     def vee_question_request_with_http_info(
         self,
-        analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO,
+        vee_question_dto: VeeQuestionDTO,
         target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
         _request_timeout: Union[
             None,
@@ -426,13 +426,13 @@ class VeeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[AnalysisCommonVeeResponseDTO]:
+    ) -> ApiResponse[VeeResponseDTO]:
         """Ask Vee a question
 
         Use plain language to ask Vee a people question. Use body parameters to specify how Vee should respond, such as returning a visualization, data, or rewording the question.   The response always returns a `conversationState` object containing a unique ID for the conversation. To ask a follow-up question or continue the conversation with Vee, include the `conversationState` from the response in your next `/question` call. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call.   <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.  If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
 
-        :param analysis_common_vee_question_dto: (required)
-        :type analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO
+        :param vee_question_dto: (required)
+        :type vee_question_dto: VeeQuestionDTO
         :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
         :type target_tenant_id: str
         :param _request_timeout: timeout setting for this request. If one
@@ -458,7 +458,7 @@ class VeeApi:
         """ # noqa: E501
 
         _param = self._vee_question_request_serialize(
-            analysis_common_vee_question_dto=analysis_common_vee_question_dto,
+            vee_question_dto=vee_question_dto,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -467,7 +467,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AnalysisCommonVeeResponseDTO",
+            '200': "VeeResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -483,7 +483,7 @@ class VeeApi:
     @validate_call
     def vee_question_request_without_preload_content(
         self,
-        analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO,
+        vee_question_dto: VeeQuestionDTO,
         target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
         _request_timeout: Union[
             None,
@@ -502,8 +502,8 @@ class VeeApi:
 
         Use plain language to ask Vee a people question. Use body parameters to specify how Vee should respond, such as returning a visualization, data, or rewording the question.   The response always returns a `conversationState` object containing a unique ID for the conversation. To ask a follow-up question or continue the conversation with Vee, include the `conversationState` from the response in your next `/question` call. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call.   <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.  If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
 
-        :param analysis_common_vee_question_dto: (required)
-        :type analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO
+        :param vee_question_dto: (required)
+        :type vee_question_dto: VeeQuestionDTO
         :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
         :type target_tenant_id: str
         :param _request_timeout: timeout setting for this request. If one
@@ -529,7 +529,7 @@ class VeeApi:
         """ # noqa: E501
 
         _param = self._vee_question_request_serialize(
-            analysis_common_vee_question_dto=analysis_common_vee_question_dto,
+            vee_question_dto=vee_question_dto,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -538,7 +538,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AnalysisCommonVeeResponseDTO",
+            '200': "VeeResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -549,7 +549,7 @@ class VeeApi:
 
     def _vee_question_request_serialize(
         self,
-        analysis_common_vee_question_dto,
+        vee_question_dto,
         target_tenant_id,
         _request_auth,
         _content_type,
@@ -578,8 +578,8 @@ class VeeApi:
             _header_params['TargetTenantID'] = target_tenant_id
         # process the form parameters
         # process the body parameter
-        if analysis_common_vee_question_dto is not None:
-            _body_params = analysis_common_vee_question_dto
+        if vee_question_dto is not None:
+            _body_params = vee_question_dto
 
 
         # set the HTTP header `Accept`
@@ -647,7 +647,7 @@ class VeeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> AnalysisCommonVeeSampleQuestionLibraryDTO:
+    ) -> VeeSampleQuestionLibraryDTO:
         """Retrieve a list of sample questions to ask Vee
 
         Get a list of sample questions to help you start using Vee. The response returns a list of questions that you can ask Vee, such as \"What is the turnover rate?\".  You may occasionally encounter a sample question that can't be answered due to data availability or your data access   <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.  If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
@@ -685,7 +685,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AnalysisCommonVeeSampleQuestionLibraryDTO",
+            '200': "VeeSampleQuestionLibraryDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -714,7 +714,7 @@ class VeeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[AnalysisCommonVeeSampleQuestionLibraryDTO]:
+    ) -> ApiResponse[VeeSampleQuestionLibraryDTO]:
         """Retrieve a list of sample questions to ask Vee
 
         Get a list of sample questions to help you start using Vee. The response returns a list of questions that you can ask Vee, such as \"What is the turnover rate?\".  You may occasionally encounter a sample question that can't be answered due to data availability or your data access   <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.  If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
@@ -752,7 +752,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AnalysisCommonVeeSampleQuestionLibraryDTO",
+            '200': "VeeSampleQuestionLibraryDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -819,7 +819,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "AnalysisCommonVeeSampleQuestionLibraryDTO",
+            '200': "VeeSampleQuestionLibraryDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -912,7 +912,7 @@ class VeeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> SystemstatusVeeStatusDTO:
+    ) -> VeeStatusDTO:
         """Check the overall current status of Vee
 
         Check the current overall status of Vee.   The overall status is one of:  * `UP` :  Vee is operational.  * `DOWN`: Vee is not operational.
@@ -950,7 +950,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "SystemstatusVeeStatusDTO",
+            '200': "VeeStatusDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -979,7 +979,7 @@ class VeeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[SystemstatusVeeStatusDTO]:
+    ) -> ApiResponse[VeeStatusDTO]:
         """Check the overall current status of Vee
 
         Check the current overall status of Vee.   The overall status is one of:  * `UP` :  Vee is operational.  * `DOWN`: Vee is not operational.
@@ -1017,7 +1017,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "SystemstatusVeeStatusDTO",
+            '200': "VeeStatusDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1084,7 +1084,7 @@ class VeeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "SystemstatusVeeStatusDTO",
+            '200': "VeeStatusDTO",
         }
         response_data = self.api_client.call_api(
             *_param,