UncountablePythonSDK 0.0.7__py3-none-any.whl → 0.0.92__py3-none-any.whl

uncountable/types/job_definition_t.py

@@ -0,0 +1,260 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from pkgs.strenum_compat import StrEnum
+import dataclasses
+from pkgs.serialization import serial_class
+from pkgs.serialization import serial_union_annotation
+from . import auth_retrieval_t
+from . import client_config_t
+from . import generic_upload_t
+from . import identifier_t
+from . import integration_server_t
+from . import secret_retrieval_t
+
+__all__: list[str] = [
+    "CronJobDefinition",
+    "GenericUploadDataSource",
+    "GenericUploadDataSourceBase",
+    "GenericUploadDataSourceS3",
+    "GenericUploadDataSourceSFTP",
+    "GenericUploadDataSourceType",
+    "JobDefinition",
+    "JobDefinitionBase",
+    "JobDefinitionType",
+    "JobExecutor",
+    "JobExecutorBase",
+    "JobExecutorGenericUpload",
+    "JobExecutorScript",
+    "JobExecutorType",
+    "JobLoggingSettings",
+    "JobResult",
+    "ProfileDefinition",
+    "ProfileMetadata",
+    "S3CloudProvider",
+    "WebhookJobDefinition",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class JobDefinitionType(StrEnum):
+    CRON = "cron"
+    WEBHOOK = "webhook"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class JobExecutorType(StrEnum):
+    SCRIPT = "script"
+    GENERIC_UPLOAD = "generic_upload"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class GenericUploadDataSourceType(StrEnum):
+    SFTP = "sftp"
+    S3 = "s3"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.JobExecutorBase",
+)
+@dataclasses.dataclass(kw_only=True)
+class JobExecutorBase:
+    type: JobExecutorType
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.JobExecutorScript",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class JobExecutorScript(JobExecutorBase):
+    type: typing.Literal[JobExecutorType.SCRIPT] = JobExecutorType.SCRIPT
+    import_path: str
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.GenericUploadDataSourceBase",
+)
+@dataclasses.dataclass(kw_only=True)
+class GenericUploadDataSourceBase:
+    type: GenericUploadDataSourceType
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.GenericUploadDataSourceSFTP",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class GenericUploadDataSourceSFTP(GenericUploadDataSourceBase):
+    type: typing.Literal[GenericUploadDataSourceType.SFTP] = GenericUploadDataSourceType.SFTP
+    host: str
+    username: str
+    pem_secret: secret_retrieval_t.SecretRetrieval
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class S3CloudProvider(StrEnum):
+    OVH = "ovh"
+    AWS = "aws"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.GenericUploadDataSourceS3",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class GenericUploadDataSourceS3(GenericUploadDataSourceBase):
+    type: typing.Literal[GenericUploadDataSourceType.S3] = GenericUploadDataSourceType.S3
+    bucket_name: str
+    cloud_provider: S3CloudProvider | None = None
+    endpoint_url: str | None = None
+    region_name: str | None = None
+    access_key_id: str | None = None
+    access_key_secret: secret_retrieval_t.SecretRetrieval | None = None
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+GenericUploadDataSource = typing.Annotated[
+    typing.Union[GenericUploadDataSourceSFTP, GenericUploadDataSourceS3],
+    serial_union_annotation(
+    named_type_path="sdk.job_definition.GenericUploadDataSource",
+        discriminator="type",
+        discriminator_map={
+            "sftp": GenericUploadDataSourceSFTP,
+            "s3": GenericUploadDataSourceS3,
+        },
+    ),
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.JobExecutorGenericUpload",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class JobExecutorGenericUpload(JobExecutorBase):
+    type: typing.Literal[JobExecutorType.GENERIC_UPLOAD] = JobExecutorType.GENERIC_UPLOAD
+    data_source: GenericUploadDataSource
+    upload_strategy: generic_upload_t.GenericUploadStrategy
+    remote_directories: list[generic_upload_t.GenericRemoteDirectoryScope]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+JobExecutor = typing.Annotated[
+    typing.Union[JobExecutorScript, JobExecutorGenericUpload],
+    serial_union_annotation(
+    named_type_path="sdk.job_definition.JobExecutor",
+        discriminator="type",
+        discriminator_map={
+            "script": JobExecutorScript,
+            "generic_upload": JobExecutorGenericUpload,
+        },
+    ),
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.JobLoggingSettings",
+)
+@dataclasses.dataclass(kw_only=True)
+class JobLoggingSettings:
+    enabled: bool = False
+    share_with_user_groups: list[identifier_t.IdentifierKey] | None = None
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.JobDefinitionBase",
+)
+@dataclasses.dataclass(kw_only=True)
+class JobDefinitionBase:
+    id: str
+    name: str
+    executor: JobExecutor
+    enabled: bool = True
+    logging_settings: JobLoggingSettings | None = None
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.CronJobDefinition",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class CronJobDefinition(JobDefinitionBase):
+    type: typing.Literal[JobDefinitionType.CRON] = JobDefinitionType.CRON
+    cron_spec: str
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.WebhookJobDefinition",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class WebhookJobDefinition(JobDefinitionBase):
+    type: typing.Literal[JobDefinitionType.WEBHOOK] = JobDefinitionType.WEBHOOK
+    signature_key_secret: secret_retrieval_t.SecretRetrieval
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+JobDefinition = typing.Annotated[
+    typing.Union[CronJobDefinition, WebhookJobDefinition],
+    serial_union_annotation(
+    named_type_path="sdk.job_definition.JobDefinition",
+        discriminator="type",
+        discriminator_map={
+            "cron": CronJobDefinition,
+            "webhook": WebhookJobDefinition,
+        },
+    ),
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.ProfileDefinition",
+)
+@dataclasses.dataclass(kw_only=True)
+class ProfileDefinition:
+    jobs: list[JobDefinition]
+    auth_retrieval: auth_retrieval_t.AuthRetrieval | None = None
+    base_url: str | None = None
+    client_options: client_config_t.ClientConfigOptions | None = None
+    environments: dict[integration_server_t.IntegrationEnvironment, integration_server_t.EnvironmentConfig] | None = None
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.ProfileMetadata",
+)
+@dataclasses.dataclass(kw_only=True)
+class ProfileMetadata:
+    name: str
+    base_url: str
+    auth_retrieval: auth_retrieval_t.AuthRetrieval
+    client_options: typing.Optional[client_config_t.ClientConfigOptions]
+    jobs: list[JobDefinition]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.job_definition.JobResult",
+)
+@dataclasses.dataclass(kw_only=True)
+class JobResult:
+    success: bool
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/outputs.py

