cribl-control-plane 0.0.20__tar.gz → 0.0.21a1__tar.gz

{cribl_control_plane-0.0.20 → cribl_control_plane-0.0.21a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cribl-control-plane
-Version: 0.0.20
+Version: 0.0.21a1
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -31,6 +31,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)
@@ -301,6 +302,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.update_packs(size=779474, request_body=open("example.file", "rb"))
+
+    # Handle response
+    print(res)
+
+```
+<!-- End File uploads [file-upload] -->
+
 <!-- Start Retries [retries] -->
 ## Retries
 

{cribl_control_plane-0.0.20 → cribl_control_plane-0.0.21a1}/README-PYPI.md

@@ -14,6 +14,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)
@@ -284,6 +285,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.update_packs(size=779474, request_body=open("example.file", "rb"))
+
+    # Handle response
+    print(res)
+
+```
+<!-- End File uploads [file-upload] -->
+
 <!-- Start Retries [retries] -->
 ## Retries
 

{cribl_control_plane-0.0.20 → cribl_control_plane-0.0.21a1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cribl-control-plane"
-version = "0.0.20"
+version = "0.0.21a1"
 description = "Python Client SDK Generated by Speakeasy."
 authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"

{cribl_control_plane-0.0.20 → cribl_control_plane-0.0.21a1}/src/cribl_control_plane/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "cribl-control-plane"
-__version__: str = "0.0.20"
+__version__: str = "0.0.21a1"
 __openapi_doc_version__: str = "4.14.0-alpha.1753968519625-08e89eb4"
 __gen_version__: str = "2.660.0"
-__user_agent__: str = "speakeasy-sdk/python 0.0.20 2.660.0 4.14.0-alpha.1753968519625-08e89eb4 cribl-control-plane"
+__user_agent__: str = "speakeasy-sdk/python 0.0.21a1 2.660.0 4.14.0-alpha.1753968519625-08e89eb4 cribl-control-plane"
 
 try:
     if __package__ is not None:

{cribl_control_plane-0.0.20 → cribl_control_plane-0.0.21a1}/src/cribl_control_plane/models/updatepacksop.py

@@ -3,16 +3,31 @@
 from __future__ import annotations
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
-from typing import Any, Dict, List, Optional
+import io
+from typing import Any, Dict, IO, List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdatePacksRequestTypedDict(TypedDict):
+    size: int
+    r"""Size of the pack file in bytes"""
+    request_body: Union[bytes, IO[bytes], io.BufferedReader]
+    r"""file data"""
     filename: NotRequired[str]
     r"""the file to upload"""
 
 
 class UpdatePacksRequest(BaseModel):
+    size: Annotated[
+        int, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Size of the pack file in bytes"""
+
+    request_body: Annotated[
+        Union[bytes, IO[bytes], io.BufferedReader], FieldMetadata(request=True)
+    ]
+    r"""file data"""
+
     filename: Annotated[
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

{cribl_control_plane-0.0.20 → cribl_control_plane-0.0.21a1}/src/cribl_control_plane/packs.py

@@ -6,7 +6,8 @@ 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
+import io
+from typing import Any, IO, List, Mapping, Optional, Union
 
 
 class Packs(BaseSDK):
@@ -451,6 +452,8 @@ class Packs(BaseSDK):
     def update_packs(
         self,
         *,
+        size: int,
+        request_body: Union[bytes, IO[bytes], io.BufferedReader],
         filename: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -461,6 +464,8 @@ class Packs(BaseSDK):
 
         Upload Pack
 
+        :param size: Size of the pack file in bytes
+        :param request_body: file data
         :param filename: the file to upload
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -479,6 +484,8 @@ class Packs(BaseSDK):
 
         request = models.UpdatePacksRequest(
             filename=filename,
+            size=size,
+            request_body=request_body,
         )
 
         req = self._build_request(
@@ -487,13 +494,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=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,
         )
 
@@ -538,6 +552,8 @@ class Packs(BaseSDK):
     async def update_packs_async(
         self,
         *,
+        size: int,
+        request_body: Union[bytes, IO[bytes], io.BufferedReader],
         filename: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -548,6 +564,8 @@ class Packs(BaseSDK):
 
         Upload Pack
 
+        :param size: Size of the pack file in bytes
+        :param request_body: file data
         :param filename: the file to upload
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -566,6 +584,8 @@ class Packs(BaseSDK):
 
         request = models.UpdatePacksRequest(
             filename=filename,
+            size=size,
+            request_body=request_body,
         )
 
         req = self._build_request_async(
@@ -574,13 +594,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=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,
         )