cribl-control-plane 0.1.0b2__py3-none-any.whl → 0.1.1rc2__py3-none-any.whl

cribl_control_plane/models/outputwebhook.py

@@ -26,9 +26,13 @@ class OutputWebhookMethod(str, Enum, metaclass=utils.OpenEnumMeta):
 class OutputWebhookFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to format events before sending out"""
 
+    # NDJSON (Newline Delimited JSON)
     NDJSON = "ndjson"
+    # JSON Array
     JSON_ARRAY = "json_array"
+    # Custom
     CUSTOM = "custom"
+    # Advanced
     ADVANCED = "advanced"
 
 
@@ -46,8 +50,11 @@ class OutputWebhookExtraHTTPHeader(BaseModel):
 class OutputWebhookFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
+    # Payload
     PAYLOAD = "payload"
+    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
+    # None
     NONE = "none"
 
 
@@ -108,19 +115,28 @@ class OutputWebhookTimeoutRetrySettings(BaseModel):
 class OutputWebhookBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
 class OutputWebhookAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Authentication method to use for the HTTP request"""
 
+    # None
     NONE = "none"
+    # Basic
     BASIC = "basic"
+    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
+    # Token
     TOKEN = "token"
+    # Token (text secret)
     TEXT_SECRET = "textSecret"
+    # OAuth
     OAUTH = "oauth"
 
 
@@ -199,22 +215,29 @@ class OutputWebhookTLSSettingsClientSide(BaseModel):
 class OutputWebhookCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputWebhookQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
+    # Block
     BLOCK = "block"
+    # Drop new data
     DROP = "drop"
 
 
 class OutputWebhookMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
 
+    # Error
     ERROR = "error"
+    # Backpressure
     BACKPRESSURE = "backpressure"
+    # Always On
     ALWAYS = "always"
 
 

cribl_control_plane/models/outputxsiam.py

@@ -29,8 +29,11 @@ class OutputXsiamExtraHTTPHeader(BaseModel):
 class OutputXsiamFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
+    # Payload
     PAYLOAD = "payload"
+    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
+    # None
     NONE = "none"
 
 
@@ -98,8 +101,11 @@ class OutputXsiamTimeoutRetrySettings(BaseModel):
 class OutputXsiamBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
@@ -119,22 +125,29 @@ class OutputXsiamURL(BaseModel):
 class OutputXsiamCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputXsiamQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
+    # Block
     BLOCK = "block"
+    # Drop new data
     DROP = "drop"
 
 
 class OutputXsiamMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
 
+    # Error
     ERROR = "error"
+    # Backpressure
     BACKPRESSURE = "backpressure"
+    # Always On
     ALWAYS = "always"
 
 

cribl_control_plane/models/packinfo.py

@@ -9,25 +9,26 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class PackInfoTagsTypedDict(TypedDict):
     data_type: List[str]
-    technology: List[str]
     domain: NotRequired[List[str]]
     streamtags: NotRequired[List[str]]
+    technology: NotRequired[List[str]]
 
 
 class PackInfoTags(BaseModel):
     data_type: Annotated[List[str], pydantic.Field(alias="dataType")]
 
-    technology: List[str]
-
     domain: Optional[List[str]] = None
 
     streamtags: Optional[List[str]] = None
 
+    technology: Optional[List[str]] = None
+
 
 class PackInfoTypedDict(TypedDict):
     id: str
     source: str
     author: NotRequired[str]
+    dependencies: NotRequired[Dict[str, str]]
     description: NotRequired[str]
     display_name: NotRequired[str]
     exports: NotRequired[List[str]]
@@ -48,6 +49,8 @@ class PackInfo(BaseModel):
 
     author: Optional[str] = None
 
+    dependencies: Optional[Dict[str, str]] = None
+
     description: Optional[str] = None
 
     display_name: Annotated[Optional[str], pydantic.Field(alias="displayName")] = None

cribl_control_plane/models/packinstallinfo.py

@@ -9,25 +9,26 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class PackInstallInfoTagsTypedDict(TypedDict):
     data_type: List[str]
-    technology: List[str]
     domain: NotRequired[List[str]]
     streamtags: NotRequired[List[str]]
+    technology: NotRequired[List[str]]
 
 
 class PackInstallInfoTags(BaseModel):
     data_type: Annotated[List[str], pydantic.Field(alias="dataType")]
 
-    technology: List[str]
-
     domain: Optional[List[str]] = None
 
     streamtags: Optional[List[str]] = None
 
+    technology: Optional[List[str]] = None
+
 
 class PackInstallInfoTypedDict(TypedDict):
     id: str
     source: str
     author: NotRequired[str]
