groundx 2.0.11__py3-none-any.whl

groundx/types/bucket_list_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .bucket_detail import BucketDetail
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class BucketListResponse(UniversalBaseModel):
+    buckets: typing.Optional[typing.List[BucketDetail]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/bucket_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .bucket_detail import BucketDetail
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class BucketResponse(UniversalBaseModel):
+    bucket: BucketDetail
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/bucket_update_detail.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class BucketUpdateDetail(UniversalBaseModel):
+    bucket_id: typing_extensions.Annotated[int, FieldMetadata(alias="bucketId")]
+    name: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/bucket_update_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .bucket_update_detail import BucketUpdateDetail
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class BucketUpdateResponse(UniversalBaseModel):
+    bucket: BucketUpdateDetail
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/customer_detail.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .subscription_detail import SubscriptionDetail
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CustomerDetail(UniversalBaseModel):
+    """
+    Account information for the user
+    """
+
+    email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Email associated with the account
+    """
+
+    first: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Given name associated with the account, if known
+    """
+
+    last: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Family name associated with the account, if known
+    """
+
+    subscription: typing.Optional[SubscriptionDetail] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/customer_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .customer_detail import CustomerDetail
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class CustomerResponse(UniversalBaseModel):
+    customer: CustomerDetail
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/document_detail.py

@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from ..core.serialization import FieldMetadata
+import pydantic
+from .document_type import DocumentType
+from .processing_status import ProcessingStatus
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class DocumentDetail(UniversalBaseModel):
+    bucket_id: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="bucketId")] = None
+    document_id: typing_extensions.Annotated[str, FieldMetadata(alias="documentId")] = pydantic.Field()
+    """
+    Unique system generated ID for the document
+    """
+
+    file_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fileName")] = None
+    file_size: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fileSize")] = pydantic.Field(
+        default=None
+    )
+    """
+    The file size of the file stored in GroundX
+    """
+
+    file_type: typing_extensions.Annotated[typing.Optional[DocumentType], FieldMetadata(alias="fileType")] = None
+    process_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="processId")] = pydantic.Field(
+        default=None
+    )
+    """
+    Unique system generated ID for the ingest request
+    """
+
+    search_data: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="searchData")
+    ] = None
+    source_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="sourceUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    Source document URL
+    """
+
+    status: typing.Optional[ProcessingStatus] = None
+    status_message: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="statusMessage")] = None
+    xray_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="xrayUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    Document X-Ray results
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/document_list_response.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .document_detail import DocumentDetail
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class DocumentListResponse(UniversalBaseModel):
+    documents: typing.Optional[typing.List[DocumentDetail]] = None
+    next_token: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="nextToken")] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/document_lookup_response.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .document_detail import DocumentDetail
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class DocumentLookupResponse(UniversalBaseModel):
+    count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The number of results returned in the current response
+    """
+
+    documents: typing.Optional[typing.List[DocumentDetail]] = None
+    next_token: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="nextToken")] = None
+    total: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The total number of results found
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/document_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .document_detail import DocumentDetail
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class DocumentResponse(UniversalBaseModel):
+    document: typing.Optional[DocumentDetail] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/document_type.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DocumentType = typing.Union[
+    typing.Literal["txt", "docx", "pptx", "xlsx", "pdf", "png", "jpg", "csv", "tsv", "json"], typing.Any
+]

groundx/types/group_detail.py

@@ -0,0 +1,52 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .bucket_detail import BucketDetail
+import pydantic
+import datetime as dt
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GroupDetail(UniversalBaseModel):
+    buckets: typing.Optional[typing.List[BucketDetail]] = pydantic.Field(default=None)
+    """
+    The content buckets associated with the group
+    """
+
+    created: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The data time when the group was created, in RFC3339 format
+    """
+
+    file_count: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="fileCount")] = pydantic.Field(
+        default=None
+    )
+    """
+    The number of files contained in the content buckets associated with the group
+    """
+
+    file_size: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fileSize")] = pydantic.Field(
+        default=None
+    )
+    """
+    The total file size of files contained in the content buckets associated with the group
+    """
+
+    group_id: typing_extensions.Annotated[int, FieldMetadata(alias="groupId")]
+    name: typing.Optional[str] = None
+    updated: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The data time when the group was last updated, in RFC3339 format
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/group_list_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .group_detail import GroupDetail
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GroupListResponse(UniversalBaseModel):
+    groups: typing.Optional[typing.List[GroupDetail]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/group_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .group_detail import GroupDetail
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class GroupResponse(UniversalBaseModel):
+    group: GroupDetail
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/health_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .health_response_health import HealthResponseHealth
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class HealthResponse(UniversalBaseModel):
+    health: HealthResponseHealth
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/health_response_health.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .health_service import HealthService
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class HealthResponseHealth(UniversalBaseModel):
+    services: typing.List[HealthService]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/health_service.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import datetime as dt
+from ..core.serialization import FieldMetadata
+import pydantic
+from .health_service_status import HealthServiceStatus
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class HealthService(UniversalBaseModel):
+    last_update: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="lastUpdate")] = pydantic.Field()
+    """
+    The data time when the service status was last updated, in RFC3339 format
+    """
+
+    service: str = pydantic.Field()
+    """
+    The name of the service
+    """
+
+    status: HealthServiceStatus = pydantic.Field()
+    """
+    The health status of the service
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/health_service_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+HealthServiceStatus = typing.Union[typing.Literal["healthy", "degraded", "down", "unknown"], typing.Any]

groundx/types/ingest_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .ingest_response_ingest import IngestResponseIngest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class IngestResponse(UniversalBaseModel):
+    ingest: IngestResponseIngest
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/ingest_response_ingest.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from .processing_status import ProcessingStatus
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class IngestResponseIngest(UniversalBaseModel):
+    process_id: typing_extensions.Annotated[str, FieldMetadata(alias="processId")]
+    status: ProcessingStatus
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/message_response.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class MessageResponse(UniversalBaseModel):
+    message: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/meter_detail.py

@@ -0,0 +1,40 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class MeterDetail(UniversalBaseModel):
+    """
+    Current usage and limits for the user for the given metric
+    """
+
+    max: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Maximum limit for the current billing period
+    """
+
+    meter_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="meterId")] = pydantic.Field(
+        default=None
+    )
+    """
+    Unique system generated ID for the meteric
+    """
+
+    value: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Current usage for the current billing period
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/process_status_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .process_status_response_ingest import ProcessStatusResponseIngest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class ProcessStatusResponse(UniversalBaseModel):
+    ingest: ProcessStatusResponseIngest
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/process_status_response_ingest.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import typing
+from .process_status_response_ingest_progress import ProcessStatusResponseIngestProgress
+from .processing_status import ProcessingStatus
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ProcessStatusResponseIngest(UniversalBaseModel):
+    process_id: typing_extensions.Annotated[str, FieldMetadata(alias="processId")]
+    progress: typing.Optional[ProcessStatusResponseIngestProgress] = None
+    status: ProcessingStatus
+    status_message: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="statusMessage")] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/process_status_response_ingest_progress.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .process_status_response_ingest_progress_cancelled import ProcessStatusResponseIngestProgressCancelled
+from .process_status_response_ingest_progress_complete import ProcessStatusResponseIngestProgressComplete
+from .process_status_response_ingest_progress_errors import ProcessStatusResponseIngestProgressErrors
+from .process_status_response_ingest_progress_processing import ProcessStatusResponseIngestProgressProcessing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ProcessStatusResponseIngestProgress(UniversalBaseModel):
+    cancelled: typing.Optional[ProcessStatusResponseIngestProgressCancelled] = None
+    complete: typing.Optional[ProcessStatusResponseIngestProgressComplete] = None
+    errors: typing.Optional[ProcessStatusResponseIngestProgressErrors] = None
+    processing: typing.Optional[ProcessStatusResponseIngestProgressProcessing] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow