cribl-control-plane 0.0.39__py3-none-any.whl → 0.5.0b3__py3-none-any.whl

cribl_control_plane/models/systemsettingsconf.py

@@ -0,0 +1,291 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .backupssettings_union import BackupsSettingsUnion, BackupsSettingsUnionTypedDict
+from .piisettings_union import PiiSettingsUnion, PiiSettingsUnionTypedDict
+from .rollbacksettings_union import (
+    RollbackSettingsUnion,
+    RollbackSettingsUnionTypedDict,
+)
+from .snisettings_union import SniSettingsUnion, SniSettingsUnionTypedDict
+from .tlssettings_union import TLSSettingsUnion, TLSSettingsUnionTypedDict
+from .upgradegroupsettings_union import (
+    UpgradeGroupSettingsUnion,
+    UpgradeGroupSettingsUnionTypedDict,
+)
+from .upgradesettings import UpgradeSettings, UpgradeSettingsTypedDict
+from cribl_control_plane import models, utils
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import validate_open_enum
+from enum import Enum
+import pydantic
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class SslTypedDict(TypedDict):
+    cert_path: str
+    disabled: bool
+    passphrase: str
+    priv_key_path: str
+    ca_path: NotRequired[str]
+
+
+class Ssl(BaseModel):
+    cert_path: Annotated[str, pydantic.Field(alias="certPath")]
+
+    disabled: bool
+
+    passphrase: str
+
+    priv_key_path: Annotated[str, pydantic.Field(alias="privKeyPath")]
+
+    ca_path: Annotated[Optional[str], pydantic.Field(alias="caPath")] = None
+
+
+class APITypedDict(TypedDict):
+    disabled: bool
+    host: str
+    port: float
+    base_url: NotRequired[str]
+    disable_api_cache: NotRequired[bool]
+    headers: NotRequired[Dict[str, str]]
+    idle_session_ttl: NotRequired[float]
+    listen_on_port: NotRequired[bool]
+    login_rate_limit: NotRequired[str]
+    protocol: NotRequired[str]
+    scripts: NotRequired[bool]
+    sensitive_fields: NotRequired[List[str]]
+    ssl: NotRequired[SslTypedDict]
+    sso_rate_limit: NotRequired[str]
+    worker_remote_access: NotRequired[bool]
+
+
+class API(BaseModel):
+    disabled: bool
+
+    host: str
+
+    port: float
+
+    base_url: Annotated[Optional[str], pydantic.Field(alias="baseUrl")] = None
+
+    disable_api_cache: Annotated[
+        Optional[bool], pydantic.Field(alias="disableApiCache")
+    ] = None
+
+    headers: Optional[Dict[str, str]] = None
+
+    idle_session_ttl: Annotated[
+        Optional[float], pydantic.Field(alias="idleSessionTTL")
+    ] = None
+
+    listen_on_port: Annotated[Optional[bool], pydantic.Field(alias="listenOnPort")] = (
+        None
+    )
+
+    login_rate_limit: Annotated[
+        Optional[str], pydantic.Field(alias="loginRateLimit")
+    ] = None
+
+    protocol: Optional[str] = None
+
+    scripts: Optional[bool] = None
+
+    sensitive_fields: Annotated[
+        Optional[List[str]], pydantic.Field(alias="sensitiveFields")
+    ] = None
+
+    ssl: Optional[Ssl] = None
+
+    sso_rate_limit: Annotated[Optional[str], pydantic.Field(alias="ssoRateLimit")] = (
+        None
+    )
+
+    worker_remote_access: Annotated[
+        Optional[bool], pydantic.Field(alias="workerRemoteAccess")
+    ] = None
+
+
+class CustomLogoTypedDict(TypedDict):
+    enabled: bool
+    logo_description: NotRequired[str]
+    logo_image: NotRequired[str]
+
+
+class CustomLogo(BaseModel):
+    enabled: bool
+
+    logo_description: Annotated[
+        Optional[str], pydantic.Field(alias="logoDescription")
+    ] = None
+
+    logo_image: Annotated[Optional[str], pydantic.Field(alias="logoImage")] = None
+
+
+class ProxyTypedDict(TypedDict):
+    use_env_vars: bool
+
+
+class Proxy(BaseModel):
+    use_env_vars: Annotated[bool, pydantic.Field(alias="useEnvVars")]
+
+
+class ShutdownTypedDict(TypedDict):
+    drain_timeout: float
+
+
+class Shutdown(BaseModel):
+    drain_timeout: Annotated[float, pydantic.Field(alias="drainTimeout")]
+
+
+class SocketsTypedDict(TypedDict):
+    directory: NotRequired[str]
+
+
+class Sockets(BaseModel):
+    directory: Optional[str] = None
+
+
+class FeatureFlagOverrideTypedDict(TypedDict):
+    disabled: bool
+    flag_id: str
+
+
+class FeatureFlagOverride(BaseModel):
+    disabled: bool
+
+    flag_id: Annotated[str, pydantic.Field(alias="flagId")]
+
+
+class SupportTypedDict(TypedDict):
+    feature_flag_overrides: NotRequired[List[FeatureFlagOverrideTypedDict]]
+
+
+class Support(BaseModel):
+    feature_flag_overrides: Annotated[
+        Optional[List[FeatureFlagOverride]],
+        pydantic.Field(alias="featureFlagOverrides"),
+    ] = None
+
+
+class Upgrade(str, Enum, metaclass=utils.OpenEnumMeta):
+    FALSE = "false"
+    API = "api"
+
+
+class SystemSettingsConfSystemTypedDict(TypedDict):
+    intercom: bool
+    upgrade: Upgrade
+
+
+class SystemSettingsConfSystem(BaseModel):
+    intercom: bool
+
+    upgrade: Annotated[Upgrade, PlainValidator(validate_open_enum(False))]
+
+    @field_serializer("upgrade")
+    def serialize_upgrade(self, value):
+        if isinstance(value, str):
+            try:
+                return models.Upgrade(value)
+            except ValueError:
+                return value
+        return value
+
+
+class SystemSettingsConfWorkersTypedDict(TypedDict):
+    count: float
+    memory: float
+    minimum: float
+    enable_heap_snapshots: NotRequired[bool]
+    load_throttle_perc: NotRequired[float]
+    startup_max_conns: NotRequired[float]
+    startup_throttle_timeout: NotRequired[float]
+    v8_single_thread: NotRequired[bool]
+
+
+class SystemSettingsConfWorkers(BaseModel):
+    count: float
+
+    memory: float
+
+    minimum: float
+
+    enable_heap_snapshots: Annotated[
+        Optional[bool], pydantic.Field(alias="enableHeapSnapshots")
+    ] = None
+
+    load_throttle_perc: Annotated[
+        Optional[float], pydantic.Field(alias="loadThrottlePerc")
+    ] = None
+
+    startup_max_conns: Annotated[
+        Optional[float], pydantic.Field(alias="startupMaxConns")
+    ] = None
+
+    startup_throttle_timeout: Annotated[
+        Optional[float], pydantic.Field(alias="startupThrottleTimeout")
+    ] = None
+
+    v8_single_thread: Annotated[
+        Optional[bool], pydantic.Field(alias="v8SingleThread")
+    ] = None
+
+
+class SystemSettingsConfTypedDict(TypedDict):
+    api: APITypedDict
+    backups: BackupsSettingsUnionTypedDict
+    pii: PiiSettingsUnionTypedDict
+    proxy: ProxyTypedDict
+    rollback: RollbackSettingsUnionTypedDict
+    shutdown: ShutdownTypedDict
+    sni: SniSettingsUnionTypedDict
+    system: SystemSettingsConfSystemTypedDict
+    tls: TLSSettingsUnionTypedDict
+    upgrade_group_settings: UpgradeGroupSettingsUnionTypedDict
+    upgrade_settings: UpgradeSettingsTypedDict
+    workers: SystemSettingsConfWorkersTypedDict
+    custom_logo: NotRequired[CustomLogoTypedDict]
+    sockets: NotRequired[SocketsTypedDict]
+    support: NotRequired[SupportTypedDict]
+
+
+class SystemSettingsConf(BaseModel):
+    api: API
+
+    backups: BackupsSettingsUnion
+
+    pii: PiiSettingsUnion
+
+    proxy: Proxy
+
+    rollback: RollbackSettingsUnion
+
+    shutdown: Shutdown
+
+    sni: SniSettingsUnion
+
+    system: SystemSettingsConfSystem
+
+    tls: TLSSettingsUnion
+
+    upgrade_group_settings: Annotated[
+        UpgradeGroupSettingsUnion, pydantic.Field(alias="upgradeGroupSettings")
+    ]
+
+    upgrade_settings: Annotated[
+        UpgradeSettings, pydantic.Field(alias="upgradeSettings")
+    ]
+
+    workers: SystemSettingsConfWorkers
+
+    custom_logo: Annotated[Optional[CustomLogo], pydantic.Field(alias="customLogo")] = (
+        None
+    )
+
+    sockets: Optional[Sockets] = None
+
+    support: Optional[Support] = None