+    dependencies: NotRequired[Dict[str, str]]
     description: NotRequired[str]
     display_name: NotRequired[str]
     exports: NotRequired[List[str]]
@@ -49,6 +50,8 @@ class PackInstallInfo(BaseModel):
 
     author: Optional[str] = None
 
+    dependencies: Optional[Dict[str, str]] = None
+
     description: Optional[str] = None
 
     display_name: Annotated[Optional[str], pydantic.Field(alias="displayName")] = None

cribl_control_plane/models/runnablejobcollection.py

@@ -363,9 +363,13 @@ class RunnableJobCollectionTimeWarning(BaseModel):
 
 
 class WhereToCapture(int, Enum, metaclass=utils.OpenEnumMeta):
+    # 1. Before pre-processing Pipeline
     ZERO = 0
+    # 2. Before the Routes
     ONE = 1
+    # 3. Before post-processing Pipeline
     TWO = 2
+    # 4. Before the Destination
     THREE = 3
 
 

cribl_control_plane/models/updatecribllakedatasetbylakeidandidop.py

@@ -2,6 +2,10 @@
 
 from __future__ import annotations
 from .cribllakedataset import CriblLakeDataset, CriblLakeDatasetTypedDict
+from .cribllakedatasetupdate import (
+    CriblLakeDatasetUpdate,
+    CriblLakeDatasetUpdateTypedDict,
+)
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
 import pydantic
@@ -14,8 +18,8 @@ class UpdateCriblLakeDatasetByLakeIDAndIDRequestTypedDict(TypedDict):
     r"""The <code>id</code> of the Lake that contains the Lake Dataset to update."""
     id_param: str
     r"""The <code>id</code> of the Lake Dataset to update."""
-    cribl_lake_dataset: CriblLakeDatasetTypedDict
-    r"""CriblLakeDataset object"""
+    cribl_lake_dataset_update: CriblLakeDatasetUpdateTypedDict
+    r"""CriblLakeDatasetUpdate object"""
 
 
 class UpdateCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
@@ -33,11 +37,11 @@ class UpdateCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
     ]
     r"""The <code>id</code> of the Lake Dataset to update."""
 
