cribl-control-plane 0.0.37a1__py3-none-any.whl → 0.0.38a1__py3-none-any.whl

cribl_control_plane/models/systemsettingsconf.py

@@ -0,0 +1,311 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .upgradegroupsettings import UpgradeGroupSettings, UpgradeGroupSettingsTypedDict
+from .upgradesettings import UpgradeSettings, UpgradeSettingsTypedDict
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class SystemSettingsConfHeadersTypedDict(TypedDict):
+    pass
+
+
+class SystemSettingsConfHeaders(BaseModel):
+    pass
+
+
+class SystemSettingsConfSslTypedDict(TypedDict):
+    cert_path: str
+    disabled: bool
+    passphrase: str
+    priv_key_path: str
+    ca_path: NotRequired[str]
+
+
+class SystemSettingsConfSsl(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 SystemSettingsConfAPITypedDict(TypedDict):
+    disabled: bool
+    host: str
+    port: float
+    protocol: str
+    ssl: SystemSettingsConfSslTypedDict
+    worker_remote_access: bool
+    base_url: NotRequired[str]
+    disable_api_cache: NotRequired[bool]
+    headers: NotRequired[SystemSettingsConfHeadersTypedDict]
+    idle_session_ttl: NotRequired[float]
+    listen_on_port: NotRequired[bool]
+    login_rate_limit: NotRequired[str]
+    scripts: NotRequired[bool]
+    sensitive_fields: NotRequired[List[str]]
+    sso_rate_limit: NotRequired[str]
+
+
+class SystemSettingsConfAPI(BaseModel):
+    disabled: bool
+
+    host: str
+
+    port: float
+
+    protocol: str
+
+    ssl: SystemSettingsConfSsl
+
+    worker_remote_access: Annotated[bool, pydantic.Field(alias="workerRemoteAccess")]
+
+    base_url: Annotated[Optional[str], pydantic.Field(alias="baseUrl")] = None
+
+    disable_api_cache: Annotated[
+        Optional[bool], pydantic.Field(alias="disableApiCache")
+    ] = None
+
+    headers: Optional[SystemSettingsConfHeaders] = 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
+
+    scripts: Optional[bool] = None
+
+    sensitive_fields: Annotated[
+        Optional[List[str]], pydantic.Field(alias="sensitiveFields")
+    ] = None
+
+    sso_rate_limit: Annotated[Optional[str], pydantic.Field(alias="ssoRateLimit")] = (
+        None
+    )
+
+
+class SystemSettingsConfBackupsTypedDict(TypedDict):
+    backup_persistence: str
+    backups_directory: str
+
+
+class SystemSettingsConfBackups(BaseModel):
+    backup_persistence: Annotated[str, pydantic.Field(alias="backupPersistence")]
+
+    backups_directory: Annotated[str, pydantic.Field(alias="backupsDirectory")]
+
+
+class SystemSettingsConfCustomLogoTypedDict(TypedDict):
+    enabled: bool
+    logo_description: str
+    logo_image: str
+
+
+class SystemSettingsConfCustomLogo(BaseModel):
+    enabled: bool
+
+    logo_description: Annotated[str, pydantic.Field(alias="logoDescription")]
+
+    logo_image: Annotated[str, pydantic.Field(alias="logoImage")]
+
+
+class SystemSettingsConfPiiTypedDict(TypedDict):
+    enable_pii_detection: bool
+
+
+class SystemSettingsConfPii(BaseModel):
+    enable_pii_detection: Annotated[bool, pydantic.Field(alias="enablePiiDetection")]
+
+
+class SystemSettingsConfProxyTypedDict(TypedDict):
+    use_env_vars: bool
+
+
+class SystemSettingsConfProxy(BaseModel):
+    use_env_vars: Annotated[bool, pydantic.Field(alias="useEnvVars")]
+
+
+class SystemSettingsConfRollbackTypedDict(TypedDict):
+    rollback_enabled: bool
+    rollback_retries: NotRequired[float]
+    rollback_timeout: NotRequired[float]
+
+
+class SystemSettingsConfRollback(BaseModel):
+    rollback_enabled: Annotated[bool, pydantic.Field(alias="rollbackEnabled")]
+
+    rollback_retries: Annotated[
+        Optional[float], pydantic.Field(alias="rollbackRetries")
+    ] = None
+
+    rollback_timeout: Annotated[
+        Optional[float], pydantic.Field(alias="rollbackTimeout")
+    ] = None
+
+
+class SystemSettingsConfShutdownTypedDict(TypedDict):
+    drain_timeout: float
+
+
+class SystemSettingsConfShutdown(BaseModel):
+    drain_timeout: Annotated[float, pydantic.Field(alias="drainTimeout")]
+
+
+class SystemSettingsConfSniTypedDict(TypedDict):
+    disable_sni_routing: bool
+
+
+class SystemSettingsConfSni(BaseModel):
+    disable_sni_routing: Annotated[bool, pydantic.Field(alias="disableSNIRouting")]
+
+
+class SystemSettingsConfSocketsTypedDict(TypedDict):
+    directory: NotRequired[str]
+
+
+class SystemSettingsConfSockets(BaseModel):
+    directory: Optional[str] = None
+
+
+class SystemSettingsConfUpgrade(str, Enum):
+    FALSE = "false"
+    API = "api"
+
+
+class SystemSettingsConfSystemTypedDict(TypedDict):
+    intercom: bool
+    upgrade: SystemSettingsConfUpgrade
+
+
+class SystemSettingsConfSystem(BaseModel):
+    intercom: bool
+
+    upgrade: SystemSettingsConfUpgrade
+
+
+class SystemSettingsConfTLSTypedDict(TypedDict):
+    default_cipher_list: str
+    default_ecdh_curve: str
+    max_version: str
+    min_version: str
+    reject_unauthorized: bool
+
+
+class SystemSettingsConfTLS(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")]
+
+
+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: SystemSettingsConfAPITypedDict
+    backups: SystemSettingsConfBackupsTypedDict
+    custom_logo: SystemSettingsConfCustomLogoTypedDict
+    pii: SystemSettingsConfPiiTypedDict
+    proxy: SystemSettingsConfProxyTypedDict
+    rollback: SystemSettingsConfRollbackTypedDict
+    shutdown: SystemSettingsConfShutdownTypedDict
+    sni: SystemSettingsConfSniTypedDict
+    system: SystemSettingsConfSystemTypedDict
+    tls: SystemSettingsConfTLSTypedDict
+    upgrade_group_settings: UpgradeGroupSettingsTypedDict
+    upgrade_settings: UpgradeSettingsTypedDict
+    workers: SystemSettingsConfWorkersTypedDict
+    sockets: NotRequired[SystemSettingsConfSocketsTypedDict]
+
+
+class SystemSettingsConf(BaseModel):
+    api: SystemSettingsConfAPI
+
+    backups: SystemSettingsConfBackups
+
+    custom_logo: Annotated[
+        SystemSettingsConfCustomLogo, pydantic.Field(alias="customLogo")
+    ]
+
+    pii: SystemSettingsConfPii
+
+    proxy: SystemSettingsConfProxy
+
+    rollback: SystemSettingsConfRollback
+
+    shutdown: SystemSettingsConfShutdown
+
+    sni: SystemSettingsConfSni
+
+    system: SystemSettingsConfSystem
+
+    tls: SystemSettingsConfTLS
+
+    upgrade_group_settings: Annotated[
+        UpgradeGroupSettings, pydantic.Field(alias="upgradeGroupSettings")
+    ]
+
+    upgrade_settings: Annotated[
+        UpgradeSettings, pydantic.Field(alias="upgradeSettings")
+    ]
+
+    workers: SystemSettingsConfWorkers
+
+    sockets: Optional[SystemSettingsConfSockets] = None

cribl_control_plane/models/updatesystemsettingsauthop.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .authconfig import AuthConfig, AuthConfigTypedDict
+from cribl_control_plane.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class UpdateSystemSettingsAuthResponseTypedDict(TypedDict):
+    r"""a list of AuthConfig objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[AuthConfigTypedDict]]
+
+
+class UpdateSystemSettingsAuthResponse(BaseModel):
+    r"""a list of AuthConfig objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[AuthConfig]] = None

cribl_control_plane/models/updatesystemsettingsconfop.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .systemsettings import SystemSettings, SystemSettingsTypedDict
+from cribl_control_plane.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class UpdateSystemSettingsConfResponseTypedDict(TypedDict):
+    r"""a list of SystemSettings objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[SystemSettingsTypedDict]]
+
+
+class UpdateSystemSettingsConfResponse(BaseModel):
+    r"""a list of SystemSettings objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[SystemSettings]] = None