@@ -0,0 +1,8 @@
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+# DO NOT MODIFY -- This file is generated by type_spec
+# Kept only for SDK backwards compatibility
+from .outputs_t import SimpleOutput as SimpleOutput
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/outputs_t.py

@@ -0,0 +1,30 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+import dataclasses
+from pkgs.serialization import serial_class
+from . import base_t
+from . import units_t
+
+__all__: list[str] = [
+    "SimpleOutput",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.outputs.SimpleOutput",
+)
+@dataclasses.dataclass(kw_only=True)
+class SimpleOutput:
+    output_id: base_t.ObjectId
+    name: str
+    unit: typing.Optional[units_t.SimpleUnit]
+    quantity_type: str
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/overrides.py

@@ -0,0 +1,10 @@
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+# DO NOT MODIFY -- This file is generated by type_spec
+# Kept only for SDK backwards compatibility
+from .overrides_t import SecretRetrievalOverride as SecretRetrievalOverride
+from .overrides_t import SecretRetrievalOverrides as SecretRetrievalOverrides
+from .overrides_t import Overrides as Overrides
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/overrides_t.py

@@ -0,0 +1,49 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+import dataclasses
+from pkgs.serialization import serial_class
+from pkgs.serialization import serial_alias_annotation
+from . import secret_retrieval_t
+
+__all__: list[str] = [
+    "Overrides",
+    "SecretRetrievalOverride",
+    "SecretRetrievalOverrides",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.overrides.SecretRetrievalOverride",
+)
+@dataclasses.dataclass(kw_only=True)
+class SecretRetrievalOverride:
+    profile_name: str
+    secret_retrieval: secret_retrieval_t.SecretRetrieval
+    value: str
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+SecretRetrievalOverrides = typing.Annotated[
+    list[SecretRetrievalOverride],
+    serial_alias_annotation(
+    named_type_path="sdk.overrides.SecretRetrievalOverrides",
+    ),
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.overrides.Overrides",
+)
+@dataclasses.dataclass(kw_only=True)
+class Overrides:
+    secrets: SecretRetrievalOverrides
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/permissions.py

