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

visier_platform_sdk/api/data_intake_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, StrictBytes, StrictInt, StrictStr
 from typing import Optional, Tuple, Union
 from typing_extensions import Annotated
-from visier_platform_sdk.models.data_in_push_data_cancel_response import DataInPushDataCancelResponse
-from visier_platform_sdk.models.data_in_push_data_complete_request import DataInPushDataCompleteRequest
-from visier_platform_sdk.models.data_in_push_data_complete_response import DataInPushDataCompleteResponse
-from visier_platform_sdk.models.data_in_push_data_response import DataInPushDataResponse
-from visier_platform_sdk.models.data_in_start_transfer_response import DataInStartTransferResponse
-from visier_platform_sdk.models.designer_push_data_source_definitions_dto import DesignerPushDataSourceDefinitionsDTO
+from visier_platform_sdk.models.push_data_cancel_response import PushDataCancelResponse
+from visier_platform_sdk.models.push_data_complete_request import PushDataCompleteRequest
+from visier_platform_sdk.models.push_data_complete_response import PushDataCompleteResponse
+from visier_platform_sdk.models.push_data_response import PushDataResponse
+from visier_platform_sdk.models.push_data_source_definitions_dto import PushDataSourceDefinitionsDTO
+from visier_platform_sdk.models.start_transfer_response import StartTransferResponse
 
 from visier_platform_sdk.api_client import ApiClient, RequestSerialized
 from visier_platform_sdk.api_response import ApiResponse
@@ -61,7 +61,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> DesignerPushDataSourceDefinitionsDTO:
+    ) -> PushDataSourceDefinitionsDTO:
         """Retrieve a list of sources
 
         Prior to transferring data to Visier, you must identify the sources you want to target. Sources store data for  the solution and are used to map data to Visier's data model.   **Note:** To set up sources in your tenant, contact Visier Customer Success.  This API allows you to query the list of available sources, and identify the source schema and required fields.
@@ -99,7 +99,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DesignerPushDataSourceDefinitionsDTO",
+            '200': "PushDataSourceDefinitionsDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -128,7 +128,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[DesignerPushDataSourceDefinitionsDTO]:
+    ) -> ApiResponse[PushDataSourceDefinitionsDTO]:
         """Retrieve a list of sources
 
         Prior to transferring data to Visier, you must identify the sources you want to target. Sources store data for  the solution and are used to map data to Visier's data model.   **Note:** To set up sources in your tenant, contact Visier Customer Success.  This API allows you to query the list of available sources, and identify the source schema and required fields.
@@ -166,7 +166,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DesignerPushDataSourceDefinitionsDTO",
+            '200': "PushDataSourceDefinitionsDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -233,7 +233,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DesignerPushDataSourceDefinitionsDTO",
+            '200': "PushDataSourceDefinitionsDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -331,7 +331,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> DataInPushDataResponse:
+    ) -> PushDataResponse:
         """Transfer data to sources via JSON
 
         Transfer data to Visier in batches of records. Each request includes a batch of records  formatted as a comma separated array with the first row containing the column headers in the request body. Each  subsequent request should also include the first row as a header.   Each request transfers a batch of records to a single source. Transfer sessions may include one or more batches before completion.   Each batch is identified by a sequence number. Sequence numbers help identify any batches  that were delivered incorrectly.   Each batch is limited to the following request size:  - Batch size limit: 10 MB  - Record count limit: 300,000 rows
@@ -384,7 +384,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataResponse",
+            '200': "PushDataResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -418,7 +418,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[DataInPushDataResponse]:
+    ) -> ApiResponse[PushDataResponse]:
         """Transfer data to sources via JSON
 
         Transfer data to Visier in batches of records. Each request includes a batch of records  formatted as a comma separated array with the first row containing the column headers in the request body. Each  subsequent request should also include the first row as a header.   Each request transfers a batch of records to a single source. Transfer sessions may include one or more batches before completion.   Each batch is identified by a sequence number. Sequence numbers help identify any batches  that were delivered incorrectly.   Each batch is limited to the following request size:  - Batch size limit: 10 MB  - Record count limit: 300,000 rows