cribl_control_plane/models/tlssettings_union.py

@@ -0,0 +1,43 @@
+"""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 Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
+
+
+class TLSSettings2TypedDict(TypedDict):
+    pass
+
+
+class TLSSettings2(BaseModel):
+    pass
+
+
+class TLSSettings1TypedDict(TypedDict):
+    default_cipher_list: str
+    default_ecdh_curve: str
+    max_version: str
+    min_version: str
+    reject_unauthorized: bool
+
+
+class TLSSettings1(BaseModel):
+    default_cipher_list: Annotated[str, pydantic.Field(alias="defaultCipherList")]
+
+    default_ecdh_curve: Annotated[str, pydantic.Field(alias="defaultEcdhCurve")]
+
+    max_version: Annotated[str, pydantic.Field(alias="maxVersion")]
+
+    min_version: Annotated[str, pydantic.Field(alias="minVersion")]
+
+    reject_unauthorized: Annotated[bool, pydantic.Field(alias="rejectUnauthorized")]
+
+
+TLSSettingsUnionTypedDict = TypeAliasType(
+    "TLSSettingsUnionTypedDict", Union[TLSSettings2TypedDict, TLSSettings1TypedDict]
+)
+
+
+TLSSettingsUnion = TypeAliasType("TLSSettingsUnion", Union[TLSSettings2, TLSSettings1])

cribl_control_plane/models/updateconfiggroupbyproductandidop.py

@@ -3,11 +3,18 @@
 from __future__ import annotations
 from .configgroup import ConfigGroup, ConfigGroupTypedDict
 from .productscore import ProductsCore
+from cribl_control_plane import models
 from cribl_control_plane.types import BaseModel
-from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
+from cribl_control_plane.utils import (
+    FieldMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+    validate_open_enum,
+)
 import pydantic
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing_extensions import Annotated, TypedDict
 
 
 class UpdateConfigGroupByProductAndIDRequestTypedDict(TypedDict):
@@ -21,7 +28,7 @@ class UpdateConfigGroupByProductAndIDRequestTypedDict(TypedDict):
 
 class UpdateConfigGroupByProductAndIDRequest(BaseModel):
     product: Annotated[
-        ProductsCore,
+        Annotated[ProductsCore, PlainValidator(validate_open_enum(False))],
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
     r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
@@ -39,19 +46,11 @@ class UpdateConfigGroupByProductAndIDRequest(BaseModel):
     ]
     r"""ConfigGroup object"""
 
-
-class UpdateConfigGroupByProductAndIDResponseTypedDict(TypedDict):
-    r"""a list of ConfigGroup objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[ConfigGroupTypedDict]]
-
-
-class UpdateConfigGroupByProductAndIDResponse(BaseModel):
-    r"""a list of ConfigGroup objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[ConfigGroup]] = None
+    @field_serializer("product")
+    def serialize_product(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ProductsCore(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/updateconfiggroupdeploybyproductandidop.py

@@ -1,13 +1,19 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .configgroup import ConfigGroup, ConfigGroupTypedDict
 from .deployrequest import DeployRequest, DeployRequestTypedDict
 from .productscore import ProductsCore
+from cribl_control_plane import models
 from cribl_control_plane.types import BaseModel
-from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from cribl_control_plane.utils import (
+    FieldMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+    validate_open_enum,
+)
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing_extensions import Annotated, TypedDict
 
 
 class UpdateConfigGroupDeployByProductAndIDRequestTypedDict(TypedDict):
@@ -21,7 +27,7 @@ class UpdateConfigGroupDeployByProductAndIDRequestTypedDict(TypedDict):
 
 class UpdateConfigGroupDeployByProductAndIDRequest(BaseModel):
     product: Annotated[
-        ProductsCore,
+        Annotated[ProductsCore, PlainValidator(validate_open_enum(False))],
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
     r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
@@ -37,19 +43,11 @@ class UpdateConfigGroupDeployByProductAndIDRequest(BaseModel):
     ]
     r"""DeployRequest object"""
 
-
-class UpdateConfigGroupDeployByProductAndIDResponseTypedDict(TypedDict):
-    r"""a list of ConfigGroup objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[ConfigGroupTypedDict]]
-
-
-class UpdateConfigGroupDeployByProductAndIDResponse(BaseModel):
-    r"""a list of ConfigGroup objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[ConfigGroup]] = None
+    @field_serializer("product")
+    def serialize_product(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ProductsCore(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/updatecribllakedatasetbylakeidandidop.py

@@ -1,12 +1,14 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 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
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class UpdateCriblLakeDatasetByLakeIDAndIDRequestTypedDict(TypedDict):
@@ -14,8 +16,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,25 +35,8 @@ 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"""
-
-
-class UpdateCriblLakeDatasetByLakeIDAndIDResponseTypedDict(TypedDict):
-    r"""a list of CriblLakeDataset objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[CriblLakeDatasetTypedDict]]
-
-
-class UpdateCriblLakeDatasetByLakeIDAndIDResponse(BaseModel):
-    r"""a list of CriblLakeDataset objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[CriblLakeDataset]] = None
+    r"""CriblLakeDatasetUpdate object"""

