cribl-control-plane 0.0.21__py3-none-any.whl → 0.4.0b23__py3-none-any.whl

cribl_control_plane/models/getoutputbyidop.py

@@ -1,37 +1,18 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .output import Output, OutputTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class GetOutputByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to GET"""
+    r"""The <code>id</code> of the Destination to get."""
 
 
 class GetOutputByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to GET"""
-
-
-class GetOutputByIDResponseTypedDict(TypedDict):
-    r"""a list of Destination objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[OutputTypedDict]]
-
-
-class GetOutputByIDResponse(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
+    r"""The <code>id</code> of the Destination to get."""

cribl_control_plane/models/getoutputpqbyidop.py

@@ -3,34 +3,16 @@
 from __future__ import annotations
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata
-from typing import Any, Dict, List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class GetOutputPqByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to get PQ job information for."""
 
 
 class GetOutputPqByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Destination Id"""
-
-
-class GetOutputPqByIDResponseTypedDict(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 GetOutputPqByIDResponse(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
+    r"""The <code>id</code> of the Destination to get PQ job information for."""

cribl_control_plane/models/getoutputsamplesbyidop.py

@@ -1,37 +1,18 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .outputsamplesresponse import OutputSamplesResponse, OutputSamplesResponseTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class GetOutputSamplesByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to get sample event data for."""
 
 
 class GetOutputSamplesByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Destination Id"""
-
-
-class GetOutputSamplesByIDResponseTypedDict(TypedDict):
-    r"""a list of OutputSamplesResponse objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[OutputSamplesResponseTypedDict]]
-
-
-class GetOutputSamplesByIDResponse(BaseModel):
-    r"""a list of OutputSamplesResponse objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[OutputSamplesResponse]] = None
+    r"""The <code>id</code> of the Destination to get sample event data for."""

cribl_control_plane/models/getpacksbyidop.py

@@ -0,0 +1,18 @@
+"""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, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class GetPacksByIDRequestTypedDict(TypedDict):
+    id: str
+    r"""The <code>id</code> of the Pack to get."""
+
+
+class GetPacksByIDRequest(BaseModel):
+    id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""The <code>id</code> of the Pack to get."""

cribl_control_plane/models/getpacksop.py

@@ -1,17 +1,16 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .packinfo import PackInfo, PackInfoTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
 import pydantic
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class GetPacksRequestTypedDict(TypedDict):
     with_: NotRequired[str]
-    r"""Comma separated list of entities, \"outputs\", \"inputs\" """
+    r"""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>."""
 
 
 class GetPacksRequest(BaseModel):
@@ -20,21 +19,4 @@ class GetPacksRequest(BaseModel):
         pydantic.Field(alias="with"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Comma separated list of entities, \"outputs\", \"inputs\" """
-
-
-class GetPacksResponseTypedDict(TypedDict):
-    r"""a list of PackInfo objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[PackInfoTypedDict]]
-
-
-class GetPacksResponse(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
+    r"""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>."""

cribl_control_plane/models/getpipelinebyidop.py

@@ -1,37 +1,18 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .pipeline import Pipeline, PipelineTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class GetPipelineByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to GET"""
+    r"""The <code>id</code> of the Pipeline to get."""
 
 
 class GetPipelineByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to GET"""
-
-
-class GetPipelineByIDResponseTypedDict(TypedDict):
-    r"""a list of Pipeline objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[PipelineTypedDict]]
-
-
-class GetPipelineByIDResponse(BaseModel):
-    r"""a list of Pipeline objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[Pipeline]] = None
+    r"""The <code>id</code> of the Pipeline to get."""

cribl_control_plane/models/getroutesbyidop.py

@@ -1,37 +1,18 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .routes import Routes, RoutesTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata
-from typing import List, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 
 class GetRoutesByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to GET"""