@@ -471,7 +471,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataResponse",
+            '200': "PushDataResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -558,7 +558,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataResponse",
+            '200': "PushDataResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -686,7 +686,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> DataInPushDataCancelResponse:
+    ) -> PushDataCancelResponse:
         """Cancel a transfer session
 
         Cancel a transfer session after starting it. If a transfer session is cancelled, all  records within the transfer session do not persist in Visier's data store.   If you cancel a transfer session, please start a new transfer session and resend the complete data set.   You might cancel a transfer session if:  - A request to send a batch of records failed.  - The original set of records is incomplete.  - An infrastructure error occurs.
@@ -727,7 +727,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataCancelResponse",
+            '200': "PushDataCancelResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -757,7 +757,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[DataInPushDataCancelResponse]:
+    ) -> ApiResponse[PushDataCancelResponse]:
         """Cancel a transfer session
 
         Cancel a transfer session after starting it. If a transfer session is cancelled, all  records within the transfer session do not persist in Visier's data store.   If you cancel a transfer session, please start a new transfer session and resend the complete data set.   You might cancel a transfer session if:  - A request to send a batch of records failed.  - The original set of records is incomplete.  - An infrastructure error occurs.
@@ -798,7 +798,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataCancelResponse",
+            '200': "PushDataCancelResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -869,7 +869,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataCancelResponse",
+            '200': "PushDataCancelResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -952,7 +952,7 @@ class DataIntakeApi:
     @validate_call
     def push_data_complete(
         self,
-        data_in_push_data_complete_request: DataInPushDataCompleteRequest,
+        push_data_complete_request: PushDataCompleteRequest,
         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,
@@ -966,13 +966,13 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> DataInPushDataCompleteResponse:
+    ) -> PushDataCompleteResponse:
         """Complete a transfer session
 
         Complete the specified transfer session by triggering a receiving job. A receiving job  validates the transferred data and adds the transferred data to Visier's data store.   You can set an optional parameter to generate a data version through a processing job immediately after the receiving job completes.
 
-        :param data_in_push_data_complete_request: (required)
-        :type data_in_push_data_complete_request: DataInPushDataCompleteRequest
+        :param push_data_complete_request: (required)
+        :type push_data_complete_request: PushDataCompleteRequest
         :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
@@ -998,7 +998,7 @@ class DataIntakeApi:
         """ # noqa: E501
 
         _param = self._push_data_complete_serialize(
-            data_in_push_data_complete_request=data_in_push_data_complete_request,
+            push_data_complete_request=push_data_complete_request,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1007,7 +1007,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataCompleteResponse",
+            '200': "PushDataCompleteResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1023,7 +1023,7 @@ class DataIntakeApi:
     @validate_call
     def push_data_complete_with_http_info(
         self,
-        data_in_push_data_complete_request: DataInPushDataCompleteRequest,
+        push_data_complete_request: PushDataCompleteRequest,
         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,
@@ -1037,13 +1037,13 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[DataInPushDataCompleteResponse]:
+    ) -> ApiResponse[PushDataCompleteResponse]:
         """Complete a transfer session
 
         Complete the specified transfer session by triggering a receiving job. A receiving job  validates the transferred data and adds the transferred data to Visier's data store.   You can set an optional parameter to generate a data version through a processing job immediately after the receiving job completes.
 
-        :param data_in_push_data_complete_request: (required)
-        :type data_in_push_data_complete_request: DataInPushDataCompleteRequest
+        :param push_data_complete_request: (required)
+        :type push_data_complete_request: PushDataCompleteRequest
         :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
@@ -1069,7 +1069,7 @@ class DataIntakeApi:
         """ # noqa: E501
 
         _param = self._push_data_complete_serialize(
-            data_in_push_data_complete_request=data_in_push_data_complete_request,
+            push_data_complete_request=push_data_complete_request,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1078,7 +1078,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataCompleteResponse",
+            '200': "PushDataCompleteResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1094,7 +1094,7 @@ class DataIntakeApi:
     @validate_call
     def push_data_complete_without_preload_content(
         self,
-        data_in_push_data_complete_request: DataInPushDataCompleteRequest,
+        push_data_complete_request: PushDataCompleteRequest,
         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,
@@ -1113,8 +1113,8 @@ class DataIntakeApi:
 
         Complete the specified transfer session by triggering a receiving job. A receiving job  validates the transferred data and adds the transferred data to Visier's data store.   You can set an optional parameter to generate a data version through a processing job immediately after the receiving job completes.
 
-        :param data_in_push_data_complete_request: (required)
-        :type data_in_push_data_complete_request: DataInPushDataCompleteRequest
+        :param push_data_complete_request: (required)
+        :type push_data_complete_request: PushDataCompleteRequest
         :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
@@ -1140,7 +1140,7 @@ class DataIntakeApi:
         """ # noqa: E501
 
         _param = self._push_data_complete_serialize(
-            data_in_push_data_complete_request=data_in_push_data_complete_request,
+            push_data_complete_request=push_data_complete_request,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1149,7 +1149,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataCompleteResponse",
+            '200': "PushDataCompleteResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1160,7 +1160,7 @@ class DataIntakeApi:
 
     def _push_data_complete_serialize(
         self,
-        data_in_push_data_complete_request,
+        push_data_complete_request,
         target_tenant_id,
         _request_auth,
         _content_type,
@@ -1189,8 +1189,8 @@ class DataIntakeApi:
             _header_params['TargetTenantID'] = target_tenant_id
         # process the form parameters
         # process the body parameter
-        if data_in_push_data_complete_request is not None:
-            _body_params = data_in_push_data_complete_request
+        if push_data_complete_request is not None:
+            _body_params = push_data_complete_request
 
 
         # set the HTTP header `Accept`
@@ -1258,7 +1258,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> DataInStartTransferResponse:
+    ) -> StartTransferResponse:
         """Start a transfer session
 
         Start a new transfer session. A transfer session can include one or more batches of records to be  sent to Visier. Batches of records may be transferred as JSON or file payloads.   Recommended: For optimal performance, please include all batches of records in a single transfer session.
@@ -1296,7 +1296,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInStartTransferResponse",
+            '200': "StartTransferResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1325,7 +1325,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[DataInStartTransferResponse]:
+    ) -> ApiResponse[StartTransferResponse]:
         """Start a transfer session
 
         Start a new transfer session. A transfer session can include one or more batches of records to be  sent to Visier. Batches of records may be transferred as JSON or file payloads.   Recommended: For optimal performance, please include all batches of records in a single transfer session.
@@ -1363,7 +1363,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInStartTransferResponse",
+            '200': "StartTransferResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1430,7 +1430,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInStartTransferResponse",
+            '200': "StartTransferResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1528,7 +1528,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> DataInPushDataResponse:
+    ) -> PushDataResponse:
         """Transfer data to sources via file upload
 
         Upload data to Visier as CSV or ZIP files. Each request transfers a single file. If the  data intended for Visier is stored in multiple files, you may compress them into a single ZIP file or make  multiple requests within the same transfer session.   File size limit: 3 GB   Each file is identified by a sequence number. Sequence numbers help identify any batches that were delivered incorrectly.   If you define a specific source in the request, all files within the request will target the declared source. If  a source is not defined, the filenames are matched against the source regex to correctly assign each file to a  source. To find out the source regex, please contact Visier Customer Success.   **Note:** If you include files that should target multiple sources in one ZIP file, do not define a source in the request.   Analytic tenants: For optimal transfer speed, provide one ZIP file per source.  Administrating tenants: For optimal transfer speed, provide one ZIP file containing all the required data files for your analytic tenants.  In the ZIP file, use one folder per analytic tenant. The ZIP file must adhere to the following file structure:   File1.zip  - Folder1: WFF_tenantCode1     - Filename1.csv     - Filename2.csv  - Folder2: WFF_tenantCode2     - Filename3.csv     - Filename4.csv
@@ -1581,7 +1581,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataResponse",
+            '200': "PushDataResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1615,7 +1615,7 @@ class DataIntakeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[DataInPushDataResponse]:
+    ) -> ApiResponse[PushDataResponse]:
         """Transfer data to sources via file upload
 
         Upload data to Visier as CSV or ZIP files. Each request transfers a single file. If the  data intended for Visier is stored in multiple files, you may compress them into a single ZIP file or make  multiple requests within the same transfer session.   File size limit: 3 GB   Each file is identified by a sequence number. Sequence numbers help identify any batches that were delivered incorrectly.   If you define a specific source in the request, all files within the request will target the declared source. If  a source is not defined, the filenames are matched against the source regex to correctly assign each file to a  source. To find out the source regex, please contact Visier Customer Success.   **Note:** If you include files that should target multiple sources in one ZIP file, do not define a source in the request.   Analytic tenants: For optimal transfer speed, provide one ZIP file per source.  Administrating tenants: For optimal transfer speed, provide one ZIP file containing all the required data files for your analytic tenants.  In the ZIP file, use one folder per analytic tenant. The ZIP file must adhere to the following file structure:   File1.zip  - Folder1: WFF_tenantCode1     - Filename1.csv     - Filename2.csv  - Folder2: WFF_tenantCode2     - Filename3.csv     - Filename4.csv
@@ -1668,7 +1668,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataResponse",
+            '200': "PushDataResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1755,7 +1755,7 @@ class DataIntakeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "DataInPushDataResponse",
+            '200': "PushDataResponse",
         }
         response_data = self.api_client.call_api(
             *_param,