cribl_control_plane/models/updatesystemsettingsgitsettingsop.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .gitsettings import GitSettings, GitSettingsTypedDict
+from cribl_control_plane.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class UpdateSystemSettingsGitSettingsResponseTypedDict(TypedDict):
+    r"""a list of GitSettings objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[GitSettingsTypedDict]]
+
+
+class UpdateSystemSettingsGitSettingsResponse(BaseModel):
+    r"""a list of GitSettings objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[GitSettings]] = None

cribl_control_plane/models/upgradegroupsettings.py

@@ -0,0 +1,24 @@
+"""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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UpgradeGroupSettingsTypedDict(TypedDict):
+    is_rolling: NotRequired[bool]
+    quantity: NotRequired[float]
+    retry_count: NotRequired[float]
+    retry_delay: NotRequired[float]
+
+
+class UpgradeGroupSettings(BaseModel):
+    is_rolling: Annotated[Optional[bool], pydantic.Field(alias="isRolling")] = None
+
+    quantity: Optional[float] = None
+
+    retry_count: Annotated[Optional[float], pydantic.Field(alias="retryCount")] = None
+
+    retry_delay: Annotated[Optional[float], pydantic.Field(alias="retryDelay")] = None

cribl_control_plane/models/upgradepackageurls.py

@@ -0,0 +1,20 @@
+"""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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UpgradePackageUrlsTypedDict(TypedDict):
+    package_url: str
+    package_hash_url: NotRequired[str]
+
+
+class UpgradePackageUrls(BaseModel):
+    package_url: Annotated[str, pydantic.Field(alias="packageUrl")]
+
+    package_hash_url: Annotated[
+        Optional[str], pydantic.Field(alias="packageHashUrl")
+    ] = None

