viam-sdk 0.49.0__py3-none-win_amd64.whl → 0.50.0__py3-none-win_amd64.whl

viam/app/app_client.py

@@ -786,7 +786,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#deleteorganization>`_.
         """
@@ -802,7 +802,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to list members of.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
 
         Returns:
             Tuple[List[viam.proto.app.OrganizationMember], List[viam.proto.app.OrganizationInvite]]: A tuple containing two lists; the first
@@ -829,7 +829,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to create an invite for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             email (str): The email address to send the invite to.
             authorizations (Optional[List[viam.proto.app.Authorization]]): Specifications of the
                 authorizations to include in the invite. If not provided, full owner permissions will
@@ -887,7 +887,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization that the invite is for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             email (str): Email of the user the invite was sent to.
             add_authorizations (Optional[List[viam.proto.app.Authorization]]): Optional list of authorizations to add to the invite.
             remove_authorizations (Optional[List[viam.proto.app.Authorization]]): Optional list of authorizations to remove from the invite.
@@ -921,7 +921,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the org to remove the user from.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             user_id (str): The ID of the user to remove.
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#deleteorganizationmember>`_.
@@ -938,7 +938,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization that the invite to delete was for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             email (str): The email address the pending invite was sent to.
 
         Raises:
@@ -958,7 +958,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization that the invite to resend was for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             email (str): The email address associated with the invite.
 
         Raises:
@@ -982,7 +982,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to create the location under.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             name (str): Name of the location.
             parent_location_id (Optional[str]): Optional parent location to put the location under. Defaults to a root-level location if no
                 location ID is provided.
@@ -1094,7 +1094,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the org to list locations for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
 
         Returns:
             List[viam.proto.app.Location]: The list of locations.
@@ -1241,7 +1241,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to list rover rental robots for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
 
         Returns:
             List[viam.proto.app.RoverRentalRobot]: The list of rover rental robots.
@@ -1744,7 +1744,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to list fragments for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             show_public (bool): Optional boolean specifying whether or not to only show public fragments. If True, only public fragments
                 will return. If False, only private fragments will return. Defaults to True.
 
@@ -1800,7 +1800,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to create the fragment within.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             name (str): Name of the fragment.
             config (Optional[Mapping[str, Any]]): Optional Dictionary representation of new config to assign to specified fragment. Can be
                 assigned by updating the fragment.
@@ -1942,7 +1942,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to create the role in.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             identity_id (str): ID of the entity the role belongs to (for example, a user ID).
             role (Union[Literal["owner"], Literal["operator"]]): The role to add.
             resource_type (Union[Literal["organization"], Literal["location"], Literal["robot"]]): Type of the resource to add role to.
@@ -1987,7 +1987,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization the role exists in.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             identity_id (str): ID of the entity the role belongs to (for example, a user ID).
             role (Union[Literal["owner"], Literal["operator"]]): The role to remove.
             resource_type (Union[Literal["organization"], Literal["location"], Literal["robot"]]): Type of the resource the role is being
@@ -2290,7 +2290,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to create the module under.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             name (str): The name of the module. Must be unique within your organization.
 
         Raises:
@@ -2431,7 +2431,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to list modules for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
 
         Returns:
             List[viam.proto.app.Module]: The list of modules.
@@ -2465,7 +2465,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to create the key for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             authorizations (List[viam.proto.app.Authorization]): A list of authorizations to associate
                 with the key.
             name (Optional[str]): A name for the key. If None, defaults to the current timestamp.
@@ -2531,7 +2531,7 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization to list API keys for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
 
         Returns:
             List[viam.proto.app.APIKeyWithAuthorizations]: The existing API keys and authorizations.
@@ -2570,13 +2570,13 @@ class AppClient:
 
         Args:
             org_id (str): The ID of the organization with which the user-defined metadata is associated.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
 
         Returns:
             Mapping[str, Any]: The user-defined metadata converted from JSON to a Python dictionary
         """
         request = GetOrganizationMetadataRequest(organization_id=org_id)
