edgeimpulse-api 1.96.4__tar.gz → 1.97.2__tar.gz

{edgeimpulse_api-1.96.4 → edgeimpulse_api-1.97.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edgeimpulse-api
-Version: 1.96.4
+Version: 1.97.2
 Summary: Python bindings for the Edge Impulse API.
 Home-page: https://edgeimpulse.com
 License: BSD-3-Clause-Clear

{edgeimpulse_api-1.96.4 → edgeimpulse_api-1.97.2}/edgeimpulse_api/__init__.py

@@ -14,7 +14,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "1.96.4" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
+__version__ = "1.97.2" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
 
 # import apis into sdk package
 from edgeimpulse_api.api.classify_api import ClassifyApi
@@ -327,6 +327,7 @@ from edgeimpulse_api.models.development_boards_response_all_of import Developmen
 from edgeimpulse_api.models.development_keys import DevelopmentKeys
 from edgeimpulse_api.models.development_keys_response import DevelopmentKeysResponse
 from edgeimpulse_api.models.device import Device
+from edgeimpulse_api.models.device_deployment_event import DeviceDeploymentEvent
 from edgeimpulse_api.models.device_inference_info import DeviceInferenceInfo
 from edgeimpulse_api.models.device_sensors_inner import DeviceSensorsInner
 from edgeimpulse_api.models.downgrade_subscription_request import DowngradeSubscriptionRequest
@@ -611,6 +612,8 @@ from edgeimpulse_api.models.list_api_keys_response import ListApiKeysResponse
 from edgeimpulse_api.models.list_api_keys_response_all_of import ListApiKeysResponseAllOf
 from edgeimpulse_api.models.list_deployment_history_response import ListDeploymentHistoryResponse
 from edgeimpulse_api.models.list_deployment_history_response_all_of import ListDeploymentHistoryResponseAllOf
+from edgeimpulse_api.models.list_device_deployment_history_response import ListDeviceDeploymentHistoryResponse
+from edgeimpulse_api.models.list_device_deployment_history_response_all_of import ListDeviceDeploymentHistoryResponseAllOf
 from edgeimpulse_api.models.list_devices_response import ListDevicesResponse
 from edgeimpulse_api.models.list_devices_response_all_of import ListDevicesResponseAllOf
 from edgeimpulse_api.models.list_email_response import ListEmailResponse

{edgeimpulse_api-1.96.4 → edgeimpulse_api-1.97.2}/edgeimpulse_api/api/devices_api.py

@@ -17,13 +17,16 @@ import re  # noqa: F401
 from pydantic.v1 import validate_arguments, ValidationError
 from typing_extensions import Annotated
 
-from pydantic.v1 import Field, StrictInt, StrictStr
+from pydantic.v1 import Field, StrictInt, StrictStr, conint
+
+from typing import Optional
 
 from edgeimpulse_api.models.create_device_request import CreateDeviceRequest
 from edgeimpulse_api.models.generic_api_response import GenericApiResponse
 from edgeimpulse_api.models.get_device_response import GetDeviceResponse
 from edgeimpulse_api.models.get_impulse_records_request import GetImpulseRecordsRequest
 from edgeimpulse_api.models.keep_device_debug_stream_alive_request import KeepDeviceDebugStreamAliveRequest
+from edgeimpulse_api.models.list_device_deployment_history_response import ListDeviceDeploymentHistoryResponse
 from edgeimpulse_api.models.list_devices_response import ListDevicesResponse
 from edgeimpulse_api.models.rename_device_request import RenameDeviceRequest
 from edgeimpulse_api.models.start_device_debug_stream_response import StartDeviceDebugStreamResponse
@@ -780,6 +783,167 @@ class DevicesApi(object):
             collection_formats=_collection_formats,
             _request_auth=_params.get('_request_auth'))
 