cribl_control_plane/models/upgradesettings.py

@@ -0,0 +1,36 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .upgradepackageurls import UpgradePackageUrls, UpgradePackageUrlsTypedDict
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UpgradeSettingsTypedDict(TypedDict):
+    disable_automatic_upgrade: bool
+    enable_legacy_edge_upgrade: bool
+    upgrade_source: str
+    automatic_upgrade_check_period: NotRequired[str]
+    package_urls: NotRequired[List[UpgradePackageUrlsTypedDict]]
+
+
+class UpgradeSettings(BaseModel):
+    disable_automatic_upgrade: Annotated[
+        bool, pydantic.Field(alias="disableAutomaticUpgrade")
+    ]
+
+    enable_legacy_edge_upgrade: Annotated[
+        bool, pydantic.Field(alias="enableLegacyEdgeUpgrade")
+    ]
+
+    upgrade_source: Annotated[str, pydantic.Field(alias="upgradeSource")]
+
+    automatic_upgrade_check_period: Annotated[
+        Optional[str], pydantic.Field(alias="automaticUpgradeCheckPeriod")
+    ] = None
+
+    package_urls: Annotated[
+        Optional[List[UpgradePackageUrls]], pydantic.Field(alias="packageUrls")
+    ] = None

cribl_control_plane/packs.py

@@ -622,6 +622,180 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def get(
+        self,
+        *,
+        id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetPacksByIDResponse:
+        r"""Get a Pack
+
+        Get the specified Pack.
+
+        :param id: The <code>id</code> of the Pack to get.
+        :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.GetPacksByIDRequest(
+            id=id,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/packs/{id}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            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="getPacksById",
+                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.GetPacksByIDResponse, 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 get_async(
+        self,
+        *,
+        id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetPacksByIDResponse:
+        r"""Get a Pack
+
+        Get the specified Pack.
+
+        :param id: The <code>id</code> of the Pack to get.
+        :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.GetPacksByIDRequest(
+            id=id,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/packs/{id}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            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="getPacksById",
+                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.GetPacksByIDResponse, 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 update(
         self,
         *,

cribl_control_plane/sdk.py

@@ -24,6 +24,7 @@ if TYPE_CHECKING:
     from cribl_control_plane.pipelines import Pipelines
     from cribl_control_plane.routes_sdk import RoutesSDK
     from cribl_control_plane.sources import Sources
+    from cribl_control_plane.system_sdk import SystemSDK
     from cribl_control_plane.versions import Versions
 
 
@@ -45,6 +46,7 @@ class CriblControlPlane(BaseSDK):
     r"""Actions related to REST server health"""
     packs: "Packs"
     r"""Actions related to Packs"""
+    system: "SystemSDK"
     versions: "Versions"
     groups: "GroupsSDK"
     r"""Actions related to Groups"""
@@ -58,6 +60,7 @@ class CriblControlPlane(BaseSDK):
         "nodes": ("cribl_control_plane.nodes", "Nodes"),
         "health": ("cribl_control_plane.health", "Health"),
         "packs": ("cribl_control_plane.packs", "Packs"),
+        "system": ("cribl_control_plane.system_sdk", "SystemSDK"),
         "versions": ("cribl_control_plane.versions", "Versions"),
         "groups": ("cribl_control_plane.groups_sdk", "GroupsSDK"),
     }

cribl_control_plane/settings.py

@@ -0,0 +1,23 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from .sdkconfiguration import SDKConfiguration
+from cribl_control_plane.cribl import Cribl
+from cribl_control_plane.settings_auth import SettingsAuth
+from cribl_control_plane.settings_git import SettingsGit
+
+
+class Settings(BaseSDK):
+    auth: SettingsAuth
+    cribl: Cribl
+    git: SettingsGit
+
+    def __init__(self, sdk_config: SDKConfiguration) -> None:
+        BaseSDK.__init__(self, sdk_config)
+        self.sdk_configuration = sdk_config
+        self._init_sdks()
+
+    def _init_sdks(self):
+        self.auth = SettingsAuth(self.sdk_configuration)
+        self.cribl = Cribl(self.sdk_configuration)
+        self.git = SettingsGit(self.sdk_configuration)