-        response: GetOrganizationMetadataResponse = await self._app_client.GetOrganizationMetadata(request)
+        response: GetOrganizationMetadataResponse = await self._app_client.GetOrganizationMetadata(request, metadata=self._metadata)
         return struct_to_dict(response.data)
 
     async def update_organization_metadata(self, org_id: str, metadata: Mapping[str, Any]) -> None:
@@ -2588,11 +2588,11 @@ class AppClient:
 
         Args:
             organization_id (str): The ID of the organization with which to associate the user-defined metadata.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             metadata (Mapping[str, Any]): The user-defined metadata to upload as a Python dictionary.
         """
         request = UpdateOrganizationMetadataRequest(organization_id=org_id, data=dict_to_struct(metadata))
-        _: UpdateOrganizationMetadataResponse = await self._app_client.UpdateOrganizationMetadata(request)
+        _: UpdateOrganizationMetadataResponse = await self._app_client.UpdateOrganizationMetadata(request, metadata=self._metadata)
 
     async def get_location_metadata(self, location_id: str) -> Mapping[str, Any]:
         """Get a location's user-defined metadata.
@@ -2603,13 +2603,13 @@ class AppClient:
 
         Args:
             location_id (str): The ID of the location with which the user-defined metadata is associated.
-                You can obtain your location ID from the Viam app's locations page.
+                You can obtain your location ID from the location's page.
 
         Returns:
             Mapping[str, Any]: The user-defined metadata converted from JSON to a Python dictionary.
         """
         request = GetLocationMetadataRequest(location_id=location_id)
-        response: GetLocationMetadataResponse = await self._app_client.GetLocationMetadata(request)
+        response: GetLocationMetadataResponse = await self._app_client.GetLocationMetadata(request, metadata=self._metadata)
         return struct_to_dict(response.data)
 
     async def update_location_metadata(self, location_id: str, metadata: Mapping[str, Any]) -> None:
@@ -2621,11 +2621,11 @@ class AppClient:
 
         Args:
             location_id (str): The ID of the location with which to associate the user-defined metadata.
-                You can obtain your location ID from the Viam app's locations page.
+                You can obtain your location ID from the location's page.
             metadata (Mapping[str, Any]): The user-defined metadata converted from JSON to a Python dictionary.
         """
         request = UpdateLocationMetadataRequest(location_id=location_id, data=dict_to_struct(metadata))
-        _: UpdateLocationMetadataResponse = await self._app_client.UpdateLocationMetadata(request)
+        _: UpdateLocationMetadataResponse = await self._app_client.UpdateLocationMetadata(request, metadata=self._metadata)
 
     async def get_robot_metadata(self, robot_id: str) -> Mapping[str, Any]:
         """Get a robot's user-defined metadata.
@@ -2636,13 +2636,13 @@ class AppClient:
 
         Args:
             robot_id (str): The ID of the robot with which the user-defined metadata is associated.
-                You can obtain your robot ID from the Viam app's machine page.
+                You can obtain your robot ID from the machine page.
 
         Returns:
             Mapping[str, Any]: The user-defined metadata converted from JSON to a Python dictionary.
         """
         request = GetRobotMetadataRequest(id=robot_id)
-        response: GetRobotMetadataResponse = await self._app_client.GetRobotMetadata(request)
+        response: GetRobotMetadataResponse = await self._app_client.GetRobotMetadata(request, metadata=self._metadata)
         return struct_to_dict(response.data)
 
     async def update_robot_metadata(self, robot_id: str, metadata: Mapping[str, Any]) -> None:
@@ -2654,11 +2654,11 @@ class AppClient:
 
         Args:
             robot_id (str): The ID of the robot with which to associate the user-defined metadata.