+    @validate_arguments
+    def list_device_deployment_history(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], device_id : Annotated[StrictStr, Field(..., description="Device ID")], since : Annotated[Optional[conint(strict=True, ge=0)], Field(description="Inclusive Unix timestamp in milliseconds based on Studio's server receive time.")] = None, limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results")] = None, offset : Annotated[Optional[StrictInt], Field(description="Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.")] = None, **kwargs) -> ListDeviceDeploymentHistoryResponse:  # noqa: E501
+        """List device deployment events
+
+        Lists model deployment and rollback events reported by this device, newest first.
+
+        :param project_id: Project ID (required)
+        :type project_id: int
+        :param device_id: Device ID (required)
+        :type device_id: str
+        :param since: Inclusive Unix timestamp in milliseconds based on Studio's server receive time.
+        :type since: int
+        :param limit: Maximum number of results
+        :type limit: int
+        :param offset: Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+        :type offset: int
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: ListDeviceDeploymentHistoryResponse
+        """
+        kwargs['_return_http_data_only'] = True
+        return self._list_device_deployment_history_with_http_info(project_id, device_id, since, limit, offset, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def _list_device_deployment_history_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], device_id : Annotated[StrictStr, Field(..., description="Device ID")], since : Annotated[Optional[conint(strict=True, ge=0)], Field(description="Inclusive Unix timestamp in milliseconds based on Studio's server receive time.")] = None, limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results")] = None, offset : Annotated[Optional[StrictInt], Field(description="Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.")] = None, **kwargs):  # noqa: E501
+        """List device deployment events
+
+        Lists model deployment and rollback events reported by this device, newest first.
+
+        :param project_id: Project ID (required)
+        :type project_id: int
+        :param device_id: Device ID (required)
+        :type device_id: str
+        :param since: Inclusive Unix timestamp in milliseconds based on Studio's server receive time.
+        :type since: int
+        :param limit: Maximum number of results
+        :type limit: int
+        :param offset: Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+        :type offset: int
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :type _return_http_data_only: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(ListDeviceDeploymentHistoryResponse, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'project_id',
+            'device_id',
+            'since',
+            'limit',
+            'offset'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method list_device_deployment_history" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+        if _params['project_id']:
+            _path_params['projectId'] = _params['project_id']
+        if _params['device_id']:
+            _path_params['deviceId'] = _params['device_id']
+
+        # process the query parameters
+        _query_params = []
+        if _params.get('since') is not None:  # noqa: E501
+            _query_params.append(('since', _params['since']))
+        if _params.get('limit') is not None:  # noqa: E501
+            _query_params.append(('limit', _params['limit']))
+        if _params.get('offset') is not None:  # noqa: E501
+            _query_params.append(('offset', _params['offset']))
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+
+        # process the form parameters
+        _form_params = []
+        _files = {}
+
+        # process the body parameter
+        _body_params = None
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # authentication setting
+        _auth_settings = ['ApiKeyAuthentication', 'OAuth2', 'OAuth2', 'OAuth2', 'OAuth2', 'JWTAuthentication', 'JWTHttpHeaderAuthentication']  # noqa: E501
+
+        _response_types_map = {
+            '200': "ListDeviceDeploymentHistoryResponse",
+        }
+
+        return self.api_client.call_api(
+            '/api/{projectId}/devices/{deviceId}/deployment-events', 'GET',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
     @validate_arguments
     def list_devices(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], **kwargs) -> ListDevicesResponse:  # noqa: E501
         """Lists devices

{edgeimpulse_api-1.96.4 → edgeimpulse_api-1.97.2}/edgeimpulse_api/api/learn_api.py

@@ -17,7 +17,7 @@ import re  # noqa: F401
 from pydantic.v1 import validate_arguments, ValidationError
 from typing_extensions import Annotated
 
-from pydantic import Field, StrictBool, StrictInt, StrictStr
+from pydantic import Field, StrictBool, StrictBytes, StrictInt, StrictStr
 
 from typing import List, Optional
 
