samsara-api 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

samsara/types/reading_definition_response_body.py

@@ -0,0 +1,59 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .enum_value_response_body import EnumValueResponseBody
+from .reading_type_response_body import ReadingTypeResponseBody
+
+
+class ReadingDefinitionResponseBody(UniversalBaseModel):
+    """
+    Definition of a reading.
+    """
+
+    category: str = pydantic.Field()
+    """
+    The category enumeration that this reading belongs to.
+    """
+
+    description: str = pydantic.Field()
+    """
+    The human readable description for this reading. Translated to English.
+    """
+
+    entity_type: typing_extensions.Annotated[str, FieldMetadata(alias="entityType")] = pydantic.Field()
+    """
+    Entity type of this reading.
+    """
+
+    enum_values: typing_extensions.Annotated[
+        typing.Optional[typing.List[EnumValueResponseBody]], FieldMetadata(alias="enumValues")
+    ] = pydantic.Field(default=None)
+    """
+    Array of enumeration values
+    """
+
+    label: str = pydantic.Field()
+    """
+    The label for this reading that is suitable to show to a user. Translated to English.
+    """
+
+    reading_id: typing_extensions.Annotated[str, FieldMetadata(alias="readingId")] = pydantic.Field()
+    """
+    The ID of the reading used to fetch time series data in other endpoints.
+    """
+
+    type: ReadingTypeResponseBody
+
+    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

samsara/types/reading_history_response_body.py

@@ -0,0 +1,47 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class ReadingHistoryResponseBody(UniversalBaseModel):
+    """
+    A history of reading values for an entity.
+    """
+
+    entity_id: typing_extensions.Annotated[str, FieldMetadata(alias="entityId")] = pydantic.Field()
+    """
+    The ID of the entity this readings is for.
+    """
+
+    external_ids: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, str]], FieldMetadata(alias="externalIds")
+    ] = pydantic.Field(default=None)
+    """
+    A map of external ids
+    """
+
+    happened_at_time: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="happenedAtTime")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The time in RFC 3339 format when the reading was measured.
+    """
+
+    value: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    The value of the reading.
+    """
+
+    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

samsara/types/reading_snapshot_response_body.py

@@ -0,0 +1,52 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class ReadingSnapshotResponseBody(UniversalBaseModel):
+    """
+    A snapshot of a reading value at a point in time.
+    """
+
+    entity_id: typing_extensions.Annotated[str, FieldMetadata(alias="entityId")] = pydantic.Field()
+    """
+    The ID of the entity this readings is for.
+    """
+
+    external_ids: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, str]], FieldMetadata(alias="externalIds")
+    ] = pydantic.Field(default=None)
+    """
+    A map of external ids
+    """
+
+    happened_at_time: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="happenedAtTime")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The time in RFC 3339 format when the reading was measured.
+    """
+
+    reading_id: typing_extensions.Annotated[str, FieldMetadata(alias="readingId")] = pydantic.Field()
+    """
+    The ID of the reading for which the data is being returned.
+    """
+
+    value: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    The value of the reading.
+    """
+
+    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

samsara/types/reading_trigger_continuous_value_object_request_body.py