-    cribl_lake_dataset: Annotated[
-        CriblLakeDataset,
+    cribl_lake_dataset_update: Annotated[
+        CriblLakeDatasetUpdate,
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
-    r"""CriblLakeDataset object"""
+    r"""CriblLakeDatasetUpdate object"""
 
 
 class UpdateCriblLakeDatasetByLakeIDAndIDResponseTypedDict(TypedDict):

cribl_control_plane/models/updatepacksop.py

@@ -0,0 +1,27 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
+import io
+from typing import IO, Union
+from typing_extensions import Annotated, TypedDict
+
+
+class UpdatePacksRequestTypedDict(TypedDict):
+    filename: str
+    r"""Filename of the pack file to upload"""
+    request_body: Union[bytes, IO[bytes], io.BufferedReader]
+    r"""Binary file content"""
+
+
+class UpdatePacksRequest(BaseModel):
+    filename: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Filename of the pack file to upload"""
+
+    request_body: Annotated[
+        Union[bytes, IO[bytes], io.BufferedReader], FieldMetadata(request=True)
+    ]
+    r"""Binary file content"""

cribl_control_plane/models/uploadpackresponse.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class UploadPackResponseTypedDict(TypedDict):
+    source: str
+
+
+class UploadPackResponse(BaseModel):
+    source: str

cribl_control_plane/packs.py

@@ -6,7 +6,8 @@ from cribl_control_plane._hooks import HookContext
 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, Mapping, Optional, Union, cast
+import io
+from typing import Any, IO, Mapping, Optional, Union, cast
 
 
 class Packs(BaseSDK):
@@ -370,6 +371,200 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def upload(
+        self,
+        *,
+        filename: str,
+        request_body: Union[bytes, IO[bytes], io.BufferedReader],
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.UploadPackResponse:
+        r"""Upload a Pack file
+
+        Upload a Pack file. Returns a source identifier that can be used to install the pack via the install a Pack endpoint.
+
+        :param filename: Filename of the pack file to upload
+        :param request_body: Binary file content
+        :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.UpdatePacksRequest(
+            filename=filename,
+            request_body=request_body,
+        )
+
+        req = self._build_request(
+            method="PUT",
+            path="/packs",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            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.request_body,
+                False,
+                False,
+                "raw",
+                Union[bytes, IO[bytes], io.BufferedReader],
+            ),
+            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="updatePacks",
+                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.UploadPackResponse, 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 upload_async(
+        self,
+        *,
+        filename: str,
+        request_body: Union[bytes, IO[bytes], io.BufferedReader],
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.UploadPackResponse:
+        r"""Upload a Pack file
+
+        Upload a Pack file. Returns a source identifier that can be used to install the pack via the install a Pack endpoint.
+
+        :param filename: Filename of the pack file to upload
+        :param request_body: Binary file content
+        :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.UpdatePacksRequest(
+            filename=filename,
+            request_body=request_body,
+        )
+
+        req = self._build_request_async(
+            method="PUT",
+            path="/packs",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            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.request_body,
+                False,
+                False,
+                "raw",
+                Union[bytes, IO[bytes], io.BufferedReader],
+            ),
+            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="updatePacks",
+                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.UploadPackResponse, 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 delete(
         self,
         *,

{cribl_control_plane-0.1.0b2.dist-info → cribl_control_plane-0.1.1rc2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cribl-control-plane
-Version: 0.1.0b2
+Version: 0.1.1rc2
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -17,11 +17,20 @@ Project-URL: Repository, https://github.com/criblio/cribl_control_plane_sdk_pyth
 Description-Content-Type: text/markdown
 
 # cribl_control_plane_sdk_python
-<!-- Start Summary [summary] -->
-## Summary
 
-Cribl API Reference: This API Reference lists available REST endpoints, along with their supported operations for accessing, creating, updating, or deleting resources. See our complementary product documentation at [docs.cribl.io](http://docs.cribl.io).
-<!-- End Summary [summary] -->
+The Cribl Python SDK for the control plane provides operational control over Cribl resources and helps streamline the process of integrating with Cribl.
+
+In addition to the usage examples in this repository, the Cribl documentation includes [code examples for common use cases](https://docs.cribl.io/cribl-as-code/code-examples).
+
+Complementary API reference documentation is available at https://docs.cribl.io/cribl-as-code/api-reference. Product documentation is available at https://docs.cribl.io.
+
+> [!IMPORTANT]
+> **Preview Feature**
+> The Cribl SDKs are Preview features that are still being developed. We do not recommend using them in a production environment, because the features might not be fully tested or optimized for performance, and related documentation could be incomplete.
+>
+> Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the features remain in Preview.
+
+<!-- No Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
@@ -32,6 +41,7 @@ Cribl API Reference: This API Reference lists available REST endpoints, along wi
   * [SDK Example Usage](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#sdk-example-usage)
   * [Authentication](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#authentication)
   * [Available Resources and Operations](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#available-resources-and-operations)
+  * [File uploads](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#file-uploads)
   * [Retries](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#retries)
   * [Error Handling](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#error-handling)
   * [Custom HTTP Client](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#custom-http-client)
@@ -306,14 +316,10 @@ with CriblControlPlane(
 <details open>
 <summary>Available methods</summary>
 
-### [auth](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/authsdk/README.md)
-
-
 #### [auth.tokens](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/tokens/README.md)
 
 * [get](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/tokens/README.md#get) - Log in and fetch an authentication token
 
-
 ### [destinations](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/destinations/README.md)
 
 * [list](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/destinations/README.md#list) - List all Destinations
@@ -378,6 +384,7 @@ with CriblControlPlane(
 
 * [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
+* [upload](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#upload) - Upload a Pack file
 * [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
@@ -410,9 +417,6 @@ with CriblControlPlane(
 * [create](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/hectokens/README.md#create) - Add an HEC token and optional metadata to a Splunk HEC Source
 * [update](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/hectokens/README.md#update) - Update metadata for an HEC token for a Splunk HEC Source
 
-### [versions](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/versions/README.md)
-
-
 #### [versions.branches](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/branches/README.md)
 
 * [list](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/branches/README.md#list) - List all branches in the Git repository used for Cribl configuration
@@ -444,6 +448,36 @@ with CriblControlPlane(
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
+<!-- Start File uploads [file-upload] -->
+## File uploads
+
+Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
+
+> [!TIP]
+>
+> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
+>
+
+```python
+from cribl_control_plane import CriblControlPlane, models
+import os
+
+
+with CriblControlPlane(
+    server_url="https://api.example.com",
+    security=models.Security(
+        bearer_auth=os.getenv("CRIBLCONTROLPLANE_BEARER_AUTH", ""),
+    ),
+) as ccp_client:
+
+    res = ccp_client.packs.upload(filename="example.file", request_body=open("example.file", "rb"))
+
+    # Handle response
+    print(res)
+
+```
+<!-- End File uploads [file-upload] -->
+
 <!-- Start Retries [retries] -->
 ## Retries
 
@@ -657,7 +691,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 62 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 63 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>