@@ -3672,7 +3672,7 @@ class LearnApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def upload_pretrained_model(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], model_file : StrictStr, model_file_name : StrictStr, model_file_type : StrictStr, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, representative_features : Optional[StrictStr] = None, device : Annotated[Optional[StrictStr], Field(description="MCU used for calculating latency, query `latencyDevices` in `listProject` for a list of supported devices (and use the \\\"mcu\\\" property here). If this is kept empty then we'll show an overview of multiple devices.")] = None, override_input_shape : Annotated[Optional[List[StrictInt]], Field(description="Optional for ONNX files: overrides the input shape of the model. This is highly suggested if the model has dynamic dimensions. If this field is not set, then all dynamic dimensions will be set to '1'.")] = None, **kwargs) -> StartJobResponse:  # noqa: E501
+    def upload_pretrained_model(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], model_file : StrictStr, model_file_name : StrictStr, model_file_type : StrictStr, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, representative_features : Optional[StrictStr] = None, device : Annotated[Optional[StrictStr], Field(description="MCU used for calculating latency, query `latencyDevices` in `listProject` for a list of supported devices (and use the \\\"mcu\\\" property here). If this is kept empty then we'll show an overview of multiple devices.")] = None, override_input_shape : Annotated[Optional[List[StrictInt]], Field(description="Optional for ONNX files: overrides the input shape of the model. This is highly suggested if the model has dynamic dimensions. If this field is not set, then all dynamic dimensions will be set to '1'.")] = None, additional_files : Optional[List[StrictBytes]] = None, **kwargs) -> StartJobResponse:  # noqa: E501
         """Upload a pretrained model
 
         Upload a pretrained model and receive info back about the input/output tensors. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`.
@@ -3693,6 +3693,8 @@ class LearnApi(object):
         :type device: str
         :param override_input_shape: Optional for ONNX files: overrides the input shape of the model. This is highly suggested if the model has dynamic dimensions. If this field is not set, then all dynamic dimensions will be set to '1'.
         :type override_input_shape: List[int]
+        :param additional_files:
+        :type additional_files: List[str]
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3709,10 +3711,10 @@ class LearnApi(object):
         :rtype: StartJobResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self._upload_pretrained_model_with_http_info(project_id, model_file, model_file_name, model_file_type, impulse_id, representative_features, device, override_input_shape, **kwargs)  # noqa: E501
+        return self._upload_pretrained_model_with_http_info(project_id, model_file, model_file_name, model_file_type, impulse_id, representative_features, device, override_input_shape, additional_files, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _upload_pretrained_model_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], model_file : StrictStr, model_file_name : StrictStr, model_file_type : StrictStr, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, representative_features : Optional[StrictStr] = None, device : Annotated[Optional[StrictStr], Field(description="MCU used for calculating latency, query `latencyDevices` in `listProject` for a list of supported devices (and use the \\\"mcu\\\" property here). If this is kept empty then we'll show an overview of multiple devices.")] = None, override_input_shape : Annotated[Optional[List[StrictInt]], Field(description="Optional for ONNX files: overrides the input shape of the model. This is highly suggested if the model has dynamic dimensions. If this field is not set, then all dynamic dimensions will be set to '1'.")] = None, **kwargs):  # noqa: E501
+    def _upload_pretrained_model_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], model_file : StrictStr, model_file_name : StrictStr, model_file_type : StrictStr, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, representative_features : Optional[StrictStr] = None, device : Annotated[Optional[StrictStr], Field(description="MCU used for calculating latency, query `latencyDevices` in `listProject` for a list of supported devices (and use the \\\"mcu\\\" property here). If this is kept empty then we'll show an overview of multiple devices.")] = None, override_input_shape : Annotated[Optional[List[StrictInt]], Field(description="Optional for ONNX files: overrides the input shape of the model. This is highly suggested if the model has dynamic dimensions. If this field is not set, then all dynamic dimensions will be set to '1'.")] = None, additional_files : Optional[List[StrictBytes]] = None, **kwargs):  # noqa: E501
         """Upload a pretrained model
 
         Upload a pretrained model and receive info back about the input/output tensors. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`.
@@ -3733,6 +3735,8 @@ class LearnApi(object):
         :type device: str
         :param override_input_shape: Optional for ONNX files: overrides the input shape of the model. This is highly suggested if the model has dynamic dimensions. If this field is not set, then all dynamic dimensions will be set to '1'.
         :type override_input_shape: List[int]
+        :param additional_files:
+        :type additional_files: List[str]
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _return_http_data_only: response data without head status code
@@ -3767,7 +3771,8 @@ class LearnApi(object):
             'impulse_id',
             'representative_features',
             'device',
-            'override_input_shape'
+            'override_input_shape',
+            'additional_files'
         ]
         _all_params.extend(
             [
@@ -3822,6 +3827,9 @@ class LearnApi(object):
         if _params['override_input_shape']:
             _form_params.append(('overrideInputShape', _params['override_input_shape']))
             _collection_formats['overrideInputShape'] = 'csv'
+        if _params['additional_files']:
+            _files['additionalFiles'] = _params['additional_files']
+            _collection_formats['additionalFiles'] = 'csv'
 
         # process the body parameter
         _body_params = None

{edgeimpulse_api-1.96.4 → edgeimpulse_api-1.97.2}/edgeimpulse_api/models/__init__.py

@@ -286,6 +286,7 @@ from edgeimpulse_api.models.development_boards_response_all_of import Developmen
 from edgeimpulse_api.models.development_keys import DevelopmentKeys
 from edgeimpulse_api.models.development_keys_response import DevelopmentKeysResponse
 from edgeimpulse_api.models.device import Device
+from edgeimpulse_api.models.device_deployment_event import DeviceDeploymentEvent
 from edgeimpulse_api.models.device_inference_info import DeviceInferenceInfo
 from edgeimpulse_api.models.device_sensors_inner import DeviceSensorsInner
 from edgeimpulse_api.models.downgrade_subscription_request import DowngradeSubscriptionRequest
@@ -570,6 +571,8 @@ from edgeimpulse_api.models.list_api_keys_response import ListApiKeysResponse
 from edgeimpulse_api.models.list_api_keys_response_all_of import ListApiKeysResponseAllOf
 from edgeimpulse_api.models.list_deployment_history_response import ListDeploymentHistoryResponse
 from edgeimpulse_api.models.list_deployment_history_response_all_of import ListDeploymentHistoryResponseAllOf
+from edgeimpulse_api.models.list_device_deployment_history_response import ListDeviceDeploymentHistoryResponse
+from edgeimpulse_api.models.list_device_deployment_history_response_all_of import ListDeviceDeploymentHistoryResponseAllOf
 from edgeimpulse_api.models.list_devices_response import ListDevicesResponse
 from edgeimpulse_api.models.list_devices_response_all_of import ListDevicesResponseAllOf
 from edgeimpulse_api.models.list_email_response import ListEmailResponse

{edgeimpulse_api-1.96.4 → edgeimpulse_api-1.97.2}/edgeimpulse_api/models/deploy_pretrained_model_model_classification.py

@@ -17,13 +17,14 @@ import re  # noqa: F401
 import json
 
 
-from typing import List
-from pydantic.v1 import BaseModel, Field, StrictStr, validator
+from typing import List, Optional
+from pydantic.v1 import BaseModel, Field, StrictBool, StrictStr, validator
 
 class DeployPretrainedModelModelClassification(BaseModel):
     model_type: StrictStr = Field(..., alias="modelType")
     labels: List[StrictStr] = ...
-    __properties = ["modelType", "labels"]
+    add_softmax: Optional[StrictBool] = Field(None, alias="addSoftmax")
+    __properties = ["modelType", "labels", "addSoftmax"]
 
     @validator('model_type')
     def model_type_validate_enum(cls, v):
@@ -67,7 +68,8 @@ class DeployPretrainedModelModelClassification(BaseModel):
 
         _obj = DeployPretrainedModelModelClassification.construct(**{
             "model_type": obj.get("modelType"),
-            "labels": obj.get("labels")
+            "labels": obj.get("labels"),
+            "add_softmax": obj.get("addSoftmax")
         })
         return _obj
 

{edgeimpulse_api-1.96.4 → edgeimpulse_api-1.97.2}/edgeimpulse_api/models/deployment_history.py

@@ -18,7 +18,7 @@ import json
 
 from datetime import datetime
 from typing import Optional
-from pydantic.v1 import BaseModel, Field, StrictBool, StrictInt, StrictStr
+from pydantic.v1 import BaseModel, Field, StrictBool, StrictInt, StrictStr, constr, validator
 from edgeimpulse_api.models.created_updated_by_user import CreatedUpdatedByUser
 from edgeimpulse_api.models.dataset_version import DatasetVersion
 from edgeimpulse_api.models.deployment_target_engine import DeploymentTargetEngine
@@ -40,7 +40,14 @@ class DeploymentHistory(BaseModel):
     download_url: StrictStr = Field(..., alias="downloadUrl")
     created_by_build_public_deployment_job: StrictBool = Field(..., alias="createdByBuildPublicDeploymentJob", description="If set, then this deployment was created by an anonymous user through buildPublicDeploymentJob.")
     dataset_version: Optional[DatasetVersion] = Field(None, alias="datasetVersion")
-    __properties = ["created", "deploymentVersion", "deploymentFormat", "deploymentTarget", "engine", "modelType", "impulseId", "impulseName", "impulseIsDeleted", "createdByUser", "impulseHasChangedSinceDeployment", "downloadUrl", "createdByBuildPublicDeploymentJob", "datasetVersion"]
+    artifact_digest: Optional[constr(strict=True)] = Field(None, alias="artifactDigest", description="SHA-256 digest of the exact artifact returned by downloadHistoricDeployment. Omitted for deployments created before artifact digests were recorded.")
+    __properties = ["created", "deploymentVersion", "deploymentFormat", "deploymentTarget", "engine", "modelType", "impulseId", "impulseName", "impulseIsDeleted", "createdByUser", "impulseHasChangedSinceDeployment", "downloadUrl", "createdByBuildPublicDeploymentJob", "datasetVersion", "artifactDigest"]
+
+    @validator('artifact_digest')
+    def artifact_digest_validate_regular_expression(cls, v):
+        if not re.match(r"^sha256:[0-9a-f]{64}$", v):
+            raise ValueError(r"must validate the regular expression /^sha256:[0-9a-f]{64}$/")
+        return v
 
     class Config:
         allow_population_by_field_name = True
@@ -99,7 +106,8 @@ class DeploymentHistory(BaseModel):
             "impulse_has_changed_since_deployment": obj.get("impulseHasChangedSinceDeployment"),
             "download_url": obj.get("downloadUrl"),
             "created_by_build_public_deployment_job": obj.get("createdByBuildPublicDeploymentJob"),
-            "dataset_version": DatasetVersion.from_dict(obj.get("datasetVersion")) if obj.get("datasetVersion") is not None else None
+            "dataset_version": DatasetVersion.from_dict(obj.get("datasetVersion")) if obj.get("datasetVersion") is not None else None,
+            "artifact_digest": obj.get("artifactDigest")
         })
         return _obj
 

edgeimpulse_api-1.97.2/edgeimpulse_api/models/device_deployment_event.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    Edge Impulse API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Optional
+from pydantic.v1 import BaseModel, Field, StrictInt, StrictStr, constr, validator
+
+class DeviceDeploymentEvent(BaseModel):
+    id: StrictInt = Field(..., description="Unique identifier for this deployment event.")
+    received_at: datetime = Field(..., alias="receivedAt", description="Date and time when Remote Management received the result from the device.")
+    status: StrictStr = Field(..., description="Whether the device successfully completed the operation.")
+    operation: Optional[StrictStr] = Field(None, description="Deployment operation performed by the device. Omitted for legacy results that did not report it.")
+    deployment_version: Optional[StrictInt] = Field(None, alias="deploymentVersion", description="Project deployment version targeted by the operation, when reported by the device.")
+    image_digest: Optional[constr(strict=True)] = Field(None, alias="imageDigest", description="SHA-256 digest of the runner container image active after a successful operation, when reported by the device.")
+    bundle_digest: Optional[constr(strict=True)] = Field(None, alias="bundleDigest", description="SHA-256 digest of the model artifact or inference bundle active after a successful operation, when reported by the device.")
+    error: Optional[StrictStr] = Field(None, description="Device-reported failure reason. Omitted for successful operations.")
+    __properties = ["id", "receivedAt", "status", "operation", "deploymentVersion", "imageDigest", "bundleDigest", "error"]
+
+    @validator('status')
+    def status_validate_enum(cls, v):
+        if v not in ('success', 'failure'):
+            raise ValueError("must validate the enum values ('success', 'failure')")
+        return v
+
+    @validator('operation')
+    def operation_validate_enum(cls, v):
+        if v is None:
+            return v
+
+        if v not in ('deploy', 'rollback'):
+            raise ValueError("must validate the enum values ('deploy', 'rollback')")
+        return v
+
+    @validator('image_digest')
+    def image_digest_validate_regular_expression(cls, v):
+        if not re.match(r"^sha256:[0-9a-f]{64}$", v):
+            raise ValueError(r"must validate the regular expression /^sha256:[0-9a-f]{64}$/")
+        return v
+
+    @validator('bundle_digest')
+    def bundle_digest_validate_regular_expression(cls, v):
+        if not re.match(r"^sha256:[0-9a-f]{64}$", v):
+            raise ValueError(r"must validate the regular expression /^sha256:[0-9a-f]{64}$/")
+        return v
+
+    class Config:
+        allow_population_by_field_name = True
+        validate_assignment = False
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self,indent=None) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict(),indent=indent)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> DeviceDeploymentEvent:
+        """Create an instance of DeviceDeploymentEvent from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> DeviceDeploymentEvent:
+        """Create an instance of DeviceDeploymentEvent from a dict"""
+        if obj is None:
+            return None
+
+        if type(obj) is not dict:
+            return DeviceDeploymentEvent.construct(**obj)
+
+        _obj = DeviceDeploymentEvent.construct(**{
+            "id": obj.get("id"),
+            "received_at": obj.get("receivedAt"),
+            "status": obj.get("status"),
+            "operation": obj.get("operation"),
+            "deployment_version": obj.get("deploymentVersion"),
+            "image_digest": obj.get("imageDigest"),
+            "bundle_digest": obj.get("bundleDigest"),
+            "error": obj.get("error")
+        })
+        return _obj
+

edgeimpulse_api-1.97.2/edgeimpulse_api/models/list_device_deployment_history_response.py

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+"""
+    Edge Impulse API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import List, Optional
+from pydantic.v1 import BaseModel, Field, StrictBool, StrictInt, StrictStr
+from edgeimpulse_api.models.device_deployment_event import DeviceDeploymentEvent
+
+class ListDeviceDeploymentHistoryResponse(BaseModel):
+    success: StrictBool = Field(..., description="Whether the operation succeeded")
+    error: Optional[StrictStr] = Field(None, description="Optional error description (set if 'success' was false)")
+    events: List[DeviceDeploymentEvent] = Field(..., description="Device deployment events in newest-first order.")
+    total_deployment_event_count: StrictInt = Field(..., alias="totalDeploymentEventCount", description="Total number of deployment events for this device, before pagination.")
+    __properties = ["success", "error", "events", "totalDeploymentEventCount"]
+
+    class Config:
+        allow_population_by_field_name = True
+        validate_assignment = False
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self,indent=None) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict(),indent=indent)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ListDeviceDeploymentHistoryResponse:
+        """Create an instance of ListDeviceDeploymentHistoryResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in events (list)
+        _items = []
+        if self.events:
+            for _item in self.events:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['events'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ListDeviceDeploymentHistoryResponse:
+        """Create an instance of ListDeviceDeploymentHistoryResponse from a dict"""
+        if obj is None:
+            return None
+
+        if type(obj) is not dict:
+            return ListDeviceDeploymentHistoryResponse.construct(**obj)
+
+        _obj = ListDeviceDeploymentHistoryResponse.construct(**{
+            "success": obj.get("success"),
+            "error": obj.get("error"),
+            "events": [DeviceDeploymentEvent.from_dict(_item) for _item in obj.get("events")] if obj.get("events") is not None else None,
+            "total_deployment_event_count": obj.get("totalDeploymentEventCount")
+        })
+        return _obj
+

edgeimpulse_api-1.97.2/edgeimpulse_api/models/list_device_deployment_history_response_all_of.py

@@ -0,0 +1,75 @@
+# coding: utf-8
+
+"""
+    Edge Impulse API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import List
+from pydantic.v1 import BaseModel, Field, StrictInt
+from edgeimpulse_api.models.device_deployment_event import DeviceDeploymentEvent
+
+class ListDeviceDeploymentHistoryResponseAllOf(BaseModel):
+    events: List[DeviceDeploymentEvent] = Field(..., description="Device deployment events in newest-first order.")
+    total_deployment_event_count: StrictInt = Field(..., alias="totalDeploymentEventCount", description="Total number of deployment events for this device, before pagination.")
+    __properties = ["events", "totalDeploymentEventCount"]
+
+    class Config:
+        allow_population_by_field_name = True
+        validate_assignment = False
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self,indent=None) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict(),indent=indent)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ListDeviceDeploymentHistoryResponseAllOf:
+        """Create an instance of ListDeviceDeploymentHistoryResponseAllOf from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in events (list)
+        _items = []
+        if self.events:
+            for _item in self.events:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['events'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ListDeviceDeploymentHistoryResponseAllOf:
+        """Create an instance of ListDeviceDeploymentHistoryResponseAllOf from a dict"""
+        if obj is None:
+            return None
+
+        if type(obj) is not dict:
+            return ListDeviceDeploymentHistoryResponseAllOf.construct(**obj)
+
+        _obj = ListDeviceDeploymentHistoryResponseAllOf.construct(**{
+            "events": [DeviceDeploymentEvent.from_dict(_item) for _item in obj.get("events")] if obj.get("events") is not None else None,
+            "total_deployment_event_count": obj.get("totalDeploymentEventCount")
+        })
+        return _obj
+

{edgeimpulse_api-1.96.4 → edgeimpulse_api-1.97.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "edgeimpulse-api"
-version = "1.96.4" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
+version = "1.97.2" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
 description = "Python bindings for the Edge Impulse API."
 authors = ["EdgeImpulse Inc. <hello@edgeimpulse.com>"]
 license = "BSD-3-Clause-Clear"