-                You can obtain your robot ID from the Viam app's machine page.
+                You can obtain your robot ID from the machine page.
             metadata (Mapping[str, Any]): The user-defined metadata converted from JSON to a Python dictionary.
         """
         request = UpdateRobotMetadataRequest(id=robot_id, data=dict_to_struct(metadata))
-        _: UpdateRobotMetadataResponse = await self._app_client.UpdateRobotMetadata(request)
+        _: UpdateRobotMetadataResponse = await self._app_client.UpdateRobotMetadata(request, metadata=self._metadata)
 
     async def get_robot_part_metadata(self, robot_part_id: str) -> Mapping[str, Any]:
         """Get a robot part's user-defined metadata.
@@ -2669,13 +2669,13 @@ class AppClient:
 
         Args:
             robot_part_id (str): The ID of the robot part with which the user-defined metadata is associated.
-                You can obtain your robot part ID from the Viam app's machine page.
+                You can obtain your robot part ID from the machine page.
 
         Returns:
             Mapping[str, Any]: The user-defined metadata converted from JSON to a Python dictionary.
         """
         request = GetRobotPartMetadataRequest(id=robot_part_id)
-        response: GetRobotPartMetadataResponse = await self._app_client.GetRobotPartMetadata(request)
+        response: GetRobotPartMetadataResponse = await self._app_client.GetRobotPartMetadata(request, metadata=self._metadata)
         return struct_to_dict(response.data)
 
     async def update_robot_part_metadata(self, robot_part_id: str, metadata: Mapping[str, Any]) -> None:
@@ -2687,8 +2687,8 @@ class AppClient:
 
         Args:
             robot_id (str): The ID of the robot part with which to associate the user-defined metadata.
-                You can obtain your robot part ID from the Viam app's machine page.
+                You can obtain your robot part ID from the machine page.
             metadata (Mapping[str, Any]): The user-defined metadata converted from JSON to a Python dictionary.
         """
         request = UpdateRobotPartMetadataRequest(id=robot_part_id, data=dict_to_struct(metadata))
-        _: UpdateRobotPartMetadataResponse = await self._app_client.UpdateRobotPartMetadata(request)
+        _: UpdateRobotPartMetadataResponse = await self._app_client.UpdateRobotPartMetadata(request, metadata=self._metadata)

viam/app/data_client.py

@@ -106,7 +106,7 @@ from viam.proto.app.datasync import (
     StreamingDataCaptureUploadResponse,
     UploadMetadata,
 )
-from viam.utils import ValueTypes, _alias_param, create_filter, datetime_to_timestamp, struct_to_dict
+from viam.utils import ValueTypes, _alias_param, create_filter, datetime_to_timestamp, dict_to_struct, struct_to_dict
 
 LOGGER = logging.getLogger(__name__)
 
@@ -474,7 +474,7 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization that owns the data.
-                To find your organization ID, visit the organization settings page in the Viam app.
+                To find your organization ID, visit the organization settings page.
             sql_query (str): The SQL query to run.
 
         Returns:
@@ -510,7 +510,7 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization that owns the data.
-                To find your organization ID, visit the organization settings page in the Viam app.
+                To find your organization ID, visit the organization settings page.
             query (Union[List[bytes], List[Dict[str, Any]]]): The MQL query to run, as a list of MongoDB aggregation pipeline stages.
                 Each stage can be provided as either a dictionary or raw BSON bytes, but support for bytes will be removed in the
                 future, so prefer the dictionary option.
