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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cribl-control-plane
-Version: 0.0.20
+Version: 0.0.21a2
 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,39 @@ 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(filename="example.file", size=779474, file={
+        "file_name": "example.file",
+        "content": 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.21a2}/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,39 @@ 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(filename="example.file", size=779474, file={
+        "file_name": "example.file",
+        "content": 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.21a2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cribl-control-plane"
-version = "0.0.20"
+version = "0.0.21a2"
 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.21a2}/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.21a2"
 __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.21a2 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.21a2}/src/cribl_control_plane/models/__init__.py

@@ -4748,7 +4748,11 @@ if TYPE_CHECKING:
         UpdatePacksByIDResponseTypedDict,
     )
     from .updatepacksop import (
+        UpdatePacksFile,
+        UpdatePacksFileTypedDict,
         UpdatePacksRequest,
+        UpdatePacksRequestBody,
+        UpdatePacksRequestBodyTypedDict,
         UpdatePacksRequestTypedDict,
         UpdatePacksResponse,
         UpdatePacksResponseTypedDict,
@@ -9165,7 +9169,11 @@ __all__ = [
     "UpdatePacksByIDRequestTypedDict",
     "UpdatePacksByIDResponse",
     "UpdatePacksByIDResponseTypedDict",
+    "UpdatePacksFile",
+    "UpdatePacksFileTypedDict",
     "UpdatePacksRequest",
+    "UpdatePacksRequestBody",
+    "UpdatePacksRequestBodyTypedDict",
     "UpdatePacksRequestTypedDict",
     "UpdatePacksResponse",
     "UpdatePacksResponseTypedDict",
@@ -13584,7 +13592,11 @@ _dynamic_imports: dict[str, str] = {
     "UpdatePacksByIDRequestTypedDict": ".updatepacksbyidop",
     "UpdatePacksByIDResponse": ".updatepacksbyidop",
     "UpdatePacksByIDResponseTypedDict": ".updatepacksbyidop",
+    "UpdatePacksFile": ".updatepacksop",
+    "UpdatePacksFileTypedDict": ".updatepacksop",
     "UpdatePacksRequest": ".updatepacksop",
+    "UpdatePacksRequestBody": ".updatepacksop",
+    "UpdatePacksRequestBodyTypedDict": ".updatepacksop",
     "UpdatePacksRequestTypedDict": ".updatepacksop",
     "UpdatePacksResponse": ".updatepacksop",
     "UpdatePacksResponseTypedDict": ".updatepacksop",

cribl_control_plane-0.0.21a2/src/cribl_control_plane/models/updatepacksop.py

@@ -0,0 +1,98 @@
+"""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,
+    MultipartFormMetadata,
+    QueryParamMetadata,
+    RequestMetadata,
+)
+import io
+import pydantic
+from typing import Any, Dict, IO, List, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UpdatePacksFileTypedDict(TypedDict):
+    file_name: str
+    content: Union[bytes, IO[bytes], io.BufferedReader]
+    content_type: NotRequired[str]
+
+
+class UpdatePacksFile(BaseModel):
+    file_name: Annotated[
+        str, pydantic.Field(alias="fileName"), FieldMetadata(multipart=True)
+    ]
+
+    content: Annotated[
+        Union[bytes, IO[bytes], io.BufferedReader],
+        pydantic.Field(alias=""),
+        FieldMetadata(multipart=MultipartFormMetadata(content=True)),
+    ]
+
+    content_type: Annotated[
+        Optional[str],
+        pydantic.Field(alias="Content-Type"),
+        FieldMetadata(multipart=True),
+    ] = None
+
+
+class UpdatePacksRequestBodyTypedDict(TypedDict):
+    r"""multipart upload of the pack file"""
+
+    file: UpdatePacksFileTypedDict
+    r"""The pack file to upload"""
+
+
+class UpdatePacksRequestBody(BaseModel):
+    r"""multipart upload of the pack file"""
+
+    file: Annotated[
+        UpdatePacksFile, FieldMetadata(multipart=MultipartFormMetadata(file=True))
+    ]
+    r"""The pack file to upload"""
+
+
+class UpdatePacksRequestTypedDict(TypedDict):
+    filename: str
+    r"""the file to upload"""
+    size: int
+    r"""Size of the pack file in bytes"""
+    request_body: UpdatePacksRequestBodyTypedDict
+    r"""multipart upload of the pack file"""
+
+
+class UpdatePacksRequest(BaseModel):
+    filename: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""the file to upload"""
+
+    size: Annotated[
+        int, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Size of the pack file in bytes"""
+
+    request_body: Annotated[
+        UpdatePacksRequestBody,
+        FieldMetadata(request=RequestMetadata(media_type="multipart/form-data")),
+    ]
+    r"""multipart upload of the pack file"""
+
+
+class UpdatePacksResponseTypedDict(TypedDict):
+    r"""a list of any objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[Dict[str, Any]]]
+
+
+class UpdatePacksResponse(BaseModel):
+    r"""a list of any objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[Dict[str, Any]]] = None

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

@@ -451,7 +451,9 @@ class Packs(BaseSDK):
     def update_packs(
         self,
         *,
-        filename: Optional[str] = None,
+        filename: str,
+        size: int,
+        file: Union[models.UpdatePacksFile, models.UpdatePacksFileTypedDict],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -462,6 +464,8 @@ class Packs(BaseSDK):
         Upload Pack
 
         :param filename: the file to upload
+        :param size: Size of the pack file in bytes
+        :param file: The pack file to upload
         :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
@@ -479,6 +483,10 @@ class Packs(BaseSDK):
 
         request = models.UpdatePacksRequest(
             filename=filename,
+            size=size,
+            request_body=models.UpdatePacksRequestBody(
+                file=utils.get_pydantic_model(file, models.UpdatePacksFile),
+            ),
         )
 
         req = self._build_request(
@@ -487,13 +495,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,
+                "multipart",
+                models.UpdatePacksRequestBody,
+            ),
             timeout_ms=timeout_ms,
         )
 
@@ -538,7 +553,9 @@ class Packs(BaseSDK):
     async def update_packs_async(
         self,
         *,
-        filename: Optional[str] = None,
+        filename: str,
+        size: int,
+        file: Union[models.UpdatePacksFile, models.UpdatePacksFileTypedDict],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -549,6 +566,8 @@ class Packs(BaseSDK):
         Upload Pack
 
         :param filename: the file to upload
+        :param size: Size of the pack file in bytes
+        :param file: The pack file to upload
         :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
@@ -566,6 +585,10 @@ class Packs(BaseSDK):
 
         request = models.UpdatePacksRequest(
             filename=filename,
+            size=size,
+            request_body=models.UpdatePacksRequestBody(
+                file=utils.get_pydantic_model(file, models.UpdatePacksFile),
+            ),
         )
 
         req = self._build_request_async(
@@ -574,13 +597,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,
+                "multipart",
+                models.UpdatePacksRequestBody,
+            ),
             timeout_ms=timeout_ms,
         )
 

cribl_control_plane-0.0.20/src/cribl_control_plane/models/updatepacksop.py

@@ -1,37 +0,0 @@
-"""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
-from typing import Any, Dict, List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
-
-
-class UpdatePacksRequestTypedDict(TypedDict):
-    filename: NotRequired[str]
-    r"""the file to upload"""
-
-
-class UpdatePacksRequest(BaseModel):
-    filename: Annotated[
-        Optional[str],
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = None
-    r"""the file to upload"""
-
-
-class UpdatePacksResponseTypedDict(TypedDict):
-    r"""a list of any objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[Dict[str, Any]]]
-
-
-class UpdatePacksResponse(BaseModel):
-    r"""a list of any objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[Dict[str, Any]]] = None