@@ -0,0 +1,51 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .reading_trigger_continuous_value_object_request_body_operation import (
+    ReadingTriggerContinuousValueObjectRequestBodyOperation,
+)
+from .reading_trigger_continuous_value_object_request_body_unit import (
+    ReadingTriggerContinuousValueObjectRequestBodyUnit,
+)
+
+
+class ReadingTriggerContinuousValueObjectRequestBody(UniversalBaseModel):
+    """
+    Threshold to alert on if reading is continuous, either enum or continuous threshold may be set.
+    """
+
+    operation: ReadingTriggerContinuousValueObjectRequestBodyOperation = pydantic.Field()
+    """
+    The operation to use when comparing the value to the threshold.  Valid values: `GREATER`, `INSIDE_RANGE`, `LESS`, `OUTSIDE_RANGE`
+    """
+
+    threshold: int = pydantic.Field()
+    """
+    The lower threshold of criticality.
+    """
+
+    unit: typing.Optional[ReadingTriggerContinuousValueObjectRequestBodyUnit] = pydantic.Field(default=None)
+    """
+    The unit of the threshold defined by reading type. If not provided base unit of the reading will be used.  Valid values: `bar`, `celsius`, `fahrenheit`, `foot`, `gallon`, `galpermi`, `gforce`, `gperliter`, `gperm`, `hour`, `impgallon`, `impgalpermi`, `inch`, `kelvin`, `kgper100kmgaseousfuel`, `kgpergallon`, `kgperkm`, `kgperliter`, `kgpermi`, `kilogram`, `kilogramgaseousfuel`, `kilometer`, `kilopascal`, `kilowatthour`, `kmperhr`, `lbpermi`, `liter`, `litergaseousfuel`, `lper100km`, `lper100kmgaseousfuel`, `lperkm`, `lperm`, `meter`, `meterspersec`, `mile`, `milliknot`, `millisecond`, `millivolt`, `mipergal`, `miperhr`, `miperimpgal`, `mpgusgalgaseousfuel`, `mpkggaseousfuel`, `percent`, `pound`, `poundsPerSquareInch`, `poundspergallon`, `poundsperliter`, `second`, `usd`, `usgallongaseousfuel`, `volt`, `watthour`
+    """
+
+    upper_threshold: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="upperThreshold")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The upper threshold of criticality. Required for RANGE operations.
+    """
+
+    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

samsara/types/reading_trigger_continuous_value_object_request_body_operation.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReadingTriggerContinuousValueObjectRequestBodyOperation = typing.Union[
+    typing.Literal["GREATER", "INSIDE_RANGE", "LESS", "OUTSIDE_RANGE"], typing.Any
+]

samsara/types/reading_trigger_continuous_value_object_request_body_unit.py

@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReadingTriggerContinuousValueObjectRequestBodyUnit = typing.Union[
+    typing.Literal[
+        "bar",
+        "celsius",
+        "fahrenheit",
+        "foot",
+        "gallon",
+        "galpermi",
+        "gforce",
+        "gperliter",
+        "gperm",
+        "hour",
+        "impgallon",
+        "impgalpermi",
+        "inch",
+        "kelvin",
+        "kgper100kmgaseousfuel",
+        "kgpergallon",
+        "kgperkm",
+        "kgperliter",
+        "kgpermi",
+        "kilogram",
+        "kilogramgaseousfuel",
+        "kilometer",
+        "kilopascal",
+        "kilowatthour",
+        "kmperhr",
+        "lbpermi",
+        "liter",
+        "litergaseousfuel",
+        "lper100km",
+        "lper100kmgaseousfuel",
+        "lperkm",
+        "lperm",
+        "meter",
+        "meterspersec",
+        "mile",
+        "milliknot",
+        "millisecond",
+        "millivolt",
+        "mipergal",
+        "miperhr",
+        "miperimpgal",
+        "mpgusgalgaseousfuel",
+        "mpkggaseousfuel",
+        "percent",
+        "pound",
+        "poundsPerSquareInch",
+        "poundspergallon",
+        "poundsperliter",
+        "second",
+        "usd",
+        "usgallongaseousfuel",
+        "volt",
+        "watthour",
+    ],
+    typing.Any,
+]

samsara/types/reading_trigger_continuous_value_object_response_body.py

@@ -0,0 +1,51 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .reading_trigger_continuous_value_object_response_body_operation import (
+    ReadingTriggerContinuousValueObjectResponseBodyOperation,
+)
+from .reading_trigger_continuous_value_object_response_body_unit import (
+    ReadingTriggerContinuousValueObjectResponseBodyUnit,
+)
+
+
+class ReadingTriggerContinuousValueObjectResponseBody(UniversalBaseModel):
+    """
+    Threshold to alert on if reading is continuous, either enum or continuous threshold may be set.
+    """
+
+    operation: ReadingTriggerContinuousValueObjectResponseBodyOperation = pydantic.Field()
+    """
+    The operation to use when comparing the value to the threshold.  Valid values: `GREATER`, `INSIDE_RANGE`, `LESS`, `OUTSIDE_RANGE`
+    """
+
+    threshold: int = pydantic.Field()
+    """
+    The lower threshold of criticality.
+    """
+
+    unit: typing.Optional[ReadingTriggerContinuousValueObjectResponseBodyUnit] = pydantic.Field(default=None)
+    """
+    The unit of the threshold defined by reading type. If not provided base unit of the reading will be used.  Valid values: `bar`, `celsius`, `fahrenheit`, `foot`, `gallon`, `galpermi`, `gforce`, `gperliter`, `gperm`, `hour`, `impgallon`, `impgalpermi`, `inch`, `kelvin`, `kgper100kmgaseousfuel`, `kgpergallon`, `kgperkm`, `kgperliter`, `kgpermi`, `kilogram`, `kilogramgaseousfuel`, `kilometer`, `kilopascal`, `kilowatthour`, `kmperhr`, `lbpermi`, `liter`, `litergaseousfuel`, `lper100km`, `lper100kmgaseousfuel`, `lperkm`, `lperm`, `meter`, `meterspersec`, `mile`, `milliknot`, `millisecond`, `millivolt`, `mipergal`, `miperhr`, `miperimpgal`, `mpgusgalgaseousfuel`, `mpkggaseousfuel`, `percent`, `pound`, `poundsPerSquareInch`, `poundspergallon`, `poundsperliter`, `second`, `usd`, `usgallongaseousfuel`, `volt`, `watthour`
+    """
+
+    upper_threshold: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="upperThreshold")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The upper threshold of criticality. Required for RANGE operations.
+    """
+
+    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

