cribl-control-plane 0.0.37a1__py3-none-any.whl → 0.0.38__py3-none-any.whl

cribl_control_plane/packs.py

@@ -3,10 +3,10 @@
 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.types import BaseModel, 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
+from typing import Any, Mapping, Optional, Union, cast
 
 
 class Packs(BaseSDK):
@@ -15,45 +15,19 @@ class Packs(BaseSDK):
     def install(
         self,
         *,
-        id: str,
-        source: str,
-        allow_custom_functions: Optional[bool] = None,
-        author: Optional[str] = None,
-        description: Optional[str] = None,
-        display_name: Optional[str] = None,
-        exports: Optional[List[str]] = None,
-        force: Optional[bool] = None,
-        inputs: Optional[float] = None,
-        min_log_stream_version: Optional[str] = None,
-        outputs: Optional[float] = None,
-        spec: Optional[str] = None,
-        tags: Optional[
-            Union[models.PackRequestBodyTags, models.PackRequestBodyTagsTypedDict]
-        ] = None,
-        version: Optional[str] = None,
+        request: Union[
+            models.PackRequestBodyUnion, models.PackRequestBodyUnionTypedDict
+        ],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePacksResponse:
-        r"""Install a Pack
+        r"""Create or install a Pack
 
-        Install a Pack.
+        Create or install a Pack.
 
-        :param id:
-        :param source:
-        :param allow_custom_functions:
-        :param author:
-        :param description:
-        :param display_name:
-        :param exports:
-        :param force:
-        :param inputs:
-        :param min_log_stream_version:
-        :param outputs:
-        :param spec:
-        :param tags:
-        :param version:
+        :param request: The request object to send.
         :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
@@ -69,22 +43,9 @@ class Packs(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.PackRequestBody(
-            allow_custom_functions=allow_custom_functions,
-            author=author,
-            description=description,
-            display_name=display_name,
-            exports=exports,
-            force=force,
-            id=id,
-            inputs=inputs,
-            min_log_stream_version=min_log_stream_version,
-            outputs=outputs,
-            source=source,
-            spec=spec,
-            tags=utils.get_pydantic_model(tags, Optional[models.PackRequestBodyTags]),
-            version=version,
-        )
+        if not isinstance(request, BaseModel):
+            request = utils.unmarshal(request, models.PackRequestBodyUnion)
+        request = cast(models.PackRequestBodyUnion, request)
 
         req = self._build_request(
             method="POST",
@@ -100,7 +61,7 @@ class Packs(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.PackRequestBody
+                request, False, False, "json", models.PackRequestBodyUnion
             ),
             timeout_ms=timeout_ms,
         )
@@ -146,45 +107,19 @@ class Packs(BaseSDK):
     async def install_async(
         self,
         *,
-        id: str,
-        source: str,
-        allow_custom_functions: Optional[bool] = None,
-        author: Optional[str] = None,
-        description: Optional[str] = None,
-        display_name: Optional[str] = None,
-        exports: Optional[List[str]] = None,
-        force: Optional[bool] = None,
-        inputs: Optional[float] = None,
-        min_log_stream_version: Optional[str] = None,
-        outputs: Optional[float] = None,
-        spec: Optional[str] = None,
-        tags: Optional[
-            Union[models.PackRequestBodyTags, models.PackRequestBodyTagsTypedDict]
-        ] = None,
-        version: Optional[str] = None,
+        request: Union[
+            models.PackRequestBodyUnion, models.PackRequestBodyUnionTypedDict
+        ],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePacksResponse:
-        r"""Install a Pack
+        r"""Create or install a Pack
 
-        Install a Pack.
+        Create or install a Pack.
 
-        :param id:
-        :param source:
-        :param allow_custom_functions:
-        :param author:
-        :param description:
-        :param display_name:
-        :param exports:
-        :param force:
-        :param inputs:
-        :param min_log_stream_version:
-        :param outputs:
-        :param spec:
-        :param tags:
-        :param version:
+        :param request: The request object to send.
         :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
@@ -200,22 +135,9 @@ class Packs(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.PackRequestBody(
-            allow_custom_functions=allow_custom_functions,
-            author=author,
-            description=description,
-            display_name=display_name,
-            exports=exports,
-            force=force,
-            id=id,
-            inputs=inputs,
-            min_log_stream_version=min_log_stream_version,
-            outputs=outputs,
-            source=source,
-            spec=spec,
-            tags=utils.get_pydantic_model(tags, Optional[models.PackRequestBodyTags]),
-            version=version,
-        )
+        if not isinstance(request, BaseModel):
+            request = utils.unmarshal(request, models.PackRequestBodyUnion)
+        request = cast(models.PackRequestBodyUnion, request)
 
         req = self._build_request_async(
             method="POST",
@@ -231,7 +153,7 @@ class Packs(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.PackRequestBody
+                request, False, False, "json", models.PackRequestBodyUnion
             ),
             timeout_ms=timeout_ms,
         )
@@ -622,11 +544,186 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def get(
+        self,
+        *,
+        id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetPacksByIDResponse:
+        r"""Get a Pack
+
+        Get the specified Pack.
+
+        :param id: The <code>id</code> of the Pack to get.
+        :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.GetPacksByIDRequest(
+            id=id,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/packs/{id}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            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,
+            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="getPacksById",
+                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.GetPacksByIDResponse, 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 get_async(
+        self,
+        *,
+        id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetPacksByIDResponse:
+        r"""Get a Pack
+
+        Get the specified Pack.
+
+        :param id: The <code>id</code> of the Pack to get.
+        :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.GetPacksByIDRequest(
+            id=id,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/packs/{id}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            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,
+            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="getPacksById",
+                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.GetPacksByIDResponse, 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,
-        source: Optional[str] = None,
+        source: str,
+        allow_custom_functions: Optional[bool] = None,
         minor: Optional[str] = None,
         spec: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -639,9 +736,10 @@ class Packs(BaseSDK):
         Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
         :param id: The <code>id</code> of the Pack to upgrade.
-        :param source: body string required Pack source
-        :param minor: body boolean optional Only upgrade to minor/patch versions
-        :param spec: body string optional Specify a branch, tag or a semver spec
+        :param source:
+        :param allow_custom_functions:
+        :param minor:
+        :param spec:
         :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
@@ -659,9 +757,12 @@ class Packs(BaseSDK):
 
         request = models.UpdatePacksByIDRequest(
             id=id,
-            source=source,
-            minor=minor,
-            spec=spec,
+            pack_upgrade_request=models.PackUpgradeRequest(
+                allow_custom_functions=allow_custom_functions,
+                minor=minor,
+                source=source,
+                spec=spec,
+            ),
         )
 
         req = self._build_request(
@@ -670,13 +771,20 @@ class Packs(BaseSDK):
             base_url=base_url,
             url_variables=url_variables,
             request=request,
-            request_body_required=False,
+            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.pack_upgrade_request,
+                False,
+                False,
+                "json",
+                models.PackUpgradeRequest,
+            ),
             timeout_ms=timeout_ms,
         )
 
@@ -722,7 +830,8 @@ class Packs(BaseSDK):
         self,
         *,
         id: str,
-        source: Optional[str] = None,
+        source: str,
+        allow_custom_functions: Optional[bool] = None,
         minor: Optional[str] = None,
         spec: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -735,9 +844,10 @@ class Packs(BaseSDK):
         Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
         :param id: The <code>id</code> of the Pack to upgrade.
-        :param source: body string required Pack source
-        :param minor: body boolean optional Only upgrade to minor/patch versions
-        :param spec: body string optional Specify a branch, tag or a semver spec
+        :param source:
+        :param allow_custom_functions:
+        :param minor:
+        :param spec:
         :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
@@ -755,9 +865,12 @@ class Packs(BaseSDK):
 
         request = models.UpdatePacksByIDRequest(
             id=id,
-            source=source,
-            minor=minor,
-            spec=spec,
+            pack_upgrade_request=models.PackUpgradeRequest(
+                allow_custom_functions=allow_custom_functions,
+                minor=minor,
+                source=source,
+                spec=spec,
+            ),
         )
 
         req = self._build_request_async(
@@ -766,13 +879,20 @@ class Packs(BaseSDK):
             base_url=base_url,
             url_variables=url_variables,
             request=request,
-            request_body_required=False,
+            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.pack_upgrade_request,
+                False,
+                False,
+                "json",
+                models.PackUpgradeRequest,
+            ),
             timeout_ms=timeout_ms,
         )
 

cribl_control_plane/statuses.py

@@ -13,7 +13,7 @@ class Statuses(BaseSDK):
     def get(
         self,
         *,
-        group: Optional[str] = None,
+        group_id: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -23,7 +23,7 @@ class Statuses(BaseSDK):
 
         Get the status of the current working tree of the Git repository used for Cribl configuration. The response includes details about modified, staged, untracked, and conflicted files, as well as branch and remote tracking information.
 
-        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the status for.
+        :param group_id: The <code>id</code> of the Worker Group or Edge Fleet to get the status for.
         :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
@@ -40,7 +40,7 @@ class Statuses(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.GetVersionStatusRequest(
-            group=group,
+            group_id=group_id,
         )
 
         req = self._build_request(
@@ -100,7 +100,7 @@ class Statuses(BaseSDK):
     async def get_async(
         self,
         *,
-        group: Optional[str] = None,
+        group_id: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -110,7 +110,7 @@ class Statuses(BaseSDK):
 
         Get the status of the current working tree of the Git repository used for Cribl configuration. The response includes details about modified, staged, untracked, and conflicted files, as well as branch and remote tracking information.
 
-        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the status for.
+        :param group_id: The <code>id</code> of the Worker Group or Edge Fleet to get the status for.
         :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
@@ -127,7 +127,7 @@ class Statuses(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.GetVersionStatusRequest(
-            group=group,
+            group_id=group_id,
         )
 
         req = self._build_request_async(

{cribl_control_plane-0.0.37a1.dist-info → cribl_control_plane-0.0.38.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cribl-control-plane
-Version: 0.0.37a1
+Version: 0.0.38
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -374,9 +374,10 @@ with CriblControlPlane(
 
 ### [packs](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md)
 
-* [install](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#install) - Install a Pack
+* [install](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#install) - Create or install a Pack
 * [list](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#list) - List all Packs
 * [delete](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#delete) - Uninstall a Pack
+* [get](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#get) - Get a Pack
 * [update](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#update) - Upgrade a Pack
 
 ### [pipelines](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/pipelines/README.md)
@@ -654,7 +655,7 @@ with CriblControlPlane(
 
 
 **Inherit from [`CriblControlPlaneError`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/criblcontrolplaneerror.py)**:
-* [`HealthStatusError`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/healthstatuserror.py): Healthy status. Status code `420`. Applicable to 1 of 61 methods.*
+* [`HealthStatusError`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/healthstatuserror.py): Healthy status. Status code `420`. Applicable to 1 of 62 methods.*
 * [`ResponseValidationError`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>