Private
clientReadonly
methods: { Readonly
addfrom rpc viam.app.v1.AppService.AddRole
Readonly
I: typeof AddRoleRequestReadonly
O: typeof AddRoleResponseReadonly
kind: UnaryReadonly
name: "AddRole"Readonly
changeChanges an IdentityAuthorization to a new IdentityAuthorization
from rpc viam.app.v1.AppService.ChangeRole
Readonly
I: typeof ChangeRoleRequestReadonly
O: typeof ChangeRoleResponseReadonly
kind: UnaryReadonly
name: "ChangeRole"Readonly
checkValidates a permission for the current user
from rpc viam.app.v1.AppService.CheckPermissions
Readonly
I: typeof CheckPermissionsRequestReadonly
O: typeof CheckPermissionsResponseReadonly
kind: UnaryReadonly
name: "CheckPermissions"Readonly
createCreates a fragment
from rpc viam.app.v1.AppService.CreateFragment
Readonly
I: typeof CreateFragmentRequestReadonly
O: typeof CreateFragmentResponseReadonly
kind: UnaryReadonly
name: "CreateFragment"Readonly
createfrom rpc viam.app.v1.AppService.CreateKey
Readonly
I: typeof CreateKeyRequestReadonly
O: typeof CreateKeyResponseReadonly
kind: UnaryReadonly
name: "CreateKey"Readonly
createfrom rpc viam.app.v1.AppService.CreateKeyFromExistingKeyAuthorizations
Readonly
I: typeof CreateKeyFromExistingKeyAuthorizationsRequestReadonly
O: typeof CreateKeyFromExistingKeyAuthorizationsResponseReadonly
kind: UnaryReadonly
name: "CreateKeyFromExistingKeyAuthorizations"Readonly
createCreate a location
from rpc viam.app.v1.AppService.CreateLocation
Readonly
I: typeof CreateLocationRequestReadonly
O: typeof CreateLocationResponseReadonly
kind: UnaryReadonly
name: "CreateLocation"Readonly
createCreate a new generated Secret in the Location.
from rpc viam.app.v1.AppService.CreateLocationSecret
Readonly
I: typeof CreateLocationSecretRequestReadonly
O: typeof CreateLocationSecretResponseReadonly
kind: UnaryReadonly
name: "CreateLocationSecret"Readonly
createfrom rpc viam.app.v1.AppService.CreateModule
Readonly
I: typeof CreateModuleRequestReadonly
O: typeof CreateModuleResponseReadonly
kind: UnaryReadonly
name: "CreateModule"Readonly
createCreate a new organization
from rpc viam.app.v1.AppService.CreateOrganization
Readonly
I: typeof CreateOrganizationRequestReadonly
O: typeof CreateOrganizationResponseReadonly
kind: UnaryReadonly
name: "CreateOrganization"Readonly
createCreate an organization invite to an organization
from rpc viam.app.v1.AppService.CreateOrganizationInvite
Readonly
I: typeof CreateOrganizationInviteRequestReadonly
O: typeof CreateOrganizationInviteResponseReadonly
kind: UnaryReadonly
name: "CreateOrganizationInvite"Readonly
createfrom rpc viam.app.v1.AppService.CreateRegistryItem
Readonly
I: typeof CreateRegistryItemRequestReadonly
O: typeof CreateRegistryItemResponseReadonly
kind: UnaryReadonly
name: "CreateRegistryItem"Readonly
createCreate a new generated Secret in the Robot Part.
from rpc viam.app.v1.AppService.CreateRobotPartSecret
Readonly
I: typeof CreateRobotPartSecretRequestReadonly
O: typeof CreateRobotPartSecretResponseReadonly
kind: UnaryReadonly
name: "CreateRobotPartSecret"Readonly
deleteDeletes a fragment
from rpc viam.app.v1.AppService.DeleteFragment
Readonly
I: typeof DeleteFragmentRequestReadonly
O: typeof DeleteFragmentResponseReadonly
kind: UnaryReadonly
name: "DeleteFragment"Readonly
deletefrom rpc viam.app.v1.AppService.DeleteKey
Readonly
I: typeof DeleteKeyRequestReadonly
O: typeof DeleteKeyResponseReadonly
kind: UnaryReadonly
name: "DeleteKey"Readonly
deleteDelete a location
from rpc viam.app.v1.AppService.DeleteLocation
Readonly
I: typeof DeleteLocationRequestReadonly
O: typeof DeleteLocationResponseReadonly
kind: UnaryReadonly
name: "DeleteLocation"Readonly
deleteDelete a Secret from the Location.
from rpc viam.app.v1.AppService.DeleteLocationSecret
Readonly
I: typeof DeleteLocationSecretRequestReadonly
O: typeof DeleteLocationSecretResponseReadonly
kind: UnaryReadonly
name: "DeleteLocationSecret"Readonly
deleteDelete an organization
from rpc viam.app.v1.AppService.DeleteOrganization
Readonly
I: typeof DeleteOrganizationRequestReadonly
O: typeof DeleteOrganizationResponseReadonly
kind: UnaryReadonly
name: "DeleteOrganization"Readonly
deleteDelete an organization invite
from rpc viam.app.v1.AppService.DeleteOrganizationInvite
Readonly
I: typeof DeleteOrganizationInviteRequestReadonly
O: typeof DeleteOrganizationInviteResponseReadonly
kind: UnaryReadonly
name: "DeleteOrganizationInvite"Readonly
deleteDelete an organization member from an organization
from rpc viam.app.v1.AppService.DeleteOrganizationMember
Readonly
I: typeof DeleteOrganizationMemberRequestReadonly
O: typeof DeleteOrganizationMemberResponseReadonly
kind: UnaryReadonly
name: "DeleteOrganizationMember"Readonly
deletefrom rpc viam.app.v1.AppService.DeleteRegistryItem
Readonly
I: typeof DeleteRegistryItemRequestReadonly
O: typeof DeleteRegistryItemResponseReadonly
kind: UnaryReadonly
name: "DeleteRegistryItem"Readonly
deleteDeleteRobot deletes a robot
from rpc viam.app.v1.AppService.DeleteRobot
Readonly
I: typeof DeleteRobotRequestReadonly
O: typeof DeleteRobotResponseReadonly
kind: UnaryReadonly
name: "DeleteRobot"Readonly
deleteDelete a robot part
from rpc viam.app.v1.AppService.DeleteRobotPart
Readonly
I: typeof DeleteRobotPartRequestReadonly
O: typeof DeleteRobotPartResponseReadonly
kind: UnaryReadonly
name: "DeleteRobotPart"Readonly
deleteDelete a Secret from the RobotPart.
from rpc viam.app.v1.AppService.DeleteRobotPartSecret
Readonly
I: typeof DeleteRobotPartSecretRequestReadonly
O: typeof DeleteRobotPartSecretResponseReadonly
kind: UnaryReadonly
name: "DeleteRobotPartSecret"Readonly
disablefrom rpc viam.app.v1.AppService.DisableBillingService
Readonly
I: typeof DisableBillingServiceRequestReadonly
O: typeof DisableBillingServiceResponseReadonly
kind: UnaryReadonly
name: "DisableBillingService"Readonly
enablefrom rpc viam.app.v1.AppService.EnableBillingService
Readonly
I: typeof EnableBillingServiceRequestReadonly
O: typeof EnableBillingServiceResponseReadonly
kind: UnaryReadonly
name: "EnableBillingService"Readonly
getGets a single fragment
from rpc viam.app.v1.AppService.GetFragment
Readonly
I: typeof GetFragmentRequestReadonly
O: typeof GetFragmentResponseReadonly
kind: UnaryReadonly
name: "GetFragment"Readonly
getGets fragment history
from rpc viam.app.v1.AppService.GetFragmentHistory
Readonly
I: typeof GetFragmentHistoryRequestReadonly
O: typeof GetFragmentHistoryResponseReadonly
kind: UnaryReadonly
name: "GetFragmentHistory"Readonly
getGet a location
from rpc viam.app.v1.AppService.GetLocation
Readonly
I: typeof appApi.GetLocationRequestReadonly
O: typeof appApi.GetLocationResponseReadonly
kind: UnaryReadonly
name: "GetLocation"Readonly
getfrom rpc viam.app.v1.AppService.GetModule
Readonly
I: typeof GetModuleRequestReadonly
O: typeof GetModuleResponseReadonly
kind: UnaryReadonly
name: "GetModule"Readonly
getGet an organization
from rpc viam.app.v1.AppService.GetOrganization
Readonly
I: typeof GetOrganizationRequestReadonly
O: typeof GetOrganizationResponseReadonly
kind: UnaryReadonly
name: "GetOrganization"Readonly
getChecks for namespace availablity throughout all orgs.
from rpc viam.app.v1.AppService.GetOrganizationNamespaceAvailability
Readonly
I: typeof GetOrganizationNamespaceAvailabilityRequestReadonly
O: typeof GetOrganizationNamespaceAvailabilityResponseReadonly
kind: UnaryReadonly
name: "GetOrganizationNamespaceAvailability"Readonly
getGet all organizations that have access to a location.
from rpc viam.app.v1.AppService.GetOrganizationsWithAccessToLocation
Readonly
I: typeof GetOrganizationsWithAccessToLocationRequestReadonly
O: typeof GetOrganizationsWithAccessToLocationResponseReadonly
kind: UnaryReadonly
name: "GetOrganizationsWithAccessToLocation"Readonly
getfrom rpc viam.app.v1.AppService.GetRegistryItem
Readonly
I: typeof GetRegistryItemRequestReadonly
O: typeof GetRegistryItemResponseReadonly
kind: UnaryReadonly
name: "GetRegistryItem"Readonly
getGet a specific robot by ID
from rpc viam.app.v1.AppService.GetRobot
Readonly
I: typeof GetRobotRequestReadonly
O: typeof GetRobotResponseReadonly
kind: UnaryReadonly
name: "GetRobot"Readonly
getGets the Robot API Keys for the robot
from rpc viam.app.v1.AppService.GetRobotAPIKeys
Readonly
I: typeof GetRobotAPIKeysRequestReadonly
O: typeof GetRobotAPIKeysResponseReadonly
kind: UnaryReadonly
name: "GetRobotAPIKeys"Readonly
getGet a specific robot part by ID
from rpc viam.app.v1.AppService.GetRobotPart
Readonly
I: typeof GetRobotPartRequestReadonly
O: typeof GetRobotPartResponseReadonly
kind: UnaryReadonly
name: "GetRobotPart"Readonly
getGet a specific robot part histy by ID
from rpc viam.app.v1.AppService.GetRobotPartHistory
Readonly
I: typeof GetRobotPartHistoryRequestReadonly
O: typeof GetRobotPartHistoryResponseReadonly
kind: UnaryReadonly
name: "GetRobotPartHistory"Readonly
getfrom rpc viam.app.v1.AppService.GetRobotPartLogs
Readonly
I: typeof GetRobotPartLogsRequestReadonly
O: typeof GetRobotPartLogsResponseReadonly
kind: UnaryReadonly
name: "GetRobotPartLogs"Readonly
getfrom rpc viam.app.v1.AppService.GetRobotParts
Readonly
I: typeof GetRobotPartsRequestReadonly
O: typeof GetRobotPartsResponseReadonly
kind: UnaryReadonly
name: "GetRobotParts"Readonly
getGet Rover Rental Location Robots
from rpc viam.app.v1.AppService.GetRoverRentalRobots
Readonly
I: typeof GetRoverRentalRobotsRequestReadonly
O: typeof GetRoverRentalRobotsResponseReadonly
kind: UnaryReadonly
name: "GetRoverRentalRobots"Readonly
getGet the id of the user with the email
from rpc viam.app.v1.AppService.GetUserIDByEmail
Readonly
I: typeof GetUserIDByEmailRequestReadonly
O: typeof GetUserIDByEmailResponseReadonly
kind: UnaryReadonly
name: "GetUserIDByEmail"Readonly
listReturns all authorization roles for a given resource
from rpc viam.app.v1.AppService.ListAuthorizations
Readonly
I: typeof ListAuthorizationsRequestReadonly
O: typeof ListAuthorizationsResponseReadonly
kind: UnaryReadonly
name: "ListAuthorizations"Readonly
listGets a list of fragments
from rpc viam.app.v1.AppService.ListFragments
Readonly
I: typeof ListFragmentsRequestReadonly
O: typeof ListFragmentsResponseReadonly
kind: UnaryReadonly
name: "ListFragments"Readonly
listfrom rpc viam.app.v1.AppService.ListKeys
Readonly
I: typeof ListKeysRequestReadonly
O: typeof ListKeysResponseReadonly
kind: UnaryReadonly
name: "ListKeys"Readonly
listGet a list of locations
from rpc viam.app.v1.AppService.ListLocations
Readonly
I: typeof ListLocationsRequestReadonly
O: typeof ListLocationsResponseReadonly
kind: UnaryReadonly
name: "ListLocations"Readonly
listGets top level and nested fragments for a machine, as well as any other specified fragment ids
from rpc viam.app.v1.AppService.ListMachineFragments
Readonly
I: typeof ListMachineFragmentsRequestReadonly
O: typeof ListMachineFragmentsResponseReadonly
kind: UnaryReadonly
name: "ListMachineFragments"Readonly
listfrom rpc viam.app.v1.AppService.ListModules
Readonly
I: typeof ListModulesRequestReadonly
O: typeof ListModulesResponseReadonly
kind: UnaryReadonly
name: "ListModules"Readonly
listList all members of an organization and all invited members to the organization.
from rpc viam.app.v1.AppService.ListOrganizationMembers
Readonly
I: typeof ListOrganizationMembersRequestReadonly
O: typeof ListOrganizationMembersResponseReadonly
kind: UnaryReadonly
name: "ListOrganizationMembers"Readonly
listList organizations
from rpc viam.app.v1.AppService.ListOrganizations
Readonly
I: typeof ListOrganizationsRequestReadonly
O: typeof ListOrganizationsResponseReadonly
kind: UnaryReadonly
name: "ListOrganizations"Readonly
listList the organizations a user belongs to
from rpc viam.app.v1.AppService.ListOrganizationsByUser
Readonly
I: typeof ListOrganizationsByUserRequestReadonly
O: typeof ListOrganizationsByUserResponseReadonly
kind: UnaryReadonly
name: "ListOrganizationsByUser"Readonly
listfrom rpc viam.app.v1.AppService.ListRegistryItems
Readonly
I: typeof ListRegistryItemsRequestReadonly
O: typeof ListRegistryItemsResponseReadonly
kind: UnaryReadonly
name: "ListRegistryItems"Readonly
listGet a list of robots
from rpc viam.app.v1.AppService.ListRobots
Readonly
I: typeof ListRobotsRequestReadonly
O: typeof ListRobotsResponseReadonly
kind: UnaryReadonly
name: "ListRobots"Readonly
locationGet a location's authorization secrets
from rpc viam.app.v1.AppService.LocationAuth
Readonly
I: typeof LocationAuthRequestReadonly
O: typeof LocationAuthResponseReadonly
kind: UnaryReadonly
name: "LocationAuth"Readonly
markMarks the given part as the main part, and all the others as not
from rpc viam.app.v1.AppService.MarkPartAsMain
Readonly
I: typeof MarkPartAsMainRequestReadonly
O: typeof MarkPartAsMainResponseReadonly
kind: UnaryReadonly
name: "MarkPartAsMain"Readonly
markMarks part for restart. Once the robot part checks-in with the app the flag is reset on the robot part. Calling this multiple times before a robot part checks-in has no affect. Note: This API may be removed in the near future. TODO(APP-388): Remove
from rpc viam.app.v1.AppService.MarkPartForRestart
Readonly
I: typeof MarkPartForRestartRequestReadonly
O: typeof MarkPartForRestartResponseReadonly
kind: UnaryReadonly
name: "MarkPartForRestart"Readonly
newNewRobot creates a new robot
from rpc viam.app.v1.AppService.NewRobot
Readonly
I: typeof NewRobotRequestReadonly
O: typeof NewRobotResponseReadonly
kind: UnaryReadonly
name: "NewRobot"Readonly
newCreate a new robot part
from rpc viam.app.v1.AppService.NewRobotPart
Readonly
I: typeof NewRobotPartRequestReadonly
O: typeof NewRobotPartResponseReadonly
kind: UnaryReadonly
name: "NewRobotPart"Readonly
organizationfrom rpc viam.app.v1.AppService.OrganizationGetSupportEmail
Readonly
I: typeof OrganizationGetSupportEmailRequestReadonly
O: typeof OrganizationGetSupportEmailResponseReadonly
kind: UnaryReadonly
name: "OrganizationGetSupportEmail"Readonly
organizationfrom rpc viam.app.v1.AppService.OrganizationSetSupportEmail
Readonly
I: typeof OrganizationSetSupportEmailRequestReadonly
O: typeof OrganizationSetSupportEmailResponseReadonly
kind: UnaryReadonly
name: "OrganizationSetSupportEmail"Readonly
removeDeletes an IdentityAuthorization
from rpc viam.app.v1.AppService.RemoveRole
Readonly
I: typeof RemoveRoleRequestReadonly
O: typeof RemoveRoleResponseReadonly
kind: UnaryReadonly
name: "RemoveRole"Readonly
renamefrom rpc viam.app.v1.AppService.RenameKey
Readonly
I: typeof RenameKeyRequestReadonly
O: typeof RenameKeyResponseReadonly
kind: UnaryReadonly
name: "RenameKey"Readonly
resendResend an organization invite
from rpc viam.app.v1.AppService.ResendOrganizationInvite
Readonly
I: typeof ResendOrganizationInviteRequestReadonly
O: typeof ResendOrganizationInviteResponseReadonly
kind: UnaryReadonly
name: "ResendOrganizationInvite"Readonly
rotatefrom rpc viam.app.v1.AppService.RotateKey
Readonly
I: typeof RotateKeyRequestReadonly
O: typeof RotateKeyResponseReadonly
kind: UnaryReadonly
name: "RotateKey"Readonly
shareShare a location with an organization
from rpc viam.app.v1.AppService.ShareLocation
Readonly
I: typeof ShareLocationRequestReadonly
O: typeof ShareLocationResponseReadonly
kind: UnaryReadonly
name: "ShareLocation"Readonly
tailfrom rpc viam.app.v1.AppService.TailRobotPartLogs
Readonly
I: typeof TailRobotPartLogsRequestReadonly
O: typeof TailRobotPartLogsResponseReadonly
kind: ServerStreamingReadonly
name: "TailRobotPartLogs"Readonly
transferfrom rpc viam.app.v1.AppService.TransferRegistryItem
Readonly
I: typeof TransferRegistryItemRequestReadonly
O: typeof TransferRegistryItemResponseReadonly
kind: UnaryReadonly
name: "TransferRegistryItem"Readonly
unshareStop sharing a location with an organization
from rpc viam.app.v1.AppService.UnshareLocation
Readonly
I: typeof UnshareLocationRequestReadonly
O: typeof UnshareLocationResponseReadonly
kind: UnaryReadonly
name: "UnshareLocation"Readonly
updatefrom rpc viam.app.v1.AppService.UpdateBillingService
Readonly
I: typeof UpdateBillingServiceRequestReadonly
O: typeof UpdateBillingServiceResponseReadonly
kind: UnaryReadonly
name: "UpdateBillingService"Readonly
updateUpdates a fragment
from rpc viam.app.v1.AppService.UpdateFragment
Readonly
I: typeof UpdateFragmentRequestReadonly
O: typeof UpdateFragmentResponseReadonly
kind: UnaryReadonly
name: "UpdateFragment"Readonly
updateUpdate a location
from rpc viam.app.v1.AppService.UpdateLocation
Readonly
I: typeof UpdateLocationRequestReadonly
O: typeof UpdateLocationResponseReadonly
kind: UnaryReadonly
name: "UpdateLocation"Readonly
updatefrom rpc viam.app.v1.AppService.UpdateModule
Readonly
I: typeof UpdateModuleRequestReadonly
O: typeof UpdateModuleResponseReadonly
kind: UnaryReadonly
name: "UpdateModule"Readonly
updateUpdate an organization
from rpc viam.app.v1.AppService.UpdateOrganization
Readonly
I: typeof UpdateOrganizationRequestReadonly
O: typeof UpdateOrganizationResponseReadonly
kind: UnaryReadonly
name: "UpdateOrganization"Readonly
updateUpdate the authorizations attached to an organization invite
from rpc viam.app.v1.AppService.UpdateOrganizationInviteAuthorizations
Readonly
I: typeof UpdateOrganizationInviteAuthorizationsRequestReadonly
O: typeof UpdateOrganizationInviteAuthorizationsResponseReadonly
kind: UnaryReadonly
name: "UpdateOrganizationInviteAuthorizations"Readonly
updatefrom rpc viam.app.v1.AppService.UpdateRegistryItem
Readonly
I: typeof UpdateRegistryItemRequestReadonly
O: typeof UpdateRegistryItemResponseReadonly
kind: UnaryReadonly
name: "UpdateRegistryItem"Readonly
updateUpdateRobot updates a robot
from rpc viam.app.v1.AppService.UpdateRobot
Readonly
I: typeof UpdateRobotRequestReadonly
O: typeof UpdateRobotResponseReadonly
kind: UnaryReadonly
name: "UpdateRobot"Readonly
updateUpdate a robot
from rpc viam.app.v1.AppService.UpdateRobotPart
Readonly
I: typeof UpdateRobotPartRequestReadonly
O: typeof UpdateRobotPartResponseReadonly
kind: UnaryReadonly
name: "UpdateRobotPart"Readonly
uploadfrom rpc viam.app.v1.AppService.UploadModuleFile
Readonly
I: typeof UploadModuleFileRequestReadonly
O: typeof UploadModuleFileResponseReadonly
kind: ClientStreamingReadonly
name: "UploadModuleFile"Readonly
typeAdd a role under an organization.
The ID of the organization to create the role under
The ID of the entity the role belongs to (e.g., a user ID)
The role to add ("owner" or "operator")
The type of resource to create the role for ("robot", "location", or "organization")
The ID of the resource the role is being created for
Changes an existing role.
Checks whether requested permissions exist.
A list of permissions to check
A filtered list of the authorized permissions
Creates a new fragment.
The ID of the organization to create the fragment under
The name of the new fragment
The new fragment's config
The newly created fragment
Creates a new API key.
The list of authorizations to provide for the API key
Optional
name: stringAn optional name for the key. If none is passed, defaults to present timestamp
The new key and ID
Creates a new key with an existing key's authorizations
The ID of the key to duplicate
The new key and ID
Creates a new location.
The ID of the organization to create the location under
The name of the location to create
Optional
parentLocationId: stringOptional name of a parent location to create the new location under
The location object
Create a location secret (LocationAuth
).
The ID of the location to create a LocationAuth
for
The newly created LocationAuth
Creates a new module.
The ID of the organization to create the module under
The name of the module
The module ID and a URL to its detail page
Create a new organization.
The name of the new organization
The new organization
Creates a new invitation to join an organization.
The id of the organization to create the invite for
The email address of the user to generate an invite for
The authorizations to associate with the new invite
Bool of whether to send an email invite (true) or automatically add a user. Defaults to true
The organization invite
Create a new registry item.
The ID of the organization to create the registry item under
The name of the registry item
The type of the item in the registry.
Deletes an existing API key.
The ID of the key to delete
Get details about an organization.
The ID of the organization
Details about the organization, if it exists
List all organizations with access to a particular location.
The ID of the location to query
The list of locations with access to the requested location
Get an item from the registry.
The ID of the item to get
The requested item
Gets a list of a robot's API keys.
The ID of the robot to get API keys for
A list of the robot's API keys
Queries a specific robot part by ID.
The ID of the requested robot part
The robot part and a its json config
Get a list containing the history of a robot part.
The ID of the requested robot part
The list of the robot part's history
Get a page of log entries for a specific robot part. Logs are sorted by descending time (newest first).
The ID of the requested robot part
Optional
filter: stringOptional string to filter logs on
Optional
levels: string[]Optional array of log levels to return. Defaults to returning all log levels
Optional string indicating which page of logs to query. Defaults to the most recent
The robot requested logs and the page token for the next page of logs
Returns a list of rover rental robots for an organization.
The ID of the organization to query
The list of RoverRentalRobot
objects
List all authorizations for an organization.
The ID of the organization to list authorizations for
Optional
resourceIds: string[]Optional list of IDs of resources to list authorizations for. If not provided, all resources will be included
The list of authorizations
Lists all fragments within an organization.
The ID of the organization to list fragments for
Optional, deprecated boolean. Use fragmentVisibilities instead. If true then only public fragments will be listed. Defaults to true
The list of fragment objects
List all API keys for an organization.
The ID of the organization to query
The list of API keys
The machine ID used to filter fragments defined in a machine's parts. Also returns any fragments nested within the fragments defined in parts.
Optional
additionalFragmentIds: string[]Additional fragment IDs to append to the response. Useful when needing to view fragments that will be provisionally added to the machine alongside existing fragments.
The list of top level and nested fragments for a machine, as well as additionally specified fragment IDs.
Lists organization memebers and outstanding invites.
The id of the organization to query
An object containing organization members, pending invites, and org ID
List all organizations.
The organization list
List all organizations associated with a user.
The ID of the user to query
The list of locations the requested user has access to
List all registry items for an organization.
The ID of the organization to query registry items for
A list of types to query. If empty, will not filter on type
A list of visibilities to query for. If empty, will not filter on visibility
A list of platforms to query for. If empty, will not filter on platform
A list of statuses to query for. If empty, will not filter on status
Optional
searchTerm: stringOptional search term to filter on
Optional
pageToken: stringOptional page token for results. If not provided, will return all results
The list of registry items
Get a location's LocationAuth
(location secret(s)).
The ID of the location to retrieve LocationAuth
from.
The LocationAuth
for the requested location.
Removes a role from an organization.
The ID of the organization to remove the role from
The ID of the entity the role belongs to (e.g., a user ID)
The role to remove ("owner" or "operator")
The type of resource to remove the role from ("robot", "location", or "organization")
The ID of the resource the role is being removes from
Resends a pending organization invite.
The ID of the organization
The email associated with the invite to resend
The invite
Rotates an existing API key.
The ID of the key to rotate
The updated key and ID
Get a stream of log entries for a specific robot part. Logs are sorted by descending time (newest first).
The ID of the requested robot part
A queue to put the log entries into
Optional
filter: stringOptional string to filter logs on
Optional bool to indicate whether or not only error-level logs should be returned. Defaults to true
Updates an existing fragment.
The ID of the fragment to update
The name to update the fragment to
The config to update the fragment to
Optional
makePublic: booleanOptional, deprecated boolean specifying whether the fragment should be public or not. If not passed, the visibility will be unchanged. Fragments are private by default when created
Optional
visibility: FragmentVisibilityOptional FragmentVisibility specifying the updated fragment visibility. If not passed, the visibility will be unchanged. If visibility is not set and makePublic is set, makePublic takes effect. If makePublic and visibility are set, they must not be conflicting. If neither is set, the fragment visibility will remain unchanged.
The updated fragment
Updates location details.
The ID of the location to update
Optional
name: stringOptional string to update the location's name to
Optional
parentLocId: stringOptional string to update the location's parent location to
Optional
region: stringOptional string to update the location's region to
The location object
Updates an existing module.
The ID of the module to update
The visibility to set for the module
The url to reference for documentation, code, etc.
A short description of the module
A list of models available in the module
The executable to run to start the module program
The module URL
Updates organization details.
The id of the organization to update
Optional
name: stringOptional name to update the organization with
Optional
publicNamespace: stringOptional namespace to update the organization with
Optional
region: stringOptional region to update the organization with
Optional
cid: stringOptional CRM ID to update the organization with
The updated organization details
Updates authorizations for an existing org invite.
The id of the organization
The email address associated with the invite
List of authorizations to add to the invite
List of authorizations to remove from the invite
The organization invite
Update an existing registry item.
The ID of the registry item to update
The PackageType to update the item to
A description of the item
A visibility value to update to
Updates an existing robot's name and/or location.
The ID of the robot to update
The ID of the location to move the robot to
The name to update the robot to
The newly-modified robot object
Updates a robot part based on its ID.
The ID of the requested robot part
The new name of the robot part
The new config for the robot part
The updated robot part
Generated using TypeDoc
Creates an IdentityAuthorization