cribl-control-plane 0.0.36__tar.gz → 0.0.37__tar.gz

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cribl-control-plane
-Version: 0.0.36
+Version: 0.0.37
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -374,7 +374,7 @@ 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

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/README-PYPI.md

@@ -357,7 +357,7 @@ 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

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/pyproject.toml

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

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/src/cribl_control_plane/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "cribl-control-plane"
-__version__: str = "0.0.36"
-__openapi_doc_version__: str = "4.14.0-alpha.1755792230606-47c829c2"
+__version__: str = "0.0.37"
+__openapi_doc_version__: str = "4.14.0-alpha.1756133891055-db064179"
 __gen_version__: str = "2.686.7"
-__user_agent__: str = "speakeasy-sdk/python 0.0.36 2.686.7 4.14.0-alpha.1755792230606-47c829c2 cribl-control-plane"
+__user_agent__: str = "speakeasy-sdk/python 0.0.37 2.686.7 4.14.0-alpha.1756133891055-db064179 cribl-control-plane"
 
 try:
     if __package__ is not None:

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/src/cribl_control_plane/models/__init__.py

@@ -2943,11 +2943,17 @@ if TYPE_CHECKING:
         PackInstallInfoTagsTypedDict,
         PackInstallInfoTypedDict,
     )
-    from .packrequestbody import (
-        PackRequestBody,
-        PackRequestBodyTags,
-        PackRequestBodyTagsTypedDict,
-        PackRequestBodyTypedDict,
+    from .packrequestbody_union import (
+        PackRequestBody1,
+        PackRequestBody1TypedDict,
+        PackRequestBody2,
+        PackRequestBody2TypedDict,
+        PackRequestBodyTags1,
+        PackRequestBodyTags1TypedDict,
+        PackRequestBodyTags2,
+        PackRequestBodyTags2TypedDict,
+        PackRequestBodyUnion,
+        PackRequestBodyUnionTypedDict,
     )
     from .pipeline import (
         Conf,
@@ -5619,10 +5625,16 @@ __all__ = [
     "PackInstallInfoTags",
     "PackInstallInfoTagsTypedDict",
     "PackInstallInfoTypedDict",
-    "PackRequestBody",
-    "PackRequestBodyTags",
-    "PackRequestBodyTagsTypedDict",
-    "PackRequestBodyTypedDict",
+    "PackRequestBody1",
+    "PackRequestBody1TypedDict",
+    "PackRequestBody2",
+    "PackRequestBody2TypedDict",
+    "PackRequestBodyTags1",
+    "PackRequestBodyTags1TypedDict",
+    "PackRequestBodyTags2",
+    "PackRequestBodyTags2TypedDict",
+    "PackRequestBodyUnion",
+    "PackRequestBodyUnionTypedDict",
     "PayloadFormat",
     "Pipeline",
     "PipelineFunctionConf",
@@ -8368,10 +8380,16 @@ _dynamic_imports: dict[str, str] = {
     "PackInstallInfoTags": ".packinstallinfo",
     "PackInstallInfoTagsTypedDict": ".packinstallinfo",
     "PackInstallInfoTypedDict": ".packinstallinfo",
-    "PackRequestBody": ".packrequestbody",
-    "PackRequestBodyTags": ".packrequestbody",
-    "PackRequestBodyTagsTypedDict": ".packrequestbody",
-    "PackRequestBodyTypedDict": ".packrequestbody",
+    "PackRequestBody1": ".packrequestbody_union",
+    "PackRequestBody1TypedDict": ".packrequestbody_union",
+    "PackRequestBody2": ".packrequestbody_union",
+    "PackRequestBody2TypedDict": ".packrequestbody_union",
+    "PackRequestBodyTags1": ".packrequestbody_union",
+    "PackRequestBodyTags1TypedDict": ".packrequestbody_union",
+    "PackRequestBodyTags2": ".packrequestbody_union",
+    "PackRequestBodyTags2TypedDict": ".packrequestbody_union",
+    "PackRequestBodyUnion": ".packrequestbody_union",
+    "PackRequestBodyUnionTypedDict": ".packrequestbody_union",
     "Conf": ".pipeline",
     "ConfTypedDict": ".pipeline",
     "Pipeline": ".pipeline",

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/src/cribl_control_plane/models/inputcrowdstrike.py

@@ -201,7 +201,7 @@ class InputCrowdstrikeTypedDict(TypedDict):
     skip_on_error: NotRequired[bool]
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
     include_sqs_metadata: NotRequired[bool]
-    r"""Include metadata from SQS notifications on outgoing events"""
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
     enable_assume_role: NotRequired[bool]
     r"""Use Assume Role credentials to access Amazon S3"""
     assume_role_arn: NotRequired[str]
@@ -338,7 +338,7 @@ class InputCrowdstrike(BaseModel):
     include_sqs_metadata: Annotated[
         Optional[bool], pydantic.Field(alias="includeSqsMetadata")
     ] = False
-    r"""Include metadata from SQS notifications on outgoing events"""
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
 
     enable_assume_role: Annotated[
         Optional[bool], pydantic.Field(alias="enableAssumeRole")

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/src/cribl_control_plane/models/inputs3.py

@@ -196,7 +196,7 @@ class InputS3TypedDict(TypedDict):
     skip_on_error: NotRequired[bool]
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
     include_sqs_metadata: NotRequired[bool]
-    r"""Include metadata from SQS notifications on outgoing events"""
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
     enable_assume_role: NotRequired[bool]
     r"""Use Assume Role credentials to access Amazon S3"""
     assume_role_arn: NotRequired[str]
@@ -337,7 +337,7 @@ class InputS3(BaseModel):
     include_sqs_metadata: Annotated[
         Optional[bool], pydantic.Field(alias="includeSqsMetadata")
     ] = False
-    r"""Include metadata from SQS notifications on outgoing events"""
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
 
     enable_assume_role: Annotated[
         Optional[bool], pydantic.Field(alias="enableAssumeRole")

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/src/cribl_control_plane/models/inputs3inventory.py

@@ -201,7 +201,7 @@ class InputS3InventoryTypedDict(TypedDict):
     skip_on_error: NotRequired[bool]
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
     include_sqs_metadata: NotRequired[bool]
-    r"""Include metadata from SQS notifications on outgoing events"""
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
     enable_assume_role: NotRequired[bool]
     r"""Use Assume Role credentials to access Amazon S3"""
     assume_role_arn: NotRequired[str]
@@ -346,7 +346,7 @@ class InputS3Inventory(BaseModel):
     include_sqs_metadata: Annotated[
         Optional[bool], pydantic.Field(alias="includeSqsMetadata")
     ] = False
-    r"""Include metadata from SQS notifications on outgoing events"""
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
 
     enable_assume_role: Annotated[
         Optional[bool], pydantic.Field(alias="enableAssumeRole")

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/src/cribl_control_plane/models/inputsecuritylake.py

@@ -201,7 +201,7 @@ class InputSecurityLakeTypedDict(TypedDict):
     skip_on_error: NotRequired[bool]
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
     include_sqs_metadata: NotRequired[bool]
-    r"""Include metadata from SQS notifications on outgoing events"""
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
     enable_assume_role: NotRequired[bool]
     r"""Use Assume Role credentials to access Amazon S3"""
     assume_role_arn: NotRequired[str]
@@ -342,7 +342,7 @@ class InputSecurityLake(BaseModel):
     include_sqs_metadata: Annotated[
         Optional[bool], pydantic.Field(alias="includeSqsMetadata")
     ] = False
-    r"""Include metadata from SQS notifications on outgoing events"""
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
 
     enable_assume_role: Annotated[
         Optional[bool], pydantic.Field(alias="enableAssumeRole")

cribl_control_plane-0.0.37/src/cribl_control_plane/models/packrequestbody_union.py

@@ -0,0 +1,140 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import List, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+class PackRequestBodyTags2TypedDict(TypedDict):
+    data_type: NotRequired[List[str]]
+    domain: NotRequired[List[str]]
+    technology: NotRequired[List[str]]
+    streamtags: NotRequired[List[str]]
+
+
+class PackRequestBodyTags2(BaseModel):
+    data_type: Annotated[Optional[List[str]], pydantic.Field(alias="dataType")] = None
+
+    domain: Optional[List[str]] = None
+
+    technology: Optional[List[str]] = None
+
+    streamtags: Optional[List[str]] = None
+
+
+class PackRequestBody2TypedDict(TypedDict):
+    source: str
+    r"""The source of the pack. If not present, an empty pack will be created"""
+    id: NotRequired[str]
+    spec: NotRequired[str]
+    version: NotRequired[str]
+    min_log_stream_version: NotRequired[str]
+    display_name: NotRequired[str]
+    author: NotRequired[str]
+    description: NotRequired[str]
+    tags: NotRequired[PackRequestBodyTags2TypedDict]
+    allow_custom_functions: NotRequired[bool]
+    force: NotRequired[bool]
+
+
+class PackRequestBody2(BaseModel):
+    source: str
+    r"""The source of the pack. If not present, an empty pack will be created"""
+
+    id: Optional[str] = None
+
+    spec: Optional[str] = None
+
+    version: Optional[str] = None
+
+    min_log_stream_version: Annotated[
+        Optional[str], pydantic.Field(alias="minLogStreamVersion")
+    ] = None
+
+    display_name: Annotated[Optional[str], pydantic.Field(alias="displayName")] = None
+
+    author: Optional[str] = None
+
+    description: Optional[str] = None
+
+    tags: Optional[PackRequestBodyTags2] = None
+
+    allow_custom_functions: Annotated[
+        Optional[bool], pydantic.Field(alias="allowCustomFunctions")
+    ] = None
+
+    force: Optional[bool] = None
+
+
+class PackRequestBodyTags1TypedDict(TypedDict):
+    data_type: NotRequired[List[str]]
+    domain: NotRequired[List[str]]
+    technology: NotRequired[List[str]]
+    streamtags: NotRequired[List[str]]
+
+
+class PackRequestBodyTags1(BaseModel):
+    data_type: Annotated[Optional[List[str]], pydantic.Field(alias="dataType")] = None
+
+    domain: Optional[List[str]] = None
+
+    technology: Optional[List[str]] = None
+
+    streamtags: Optional[List[str]] = None
+
+
+class PackRequestBody1TypedDict(TypedDict):
+    id: str
+    spec: NotRequired[str]
+    version: NotRequired[str]
+    min_log_stream_version: NotRequired[str]
+    display_name: NotRequired[str]
+    author: NotRequired[str]
+    description: NotRequired[str]
+    source: NotRequired[str]
+    r"""The source of the pack. If not present, an empty pack will be created"""
+    tags: NotRequired[PackRequestBodyTags1TypedDict]
+    allow_custom_functions: NotRequired[bool]
+    force: NotRequired[bool]
+
+
+class PackRequestBody1(BaseModel):
+    id: str
+
+    spec: Optional[str] = None
+
+    version: Optional[str] = None
+
+    min_log_stream_version: Annotated[
+        Optional[str], pydantic.Field(alias="minLogStreamVersion")
+    ] = None
+
+    display_name: Annotated[Optional[str], pydantic.Field(alias="displayName")] = None
+
+    author: Optional[str] = None
+
+    description: Optional[str] = None
+
+    source: Optional[str] = None
+    r"""The source of the pack. If not present, an empty pack will be created"""
+
+    tags: Optional[PackRequestBodyTags1] = None
+
+    allow_custom_functions: Annotated[
+        Optional[bool], pydantic.Field(alias="allowCustomFunctions")
+    ] = None
+
+    force: Optional[bool] = None
+
+
+PackRequestBodyUnionTypedDict = TypeAliasType(
+    "PackRequestBodyUnionTypedDict",
+    Union[PackRequestBody1TypedDict, PackRequestBody2TypedDict],
+)
+
+
+PackRequestBodyUnion = TypeAliasType(
+    "PackRequestBodyUnion", Union[PackRequestBody1, PackRequestBody2]
+)

{cribl_control_plane-0.0.36 → cribl_control_plane-0.0.37}/src/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
-
-        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:
+        r"""Create or install a Pack
+
+        Create or install a Pack.
+
+        :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
-
-        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:
+        r"""Create or install a Pack
+
+        Create or install a Pack.
+
+        :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,
         )

cribl_control_plane-0.0.36/src/cribl_control_plane/models/packrequestbody.py

@@ -1,75 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from cribl_control_plane.types import BaseModel
-import pydantic
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
-
-
-class PackRequestBodyTagsTypedDict(TypedDict):
-    data_type: List[str]
-    domain: List[str]
-    streamtags: List[str]
-    technology: List[str]
-
-
-class PackRequestBodyTags(BaseModel):
-    data_type: Annotated[List[str], pydantic.Field(alias="dataType")]
-
-    domain: List[str]
-
-    streamtags: List[str]
-
-    technology: List[str]
-
-
-class PackRequestBodyTypedDict(TypedDict):
-    id: str
-    source: str
-    allow_custom_functions: NotRequired[bool]
-    author: NotRequired[str]
-    description: NotRequired[str]
-    display_name: NotRequired[str]
-    exports: NotRequired[List[str]]
-    force: NotRequired[bool]
-    inputs: NotRequired[float]
-    min_log_stream_version: NotRequired[str]
-    outputs: NotRequired[float]
-    spec: NotRequired[str]
-    tags: NotRequired[PackRequestBodyTagsTypedDict]
-    version: NotRequired[str]
-
-
-class PackRequestBody(BaseModel):
-    id: str
-
-    source: str
-
-    allow_custom_functions: Annotated[
-        Optional[bool], pydantic.Field(alias="allowCustomFunctions")
-    ] = None
-
-    author: Optional[str] = None
-
-    description: Optional[str] = None
-
-    display_name: Annotated[Optional[str], pydantic.Field(alias="displayName")] = None
-
-    exports: Optional[List[str]] = None
-
-    force: Optional[bool] = None
-
-    inputs: Optional[float] = None
-
-    min_log_stream_version: Annotated[
-        Optional[str], pydantic.Field(alias="minLogStreamVersion")
-    ] = None
-
-    outputs: Optional[float] = None
-
-    spec: Optional[str] = None
-
-    tags: Optional[PackRequestBodyTags] = None
-
-    version: Optional[str] = None