samsara/types/reading_trigger_continuous_value_object_response_body_operation.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReadingTriggerContinuousValueObjectResponseBodyOperation = typing.Union[
+    typing.Literal["GREATER", "INSIDE_RANGE", "LESS", "OUTSIDE_RANGE"], typing.Any
+]

samsara/types/reading_trigger_continuous_value_object_response_body_unit.py

@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReadingTriggerContinuousValueObjectResponseBodyUnit = typing.Union[
+    typing.Literal[
+        "bar",
+        "celsius",
+        "fahrenheit",
+        "foot",
+        "gallon",
+        "galpermi",
+        "gforce",
+        "gperliter",
+        "gperm",
+        "hour",
+        "impgallon",
+        "impgalpermi",
+        "inch",
+        "kelvin",
+        "kgper100kmgaseousfuel",
+        "kgpergallon",
+        "kgperkm",
+        "kgperliter",
+        "kgpermi",
+        "kilogram",
+        "kilogramgaseousfuel",
+        "kilometer",
+        "kilopascal",
+        "kilowatthour",
+        "kmperhr",
+        "lbpermi",
+        "liter",
+        "litergaseousfuel",
+        "lper100km",
+        "lper100kmgaseousfuel",
+        "lperkm",
+        "lperm",
+        "meter",
+        "meterspersec",
+        "mile",
+        "milliknot",
+        "millisecond",
+        "millivolt",
+        "mipergal",
+        "miperhr",
+        "miperimpgal",
+        "mpgusgalgaseousfuel",
+        "mpkggaseousfuel",
+        "percent",
+        "pound",
+        "poundsPerSquareInch",
+        "poundspergallon",
+        "poundsperliter",
+        "second",
+        "usd",
+        "usgallongaseousfuel",
+        "volt",
+        "watthour",
+    ],
+    typing.Any,
+]

samsara/types/reading_trigger_details_object_request_body.py

@@ -0,0 +1,48 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .reading_trigger_continuous_value_object_request_body import ReadingTriggerContinuousValueObjectRequestBody
+from .reading_trigger_enum_value_object_request_body import ReadingTriggerEnumValueObjectRequestBody
+
+
+class ReadingTriggerDetailsObjectRequestBody(UniversalBaseModel):
+    """
+    Details specific to reading based Trigger, readings can be discovered through the Readings API.
+    """
+
+    continuous_threshold: typing_extensions.Annotated[
+        typing.Optional[ReadingTriggerContinuousValueObjectRequestBody], FieldMetadata(alias="continuousThreshold")
+    ] = None
+    entity_type: typing_extensions.Annotated[str, FieldMetadata(alias="entityType")] = pydantic.Field()
+    """
+    The type of the entity associated with the reading.
+    """
+
+    enum_threshold: typing_extensions.Annotated[
+        typing.Optional[ReadingTriggerEnumValueObjectRequestBody], FieldMetadata(alias="enumThreshold")
+    ] = None
+    id: str = pydantic.Field()
+    """
+    The ID of the reading.
+    """
+
+    min_duration_milliseconds: typing_extensions.Annotated[int, FieldMetadata(alias="minDurationMilliseconds")] = (
+        pydantic.Field()
+    )
+    """
+    The number of milliseconds the trigger needs to stay active before alerting.
+    """
+
+    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