+    r"""The <code>id</code> of the Routing table to get. The supported value is <code>default</code>."""
 
 
 class GetRoutesByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to GET"""
-
-
-class GetRoutesByIDResponseTypedDict(TypedDict):
-    r"""a list of Routes objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[RoutesTypedDict]]
-
-
-class GetRoutesByIDResponse(BaseModel):
-    r"""a list of Routes objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[Routes]] = None
+    r"""The <code>id</code> of the Routing table to get. The supported value is <code>default</code>."""

cribl_control_plane/models/getsummaryop.py

@@ -1,46 +1,37 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .distributedsummary import DistributedSummary, DistributedSummaryTypedDict
+from .workertypes import WorkerTypes
+from cribl_control_plane import models
 from cribl_control_plane.types import BaseModel
-from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
-from enum import Enum
-from typing import List, Optional
+from cribl_control_plane.utils import (
+    FieldMetadata,
+    QueryParamMetadata,
+    validate_open_enum,
+)
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class GetSummaryMode(str, Enum):
-    r"""product filter"""
-
-    WORKER = "worker"
-    MANAGED_EDGE = "managed-edge"
-
-
 class GetSummaryRequestTypedDict(TypedDict):
-    mode: NotRequired[GetSummaryMode]
-    r"""product filter"""
+    mode: NotRequired[WorkerTypes]
+    r"""Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>)."""
 
 
 class GetSummaryRequest(BaseModel):
     mode: Annotated[
-        Optional[GetSummaryMode],
+        Annotated[Optional[WorkerTypes], PlainValidator(validate_open_enum(False))],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""product filter"""
-
-
-class GetSummaryResponseTypedDict(TypedDict):
-    r"""a list of DistributedSummary objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[DistributedSummaryTypedDict]]
-
-
-class GetSummaryResponse(BaseModel):
-    r"""a list of DistributedSummary objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[DistributedSummary]] = None
+    r"""Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>)."""
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.WorkerTypes(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/getversioncountop.py

@@ -4,44 +4,27 @@ from __future__ import annotations
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
 import pydantic
-from typing import Any, Dict, List, Optional
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class GetVersionCountRequestTypedDict(TypedDict):
-    group: NotRequired[str]
-    r"""Group ID"""
-    id: NotRequired[str]
-    r"""Commit ID"""
+    group_id: NotRequired[str]
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the count for."""
+    commit: NotRequired[str]
+    r"""The Git commit hash to use as the starting point for the count."""
 
 
 class GetVersionCountRequest(BaseModel):
-    group: Annotated[
+    group_id: Annotated[
         Optional[str],
+        pydantic.Field(alias="groupId"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the count for."""
 
-    id: Annotated[
+    commit: Annotated[
         Optional[str],
-        pydantic.Field(alias="ID"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Commit ID"""
-
-
-class GetVersionCountResponseTypedDict(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 GetVersionCountResponse(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
+    r"""The Git commit hash to use as the starting point for the count."""

cribl_control_plane/models/getversiondiffop.py

@@ -4,19 +4,19 @@ from __future__ import annotations
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
 import pydantic
-from typing import Any, Dict, List, Optional
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class GetVersionDiffRequestTypedDict(TypedDict):
     commit: NotRequired[str]
-    r"""Commit hash (default is HEAD)"""
-    group: NotRequired[str]
-    r"""Group ID"""
+    r"""The Git commit hash to get the diff for."""
+    group_id: NotRequired[str]
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff for."""
     filename: NotRequired[str]
-    r"""Filename"""
+    r"""The relative path of the file to get the diff for."""
     diff_line_limit: NotRequired[float]
-    r"""Limit maximum lines in the diff"""
+    r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
 
 
 class GetVersionDiffRequest(BaseModel):
@@ -24,40 +24,24 @@ class GetVersionDiffRequest(BaseModel):
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Commit hash (default is HEAD)"""
+    r"""The Git commit hash to get the diff for."""
 
-    group: Annotated[
+    group_id: Annotated[
         Optional[str],
+        pydantic.Field(alias="groupId"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff for."""
 
     filename: Annotated[
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Filename"""
+    r"""The relative path of the file to get the diff for."""
 
     diff_line_limit: Annotated[
         Optional[float],
         pydantic.Field(alias="diffLineLimit"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Limit maximum lines in the diff"""
-
-
-class GetVersionDiffResponseTypedDict(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 GetVersionDiffResponse(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
+    r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""

cribl_control_plane/models/getversionfilesop.py

@@ -1,48 +1,30 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .gitfilesresponse import GitFilesResponse, GitFilesResponseTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
 import pydantic
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class GetVersionFilesRequestTypedDict(TypedDict):
-    group: NotRequired[str]
-    r"""Group ID"""
-    id: NotRequired[str]
-    r"""Commit ID"""
+    group_id: NotRequired[str]
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get file names and status for."""
+    commit: NotRequired[str]
+    r"""The Git commit hash to use as the starting point for the request."""
 
 
 class GetVersionFilesRequest(BaseModel):
-    group: Annotated[
+    group_id: Annotated[
         Optional[str],
+        pydantic.Field(alias="groupId"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get file names and status for."""
 
-    id: Annotated[
+    commit: Annotated[
         Optional[str],
-        pydantic.Field(alias="ID"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Commit ID"""
-
-
-class GetVersionFilesResponseTypedDict(TypedDict):
-    r"""a list of GitFilesResponse objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[GitFilesResponseTypedDict]]
-
-
-class GetVersionFilesResponse(BaseModel):
-    r"""a list of GitFilesResponse objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[GitFilesResponse]] = None
+    r"""The Git commit hash to use as the starting point for the request."""

cribl_control_plane/models/getversionop.py

@@ -0,0 +1,30 @@
+"""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
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetVersionRequestTypedDict(TypedDict):
+    group_id: NotRequired[str]
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the commit history for."""
+    count: NotRequired[float]
+    r"""Maximum number of commits to return in the response for this request."""
+
+
+class GetVersionRequest(BaseModel):
+    group_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="groupId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the commit history for."""
+
+    count: Annotated[
+        Optional[float],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Maximum number of commits to return in the response for this request."""

cribl_control_plane/models/getversionshowop.py

@@ -4,19 +4,19 @@ from __future__ import annotations
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
 import pydantic
-from typing import Any, Dict, List, Optional
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class GetVersionShowRequestTypedDict(TypedDict):
     commit: NotRequired[str]
-    r"""Commit hash (default is HEAD)"""
-    group: NotRequired[str]
-    r"""Group ID"""
+    r"""The Git commit hash to retrieve the diff and log message for."""
+    group_id: NotRequired[str]
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff and log message for."""
     filename: NotRequired[str]
-    r"""Filename"""
+    r"""The relative path of the file to get the diff and log message for."""
     diff_line_limit: NotRequired[float]
-    r"""Limit maximum lines in the diff"""
+    r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
 
 
 class GetVersionShowRequest(BaseModel):
@@ -24,40 +24,24 @@ class GetVersionShowRequest(BaseModel):
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Commit hash (default is HEAD)"""
+    r"""The Git commit hash to retrieve the diff and log message for."""
 
-    group: Annotated[
+    group_id: Annotated[
         Optional[str],
+        pydantic.Field(alias="groupId"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff and log message for."""
 
     filename: Annotated[
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Filename"""
+    r"""The relative path of the file to get the diff and log message for."""
 
     diff_line_limit: Annotated[
         Optional[float],
         pydantic.Field(alias="diffLineLimit"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Limit maximum lines in the diff"""
-
-
-class GetVersionShowResponseTypedDict(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 GetVersionShowResponse(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
+    r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""