hyperstack 1.45.2a0__py3-none-any.whl → 1.46.1a0__py3-none-any.whl

hyperstack/api/dashboard_api.py

@@ -37,7 +37,7 @@ class DashboardApi:
 
 
     @validate_call
-    def retrieve_dashboard(
+    def get_dashboard(
         self,
         _request_timeout: Union[
             None,
@@ -78,7 +78,7 @@ class DashboardApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_dashboard_serialize(
+        _param = self._get_dashboard_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -103,7 +103,7 @@ class DashboardApi:
 
 
     @validate_call
-    def retrieve_dashboard_with_http_info(
+    def get_dashboard_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -144,7 +144,7 @@ class DashboardApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_dashboard_serialize(
+        _param = self._get_dashboard_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -169,7 +169,7 @@ class DashboardApi:
 
 
     @validate_call
-    def retrieve_dashboard_without_preload_content(
+    def get_dashboard_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -210,7 +210,7 @@ class DashboardApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_dashboard_serialize(
+        _param = self._get_dashboard_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -230,7 +230,7 @@ class DashboardApi:
         return response_data.response
 
 
-    def _retrieve_dashboard_serialize(
+    def _get_dashboard_serialize(
         self,
         _request_auth,
         _content_type,

hyperstack/api/deployment_api.py

@@ -311,7 +311,7 @@ class DeploymentApi:
 
 
     @validate_call
-    def details_of_deployment_by_id(
+    def get_deployment(
         self,
         id: StrictInt,
         _request_timeout: Union[
@@ -354,7 +354,7 @@ class DeploymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._details_of_deployment_by_id_serialize(
+        _param = self._get_deployment_serialize(
             id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -381,7 +381,7 @@ class DeploymentApi:
 
 
     @validate_call
-    def details_of_deployment_by_id_with_http_info(
+    def get_deployment_with_http_info(
         self,
         id: StrictInt,
         _request_timeout: Union[
@@ -424,7 +424,7 @@ class DeploymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._details_of_deployment_by_id_serialize(
+        _param = self._get_deployment_serialize(
             id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -451,7 +451,7 @@ class DeploymentApi:
 
 
     @validate_call
-    def details_of_deployment_by_id_without_preload_content(
+    def get_deployment_without_preload_content(
         self,
         id: StrictInt,
         _request_timeout: Union[
@@ -494,7 +494,7 @@ class DeploymentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._details_of_deployment_by_id_serialize(
+        _param = self._get_deployment_serialize(
             id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -516,7 +516,7 @@ class DeploymentApi:
         return response_data.response
 
 
-    def _details_of_deployment_by_id_serialize(
+    def _get_deployment_serialize(
         self,
         id,
         _request_auth,

hyperstack/api/environment_api.py

@@ -880,11 +880,9 @@ class EnvironmentApi:
 
 
     @validate_call
-    def list_environments(
+    def get_environment(
         self,
-        page: Annotated[Optional[StrictStr], Field(description="Page Number")] = None,
-        page_size: Annotated[Optional[StrictStr], Field(description="Data Per Page")] = None,
-        search: Annotated[Optional[StrictStr], Field(description="Search By ID or Name or Region")] = None,
+        id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -897,17 +895,13 @@ class EnvironmentApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Environments:
-        """List environments
+    ) -> Environment:
+        """Retrieve environment
 
-        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs...cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
+        Retrieves details about a specific environment. Provide the environment ID in the path and the new environment `name` in the request body to modify the specified environment.
 
-        :param page: Page Number
-        :type page: str
-        :param page_size: Data Per Page
-        :type page_size: str
-        :param search: Search By ID or Name or Region
-        :type search: str
+        :param id: (required)
+        :type id: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -930,10 +924,8 @@ class EnvironmentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._list_environments_serialize(
-            page=page,
-            page_size=page_size,
-            search=search,
+        _param = self._get_environment_serialize(
+            id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -941,9 +933,10 @@ class EnvironmentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Environments",
+            '200': "Environment",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -958,11 +951,9 @@ class EnvironmentApi:
 
 
     @validate_call
-    def list_environments_with_http_info(
+    def get_environment_with_http_info(
         self,
-        page: Annotated[Optional[StrictStr], Field(description="Page Number")] = None,
-        page_size: Annotated[Optional[StrictStr], Field(description="Data Per Page")] = None,
-        search: Annotated[Optional[StrictStr], Field(description="Search By ID or Name or Region")] = None,
+        id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -975,17 +966,13 @@ class EnvironmentApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[Environments]:
-        """List environments
+    ) -> ApiResponse[Environment]:
+        """Retrieve environment
 
-        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs...cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
+        Retrieves details about a specific environment. Provide the environment ID in the path and the new environment `name` in the request body to modify the specified environment.
 
-        :param page: Page Number
-        :type page: str
-        :param page_size: Data Per Page
-        :type page_size: str
-        :param search: Search By ID or Name or Region
-        :type search: str
+        :param id: (required)
+        :type id: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1008,10 +995,8 @@ class EnvironmentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._list_environments_serialize(
-            page=page,
-            page_size=page_size,
-            search=search,
+        _param = self._get_environment_serialize(
+            id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1019,9 +1004,10 @@ class EnvironmentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Environments",
+            '200': "Environment",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1036,11 +1022,9 @@ class EnvironmentApi:
 
 
     @validate_call
-    def list_environments_without_preload_content(
+    def get_environment_without_preload_content(
         self,
-        page: Annotated[Optional[StrictStr], Field(description="Page Number")] = None,
-        page_size: Annotated[Optional[StrictStr], Field(description="Data Per Page")] = None,
-        search: Annotated[Optional[StrictStr], Field(description="Search By ID or Name or Region")] = None,
+        id: StrictInt,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1054,16 +1038,12 @@ class EnvironmentApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """List environments
+        """Retrieve environment
 
-        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs...cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
+        Retrieves details about a specific environment. Provide the environment ID in the path and the new environment `name` in the request body to modify the specified environment.
 
-        :param page: Page Number
-        :type page: str
-        :param page_size: Data Per Page
-        :type page_size: str
-        :param search: Search By ID or Name or Region
-        :type search: str
+        :param id: (required)
+        :type id: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1086,10 +1066,8 @@ class EnvironmentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._list_environments_serialize(
-            page=page,
-            page_size=page_size,
-            search=search,
+        _param = self._get_environment_serialize(
+            id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1097,9 +1075,10 @@ class EnvironmentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Environments",
+            '200': "Environment",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
+            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1109,11 +1088,9 @@ class EnvironmentApi:
         return response_data.response
 
 
-    def _list_environments_serialize(
+    def _get_environment_serialize(
         self,
-        page,
-        page_size,
-        search,
+        id,
         _request_auth,
         _content_type,
         _headers,
@@ -1135,19 +1112,9 @@ class EnvironmentApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
+        if id is not None:
+            _path_params['id'] = id
         # process the query parameters
-        if page is not None:
-            
-            _query_params.append(('page', page))
-            
-        if page_size is not None:
-            
-            _query_params.append(('pageSize', page_size))
-            
-        if search is not None:
-            
-            _query_params.append(('search', search))
-            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1169,7 +1136,7 @@ class EnvironmentApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/core/environments',
+            resource_path='/core/environments/{id}',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -1186,9 +1153,11 @@ class EnvironmentApi:
 
 
     @validate_call
-    def retrieve_environment(
+    def list_environments(
         self,
-        id: StrictInt,
+        page: Annotated[Optional[StrictStr], Field(description="Page Number")] = None,
+        page_size: Annotated[Optional[StrictStr], Field(description="Data Per Page")] = None,
+        search: Annotated[Optional[StrictStr], Field(description="Search By ID or Name or Region")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1201,13 +1170,17 @@ class EnvironmentApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Environment:
-        """Retrieve environment
+    ) -> Environments:
+        """List environments
 
-        Retrieves details about a specific environment. Provide the environment ID in the path and the new environment `name` in the request body to modify the specified environment.
+        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs...cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
 
-        :param id: (required)
-        :type id: int
+        :param page: Page Number
+        :type page: str
+        :param page_size: Data Per Page
+        :type page_size: str
+        :param search: Search By ID or Name or Region
+        :type search: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1230,8 +1203,10 @@ class EnvironmentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_environment_serialize(
-            id=id,
+        _param = self._list_environments_serialize(
+            page=page,
+            page_size=page_size,
+            search=search,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1239,10 +1214,9 @@ class EnvironmentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Environment",
+            '200': "Environments",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
-            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1257,9 +1231,11 @@ class EnvironmentApi:
 
 
     @validate_call
-    def retrieve_environment_with_http_info(
+    def list_environments_with_http_info(
         self,
-        id: StrictInt,
+        page: Annotated[Optional[StrictStr], Field(description="Page Number")] = None,
+        page_size: Annotated[Optional[StrictStr], Field(description="Data Per Page")] = None,
+        search: Annotated[Optional[StrictStr], Field(description="Search By ID or Name or Region")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1272,13 +1248,17 @@ class EnvironmentApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[Environment]:
-        """Retrieve environment
+    ) -> ApiResponse[Environments]:
+        """List environments
 
-        Retrieves details about a specific environment. Provide the environment ID in the path and the new environment `name` in the request body to modify the specified environment.
+        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs...cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
 
-        :param id: (required)
-        :type id: int
+        :param page: Page Number
+        :type page: str
+        :param page_size: Data Per Page
+        :type page_size: str
+        :param search: Search By ID or Name or Region
+        :type search: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1301,8 +1281,10 @@ class EnvironmentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_environment_serialize(
-            id=id,
+        _param = self._list_environments_serialize(
+            page=page,
+            page_size=page_size,
+            search=search,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1310,10 +1292,9 @@ class EnvironmentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Environment",
+            '200': "Environments",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
-            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1328,9 +1309,11 @@ class EnvironmentApi:
 
 
     @validate_call
-    def retrieve_environment_without_preload_content(
+    def list_environments_without_preload_content(
         self,
-        id: StrictInt,
+        page: Annotated[Optional[StrictStr], Field(description="Page Number")] = None,
+        page_size: Annotated[Optional[StrictStr], Field(description="Data Per Page")] = None,
+        search: Annotated[Optional[StrictStr], Field(description="Search By ID or Name or Region")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1344,12 +1327,16 @@ class EnvironmentApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Retrieve environment
+        """List environments
 
-        Retrieves details about a specific environment. Provide the environment ID in the path and the new environment `name` in the request body to modify the specified environment.
+        Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs...cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/).
 
-        :param id: (required)
-        :type id: int
+        :param page: Page Number
+        :type page: str
+        :param page_size: Data Per Page
+        :type page_size: str
+        :param search: Search By ID or Name or Region
+        :type search: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1372,8 +1359,10 @@ class EnvironmentApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._retrieve_environment_serialize(
-            id=id,
+        _param = self._list_environments_serialize(
+            page=page,
+            page_size=page_size,
+            search=search,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1381,10 +1370,9 @@ class EnvironmentApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "Environment",
+            '200': "Environments",
             '400': "ErrorResponseModel",
             '401': "ErrorResponseModel",
-            '404': "ErrorResponseModel",
             '500': None,
         }
         response_data = self.api_client.call_api(
@@ -1394,9 +1382,11 @@ class EnvironmentApi:
         return response_data.response
 
 
-    def _retrieve_environment_serialize(
+    def _list_environments_serialize(
         self,
-        id,
+        page,
+        page_size,
+        search,
         _request_auth,
         _content_type,
         _headers,
@@ -1418,9 +1408,19 @@ class EnvironmentApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
-        if id is not None:
-            _path_params['id'] = id
         # process the query parameters
+        if page is not None:
+            
+            _query_params.append(('page', page))
+            
+        if page_size is not None:
+            
+            _query_params.append(('pageSize', page_size))
+            
+        if search is not None:
+            
+            _query_params.append(('search', search))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1442,7 +1442,7 @@ class EnvironmentApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/core/environments/{id}',
+            resource_path='/core/environments',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,