rapidata 2.35.3__py3-none-any.whl → 2.36.1__py3-none-any.whl

rapidata/api_client/api/leaderboard_api.py

@@ -33,6 +33,7 @@ from rapidata.api_client.models.runs_by_leaderboard_result_paged_result import R
 from rapidata.api_client.models.standing_by_leaderboard_paged_result import StandingByLeaderboardPagedResult
 from rapidata.api_client.models.standings_by_leaderboard_result import StandingsByLeaderboardResult
 from rapidata.api_client.models.submit_participant_result import SubmitParticipantResult
+from rapidata.api_client.models.update_leaderboard_model import UpdateLeaderboardModel
 from rapidata.api_client.models.update_leaderboard_name_model import UpdateLeaderboardNameModel
 from rapidata.api_client.models.update_leaderboard_response_config_model import UpdateLeaderboardResponseConfigModel
 
@@ -1152,7 +1153,7 @@ class LeaderboardApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> None:
-        """Updates the name of a leaderboard.
+        """(Deprecated) Updates the name of a leaderboard.
 
 
         :param leaderboard_id:  (required)
@@ -1180,6 +1181,7 @@ class LeaderboardApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """ # noqa: E501
+        warnings.warn("PUT /leaderboard/{leaderboardId}/name is deprecated.", DeprecationWarning)
 
         _param = self._leaderboard_leaderboard_id_name_put_serialize(
             leaderboard_id=leaderboard_id,
@@ -1222,7 +1224,7 @@ class LeaderboardApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[None]:
-        """Updates the name of a leaderboard.
+        """(Deprecated) Updates the name of a leaderboard.
 
 
         :param leaderboard_id:  (required)
@@ -1250,6 +1252,7 @@ class LeaderboardApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """ # noqa: E501
+        warnings.warn("PUT /leaderboard/{leaderboardId}/name is deprecated.", DeprecationWarning)
 
         _param = self._leaderboard_leaderboard_id_name_put_serialize(
             leaderboard_id=leaderboard_id,
@@ -1292,7 +1295,7 @@ class LeaderboardApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Updates the name of a leaderboard.
+        """(Deprecated) Updates the name of a leaderboard.
 
 
         :param leaderboard_id:  (required)
@@ -1320,6 +1323,7 @@ class LeaderboardApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """ # noqa: E501
+        warnings.warn("PUT /leaderboard/{leaderboardId}/name is deprecated.", DeprecationWarning)
 
         _param = self._leaderboard_leaderboard_id_name_put_serialize(
             leaderboard_id=leaderboard_id,
@@ -2532,6 +2536,288 @@ class LeaderboardApi:
 
 
 
+    @validate_call
+    def leaderboard_leaderboard_id_patch(
+        self,
+        leaderboard_id: StrictStr,
+        update_leaderboard_model: Optional[UpdateLeaderboardModel] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> None:
+        """Updates the response config of a leaderboard.
+
+
+        :param leaderboard_id:  (required)
+        :type leaderboard_id: str
+        :param update_leaderboard_model: 
+        :type update_leaderboard_model: UpdateLeaderboardModel
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._leaderboard_leaderboard_id_patch_serialize(
+            leaderboard_id=leaderboard_id,
+            update_leaderboard_model=update_leaderboard_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def leaderboard_leaderboard_id_patch_with_http_info(
+        self,
+        leaderboard_id: StrictStr,
+        update_leaderboard_model: Optional[UpdateLeaderboardModel] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[None]:
+        """Updates the response config of a leaderboard.
+
+
+        :param leaderboard_id:  (required)
+        :type leaderboard_id: str
+        :param update_leaderboard_model: 
+        :type update_leaderboard_model: UpdateLeaderboardModel
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._leaderboard_leaderboard_id_patch_serialize(
+            leaderboard_id=leaderboard_id,
+            update_leaderboard_model=update_leaderboard_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def leaderboard_leaderboard_id_patch_without_preload_content(
+        self,
+        leaderboard_id: StrictStr,
+        update_leaderboard_model: Optional[UpdateLeaderboardModel] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Updates the response config of a leaderboard.
+
+
+        :param leaderboard_id:  (required)
+        :type leaderboard_id: str
+        :param update_leaderboard_model: 
+        :type update_leaderboard_model: UpdateLeaderboardModel
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._leaderboard_leaderboard_id_patch_serialize(
+            leaderboard_id=leaderboard_id,
+            update_leaderboard_model=update_leaderboard_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _leaderboard_leaderboard_id_patch_serialize(
+        self,
+        leaderboard_id,
+        update_leaderboard_model,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if leaderboard_id is not None:
+            _path_params['leaderboardId'] = leaderboard_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if update_leaderboard_model is not None:
+            _body_params = update_leaderboard_model
+
+
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json', 
+                        'text/json', 
+                        'application/*+json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearer', 
+            'oauth2'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PATCH',
+            resource_path='/leaderboard/{leaderboardId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     def leaderboard_leaderboard_id_prompts_get(
         self,
@@ -3117,7 +3403,7 @@ class LeaderboardApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> None:
-        """Updates the response config of a leaderboard.
+        """(Deprecated) Updates the response config of a leaderboard.
 
 
         :param leaderboard_id:  (required)
@@ -3145,6 +3431,7 @@ class LeaderboardApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """ # noqa: E501
+        warnings.warn("PUT /leaderboard/{leaderboardId}/response-config is deprecated.", DeprecationWarning)
 
         _param = self._leaderboard_leaderboard_id_response_config_put_serialize(
             leaderboard_id=leaderboard_id,
@@ -3187,7 +3474,7 @@ class LeaderboardApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[None]:
-        """Updates the response config of a leaderboard.
+        """(Deprecated) Updates the response config of a leaderboard.
 
 
         :param leaderboard_id:  (required)
@@ -3215,6 +3502,7 @@ class LeaderboardApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """ # noqa: E501
+        warnings.warn("PUT /leaderboard/{leaderboardId}/response-config is deprecated.", DeprecationWarning)
 
         _param = self._leaderboard_leaderboard_id_response_config_put_serialize(
             leaderboard_id=leaderboard_id,
@@ -3257,7 +3545,7 @@ class LeaderboardApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Updates the response config of a leaderboard.
+        """(Deprecated) Updates the response config of a leaderboard.
 
 
         :param leaderboard_id:  (required)
@@ -3285,6 +3573,7 @@ class LeaderboardApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """ # noqa: E501
+        warnings.warn("PUT /leaderboard/{leaderboardId}/response-config is deprecated.", DeprecationWarning)
 
         _param = self._leaderboard_leaderboard_id_response_config_put_serialize(
             leaderboard_id=leaderboard_id,