samsara/types/reading_trigger_details_object_response_body.py

@@ -0,0 +1,48 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .reading_trigger_continuous_value_object_response_body import ReadingTriggerContinuousValueObjectResponseBody
+from .reading_trigger_enum_value_object_response_body import ReadingTriggerEnumValueObjectResponseBody
+
+
+class ReadingTriggerDetailsObjectResponseBody(UniversalBaseModel):
+    """
+    Details specific to reading based Trigger, readings can be discovered through the Readings API.
+    """
+
+    continuous_threshold: typing_extensions.Annotated[
+        typing.Optional[ReadingTriggerContinuousValueObjectResponseBody], FieldMetadata(alias="continuousThreshold")
+    ] = None
+    entity_type: typing_extensions.Annotated[str, FieldMetadata(alias="entityType")] = pydantic.Field()
+    """
+    The type of the entity associated with the reading.
+    """
+
+    enum_threshold: typing_extensions.Annotated[
+        typing.Optional[ReadingTriggerEnumValueObjectResponseBody], FieldMetadata(alias="enumThreshold")
+    ] = None
+    id: str = pydantic.Field()
+    """
+    The ID of the reading.
+    """
+
+    min_duration_milliseconds: typing_extensions.Annotated[int, FieldMetadata(alias="minDurationMilliseconds")] = (
+        pydantic.Field()
+    )
+    """
+    The number of milliseconds the trigger needs to stay active before alerting.
+    """
+
+    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

samsara/types/reading_trigger_details_response_body.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .alert_object_asset_response_body import AlertObjectAssetResponseBody
+from .continuous_reading_alert_threshold_response_body import ContinuousReadingAlertThresholdResponseBody
+from .enum_reading_alert_threshold_response_body import EnumReadingAlertThresholdResponseBody
+
+
+class ReadingTriggerDetailsResponseBody(UniversalBaseModel):
+    """
+    Details specific to Reading Triggers.
+    """
+
+    asset: typing.Optional[AlertObjectAssetResponseBody] = None
+    continuous_threshold: typing_extensions.Annotated[
+        typing.Optional[ContinuousReadingAlertThresholdResponseBody], FieldMetadata(alias="continuousThreshold")
+    ] = None
+    enum_threshold: typing_extensions.Annotated[
+        typing.Optional[EnumReadingAlertThresholdResponseBody], FieldMetadata(alias="enumThreshold")
+    ] = None
+    id: str = pydantic.Field()
+    """
+    The ID of the reading.
+    """
+
+    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

samsara/types/reading_trigger_enum_value_object_request_body.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ReadingTriggerEnumValueObjectRequestBody(UniversalBaseModel):
+    """
+    Enum value to alert on if reading is discrete, either enum or continuous threshold may be set.
+    """
+
+    number: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The numeric representation of the enum value.
+    """
+
+    symbol: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The symbol representation of the enum value.
+    """
+
+    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

samsara/types/reading_trigger_enum_value_object_response_body.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ReadingTriggerEnumValueObjectResponseBody(UniversalBaseModel):
+    """
+    Enum value to alert on if reading is discrete, either enum or continuous threshold may be set.
+    """
+
+    number: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The numeric representation of the enum value.
+    """
+
+    symbol: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The symbol representation of the enum value.
+    """
+
+    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

samsara/types/reading_type_response_body.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .reading_type_response_body_data_type import ReadingTypeResponseBodyDataType
+from .unit_response_body import UnitResponseBody
+
+
+class ReadingTypeResponseBody(UniversalBaseModel):
+    """
+    Type information for the reading.
+    """
+
+    data_type: typing_extensions.Annotated[ReadingTypeResponseBodyDataType, FieldMetadata(alias="dataType")] = (
+        pydantic.Field()
+    )
+    """
+    The data type of the reading.  Valid values: `integer`, `float`, `string`
+    """
+
+    unit: typing.Optional[UnitResponseBody] = 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

samsara/types/reading_type_response_body_data_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReadingTypeResponseBodyDataType = typing.Union[typing.Literal["integer", "float", "string"], typing.Any]