@@ -536,7 +536,12 @@ class DataClient:
 
     @_alias_param("resource_api", param_alias="resource_subtype")
     async def get_latest_tabular_data(
-        self, part_id: str, resource_name: str, resource_api: str, method_name: str
+        self,
+        part_id: str,
+        resource_name: str,
+        resource_api: str,
+        method_name: str,
+        additional_params: Optional[Mapping[str, ValueTypes]] = None,
     ) -> Optional[Tuple[datetime, datetime, Dict[str, ValueTypes]]]:
         """Gets the most recent tabular data captured from the specified data source, as long as it was synced within the last year.
 
@@ -546,7 +551,8 @@ class DataClient:
                 part_id="77ae3145-7b91-123a-a234-e567cdca8910",
                 resource_name="camera-1",
                 resource_api="rdk:component:camera",
-                method_name="GetImage"
+                method_name="GetImage",
+                additional_params={"docommand_input": {"test": "test"}}
             )
 
             if tabular_data:
@@ -562,6 +568,7 @@ class DataClient:
             resource_name (str): The name of the requested resource that captured the data. For example, "my-sensor".
             resource_api (str): The API of the requested resource that captured the data. For example, "rdk:component:sensor".
             method_name (str): The data capture method name. For exampe, "Readings".
+            additional_params (dict): Optional additional parameters of the resource that captured the data.
 
         Returns:
             Optional[Tuple[datetime, datetime, Dict[str, ValueTypes]]]:
@@ -577,7 +584,11 @@ class DataClient:
         """
 
         request = GetLatestTabularDataRequest(
-            part_id=part_id, resource_name=resource_name, resource_subtype=resource_api, method_name=method_name
+            part_id=part_id,
+            resource_name=resource_name,
+            resource_subtype=resource_api,
+            method_name=method_name,
+            additional_parameters=dict_to_struct(additional_params),
         )
         response: GetLatestTabularDataResponse = await self._data_client.GetLatestTabularData(request, metadata=self._metadata)
         if not response.payload:
@@ -593,6 +604,7 @@ class DataClient:
         method_name: str,
         start_time: Optional[datetime] = None,
         end_time: Optional[datetime] = None,
+        additional_params: Optional[Mapping[str, ValueTypes]] = None,
     ) -> List[TabularDataPoint]:
         """Obtain unified tabular data and metadata from the specified data source.
 
@@ -605,6 +617,7 @@ class DataClient:
                 method_name="<METHOD-NAME>",
                 start_time="<START_TIME>"
                 end_time="<END_TIME>"
+                additional_params="<ADDITIONAL_PARAMETERS>"
             )
 
             print(f"My data: {tabular_data}")
@@ -616,6 +629,7 @@ class DataClient:
             method_name (str): The data capture method name.
             start_time (datetime): Optional start time for requesting a specific range of data.
             end_time (datetime): Optional end time for requesting a specific range of data.
+            additional_params (dict): Optional additional parameters of the resource that captured the data.
 
         Returns:
             List[TabularDataPoint]: The unified tabular data and metadata.
@@ -625,7 +639,12 @@ class DataClient:
 
         interval = CaptureInterval(start=datetime_to_timestamp(start_time), end=datetime_to_timestamp(end_time))
         request = ExportTabularDataRequest(
-            part_id=part_id, resource_name=resource_name, resource_subtype=resource_api, method_name=method_name, interval=interval
+            part_id=part_id,
+            resource_name=resource_name,
+            resource_subtype=resource_api,
+            method_name=method_name,
+            interval=interval,
+            additional_parameters=dict_to_struct(additional_params),
         )
         response: List[ExportTabularDataResponse] = await self._data_client.ExportTabularData(request, metadata=self._metadata)
 
@@ -812,7 +831,7 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization to delete the data from.
-                To find your organization ID, visit the organization settings page in the Viam app.
+                To find your organization ID, visit the organization settings page.
             delete_older_than_days (int): Delete data that was captured up to *this many* days ago. For example, a value of
                 10 deletes any data that was captured up to 10 days ago. A value of 0 deletes *all* existing data.
 
@@ -844,7 +863,7 @@ class DataClient:
             filter (~viam.proto.app.data.Filter): Optional, specifies binary data to delete.
                 **CAUTION: Passing an empty** ``Filter`` **deletes all binary data!**
                 You must specify an organization ID with ``organization_ids`` when using this option.
-                To find your organization ID, visit the organization settings page in the Viam app.
+                To find your organization ID, visit the organization settings page.
 
         Returns:
             int: The number of items deleted.
@@ -1208,7 +1227,7 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization you'd like to connect to.
-                To find your organization ID, visit the organization settings page in the Viam app.
+                To find your organization ID, visit the organization settings page.
 
         Returns:
             str: The hostname of the federated database.
@@ -1232,7 +1251,7 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization you'd like to configure a database user for.
-                To find your organization ID, visit the organization settings page in the Viam app.
+                To find your organization ID, visit the organization settings page.
             password (str): The password of the user.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#configuredatabaseuser>`_.
@@ -1254,7 +1273,7 @@ class DataClient:
         Args:
             name (str): The name of the dataset being created.
             organization_id (str): The ID of the organization where the dataset is being created.
-                To find your organization ID, visit the organization settings page in the Viam app.
+                To find your organization ID, visit the organization settings page.
 
         Returns:
             str: The dataset ID of the created dataset.
@@ -1305,7 +1324,7 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization you'd like to retrieve datasets from.
-                To find your organization ID, visit the organization settings page in the Viam app.
+                To find your organization ID, visit the organization settings page.
 
         Returns:
             Sequence[Dataset]: The list of datasets in the organization.
@@ -1470,7 +1489,7 @@ class DataClient:
         """Upload binary sensor data.
 
         Upload binary data collected on a robot through a specific component (for example, a motor), along with the relevant metadata.
