cribl-control-plane 0.0.26__py3-none-any.whl → 0.0.27__py3-none-any.whl

cribl_control_plane/hectokens.py

@@ -0,0 +1,479 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from cribl_control_plane import errors, models, utils
+from cribl_control_plane._hooks import HookContext
+from cribl_control_plane.types import OptionalNullable, UNSET
+from cribl_control_plane.utils import get_security_from_env
+from cribl_control_plane.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Any, List, Mapping, Optional, Union
+
+
+class HecTokens(BaseSDK):
+    def create(
+        self,
+        *,
+        id: str,
+        token: str,
+        description: Optional[str] = None,
+        enabled: Optional[bool] = None,
+        metadata: Optional[
+            Union[
+                List[models.AddHecTokenRequestMetadatum],
+                List[models.AddHecTokenRequestMetadatumTypedDict],
+            ]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreateInputHecTokenByIDResponse:
+        r"""Add an HEC token and optional metadata to a Splunk HEC Source
+
+        Add token and optional metadata to an existing HEC Source
+
+        :param id: HEC Source id
+        :param token:
+        :param description:
+        :param enabled:
+        :param metadata:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CreateInputHecTokenByIDRequest(
+            id=id,
+            add_hec_token_request=models.AddHecTokenRequest(
+                description=description,
+                enabled=enabled,
+                metadata=utils.get_pydantic_model(
+                    metadata, Optional[List[models.AddHecTokenRequestMetadatum]]
+                ),
+                token=token,
+            ),
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/system/inputs/{id}/hectoken",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.add_hec_token_request,
+                False,
+                False,
+                "json",
+                models.AddHecTokenRequest,
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="createInputHecTokenById",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["401", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(
+                models.CreateInputHecTokenByIDResponse, http_res
+            )
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.ErrorData, http_res)
+            raise errors.Error(response_data, http_res)
+        if utils.match_response(http_res, ["401", "4XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def create_async(
+        self,
+        *,
+        id: str,
+        token: str,
+        description: Optional[str] = None,
+        enabled: Optional[bool] = None,
+        metadata: Optional[
+            Union[
+                List[models.AddHecTokenRequestMetadatum],
+                List[models.AddHecTokenRequestMetadatumTypedDict],
+            ]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreateInputHecTokenByIDResponse:
+        r"""Add an HEC token and optional metadata to a Splunk HEC Source
+
+        Add token and optional metadata to an existing HEC Source
+
+        :param id: HEC Source id
+        :param token:
+        :param description:
+        :param enabled:
+        :param metadata:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CreateInputHecTokenByIDRequest(
+            id=id,
+            add_hec_token_request=models.AddHecTokenRequest(
+                description=description,
+                enabled=enabled,
+                metadata=utils.get_pydantic_model(
+                    metadata, Optional[List[models.AddHecTokenRequestMetadatum]]
+                ),
+                token=token,
+            ),
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/system/inputs/{id}/hectoken",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.add_hec_token_request,
+                False,
+                False,
+                "json",
+                models.AddHecTokenRequest,
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="createInputHecTokenById",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["401", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(
+                models.CreateInputHecTokenByIDResponse, http_res
+            )
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.ErrorData, http_res)
+            raise errors.Error(response_data, http_res)
+        if utils.match_response(http_res, ["401", "4XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    def update(
+        self,
+        *,
+        id: str,
+        token: str,
+        description: Optional[str] = None,
+        enabled: Optional[bool] = None,
+        metadata: Optional[
+            Union[
+                List[models.UpdateHecTokenRequestMetadatum],
+                List[models.UpdateHecTokenRequestMetadatumTypedDict],
+            ]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.UpdateInputHecTokenByIDAndTokenResponse:
+        r"""Update metadata for an HEC token for a Splunk HEC Source
+
+        Update token metadata on existing HEC Source
+
+        :param id: HEC Source id
+        :param token: token to update
+        :param description:
+        :param enabled:
+        :param metadata:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.UpdateInputHecTokenByIDAndTokenRequest(
+            id=id,
+            token=token,
+            update_hec_token_request=models.UpdateHecTokenRequest(
+                description=description,
+                enabled=enabled,
+                metadata=utils.get_pydantic_model(
+                    metadata, Optional[List[models.UpdateHecTokenRequestMetadatum]]
+                ),
+            ),
+        )
+
+        req = self._build_request(
+            method="PATCH",
+            path="/system/inputs/{id}/hectoken/{token}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.update_hec_token_request,
+                False,
+                False,
+                "json",
+                models.UpdateHecTokenRequest,
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="updateInputHecTokenByIdAndToken",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["401", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(
+                models.UpdateInputHecTokenByIDAndTokenResponse, http_res
+            )
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.ErrorData, http_res)
+            raise errors.Error(response_data, http_res)
+        if utils.match_response(http_res, ["401", "4XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def update_async(
+        self,
+        *,
+        id: str,
+        token: str,
+        description: Optional[str] = None,
+        enabled: Optional[bool] = None,
+        metadata: Optional[
+            Union[
+                List[models.UpdateHecTokenRequestMetadatum],
+                List[models.UpdateHecTokenRequestMetadatumTypedDict],
+            ]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.UpdateInputHecTokenByIDAndTokenResponse:
+        r"""Update metadata for an HEC token for a Splunk HEC Source
+
+        Update token metadata on existing HEC Source
+
+        :param id: HEC Source id
+        :param token: token to update
+        :param description:
+        :param enabled:
+        :param metadata:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.UpdateInputHecTokenByIDAndTokenRequest(
+            id=id,
+            token=token,
+            update_hec_token_request=models.UpdateHecTokenRequest(
+                description=description,
+                enabled=enabled,
+                metadata=utils.get_pydantic_model(
+                    metadata, Optional[List[models.UpdateHecTokenRequestMetadatum]]
+                ),
+            ),
+        )
+
+        req = self._build_request_async(
+            method="PATCH",
+            path="/system/inputs/{id}/hectoken/{token}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.update_hec_token_request,
+                False,
+                False,
+                "json",
+                models.UpdateHecTokenRequest,
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="updateInputHecTokenByIdAndToken",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["401", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(
+                models.UpdateInputHecTokenByIDAndTokenResponse, http_res
+            )
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.ErrorData, http_res)
+            raise errors.Error(response_data, http_res)
+        if utils.match_response(http_res, ["401", "4XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)

cribl_control_plane/models/__init__.py

@@ -82,10 +82,6 @@ if TYPE_CHECKING:
         CreateVersionRevertResponse,
         CreateVersionRevertResponseTypedDict,
     )
-    from .createversionsyncop import (
-        CreateVersionSyncResponse,
-        CreateVersionSyncResponseTypedDict,
-    )
     from .createversionundoop import (
         CreateVersionUndoRequest,
         CreateVersionUndoRequestTypedDict,
@@ -3109,8 +3105,6 @@ __all__ = [
     "CreateVersionRevertRequestTypedDict",
     "CreateVersionRevertResponse",
     "CreateVersionRevertResponseTypedDict",
-    "CreateVersionSyncResponse",
-    "CreateVersionSyncResponseTypedDict",
     "CreateVersionUndoRequest",
     "CreateVersionUndoRequestTypedDict",
     "CreateVersionUndoResponse",
@@ -5756,8 +5750,6 @@ _dynamic_imports: dict[str, str] = {
     "CreateVersionRevertRequestTypedDict": ".createversionrevertop",
     "CreateVersionRevertResponse": ".createversionrevertop",
     "CreateVersionRevertResponseTypedDict": ".createversionrevertop",
-    "CreateVersionSyncResponse": ".createversionsyncop",
-    "CreateVersionSyncResponseTypedDict": ".createversionsyncop",
     "CreateVersionUndoRequest": ".createversionundoop",
     "CreateVersionUndoRequestTypedDict": ".createversionundoop",
     "CreateVersionUndoResponse": ".createversionundoop",