viam-sdk 0.41.1__py3-none-linux_armv6l.whl → 0.66.0__py3-none-linux_armv6l.whl

viam/app/app_client.py

@@ -52,10 +52,14 @@ from viam.proto.app import (
     GetFragmentHistoryResponse,
     GetFragmentRequest,
     GetFragmentResponse,
+    GetLocationMetadataRequest,
+    GetLocationMetadataResponse,
     GetLocationRequest,
     GetLocationResponse,
     GetModuleRequest,
     GetModuleResponse,
+    GetOrganizationMetadataRequest,
+    GetOrganizationMetadataResponse,
     GetOrganizationNamespaceAvailabilityRequest,
     GetOrganizationNamespaceAvailabilityResponse,
     GetOrganizationRequest,
@@ -66,10 +70,14 @@ from viam.proto.app import (
     GetRegistryItemResponse,
     GetRobotAPIKeysRequest,
     GetRobotAPIKeysResponse,
+    GetRobotMetadataRequest,
+    GetRobotMetadataResponse,
     GetRobotPartHistoryRequest,
     GetRobotPartHistoryResponse,
     GetRobotPartLogsRequest,
     GetRobotPartLogsResponse,
+    GetRobotPartMetadataRequest,
+    GetRobotPartMetadataResponse,
     GetRobotPartRequest,
     GetRobotPartResponse,
     GetRobotPartsRequest,
@@ -134,15 +142,23 @@ from viam.proto.app import (
     UnshareLocationRequest,
     UpdateFragmentRequest,
     UpdateFragmentResponse,
+    UpdateLocationMetadataRequest,
+    UpdateLocationMetadataResponse,
     UpdateLocationRequest,
     UpdateLocationResponse,
     UpdateModuleRequest,
     UpdateModuleResponse,
     UpdateOrganizationInviteAuthorizationsRequest,
     UpdateOrganizationInviteAuthorizationsResponse,
+    UpdateOrganizationMetadataRequest,
+    UpdateOrganizationMetadataResponse,
     UpdateOrganizationRequest,
     UpdateOrganizationResponse,
     UpdateRegistryItemRequest,
+    UpdateRobotMetadataRequest,
+    UpdateRobotMetadataResponse,
+    UpdateRobotPartMetadataRequest,
+    UpdateRobotPartMetadataResponse,
     UpdateRobotPartRequest,
     UpdateRobotPartResponse,
     UpdateRobotRequest,
@@ -193,6 +209,7 @@ class RobotPart:
         self.local_fqdn = robot_part.local_fqdn
         self.created_on = robot_part.created_on.ToDatetime() if robot_part.HasField("created_on") else None
         self.secrets = list(robot_part.secrets)
+        self.last_updated = robot_part.last_updated.ToDatetime() if robot_part.HasField("last_updated") else None
         return self
 
     id: str
@@ -209,6 +226,7 @@ class RobotPart:
     local_fqdn: str
     created_on: Optional[datetime]
     secrets: Optional[List[SharedSecret]]
+    last_updated: Optional[datetime]
 
     @property
     def proto(self) -> RobotPartPB:
@@ -227,6 +245,7 @@ class RobotPart:
             local_fqdn=self.local_fqdn,
             created_on=datetime_to_timestamp(self.created_on) if self.created_on else None,
             secrets=self.secrets,
+            last_updated=datetime_to_timestamp(self.last_updated) if self.last_updated else None,
         )
 
 
@@ -352,6 +371,7 @@ class Fragment:
         self.organization_count = fragment.organization_count
         self.only_used_by_owner = fragment.only_used_by_owner
         self.visibility = Fragment.Visibility.from_proto(fragment.visibility)
+        self.last_updated = fragment.last_updated.ToDatetime() if fragment.HasField("last_updated") else None
         return self
 
     id: str
@@ -365,6 +385,7 @@ class Fragment:
     organization_count: int
     only_used_by_owner: bool
     visibility: Visibility
+    last_updated: Optional[datetime]
 
     @property
     def proto(self) -> FragmentPB:
@@ -380,6 +401,7 @@ class Fragment:
             organization_count=self.organization_count,
             only_used_by_owner=self.only_used_by_owner,
             visibility=self.visibility.to_proto(),
+            last_updated=datetime_to_timestamp(self.last_updated) if self.last_updated else None,
         )
 
 
@@ -508,11 +530,9 @@ class AppClient:
         async def main():
 
             # Make a ViamClient
-            viam_client = await connect()
-            # Instantiate an AppClient called "cloud" to run cloud app API methods on
-            cloud = viam_client.app_client
-
-            viam_client.close()
+            async with await connect() as viam_client:
+                # Instantiate an AppClient called "cloud" to run cloud app API methods on
+                cloud = viam_client.app_client
 
         if __name__ == '__main__':
             asyncio.run(main())
@@ -520,22 +540,19 @@ class AppClient:
     For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/>`_.
     """
 
-    def __init__(self, channel: Channel, metadata: Mapping[str, str], location_id: Optional[str] = None):
+    def __init__(self, channel: Channel, metadata: Mapping[str, str]):
         """Create an `AppClient` that maintains a connection to app.
 
         Args:
             channel (grpclib.client.Channel): connection to app.
             metadata (Mapping[str, str]): Required authorization token to send requests to app.
-            location_id (Optional[str]): Default location ID.
         """
         self._metadata = metadata
         self._app_client = AppServiceStub(channel)
-        self._location_id = location_id
         self._channel = channel
 
     _app_client: AppServiceStub
     _metadata: Mapping[str, str]
-    _location_id: Optional[str]
     _channel: Channel
     _organization_id: Optional[str] = None
 
@@ -764,7 +781,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>`_.
         """
@@ -780,7 +797,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
@@ -807,7 +824,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
@@ -865,7 +882,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.
@@ -899,7 +916,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>`_.
@@ -916,7 +933,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:
@@ -936,7 +953,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:
@@ -960,7 +977,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.
@@ -996,7 +1013,7 @@ class AppClient:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#getlocation>`_.
         """
-        request = GetLocationRequest(location_id=location_id if location_id else self._location_id if self._location_id else "")
+        request = GetLocationRequest(location_id=location_id if location_id else "")
         response: GetLocationResponse = await self._app_client.GetLocation(request, metadata=self._metadata)
         return response.location
 
@@ -1072,7 +1089,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.
@@ -1135,7 +1152,7 @@ class AppClient:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#locationauth>`_.
         """
-        request = LocationAuthRequest(location_id=location_id if location_id else self._location_id if self._location_id else "")
+        request = LocationAuthRequest(location_id=location_id if location_id else "")
         response: LocationAuthResponse = await self._app_client.LocationAuth(request, metadata=self._metadata)
         return response.auth
 
@@ -1159,7 +1176,7 @@ class AppClient:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#createlocationsecret>`_.
         """
-        request = CreateLocationSecretRequest(location_id=location_id if location_id else self._location_id if self._location_id else "")
+        request = CreateLocationSecretRequest(location_id=location_id if location_id else "")
         response: CreateLocationSecretResponse = await self._app_client.CreateLocationSecret(request, metadata=self._metadata)
         return response.auth
 
@@ -1183,9 +1200,7 @@ class AppClient:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#deletelocationsecret>`_.
         """
-        request = DeleteLocationSecretRequest(
-            location_id=location_id if location_id else self._location_id if self._location_id else "", secret_id=secret_id
-        )
+        request = DeleteLocationSecretRequest(location_id=location_id if location_id else "", secret_id=secret_id)
         await self._app_client.DeleteLocationSecret(request, metadata=self._metadata)
 
     async def get_robot(self, robot_id: str) -> Robot:
@@ -1219,7 +1234,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.
@@ -1255,13 +1270,20 @@ class AppClient:
         return [RobotPart.from_proto(robot_part=part) for part in response.parts]
 
     async def get_robot_part(self, robot_part_id: str, dest: Optional[str] = None, indent: int = 4) -> RobotPart:
-        """Get a machine part.
+        """Get a machine part including its part config, part address, and other information.
 
         ::
 
             my_robot_part = await cloud.get_robot_part(
                 robot_part_id="abc12345-1a23-1234-ab12-a22a22a2aa22"
             )
+            # Get the part's config
+            machine_part_config = my_robot_part.robot_config
+            # Get the part's address
+            address = my_robot_part.fqdn
+            # Check if machine is live (last access time less than 10 sec ago)
+            if (time.time() - my_robot_part.last_access.timestamp()) <= 10000:
+                print("Machine is live.")
 
         Args:
             robot_part_id (str): ID of the machine part to get. You can retrieve this value by navigating to the machine's page,
@@ -1426,7 +1448,9 @@ class AppClient:
         response: GetRobotPartHistoryResponse = await self._app_client.GetRobotPartHistory(request, metadata=self._metadata)
         return [RobotPartHistoryEntry.from_proto(part_history) for part_history in response.history]
 
-    async def update_robot_part(self, robot_part_id: str, name: str, robot_config: Optional[Mapping[str, Any]] = None) -> RobotPart:
+    async def update_robot_part(
+        self, robot_part_id: str, name: str, robot_config: Optional[Mapping[str, Any]] = None, last_known_update: Optional[datetime] = None
+    ) -> RobotPart:
         """Change the name and assign an optional new configuration to a machine part.
 
         ::
@@ -1440,16 +1464,23 @@ class AppClient:
             name (str): New name to be updated on the robot part.
             robot_config (Mapping[str, Any]): Optional new config represented as a dictionary to be updated on the machine part. The machine
                 part's config will remain as is (no change) if one isn't passed.
-
+            last_known_update (datetime): Optional time of the last known update to this part's config. If provided, this will result in a
+                GRPCError if the upstream config has changed since this time, indicating that the local config is out of date. Omitting this
+                parameter will result in an overwrite of the upstream config.
         Raises:
-            GRPCError: If either an invalid machine part ID, name, or config is passed.
-
+            GRPCError: If either an invalid machine part ID, name, or config is passed, or if the upstream config has changed since
+                last_known_update.
         Returns:
             viam.app.app_client.RobotPart: The newly updated robot part.
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#updaterobotpart>`_.
         """
-        request = UpdateRobotPartRequest(id=robot_part_id, name=name, robot_config=dict_to_struct(robot_config) if robot_config else None)
+        request = UpdateRobotPartRequest(
+            id=robot_part_id,
+            name=name,
+            robot_config=dict_to_struct(robot_config) if robot_config else None,
+            last_known_update=datetime_to_timestamp(last_known_update),
+        )
         response: UpdateRobotPartResponse = await self._app_client.UpdateRobotPart(request, metadata=self._metadata)
         return RobotPart.from_proto(robot_part=response.part)
 
@@ -1619,7 +1650,7 @@ class AppClient:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#listrobots>`_.
         """
-        request = ListRobotsRequest(location_id=location_id if location_id else self._location_id if self._location_id else "")
+        request = ListRobotsRequest(location_id=location_id if location_id else "")
         response: ListRobotsResponse = await self._app_client.ListRobots(request, metadata=self._metadata)
         return list(response.robots)
 
@@ -1643,7 +1674,7 @@ class AppClient:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#newrobot>`_.
         """
-        request = NewRobotRequest(location=location_id if location_id else self._location_id if self._location_id else "", name=name)
+        request = NewRobotRequest(location=location_id if location_id else "", name=name)
         response: NewRobotResponse = await self._app_client.NewRobot(request, metadata=self._metadata)
         return response.id
 
@@ -1673,9 +1704,7 @@ class AppClient:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#updaterobot>`_.
         """
-        request = UpdateRobotRequest(
-            id=robot_id, name=name, location=location_id if location_id else self._location_id if self._location_id else ""
-        )
+        request = UpdateRobotRequest(id=robot_id, name=name, location=location_id if location_id else "")
         response: UpdateRobotResponse = await self._app_client.UpdateRobot(request, metadata=self._metadata)
         return response.robot
 
@@ -1708,7 +1737,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.
 
@@ -1730,7 +1759,7 @@ class AppClient:
         response: ListFragmentsResponse = await self._app_client.ListFragments(request, metadata=self._metadata)
         return [Fragment.from_proto(fragment=fragment) for fragment in response.fragments]
 
-    async def get_fragment(self, fragment_id: str) -> Fragment:
+    async def get_fragment(self, fragment_id: str, version: Optional[str] = None) -> Fragment:
         """Get a fragment.
 
         ::
@@ -1742,6 +1771,7 @@ class AppClient:
 
         Args:
             fragment_id (str): ID of the fragment to get.
+            version (str): Optional specification of the fragment version to get (revision or tag).
 
         Raises:
             GRPCError: If an invalid fragment ID is passed.
@@ -1751,7 +1781,7 @@ class AppClient:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#getfragment>`_.
         """
-        request = GetFragmentRequest(id=fragment_id)
+        request = GetFragmentRequest(id=fragment_id, version=version)
         response: GetFragmentResponse = await self._app_client.GetFragment(request, metadata=self._metadata)
         return Fragment.from_proto(fragment=response.fragment)
 
@@ -1764,7 +1794,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.
@@ -1788,6 +1818,7 @@ class AppClient:
         config: Optional[Mapping[str, Any]] = None,
         public: Optional[bool] = None,
         visibility: Optional[Fragment.Visibility] = None,
+        last_known_update: Optional[datetime] = None,
     ) -> Fragment:
         """Update a fragment name AND its config and/or visibility.
 
@@ -1810,9 +1841,11 @@ class AppClient:
             visibility (Optional[FragmentVisibility]): Optional FragmentVisibility list specifying who should be allowed
                 to view the fragment. Not passing this parameter will leave the fragment's visibility unchanged.
                 A fragment is private by default when created.
-
+            last_known_update (datetime): Optional time of the last known update to this fragment's config. If provided, this will result in
+                a GRPCError if the upstream config has changed since this time, indicating that the local config is out of date. Omitting
+                this parameter will result in an overwrite of the upstream config.
         Raises:
-            GRPCError: if an invalid ID, name, or config is passed.
+            GRPCError: if an invalid ID, name, or config is passed, or if the upstream fragment config has changed since last_known_update.
 
         Returns:
             viam.app.app_client.Fragment: The newly updated fragment.
@@ -1825,6 +1858,7 @@ class AppClient:
             config=dict_to_struct(config) if config else None,
             public=public,
             visibility=visibility.to_proto() if visibility else None,
+            last_known_update=datetime_to_timestamp(last_known_update),
         )
         response: UpdateFragmentResponse = await self._app_client.UpdateFragment(request, metadata=self._metadata)
         return Fragment.from_proto(response.fragment)
@@ -1902,7 +1936,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.
@@ -1947,7 +1981,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
@@ -2092,7 +2126,7 @@ class AppClient:
         response: CheckPermissionsResponse = await self._app_client.CheckPermissions(request, metadata=self._metadata)
         return list(response.authorized_permissions)
 
-    async def get_registry_item(self, item_id: str) -> RegistryItem:
+    async def get_registry_item(self, item_id: str, include_markdown_documentation: bool = False) -> RegistryItem:
         """Get registry item by ID.
 
         ::