cribl_control_plane/models/updatehectokenrequest.py

@@ -2,8 +2,9 @@
 
 from __future__ import annotations
 from cribl_control_plane.types import BaseModel
+import pydantic
 from typing import List, Optional
-from typing_extensions import NotRequired, TypedDict
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdateHecTokenRequestMetadatumTypedDict(TypedDict):
@@ -18,12 +19,17 @@ class UpdateHecTokenRequestMetadatum(BaseModel):
 
 
 class UpdateHecTokenRequestTypedDict(TypedDict):
+    allowed_indexes_at_token: NotRequired[List[str]]
     description: NotRequired[str]
     enabled: NotRequired[bool]
     metadata: NotRequired[List[UpdateHecTokenRequestMetadatumTypedDict]]
 
 
 class UpdateHecTokenRequest(BaseModel):
+    allowed_indexes_at_token: Annotated[
+        Optional[List[str]], pydantic.Field(alias="allowedIndexesAtToken")
+    ] = None
+
     description: Optional[str] = None
 
     enabled: Optional[bool] = None

cribl_control_plane/models/updateinputbyidop.py

@@ -4,8 +4,7 @@ from __future__ import annotations
 from .input import Input, InputTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class UpdateInputByIDRequestTypedDict(TypedDict):
@@ -25,20 +24,3 @@ class UpdateInputByIDRequest(BaseModel):
         Input, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
     r"""Input object"""