@@ -0,0 +1,8 @@
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+# DO NOT MODIFY -- This file is generated by type_spec
+# Kept only for SDK backwards compatibility
+from .permissions_t import CorePermissionType as CorePermissionType
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/permissions_t.py

@@ -0,0 +1,46 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from pkgs.strenum_compat import StrEnum
+from pkgs.serialization import serial_string_enum
+
+__all__: list[str] = [
+    "CorePermissionType",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_string_enum(
+    labels={
+        "admin_rights": "Admin Rights",
+        "read_ingredients": "View Ingredients",
+        "read_recipe_all": "View Entire Recipe",
+        "read_recipe_outputs": "View Recipe Outputs",
+        "view_material_family": "View Material Family",
+        "write_ingredients": "Modify Ingredients",
+        "write_outputs": "Modify Outputs",
+        "write_recipe_all": "Modify Entire Recipe",
+        "write_recipe_ingredients": "Modify Recipe Inputs",
+        "write_recipe_outputs": "Modify Recipe Outputs",
+        "add_recipe": "Create Experiments",
+    },
+)
+class CorePermissionType(StrEnum):
+    ADMIN_RIGHTS = "admin_rights"
+    READ_INGREDIENTS = "read_ingredients"
+    READ_RECIPE_ALL = "read_recipe_all"
+    READ_RECIPE_OUTPUTS = "read_recipe_outputs"
+    VIEW_MATERIAL_FAMILY = "view_material_family"
+    WRITE_INGREDIENTS = "write_ingredients"
+    WRITE_OUTPUTS = "write_outputs"
+    WRITE_RECIPE_ALL = "write_recipe_all"
+    WRITE_RECIPE_INGREDIENTS = "write_recipe_ingredients"
+    WRITE_RECIPE_OUTPUTS = "write_recipe_outputs"
+    ADD_RECIPE = "add_recipe"
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/phases.py

@@ -0,0 +1,8 @@
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+# DO NOT MODIFY -- This file is generated by type_spec
+# Kept only for SDK backwards compatibility
+from .phases_t import Phase as Phase
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/phases_t.py

@@ -0,0 +1,27 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+import dataclasses
+from pkgs.serialization import serial_class
+from . import base_t
+
+__all__: list[str] = [
+    "Phase",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.phases.Phase",
+)
+@dataclasses.dataclass(kw_only=True)
+class Phase:
+    id: base_t.ObjectId
+    name: str
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/post_base.py

@@ -0,0 +1,8 @@
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+# DO NOT MODIFY -- This file is generated by type_spec
+# Kept only for SDK backwards compatibility
+from .post_base_t import UpdateType as UpdateType
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/post_base_t.py

@@ -0,0 +1,30 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from pkgs.strenum_compat import StrEnum
+from pkgs.serialization import serial_string_enum
+
+__all__: list[str] = [
+    "UpdateType",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_string_enum(
+    labels={
+        "append": "Append values",
+        "override": "Wipe existing and replace",
+        "remove": "Remove values",
+    },
+)
+class UpdateType(StrEnum):
+    APPEND = "append"
+    OVERRIDE = "override"
+    REMOVE = "remove"
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/queued_job.py

@@ -0,0 +1,16 @@
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+# DO NOT MODIFY -- This file is generated by type_spec
+# Kept only for SDK backwards compatibility
+from .queued_job_t import InvocationContextType as InvocationContextType
+from .queued_job_t import InvocationContextBase as InvocationContextBase
+from .queued_job_t import InvocationContextCron as InvocationContextCron
+from .queued_job_t import InvocationContextManual as InvocationContextManual
+from .queued_job_t import InvocationContextWebhook as InvocationContextWebhook
+from .queued_job_t import InvocationContext as InvocationContext
+from .queued_job_t import QueuedJobPayload as QueuedJobPayload
+from .queued_job_t import QueuedJobResult as QueuedJobResult
+from .queued_job_t import QueuedJob as QueuedJob
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/queued_job_t.py

@@ -0,0 +1,123 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from pkgs.strenum_compat import StrEnum
+import dataclasses
+from pkgs.serialization import serial_class
+from pkgs.serialization import serial_union_annotation
+from . import base_t
+from . import job_definition_t
+
+__all__: list[str] = [
+    "InvocationContext",
+    "InvocationContextBase",
+    "InvocationContextCron",
+    "InvocationContextManual",
+    "InvocationContextType",
+    "InvocationContextWebhook",
+    "QueuedJob",
+    "QueuedJobPayload",
+    "QueuedJobResult",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class InvocationContextType(StrEnum):
+    CRON = "cron"
+    MANUAL = "manual"
+    WEBHOOK = "webhook"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.queued_job.InvocationContextBase",
+)
+@dataclasses.dataclass(kw_only=True)
+class InvocationContextBase:
+    type: InvocationContextType
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.queued_job.InvocationContextCron",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class InvocationContextCron(InvocationContextBase):
+    type: typing.Literal[InvocationContextType.CRON] = InvocationContextType.CRON
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.queued_job.InvocationContextManual",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class InvocationContextManual(InvocationContextBase):
+    type: typing.Literal[InvocationContextType.MANUAL] = InvocationContextType.MANUAL
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.queued_job.InvocationContextWebhook",
+    unconverted_values={"webhook_payload"},
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class InvocationContextWebhook(InvocationContextBase):
+    type: typing.Literal[InvocationContextType.WEBHOOK] = InvocationContextType.WEBHOOK
+    webhook_payload: base_t.JsonValue
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+InvocationContext = typing.Annotated[
+    typing.Union[InvocationContextCron, InvocationContextManual, InvocationContextWebhook],
+    serial_union_annotation(
+    named_type_path="sdk.queued_job.InvocationContext",
+        discriminator="type",
+        discriminator_map={
+            "cron": InvocationContextCron,
+            "manual": InvocationContextManual,
+            "webhook": InvocationContextWebhook,
+        },
+    ),
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.queued_job.QueuedJobPayload",
+)
+@dataclasses.dataclass(kw_only=True)
+class QueuedJobPayload:
+    invocation_context: InvocationContext
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.queued_job.QueuedJobResult",
+)
+@dataclasses.dataclass(kw_only=True)
+class QueuedJobResult:
+    queued_job_uuid: str
+    job_result: job_definition_t.JobResult
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.queued_job.QueuedJob",
+)
+@dataclasses.dataclass(kw_only=True)
+class QueuedJob:
+    queued_job_uuid: str
+    job_ref_name: str
+    num_attempts: int
+    submitted_at: datetime.datetime
+    payload: QueuedJobPayload
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/recipe_identifiers.py

@@ -0,0 +1,12 @@
+# flake8: noqa: F821
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+# DO NOT MODIFY -- This file is generated by type_spec
+# Kept only for SDK backwards compatibility
+from .recipe_identifiers_t import RecipeIdentifierEditableName as RecipeIdentifierEditableName
+from .recipe_identifiers_t import RecipeIdentifierMetadata as RecipeIdentifierMetadata
+from .recipe_identifiers_t import RecipeIdentifierMaterialFamily as RecipeIdentifierMaterialFamily
+from .recipe_identifiers_t import RecipeIdentifier as RecipeIdentifier
+from .recipe_identifiers_t import RecipeIdentifiers as RecipeIdentifiers
+# DO NOT MODIFY -- This file is generated by type_spec