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

visier_platform_sdk/api/users_v2_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,10 +20,10 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictStr
 from typing import Optional
 from typing_extensions import Annotated
-from visier_platform_sdk.models.servicing_users_api_response_dto import ServicingUsersAPIResponseDTO
-from visier_platform_sdk.models.servicing_users_creation_api_request_dto import ServicingUsersCreationAPIRequestDTO
-from visier_platform_sdk.models.servicing_users_delete_api_request_dto import ServicingUsersDeleteAPIRequestDTO
-from visier_platform_sdk.models.servicing_users_update_api_request_dto import ServicingUsersUpdateAPIRequestDTO
+from visier_platform_sdk.models.users_api_response_dto import UsersAPIResponseDTO
+from visier_platform_sdk.models.users_creation_api_request_dto import UsersCreationAPIRequestDTO
+from visier_platform_sdk.models.users_delete_api_request_dto import UsersDeleteAPIRequestDTO
+from visier_platform_sdk.models.users_update_api_request_dto import UsersUpdateAPIRequestDTO
 
 from visier_platform_sdk.api_client import ApiClient, RequestSerialized
 from visier_platform_sdk.api_response import ApiResponse
@@ -46,7 +46,7 @@ class UsersV2Api:
     @validate_call
     def add_users(
         self,
-        servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO,
+        users_creation_api_request_dto: UsersCreationAPIRequestDTO,
         tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create a user in.")] = None,
         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[
@@ -61,13 +61,13 @@ class UsersV2Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ServicingUsersAPIResponseDTO:
+    ) -> UsersAPIResponseDTO:
         """Add users
 
         Create new users. Administrating tenant users can specify the tenant in which to add these users.
 
-        :param servicing_users_creation_api_request_dto: (required)
-        :type servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO
+        :param users_creation_api_request_dto: (required)
+        :type users_creation_api_request_dto: UsersCreationAPIRequestDTO
         :param tenant_code: Specify the tenant to create a user in.
         :type tenant_code: str
         :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.
@@ -95,7 +95,7 @@ class UsersV2Api:
         """ # noqa: E501
 
         _param = self._add_users_serialize(
-            servicing_users_creation_api_request_dto=servicing_users_creation_api_request_dto,
+            users_creation_api_request_dto=users_creation_api_request_dto,
             tenant_code=tenant_code,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
@@ -105,7 +105,7 @@ class UsersV2Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ServicingUsersAPIResponseDTO",
+            '200': "UsersAPIResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -121,7 +121,7 @@ class UsersV2Api:
     @validate_call
     def add_users_with_http_info(
         self,
-        servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO,
+        users_creation_api_request_dto: UsersCreationAPIRequestDTO,
         tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create a user in.")] = None,
         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[
@@ -136,13 +136,13 @@ class UsersV2Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[ServicingUsersAPIResponseDTO]:
+    ) -> ApiResponse[UsersAPIResponseDTO]:
         """Add users
 
         Create new users. Administrating tenant users can specify the tenant in which to add these users.
 
-        :param servicing_users_creation_api_request_dto: (required)
-        :type servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO
+        :param users_creation_api_request_dto: (required)
+        :type users_creation_api_request_dto: UsersCreationAPIRequestDTO
         :param tenant_code: Specify the tenant to create a user in.
         :type tenant_code: str
         :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.
@@ -170,7 +170,7 @@ class UsersV2Api:
         """ # noqa: E501
 
         _param = self._add_users_serialize(
-            servicing_users_creation_api_request_dto=servicing_users_creation_api_request_dto,
+            users_creation_api_request_dto=users_creation_api_request_dto,
             tenant_code=tenant_code,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
@@ -180,7 +180,7 @@ class UsersV2Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ServicingUsersAPIResponseDTO",
+            '200': "UsersAPIResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -196,7 +196,7 @@ class UsersV2Api:
     @validate_call
     def add_users_without_preload_content(
         self,
-        servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO,
+        users_creation_api_request_dto: UsersCreationAPIRequestDTO,
         tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create a user in.")] = None,
         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[
@@ -216,8 +216,8 @@ class UsersV2Api:
 
         Create new users. Administrating tenant users can specify the tenant in which to add these users.
 
-        :param servicing_users_creation_api_request_dto: (required)
-        :type servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO
+        :param users_creation_api_request_dto: (required)
+        :type users_creation_api_request_dto: UsersCreationAPIRequestDTO
         :param tenant_code: Specify the tenant to create a user in.
         :type tenant_code: str
         :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.
@@ -245,7 +245,7 @@ class UsersV2Api:
         """ # noqa: E501
 
         _param = self._add_users_serialize(
-            servicing_users_creation_api_request_dto=servicing_users_creation_api_request_dto,
+            users_creation_api_request_dto=users_creation_api_request_dto,
             tenant_code=tenant_code,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
@@ -255,7 +255,7 @@ class UsersV2Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ServicingUsersAPIResponseDTO",
+            '200': "UsersAPIResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -266,7 +266,7 @@ class UsersV2Api:
 
     def _add_users_serialize(
         self,
-        servicing_users_creation_api_request_dto,
+        users_creation_api_request_dto,
         tenant_code,
         target_tenant_id,
         _request_auth,
@@ -300,8 +300,8 @@ class UsersV2Api:
             _header_params['TargetTenantID'] = target_tenant_id
         # process the form parameters
         # process the body parameter
-        if servicing_users_creation_api_request_dto is not None:
-            _body_params = servicing_users_creation_api_request_dto
+        if users_creation_api_request_dto is not None:
+            _body_params = users_creation_api_request_dto
 
 
         # set the HTTP header `Accept`
@@ -356,7 +356,7 @@ class UsersV2Api:
     @validate_call
     def delete_users(
         self,
-        servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO,
+        users_delete_api_request_dto: UsersDeleteAPIRequestDTO,
         tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete a user in.")] = None,
         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[
@@ -371,13 +371,13 @@ class UsersV2Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ServicingUsersAPIResponseDTO:
+    ) -> UsersAPIResponseDTO:
         """Delete users
 
         Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user.
 
-        :param servicing_users_delete_api_request_dto: (required)
-        :type servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO
+        :param users_delete_api_request_dto: (required)
+        :type users_delete_api_request_dto: UsersDeleteAPIRequestDTO
         :param tenant_code: Specify the tenant to delete a user in.
         :type tenant_code: str
         :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.
@@ -405,7 +405,7 @@ class UsersV2Api:
         """ # noqa: E501
 
         _param = self._delete_users_serialize(
-            servicing_users_delete_api_request_dto=servicing_users_delete_api_request_dto,
+            users_delete_api_request_dto=users_delete_api_request_dto,
             tenant_code=tenant_code,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
@@ -415,7 +415,7 @@ class UsersV2Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ServicingUsersAPIResponseDTO",
+            '200': "UsersAPIResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -431,7 +431,7 @@ class UsersV2Api:
     @validate_call
     def delete_users_with_http_info(
         self,
-        servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO,
+        users_delete_api_request_dto: UsersDeleteAPIRequestDTO,
         tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete a user in.")] = None,
         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[
@@ -446,13 +446,13 @@ class UsersV2Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[ServicingUsersAPIResponseDTO]:
+    ) -> ApiResponse[UsersAPIResponseDTO]:
         """Delete users
 
         Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user.
 
-        :param servicing_users_delete_api_request_dto: (required)
-        :type servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO
+        :param users_delete_api_request_dto: (required)
+        :type users_delete_api_request_dto: UsersDeleteAPIRequestDTO
         :param tenant_code: Specify the tenant to delete a user in.
         :type tenant_code: str
         :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.
@@ -480,7 +480,7 @@ class UsersV2Api:
         """ # noqa: E501
 
         _param = self._delete_users_serialize(
-            servicing_users_delete_api_request_dto=servicing_users_delete_api_request_dto,
+            users_delete_api_request_dto=users_delete_api_request_dto,
             tenant_code=tenant_code,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
@@ -490,7 +490,7 @@ class UsersV2Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ServicingUsersAPIResponseDTO",
+            '200': "UsersAPIResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -506,7 +506,7 @@ class UsersV2Api:
     @validate_call
     def delete_users_without_preload_content(
         self,
-        servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO,
+        users_delete_api_request_dto: UsersDeleteAPIRequestDTO,
         tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete a user in.")] = None,
         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[
@@ -526,8 +526,8 @@ class UsersV2Api:
 
         Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user.
 
-        :param servicing_users_delete_api_request_dto: (required)
-        :type servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO
+        :param users_delete_api_request_dto: (required)
+        :type users_delete_api_request_dto: UsersDeleteAPIRequestDTO
         :param tenant_code: Specify the tenant to delete a user in.
         :type tenant_code: str
         :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.
@@ -555,7 +555,7 @@ class UsersV2Api:
         """ # noqa: E501
 
         _param = self._delete_users_serialize(
-            servicing_users_delete_api_request_dto=servicing_users_delete_api_request_dto,
+            users_delete_api_request_dto=users_delete_api_request_dto,
             tenant_code=tenant_code,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
@@ -565,7 +565,7 @@ class UsersV2Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ServicingUsersAPIResponseDTO",
+            '200': "UsersAPIResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -576,7 +576,7 @@ class UsersV2Api:
 
     def _delete_users_serialize(
         self,
-        servicing_users_delete_api_request_dto,
+        users_delete_api_request_dto,
         tenant_code,
         target_tenant_id,
         _request_auth,
@@ -610,8 +610,8 @@ class UsersV2Api:
             _header_params['TargetTenantID'] = target_tenant_id
         # process the form parameters
         # process the body parameter
-        if servicing_users_delete_api_request_dto is not None:
-            _body_params = servicing_users_delete_api_request_dto
+        if users_delete_api_request_dto is not None:
+            _body_params = users_delete_api_request_dto
 
 
         # set the HTTP header `Accept`
@@ -666,7 +666,7 @@ class UsersV2Api:
     @validate_call
     def update_users(
         self,
-        servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO,
+        users_update_api_request_dto: UsersUpdateAPIRequestDTO,
         tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update a user in.")] = None,
         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[
@@ -681,13 +681,13 @@ class UsersV2Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ServicingUsersAPIResponseDTO:
+    ) -> UsersAPIResponseDTO:
         """Update users
 
         Update an existing user's information, such as their display name or if the user is enabled in Visier.
 
-        :param servicing_users_update_api_request_dto: (required)
-        :type servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO
+        :param users_update_api_request_dto: (required)
+        :type users_update_api_request_dto: UsersUpdateAPIRequestDTO
         :param tenant_code: Specify the tenant to update a user in.
         :type tenant_code: str
         :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.
@@ -715,7 +715,7 @@ class UsersV2Api:
         """ # noqa: E501
 
         _param = self._update_users_serialize(
-            servicing_users_update_api_request_dto=servicing_users_update_api_request_dto,
+            users_update_api_request_dto=users_update_api_request_dto,
             tenant_code=tenant_code,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
@@ -725,7 +725,7 @@ class UsersV2Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ServicingUsersAPIResponseDTO",
+            '200': "UsersAPIResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -741,7 +741,7 @@ class UsersV2Api:
     @validate_call
     def update_users_with_http_info(
         self,
-        servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO,
+        users_update_api_request_dto: UsersUpdateAPIRequestDTO,
         tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update a user in.")] = None,
         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[
@@ -756,13 +756,13 @@ class UsersV2Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[ServicingUsersAPIResponseDTO]:
+    ) -> ApiResponse[UsersAPIResponseDTO]:
         """Update users
 
         Update an existing user's information, such as their display name or if the user is enabled in Visier.
 
-        :param servicing_users_update_api_request_dto: (required)
-        :type servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO
+        :param users_update_api_request_dto: (required)
+        :type users_update_api_request_dto: UsersUpdateAPIRequestDTO
         :param tenant_code: Specify the tenant to update a user in.
         :type tenant_code: str
         :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.
@@ -790,7 +790,7 @@ class UsersV2Api:
         """ # noqa: E501
 
         _param = self._update_users_serialize(
-            servicing_users_update_api_request_dto=servicing_users_update_api_request_dto,
+            users_update_api_request_dto=users_update_api_request_dto,
             tenant_code=tenant_code,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
@@ -800,7 +800,7 @@ class UsersV2Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ServicingUsersAPIResponseDTO",
+            '200': "UsersAPIResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -816,7 +816,7 @@ class UsersV2Api:
     @validate_call
     def update_users_without_preload_content(
         self,
-        servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO,
+        users_update_api_request_dto: UsersUpdateAPIRequestDTO,
         tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update a user in.")] = None,
         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[
@@ -836,8 +836,8 @@ class UsersV2Api:
 
         Update an existing user's information, such as their display name or if the user is enabled in Visier.
 
-        :param servicing_users_update_api_request_dto: (required)
-        :type servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO
+        :param users_update_api_request_dto: (required)
+        :type users_update_api_request_dto: UsersUpdateAPIRequestDTO
         :param tenant_code: Specify the tenant to update a user in.
         :type tenant_code: str
         :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.
@@ -865,7 +865,7 @@ class UsersV2Api:
         """ # noqa: E501
 
         _param = self._update_users_serialize(
-            servicing_users_update_api_request_dto=servicing_users_update_api_request_dto,
+            users_update_api_request_dto=users_update_api_request_dto,
             tenant_code=tenant_code,
             target_tenant_id=target_tenant_id,
             _request_auth=_request_auth,
@@ -875,7 +875,7 @@ class UsersV2Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ServicingUsersAPIResponseDTO",
+            '200': "UsersAPIResponseDTO",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -886,7 +886,7 @@ class UsersV2Api:
 
     def _update_users_serialize(
         self,
-        servicing_users_update_api_request_dto,
+        users_update_api_request_dto,
         tenant_code,
         target_tenant_id,
         _request_auth,
@@ -920,8 +920,8 @@ class UsersV2Api:
             _header_params['TargetTenantID'] = target_tenant_id
         # process the form parameters
         # process the body parameter
-        if servicing_users_update_api_request_dto is not None:
-            _body_params = servicing_users_update_api_request_dto
+        if users_update_api_request_dto is not None:
+            _body_params = users_update_api_request_dto
 
 
         # set the HTTP header `Accept`