-
-
-class UpdateInputByIDResponseTypedDict(TypedDict):
-    r"""a list of Source objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[InputTypedDict]]
-
-
-class UpdateInputByIDResponse(BaseModel):
-    r"""a list of Source objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[Input]] = None

cribl_control_plane/models/updateinputhectokenbyidandtokenop.py

@@ -4,8 +4,7 @@ from __future__ import annotations
 from .updatehectokenrequest import UpdateHecTokenRequest, UpdateHecTokenRequestTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing import Any, Dict, List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class UpdateInputHecTokenByIDAndTokenRequestTypedDict(TypedDict):
@@ -33,20 +32,3 @@ class UpdateInputHecTokenByIDAndTokenRequest(BaseModel):
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
     r"""UpdateHecTokenRequest object"""
-
-
-class UpdateInputHecTokenByIDAndTokenResponseTypedDict(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 UpdateInputHecTokenByIDAndTokenResponse(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/models/updateoutputbyidop.py

@@ -4,8 +4,7 @@ from __future__ import annotations
 from .output import Output, OutputTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class UpdateOutputByIDRequestTypedDict(TypedDict):
@@ -25,20 +24,3 @@ class UpdateOutputByIDRequest(BaseModel):
         Output, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
     r"""Output object"""
-
-
-class UpdateOutputByIDResponseTypedDict(TypedDict):
-    r"""a list of Destination objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[OutputTypedDict]]
-
-
-class UpdateOutputByIDResponse(BaseModel):
-    r"""a list of Destination objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[Output]] = None

cribl_control_plane/models/updatepacksbyidop.py

@@ -1,12 +1,10 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .packinfo import PackInfo, PackInfoTypedDict
 from .packupgraderequest import PackUpgradeRequest, PackUpgradeRequestTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class UpdatePacksByIDRequestTypedDict(TypedDict):
@@ -27,20 +25,3 @@ class UpdatePacksByIDRequest(BaseModel):
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
     r"""PackUpgradeRequest object"""
-
-
-class UpdatePacksByIDResponseTypedDict(TypedDict):
-    r"""a list of PackInfo objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[PackInfoTypedDict]]
-
-
-class UpdatePacksByIDResponse(BaseModel):
-    r"""a list of PackInfo objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[PackInfo]] = None