-        Binary data can be found on the **DATA** page of the Viam app.
+        Binary data can be found on the **DATA** page.
 
         ::
 
@@ -1878,7 +1897,7 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization that owns the pipelines.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
 
         Returns:
             List[DataPipeline]: A list of all of the data pipelines for the given organization.
@@ -1893,6 +1912,7 @@ class DataClient:
         name: str,
         mql_binary: List[Dict[str, Any]],
         schedule: str,
+        enable_backfill: bool,
         data_source_type: TabularDataSourceType.ValueType = TabularDataSourceType.TABULAR_DATA_SOURCE_TYPE_STANDARD,
     ) -> str:
         """Create a new data pipeline.
@@ -1909,11 +1929,12 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization that will own the pipeline.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                You can obtain your organization ID from the organization settings page.
             name (str): The name of the pipeline.
             mql_binary (List[Dict[str, Any]]):The MQL pipeline to run, as a list of MongoDB aggregation pipeline stages.
             schedule (str): A cron expression representing the expected execution schedule in UTC (note this also
                 defines the input time window; an hourly schedule would process 1 hour of data at a time).
+            enable_backfill (bool):  When true, pipeline runs will be scheduled for the organization's past data.
             data_source_type (TabularDataSourceType): The type of data source to use for the pipeline.
                 Defaults to TabularDataSourceType.TABULAR_DATA_SOURCE_TYPE_STANDARD.
 
@@ -1922,7 +1943,12 @@ class DataClient:
         """
         binary: List[bytes] = [bson.encode(query) for query in mql_binary]
         request = CreateDataPipelineRequest(
-            organization_id=organization_id, name=name, mql_binary=binary, schedule=schedule, data_source_type=data_source_type
+            organization_id=organization_id,
+            name=name,
+            mql_binary=binary,
+            schedule=schedule,
+            enable_backfill=enable_backfill,
+            data_source_type=data_source_type,
         )
         response: CreateDataPipelineResponse = await self._data_pipelines_client.CreateDataPipeline(request, metadata=self._metadata)
         return response.id

viam/app/viam_client.py

@@ -58,7 +58,7 @@ class ViamClient:
 
     @classmethod
     async def create_from_dial_options(cls, dial_options: DialOptions, app_url: Optional[str] = None) -> Self:
-        """Create `ViamClient` that establishes a connection to the Viam app.
+        """Create `ViamClient` that establishes a connection to Viam.
 
         ::