cribl-control-plane 0.0.31__py3-none-any.whl → 0.0.33__py3-none-any.whl

cribl_control_plane/models/updateinputhectokenbyidandtokenop.py

@@ -10,9 +10,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class UpdateInputHecTokenByIDAndTokenRequestTypedDict(TypedDict):
     id: str
-    r"""HEC Source id"""
+    r"""The <code>id</code> of the Splunk HEC Source."""
     token: str
-    r"""token to update"""
+    r"""The <code>id</code> of the HEC token to update."""
     update_hec_token_request: UpdateHecTokenRequestTypedDict
     r"""UpdateHecTokenRequest object"""
 
@@ -21,12 +21,12 @@ class UpdateInputHecTokenByIDAndTokenRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""HEC Source id"""
+    r"""The <code>id</code> of the Splunk HEC Source."""
 
     token: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""token to update"""
+    r"""The <code>id</code> of the HEC token to update."""
 
     update_hec_token_request: Annotated[
         UpdateHecTokenRequest,

cribl_control_plane/models/updateoutputbyidop.py

@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class UpdateOutputByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to PATCH"""
+    r"""The <code>id</code> of the Destination to update."""
     output: OutputTypedDict
     r"""Output object"""
 
@@ -19,7 +19,7 @@ class UpdateOutputByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to PATCH"""
+    r"""The <code>id</code> of the Destination to update."""
 
     output: Annotated[
         Output, FieldMetadata(request=RequestMetadata(media_type="application/json"))

cribl_control_plane/models/updatepacksbyidop.py

@@ -14,7 +14,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class UpdatePacksByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Pack name"""
+    r"""The <code>id</code> of the Pack to upgrade."""
     source: NotRequired[str]
     r"""body string required Pack source"""
     minor: NotRequired[str]
@@ -27,7 +27,7 @@ class UpdatePacksByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Pack name"""
+    r"""The <code>id</code> of the Pack to upgrade."""
 
     source: Annotated[
         Optional[str],

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/nodes.py

@@ -26,26 +26,26 @@ class Nodes(BaseSDK):
         self,
         *,
         filter_exp: Optional[str] = None,
-        sort: Optional[str] = None,
         sort_exp: Optional[str] = None,
+        filter_: Optional[str] = None,
+        sort: Optional[str] = None,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
-        filter_: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.ListMasterWorkerEntryResponse:
-        r"""Retrieve detailed metadata for Worker and Edge Nodes
+        r"""Get detailed metadata for Worker and Edge Nodes
 
-        get worker and edge nodes
+        Get detailed metadata for Worker and Edge Nodes.
 
-        :param filter_exp: Filter expression evaluated against nodes
-        :param sort: Sorting object (JSON stringified) expression evaluated against nodes
-        :param sort_exp: Sorting expression evaluated against nodes
-        :param limit: Maximum number of nodes to return
-        :param offset: Pagination offset
-        :param filter_: Filter object (JSON stringified) to select nodes
+        :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
+        :param sort_exp: Sorting expression to evaluate against Nodes to specify the sort order for the response.
+        :param filter_: JSON-stringified filter object to evaluate against Nodes for inclusion in the response.
+        :param sort: JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response.
+        :param limit: Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.
+        :param offset: Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches.
         :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
@@ -63,11 +63,11 @@ class Nodes(BaseSDK):
 
         request = models.ListMasterWorkerEntryRequest(
             filter_exp=filter_exp,
-            sort=sort,
             sort_exp=sort_exp,
+            filter_=filter_,
+            sort=sort,
             limit=limit,
             offset=offset,
-            filter_=filter_,
         )
 
         req = self._build_request(
@@ -130,26 +130,26 @@ class Nodes(BaseSDK):
         self,
         *,
         filter_exp: Optional[str] = None,
-        sort: Optional[str] = None,
         sort_exp: Optional[str] = None,
+        filter_: Optional[str] = None,
+        sort: Optional[str] = None,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
-        filter_: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.ListMasterWorkerEntryResponse:
-        r"""Retrieve detailed metadata for Worker and Edge Nodes
+        r"""Get detailed metadata for Worker and Edge Nodes
 
-        get worker and edge nodes
+        Get detailed metadata for Worker and Edge Nodes.
 
-        :param filter_exp: Filter expression evaluated against nodes
-        :param sort: Sorting object (JSON stringified) expression evaluated against nodes
-        :param sort_exp: Sorting expression evaluated against nodes
-        :param limit: Maximum number of nodes to return
-        :param offset: Pagination offset
-        :param filter_: Filter object (JSON stringified) to select nodes
+        :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
+        :param sort_exp: Sorting expression to evaluate against Nodes to specify the sort order for the response.
+        :param filter_: JSON-stringified filter object to evaluate against Nodes for inclusion in the response.
+        :param sort: JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response.
+        :param limit: Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.
+        :param offset: Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches.
         :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
@@ -167,11 +167,11 @@ class Nodes(BaseSDK):
 
         request = models.ListMasterWorkerEntryRequest(
             filter_exp=filter_exp,
-            sort=sort,
             sort_exp=sort_exp,
+            filter_=filter_,
+            sort=sort,
             limit=limit,
             offset=offset,
-            filter_=filter_,
         )
 
         req = self._build_request_async(
@@ -239,11 +239,11 @@ class Nodes(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetMasterWorkerEntryResponse:
-        r"""Retrieve a count of Worker and Edge Nodes
+        r"""Get a count of Worker and Edge Nodes
 
-        get worker and edge nodes count
+        Get a count of all Worker and Edge Nodes.
 
-        :param filter_exp: Filter expression evaluated against nodes
+        :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
         :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
@@ -328,11 +328,11 @@ class Nodes(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetMasterWorkerEntryResponse:
-        r"""Retrieve a count of Worker and Edge Nodes
+        r"""Get a count of Worker and Edge Nodes
 
-        get worker and edge nodes count
+        Get a count of all Worker and Edge Nodes.
 
-        :param filter_exp: Filter expression evaluated against nodes
+        :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
         :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

cribl_control_plane/packs.py

@@ -38,7 +38,7 @@ class Packs(BaseSDK):
     ) -> models.CreatePacksResponse:
         r"""Install a Pack
 
-        Install Pack
+        Install a Pack.
 
         :param id:
         :param source:
@@ -169,7 +169,7 @@ class Packs(BaseSDK):
     ) -> models.CreatePacksResponse:
         r"""Install a Pack
 
-        Install Pack
+        Install a Pack.
 
         :param id:
         :param source:
@@ -285,9 +285,9 @@ class Packs(BaseSDK):
     ) -> models.GetPacksResponse:
         r"""List all Packs
 
-        Get info on packs
+        Get a list of all Packs.
 
-        :param with_: Comma separated list of entities, \"outputs\", \"inputs\"
+        :param with_: Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>.
         :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
@@ -372,9 +372,9 @@ class Packs(BaseSDK):
     ) -> models.GetPacksResponse:
         r"""List all Packs
 
-        Get info on packs
+        Get a list of all Packs.
 
-        :param with_: Comma separated list of entities, \"outputs\", \"inputs\"
+        :param with_: Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>.
         :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
@@ -459,9 +459,9 @@ class Packs(BaseSDK):
     ) -> models.DeletePacksByIDResponse:
         r"""Uninstall a Pack
 
-        Uninstall Pack from the system
+        Uninstall the specified Pack.
 
-        :param id: Pack name
+        :param id: The <code>id</code> of the Pack to uninstall.
         :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
@@ -546,9 +546,9 @@ class Packs(BaseSDK):
     ) -> models.DeletePacksByIDResponse:
         r"""Uninstall a Pack
 
-        Uninstall Pack from the system
+        Uninstall the specified Pack.
 
-        :param id: Pack name
+        :param id: The <code>id</code> of the Pack to uninstall.
         :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
@@ -634,11 +634,11 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdatePacksByIDResponse:
-        r"""Update a Pack
+        r"""Upgrade a Pack
 
-        Upgrade Pack
+        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
-        :param id: Pack name
+        :param id: The <code>id</code> of the Pack to upgrade.
         :param source: body string required Pack source
         :param minor: body boolean optional Only upgrade to minor/patch versions
         :param spec: body string optional Specify a branch, tag or a semver spec
@@ -730,11 +730,11 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdatePacksByIDResponse:
-        r"""Update a Pack
+        r"""Upgrade a Pack
 
-        Upgrade Pack
+        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
-        :param id: Pack name
+        :param id: The <code>id</code> of the Pack to upgrade.
         :param source: body string required Pack source
         :param minor: body boolean optional Only upgrade to minor/patch versions
         :param spec: body string optional Specify a branch, tag or a semver spec

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)