@@ -2110,7 +2144,7 @@ class AppClient:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#getregistryitem>`_.
         """
-        request = GetRegistryItemRequest(item_id=item_id)
+        request = GetRegistryItemRequest(item_id=item_id, include_markdown_documentation=include_markdown_documentation)
         response: GetRegistryItemResponse = await self._app_client.GetRegistryItem(request, metadata=self._metadata)
         return response.item
 
@@ -2250,7 +2284,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:
@@ -2391,7 +2425,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.
@@ -2425,7 +2459,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.
@@ -2491,7 +2525,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.
@@ -2507,7 +2541,7 @@ class AppClient:
 
         ::
 
-            id, key = await cloud.rotate_key("key-id")
+            key, id = await cloud.rotate_key("key-id")
 
         Args:
             id (str): The ID of the key to be rotated.
@@ -2520,3 +2554,143 @@ class AppClient:
         request = RotateKeyRequest(id=id)
         response: RotateKeyResponse = await self._app_client.RotateKey(request, metadata=self._metadata)
         return response.key, response.id
+
+    async def get_organization_metadata(self, org_id: str) -> Mapping[str, Any]:
+        """Get an organization's user-defined metadata.
+
+        ::
+
+            metadata = await cloud.get_organization_metadata(org_id="<YOUR-ORG-ID>")
+
+        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 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, metadata=self._metadata)
+        return struct_to_dict(response.data)
+
+    async def update_organization_metadata(self, org_id: str, metadata: Mapping[str, Any]) -> None:
+        """Update an organization's user-defined metadata.
+
+        ::
+
+             await cloud.update_organization_metadata(org_id="<YOUR-ORG-ID>", metadata={
+                 "TEST_API_KEY": "ABC123",
+             })
+
+        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 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, metadata=self._metadata)
+
+    async def get_location_metadata(self, location_id: str) -> Mapping[str, Any]:
+        """Get a location's user-defined metadata.
+
+        ::
+
+            metadata = await cloud.get_location_metadata(location_id="<YOUR-LOCATION-ID>")
+
+        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 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, metadata=self._metadata)
+        return struct_to_dict(response.data)
+
+    async def update_location_metadata(self, location_id: str, metadata: Mapping[str, Any]) -> None:
+        """Update a location's user-defined metadata.
+
+        ::
+
+             await cloud.update_location_metadata(location_id="<YOUR-LOCATION-ID>", metadata={
+                 "TEST_API_KEY": "ABC123",
+             })
+
+        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 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, metadata=self._metadata)
+
+    async def get_robot_metadata(self, robot_id: str) -> Mapping[str, Any]:
+        """Get a robot's user-defined metadata.
+
+        ::
+
+            metadata = await cloud.get_robot_metadata(robot_id="<YOUR-ROBOT-ID>")
+
+        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 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, metadata=self._metadata)
+        return struct_to_dict(response.data)
+
+    async def update_robot_metadata(self, robot_id: str, metadata: Mapping[str, Any]) -> None:
+        """Update a robot's user-defined metadata.
+
+        ::
+
+             await cloud.update_robot_metadata(robot_id="<YOUR-ROBOT-ID>", metadata={
+                 "TEST_API_KEY": "ABC123",
+             })
+
+        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 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, 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.
+
+        ::
+
+            metadata = await cloud.get_robot_part_metadata(robot_part_id="<YOUR-ROBOT-PART-ID>")
+
+        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 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, 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:
+        """Update a robot part's user-defined metadata.
+
+        ::
+
+             await cloud.update_robot_part_metadata(robot_part_id="<YOUR-ROBOT-PART-ID>", metadata={
+                 "TEST_API_KEY": "ABC123",
+             })
+
+        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 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, metadata=self._metadata)