Class AppClient

Index

Constructors

Methods

addRole changeRole checkPermissions createFragment createKey createKeyFromExistingKeyAuthorizations createLocation createLocationSecret createModule createOrganization createOrganizationInvite createRegistryItem createRobotPartSecret deleteFragment deleteKey deleteLocation deleteLocationSecret deleteOrganization deleteOrganizationInvite deleteOrganizationMember deleteRegistryItem deleteRobot deleteRobotPart deleteRobotPartSecret getAppContent getFragment getLocation getLocationMetadata getModule getOrganization getOrganizationMetadata getOrganizationNamespaceAvailability getOrganizationsWithAccessToLocation getRegistryItem getRobot getRobotAPIKeys getRobotMetadata getRobotPart getRobotPartHistory getRobotPartLogs getRobotPartMetadata getRobotParts getRoverRentalRobots getUserIDByEmail listAuthorizations listFragments listKeys listLocations listMachineFragments listModules listOrganizationMembers listOrganizations listOrganizationsByUser listRegistryItems listRobots locationAuth markPartAsMain markPartForRestart newRobot newRobotPart removeRole resendOrganizationInvite rotateKey shareLocation tailRobotPartLogs unshareLocation updateFragment updateLocation updateLocationMetadata updateModule updateOrganization updateOrganizationInviteAuthorizations updateOrganizationMetadata updateRegistryItem updateRobot updateRobotMetadata updateRobotPart updateRobotPartMetadata

Constructors

constructor

new AppClient(transport: Transport): AppClient
Parameters
- transport: Transport
Returns AppClient

Methods

addRole

addRole(
    organizationId: string,
    entityId: string,
    role: string,
    resourceType: string,
    resourceId: string,
): Promise<void>
Add a role under an organization.
Parameters
- organizationId: string
  The ID of the organization to create the role under
- entityId: string
  The ID of the entity the role belongs to (for example a user ID)
- role: string
  The role to add ("owner" or "operator")
- resourceType: string
  The type of resource to create the role for ("robot", "location", or "organization")
- resourceId: string
  The ID of the resource the role is being created for
Returns Promise<void>
Example
```
await appClient.addRole(
  '<YOUR-ORGANIZATION-ID>',
  '<YOUR-USER-ID>',
  'owner',
  'robot',
  '<YOUR-ROBOT-ID>'
);
```
For more information, see App API.

changeRole

changeRole(
oldAuthorization: Authorization,
newAuthorization: Authorization,
): Promise<void>

Changes an existing role.

Parameters

oldAuthorization: Authorization
The existing authorization
newAuthorization: Authorization
The new authorization to change to

Returns Promise<void>

Example

const oldAuth = new VIAM.appApi.Authorization({
  authorizationType: 'role',
  authorizationId: 'organization_owner',
  organizationId: '<YOUR-ORGANIZATION-ID>',
  resourceId: '<YOUR-RESOURCE-ID>', // The resource to grant access to
  resourceType: 'organization', // The type of resource to grant access to
  identityId: '<USER-ID>', // The user id of the user to grant access to (optional)
  roleId: 'owner', // The role to grant access to
  identityType: 'user',
});
const newAuth = new VIAM.appApi.Authorization({
  authorizationType: 'role',
  authorizationId: 'organization_operator',
  organizationId: '<YOUR-ORGANIZATION-ID>',
  resourceId: '<YOUR-RESOURCE-ID>', // The resource to grant access to
  resourceType: 'organization', // The type of resource to grant access To
  identityId: '<USER-ID>', // The user id of the user to grant access to (optional)
  roleId: 'operator', // The role to grant access to
  identityType: 'user',
});
await appClient.changeRole(oldAuth, newAuth);

For more information, see App API.

checkPermissions

checkPermissions(
permissions: AuthorizedPermissions[],
): Promise<AuthorizedPermissions[]>
Checks whether requested permissions exist.

For more information, see App API.
Parameters
- permissions: AuthorizedPermissions[]
  A list of permissions to check
Returns Promise<AuthorizedPermissions[]>
A filtered list of the authorized permissions

createFragment

createFragment(
    organizationId: string,
    name: string,
    config: Struct,
): Promise<undefined | Fragment>
Creates a new fragment.
Parameters
- organizationId: string
  The ID of the organization to create the fragment under
- name: string
  The name of the new fragment
- config: Struct
  The new fragment's config
Returns Promise<undefined | Fragment>
The newly created fragment
Example
```
const fragment = await appClient.createFragment(
  '<YOUR-ORGANIZATION-ID>',
  'newFragment'
);
```
For more information, see App API.

createKey

createKey(
authorizations: Authorization[],
name?: string,
): Promise<CreateKeyResponse>
Creates a new API key.

For more information, see App API.
Parameters
- authorizations: Authorization[]
  The list of authorizations to provide for the API key
- Optionalname: string
  An optional name for the key. If none is passed, defaults to present timestamp
Returns Promise<CreateKeyResponse>
The new key and ID

createKeyFromExistingKeyAuthorizations

createKeyFromExistingKeyAuthorizations(
id: string,
): Promise<CreateKeyFromExistingKeyAuthorizationsResponse>
Creates a new key with an existing key's authorizations
Parameters
- id: string
  The ID of the key to duplicate
Returns Promise<CreateKeyFromExistingKeyAuthorizationsResponse>
The new key and ID
Example
```
const key =
  await appClient.createKeyFromExistingKeyAuthorizations(
    '<YOUR-KEY-ID>'
  );
```
For more information, see App API.

createLocation

createLocation(
    organizationId: string,
    name: string,
    parentLocationId?: string,
): Promise<undefined | Location>
Creates a new location.
Parameters
- organizationId: string
  The ID of the organization to create the location under
- name: string
  The name of the location to create
- OptionalparentLocationId: string
  Optional name of a parent location to create the new location under
Returns Promise<undefined | Location>
The location object
Example
```
const location = await appClient.createLocation(
  '<YOUR-ORGANIZATION-ID>',
  'name'
);
```
For more information, see App API.

createLocationSecret

createLocationSecret(locId: string): Promise<undefined | LocationAuth>
Create a location secret (LocationAuth).
Parameters
- locId: string
  The ID of the location to create a LocationAuth for
Returns Promise<undefined | LocationAuth>
The newly created LocationAuth
Example
```
const locationAuth = await appClient.createLocationSecret(
  '<YOUR-LOCATION-ID>'
);
```
For more information, see App API.

createModule

createModule(
organizationId: string,
name: string,
): Promise<CreateModuleResponse>
Creates a new module.
Parameters
- organizationId: string
  The ID of the organization to create the module under
- name: string
  The name of the module
Returns Promise<CreateModuleResponse>
The module ID and a URL to its detail page
Example
```
const module = await appClient.createModule(
  '<YOUR-ORGANIZATION-ID>',
  'newModule'
);
```
For more information, see App API.

createOrganization

createOrganization(name: string): Promise<undefined | Organization>
Create a new organization.

For more information, see App API.
Parameters
- name: string
  The name of the new organization
Returns Promise<undefined | Organization>
The new organization

createOrganizationInvite

createOrganizationInvite(
    organizationId: string,
    email: string,
    authorizations: Authorization[],
    sendEmailInvite?: boolean,
): Promise<undefined | OrganizationInvite>
Creates a new invitation to join an organization.
Parameters
- organizationId: string
  The id of the organization to create the invite for
- email: string
  The email address of the user to generate an invite for
- authorizations: Authorization[]
  The authorizations to associate with the new invite
- sendEmailInvite: boolean = true
  Bool of whether to send an email invite (true) or automatically add a user. Defaults to true
Returns Promise<undefined | OrganizationInvite>
The organization invite
Example
```
const auth = new VIAM.appApi.Authorization({
  authorizationType: 'role',
  authorizationId: 'organization_operator',
  organizationId: '<YOUR-ORGANIZATION-ID>',
  resourceId: '<YOUR-RESOURCE-ID>', // The resource to grant access to
  resourceType: 'organization', // The type of resource to grant access to
  identityId: '<YOUR-USER-ID>', // The user id of the user to grant access to (optional)
  roleId: 'owner', // The role to grant access to
  identityType: 'user',
});

const invite = await appClient.createOrganizationInvite(
  '<YOUR-ORGANIZATION-ID>',
  'youremail@email.com',
  [auth]
);
```
For more information, see App API.

createRegistryItem

createRegistryItem(
    organizationId: string,
    name: string,
    type: PackageType,
): Promise<void>
Create a new registry item.
Parameters
- organizationId: string
  The ID of the organization to create the registry item under
- name: string
  The name of the registry item
- type: PackageType
  The type of the item in the registry.
Returns Promise<void>
Example
```
await appClient.createRegistryItem(
  '<YOUR-ORGANIZATION-ID>',
  'newRegistryItemName',
  5
);
```
For more information, see App API.

createRobotPartSecret

createRobotPartSecret(partId: string): Promise<undefined | RobotPart>
Creates a new secret for a robot part.
Parameters
- partId: string
  The ID of the part to create a secret for
Returns Promise<undefined | RobotPart>
The robot part object
Example
```
const robotPart = await appClient.createRobotPartSecret(
  '<YOUR-ROBOT-PART-ID>'
);
```
For more information, see App API.

deleteFragment

deleteFragment(id: string): Promise<void>
Deletes a fragment.
Parameters
- id: string
  The ID of the fragment to delete
Returns Promise<void>
Example
```
await appClient.deleteFragment('12a12ab1-1234-5678-abcd-abcd01234567');
```
For more information, see App API.

deleteKey

deleteKey(id: string): Promise<DeleteKeyResponse>
Deletes an existing API key.
Parameters
- id: string
  The ID of the key to delete
Returns Promise<DeleteKeyResponse>
Example
```
await appClient.deleteKey('<YOUR-KEY-ID>');
```
For more information, see App API.

deleteLocation

deleteLocation(locId: string): Promise<void>
Deletes a location
Parameters
- locId: string
  The ID of the location to delete
Returns Promise<void>
Example
```
await appClient.deleteLocation('<YOUR-LOCATION-ID>');
```
For more information, see App API.

deleteLocationSecret

deleteLocationSecret(locId: string, secretId: string): Promise<void>
Deletes a location secret (LocationAuth).
Parameters
- locId: string
  The ID of the location to delete the LocationAuth from
- secretId: string
  The ID of the location secret to delete
Returns Promise<void>
Example
```
await appClient.deleteLocationSecret(
  '<YOUR-LOCATION-ID>',
  '<YOUR-SECRET-ID>'
);
```
For more information, see App API.

deleteOrganization

deleteOrganization(organizationId: string): Promise<void>
Deletes an organization.
Parameters
- organizationId: string
  The id of the organization to delete
Returns Promise<void>
Example
```
await appClient.deleteOrganization('<YOUR-ORGANIZATION-ID>');
```
For more information, see App API.

deleteOrganizationInvite

deleteOrganizationInvite(organizationId: string, email: string): Promise<void>
Deletes a pending organization invite.
Parameters
- organizationId: string
  The ID of the organization
- email: string
  The email associated with the invite to delete
Returns Promise<void>
Example
```
await appClient.deleteOrganizationInvite(
  '<YOUR-ORGANIZATION-ID>',
  'youremail@email.com'
);
```
For more information, see App API.

deleteOrganizationMember

deleteOrganizationMember(organizationId: string, userId: string): Promise<void>
Removes a member from an organization.
Parameters
- organizationId: string
  The ID of the organization
- userId: string
  The ID of the user
Returns Promise<void>
Example
```
await appClient.deleteOrganizationMember(
  '<YOUR-ORGANIZATION-ID>',
  '<YOUR-USER-ID>'
);
```
For more information, see App API.

deleteRegistryItem

deleteRegistryItem(itemId: string): Promise<void>
Deletes a registry item.
Parameters
- itemId: string
  The ID of the item to delete
Returns Promise<void>
Example
```
await appClient.deleteRegistryItem('<YOUR-REGISTRY-ITEM-ID>');
```
For more information, see App API.

deleteRobot

deleteRobot(id: string): Promise<void>
Deletes a robot.
Parameters
- id: string
  The ID of the robot to delete
Returns Promise<void>
Example
```
await appClient.deleteRobot('<YOUR-ROBOT-ID>');
```
For more information, see App API.

deleteRobotPart

deleteRobotPart(partId: string): Promise<void>
Deletes a robot part.
Parameters
- partId: string
  The ID of the part to delete
Returns Promise<void>
Example
```
await appClient.deleteRobotPart('<YOUR-ROBOT-PART-ID>');
```
For more information, see App API.

deleteRobotPartSecret

deleteRobotPartSecret(partId: string, secretId: string): Promise<void>
Deletes a robot secret from a robot part.
Parameters
- partId: string
  The ID of the part to delete a secret from
- secretId: string
  The ID of the secret to delete
Returns Promise<void>
Example
```
await appClient.deleteRobotPartSecret(
  '<YOUR-ROBOT-PART-ID>',
  '<YOUR-SECRET-ID>'
);
```
For more information, see App API.

getAppContent

getAppContent(
publicNamespace: string,
name: string,
): Promise<GetAppContentResponse>
Retrieves the app content for an organization.
Parameters
- publicNamespace: string
  The public namespace of the organization
- name: string
  The name of the app
Returns Promise<GetAppContentResponse>
The blob path and entrypoint of the app content
Example
```
const appContent = await appClient.getAppContent(
  '<YOUR-PUBLIC-NAMESPACE>',
  '<YOUR-APP-NAME>'
);
```
For more information, see App API.

getFragment

getFragment(id: string): Promise<undefined | Fragment>
Looks up a fragment by ID.
Parameters
- id: string
  The ID of the fragment to look up
Returns Promise<undefined | Fragment>
The requested fragment
Example
```
const fragment = await appClient.getFragment(
  '12a12ab1-1234-5678-abcd-abcd01234567'
);
```
For more information, see App API.

getLocation

getLocation(locId: string): Promise<undefined | Location>
Looks up a location.
Parameters
- locId: string
  The ID of the location to query.
Returns Promise<undefined | Location>
The location object
Example
```
const location = await appClient.getLocation('<YOUR-LOCATION-ID>');
```
For more information, see App API.

getLocationMetadata

getLocationMetadata(id: string): Promise<Record<string, JsonValue>>
Retrieves user-defined metadata for a location.
Parameters
- id: string
  The ID of the location
Returns Promise<Record<string, JsonValue>>
The metadata associated with the location
Example
```
const metadata = await appClient.getLocationMetadata(
  '<YOUR-LOCATION-ID>'
);
```
For more information, see App API.

getModule

getModule(moduleId: string): Promise<undefined | Module>
Looks up a particular module.
Parameters
- moduleId: string
  The ID of the module
Returns Promise<undefined | Module>
The requested module
Example
```
const module = await appClient.getModule('<YOUR-MODULE-ID>');
```
For more information, see App API.

getOrganization

getOrganization(organizationId: string): Promise<undefined | Organization>
Get details about an organization.
Parameters
- organizationId: string
  The ID of the organization
Returns Promise<undefined | Organization>
Details about the organization, if it exists
Example
```
const organization = await appClient.getOrganization(
  '<YOUR-ORGANIZATION-ID>'
);
```
For more information, see App API.

getOrganizationMetadata

getOrganizationMetadata(id: string): Promise<Record<string, JsonValue>>
Retrieves user-defined metadata for an organization.
Parameters
- id: string
  The ID of the organization
Returns Promise<Record<string, JsonValue>>
The metadata associated with the organization
Example
```
const metadata = await appClient.getOrganizationMetadata(
  '<YOUR-ORGANIZATION-ID>'
);
```
For more information, see App API.

getOrganizationNamespaceAvailability

getOrganizationNamespaceAvailability(namespace: string): Promise<boolean>
Find out if an organization namespace is available.
Parameters
- namespace: string
  The namespace to query for availability
Returns Promise<boolean>
A boolean indicating whether or not the namespace is available
Example
```
const isAvailable =
  await appClient.getOrganizationNamespaceAvailability('name');
```
For more information, see App API.

getOrganizationsWithAccessToLocation

getOrganizationsWithAccessToLocation(
locationId: string,
): Promise<OrganizationIdentity[]>
List all organizations with access to a particular location.
Parameters
- locationId: string
  The ID of the location to query
Returns Promise<OrganizationIdentity[]>
The list of locations with access to the requested location
Example
```
const organizations =
  await appClient.getOrganizationsWithAccessToLocation(
    '<YOUR-LOCATION-ID>'
  );
```
For more information, see App API.

getRegistryItem

getRegistryItem(itemId: string): Promise<undefined | RegistryItem>
Get an item from the registry.
Parameters
- itemId: string
  The ID of the item to get
Returns Promise<undefined | RegistryItem>
The requested item
Example
```
const registryItem = await appClient.getRegistryItem(
  '<YOUR-REGISTRY-ITEM-ID>'
);
```
For more information, see App API.

getRobot

getRobot(id: string): Promise<undefined | appApi.Robot>
Queries a robot by its ID.
Parameters
- id: string
  The ID of the robot
Returns Promise<undefined | appApi.Robot>
The Robot object
Example
```
const robot = await appClient.getRobot('<YOUR-ROBOT-ID>');
```
For more information, see App API.

getRobotAPIKeys

getRobotAPIKeys(robotId: string): Promise<APIKeyWithAuthorizations[]>
Gets a list of a robot's API keys.
Parameters
- robotId: string
  The ID of the robot to get API keys for
Returns Promise<APIKeyWithAuthorizations[]>
A list of the robot's API keys
Example
```
const robotAPIKeys =
  await appClient.getRobotAPIKeys('<YOUR-ROBOT-ID>');
```
For more information, see App API.

getRobotMetadata

getRobotMetadata(id: string): Promise<Record<string, JsonValue>>
Retrieves user-defined metadata for a robot.
Parameters
- id: string
  The ID of the robot
Returns Promise<Record<string, JsonValue>>
The metadata associated with the robot
Example
```
const metadata = await appClient.getRobotMetadata('<YOUR-ROBOT-ID>');
```
For more information, see App API.

getRobotPart

getRobotPart(id: string): Promise<GetRobotPartResponse>

Queries a specific robot part by ID.

Parameters

id: string
The ID of the requested robot part

Returns Promise<GetRobotPartResponse>

The robot part and a its json config

Example

const robotPart = await appClient.getRobotPart('<YOUR-ROBOT-PART-ID>');
// Get the part's address
const address = robotPart.part.fqdn;
// Check if machine is live (last access time less than 10 sec ago)
if (
  Date.now() - Number(robotPart.part.lastAccess.seconds) * 1000 <=
  10000
) {
  console.log('Machine is live');
}

For more information, see App API.

getRobotPartHistory

getRobotPartHistory(id: string): Promise<RobotPartHistoryEntry[]>
Get a list containing the history of a robot part.
Parameters
- id: string
  The ID of the requested robot part
Returns Promise<RobotPartHistoryEntry[]>
The list of the robot part's history
Example
```
const robotPartHistory = await appClient.getRobotPartHistory(
  '<YOUR-ROBOT-PART-ID>'
);
```
For more information, see App API.

getRobotPartLogs

getRobotPartLogs(
    id: string,
    filter?: string,
    levels?: string[],
    pageToken?: string,
): Promise<GetRobotPartLogsResponse>
Get a page of log entries for a specific robot part. Logs are sorted by descending time (newest first).
Parameters
- id: string
  The ID of the requested robot part
- Optionalfilter: string
  Optional string to filter logs on
- Optionallevels: string[]
  Optional array of log levels to return. Defaults to returning all log levels
- pageToken: string = ''
  Optional string indicating which page of logs to query. Defaults to the most recent
Returns Promise<GetRobotPartLogsResponse>
The robot requested logs and the page token for the next page of logs
Example
```
const robotPartLogs = await appClient.getRobotPartLogs(
  '<YOUR-ROBOT-PART-ID>'
);
```
For more information, see App API.

getRobotPartMetadata

getRobotPartMetadata(id: string): Promise<Record<string, JsonValue>>
Retrieves user-defined metadata for a robot part.
Parameters
- id: string
  The ID of the robot part
Returns Promise<Record<string, JsonValue>>
The metadata associated with the robot part
Example
```
const metadata = await appClient.getRobotPartMetadata(
  '<YOUR-ROBOT-PART-ID>'
);
```
For more information, see App API.

getRobotParts

getRobotParts(robotId: string): Promise<RobotPart[]>
Returns a list of parts for a given robot
Parameters
- robotId: string
  The ID of the robot to query
Returns Promise<RobotPart[]>
The list of RobotPart objects associated with the robot
Example
```
const robotParts = await appClient.getRobotParts('<YOUR-ROBOT-ID>');
```
For more information, see App API.

getRoverRentalRobots

getRoverRentalRobots(orgId: string): Promise<RoverRentalRobot[]>
Returns a list of rover rental robots for an organization.
Parameters
- orgId: string
  The ID of the organization to query
Returns Promise<RoverRentalRobot[]>
The list of RoverRentalRobot objects
Example
```
const roverRentalRobots = await appClient.getRoverRentalRobots(
  '<YOUR-ORGANIZATION-ID>'
);
```
For more information, see App API.

getUserIDByEmail

getUserIDByEmail(email: string): Promise<string>
Obtain a user's ID from their email address. Internal use only.
Parameters
- email: string
  The email address of the user
Returns Promise<string>
The user's ID
Example
```
// This method is used internally only. To obtain a user's ID, use the listOrganizationsByUser method.
const members = await appClient.listOrganizationMembers(
  '<YOUR-ORGANIZATION-ID>'
);
```
For more information, see App API.

listAuthorizations

listAuthorizations(
organizationId: string,
resourceIds?: string[],
): Promise<Authorization[]>
List all authorizations for an organization.

For more information, see App API.
Parameters
- organizationId: string
  The ID of the organization to list authorizations for
- OptionalresourceIds: string[]
  Optional list of IDs of resources to list authorizations for. If not provided, all resources will be included
Returns Promise<Authorization[]>
The list of authorizations

listFragments

listFragments(
    organizationId: string,
    publicOnly?: boolean,
    fragmentVisibility?: FragmentVisibility[],
): Promise<Fragment[]>
Lists all fragments within an organization.
Parameters
- organizationId: string
  The ID of the organization to list fragments for
- publicOnly: boolean = true
  Optional, deprecated boolean. Use fragmentVisibilities instead. If true then only public fragments will be listed. Defaults to true
- fragmentVisibility: FragmentVisibility[] = []
Returns Promise<Fragment[]>
The list of fragment objects
Example
```
const fragments = await appClient.listFragments(
  '<YOUR-ORGANIZATION-ID>'
);
```
For more information, see App API.

listKeys

listKeys(orgId: string): Promise<APIKeyWithAuthorizations[]>
List all API keys for an organization.
Parameters
- orgId: string
  The ID of the organization to query
Returns Promise<APIKeyWithAuthorizations[]>
The list of API keys
Example
```
const keys = await appClient.listKeys('<YOUR-ORGANIZATION-ID>');
```
For more information, see App API.

listLocations

listLocations(organizationId: string): Promise<Location[]>
Lists all locations under an organization.
Parameters
- organizationId: string
  The ID of the organization to query
Returns Promise<Location[]>
A list of locations under the organization
Example
```
const locations = await appClient.listLocations(
  '<YOUR-ORGANIZATION-ID>'
);
```
For more information, see App API.

listMachineFragments

listMachineFragments(
machineId: string,
additionalFragmentIds?: string[],
): Promise<Fragment[]>
Parameters
- machineId: string
  The machine ID used to filter fragments defined in a machine's parts. Also returns any fragments nested within the fragments defined in parts.
- OptionaladditionalFragmentIds: 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.
Returns Promise<Fragment[]>
The list of top level and nested fragments for a machine, as well as additionally specified fragment IDs.
Example
```
const fragments = await appClient.listMachineFragments(
  '<YOUR-MACHINE-ID>'
);
```
For more information, see App API.

listModules

listModules(organizationId: string): Promise<Module[]>
Lists all modules for an organization.
Parameters
- organizationId: string
  The ID of the organization to query
Returns Promise<Module[]>
The organization's modules
Example
```
const modules = await appClient.listModules('<YOUR-ORGANIZATION-ID>');
```
For more information, see App API.

listOrganizationMembers

listOrganizationMembers(
organizationId: string,
): Promise<ListOrganizationMembersResponse>
Lists organization memebers and outstanding invites.
Parameters
- organizationId: string
  The id of the organization to query
Returns Promise<ListOrganizationMembersResponse>
An object containing organization members, pending invites, and org ID
Example
```
const members = await appClient.listOrganizationMembers(
  '<YOUR-ORGANIZATION-ID>'
);
```
For more information, see App API.

listOrganizations

listOrganizations(): Promise<Organization[]>
List all organizations.

Returns Promise<Organization[]>
The organization list
Example
```
const organizations = await appClient.listOrganizations();
```
For more information, see App API.

listOrganizationsByUser

listOrganizationsByUser(userId: string): Promise<OrgDetails[]>
List all organizations associated with a user. Internal use only.
Parameters
- userId: string
  The ID of the user to query
Returns Promise<OrgDetails[]>
The list of locations the requested user has access to

listRegistryItems

listRegistryItems(
    organizationId: string,
    types: PackageType[],
    visibilities: Visibility[],
    platforms: string[],
    statuses: RegistryItemStatus[],
    searchTerm?: string,
    pageToken?: string,
): Promise<RegistryItem[]>
List all registry items for an organization.
Parameters
- organizationId: string
  The ID of the organization to query registry items for
- types: PackageType[]
  A list of types to query. If empty, will not filter on type
- visibilities: Visibility[]
  A list of visibilities to query for. If empty, will not filter on visibility
- platforms: string[]
  A list of platforms to query for. If empty, will not filter on platform
- statuses: RegistryItemStatus[]
  A list of statuses to query for. If empty, will not filter on status
- OptionalsearchTerm: string
  Optional search term to filter on
- OptionalpageToken: string
  Optional page token for results. If not provided, will return all results
Returns Promise<RegistryItem[]>
The list of registry items
Example
```
const registryItems = await appClient.listRegistryItems(
  '<YOUR-ORGANIZATION-ID>',
  [], // All package types
  [1], // Private packages
  [],
  [1] // Active packages
);
```
For more information, see App API.

listRobots

listRobots(locId: string): Promise<appApi.Robot[]>
Lists all robots in a location.
Parameters
- locId: string
  The ID of the location to list robots for
Returns Promise<appApi.Robot[]>
The list of robot objects
Example
```
const robots = await appClient.listRobots('<YOUR-LOCATION-ID>');
```
For more information, see App API.

locationAuth

locationAuth(locId: string): Promise<undefined | LocationAuth>
Get a location's LocationAuth (location secret(s)).
Parameters
- locId: string
  The ID of the location to retrieve LocationAuth from.
Returns Promise<undefined | LocationAuth>
The LocationAuth for the requested location.
Example
```
const locationAuth = await appClient.locationAuth(
  '<YOUR-LOCATION-ID>'
);
```
For more information, see App API.

markPartAsMain

markPartAsMain(partId: string): Promise<void>
Marks a robot part as the main part.
Parameters
- partId: string
  The ID of the part to mark as main
Returns Promise<void>
Example
```
await appClient.markPartAsMain('<YOUR-ROBOT-PART-ID>');
```
For more information, see App API.

markPartForRestart

markPartForRestart(partId: string): Promise<void>
Marks a robot part for restart.
Parameters
- partId: string
  The ID of the part to mark for restart
Returns Promise<void>
Example
```
await appClient.markPartForRestart('<YOUR-ROBOT-PART-ID>');
```
For more information, see App API.

newRobot

newRobot(locId: string, name: string): Promise<string>
Creates a new robot.
Parameters
- locId: string
  The ID of the location to create the robot in
- name: string
  The name of the new robot
Returns Promise<string>
The new robot's ID
Example
```
const robotId = await appClient.newRobot(
  '<YOUR-LOCATION-ID>',
  'newRobot'
);
```
For more information, see App API.

newRobotPart

newRobotPart(robotId: string, partName: string): Promise<string>
Creates a new robot part.
Parameters
- robotId: string
  The ID of the robot to create a part for
- partName: string
  The name for the new robot part
Returns Promise<string>
The ID of the newly-created robot part
Example
```
const robotPartId = await appClient.newRobotPart(
  '<YOUR-ROBOT-ID>',
  'newPart'
);
```
For more information, see App API.

removeRole

removeRole(
    organizationId: string,
    entityId: string,
    role: string,
    resourceType: string,
    resourceId: string,
): Promise<void>
Removes a role from an organization.
Parameters
- organizationId: string
  The ID of the organization to remove the role from
- entityId: string
  The ID of the entity the role belongs to (for example a user ID)
- role: string
  The role to remove ("owner" or "operator")
- resourceType: string
  The type of resource to remove the role from ("robot", "location", or "organization")
- resourceId: string
  The ID of the resource the role is being removes from
Returns Promise<void>
Example
```
await appClient.removeRole(
  '<YOUR-ORGANIZATION-ID>',
  '<YOUR-USER-ID>',
  'owner',
  'robot',
  '<YOUR-ROBOT-ID>'
);
```
For more information, see App API.

resendOrganizationInvite

resendOrganizationInvite(
organizationId: string,
email: string,
): Promise<undefined | OrganizationInvite>
Resends a pending organization invite.
Parameters
- organizationId: string
  The ID of the organization
- email: string
  The email associated with the invite to resend
Returns Promise<undefined | OrganizationInvite>
The invite
Example
```
const invite = await appClient.resendOrganizationInvite(
  '<YOUR-ORGANIZATION-ID>',
  'youremail@email.com'
);
```
For more information, see App API.

rotateKey

rotateKey(id: string): Promise<RotateKeyResponse>
Rotates an existing API key.
Parameters
- id: string
  The ID of the key to rotate
Returns Promise<RotateKeyResponse>
The updated key and ID
Example
```
const key = await appClient.rotateKey('<YOUR-KEY-ID>');
```
For more information, see App API.

shareLocation

shareLocation(organizationId: string, locId: string): Promise<void>
Shares a location with another organization
Parameters
- organizationId: string
  The ID of the organization to share with
- locId: string
  The ID of the location to share
Returns Promise<void>
Example
```
await appClient.shareLocation(
  '<OTHER-ORGANIZATION-ID>',
  '<YOUR-LOCATION-ID>'
);
```
For more information, see App API.

tailRobotPartLogs

tailRobotPartLogs(
    id: string,
    queue: LogEntry[],
    filter?: string,
    errorsOnly?: boolean,
): Promise<void>
Get a stream of log entries for a specific robot part. Logs are sorted by descending time (newest first).
Parameters
- id: string
  The ID of the requested robot part
- queue: LogEntry[]
  A queue to put the log entries into
- Optionalfilter: string
  Optional string to filter logs on
- errorsOnly: boolean = true
  Optional bool to indicate whether or not only error-level logs should be returned. Defaults to true
Returns Promise<void>
Example
```
const robotPartLogs = await appClient.tailRobotPartLogs(
  '<YOUR-ROBOT-PART-ID>'
);
```
For more information, see App API.

unshareLocation

unshareLocation(organizationId: string, locId: string): Promise<void>
Unshares a location with an organization
Parameters
- organizationId: string
  The ID of the organization to unshare with
- locId: string
  The ID of the location to unshare
Returns Promise<void>
Example
```
await appClient.unshareLocation(
  '<OTHER-ORGANIZATION-ID>',
  '<YOUR-LOCATION-ID>'
);
```
For more information, see App API.

updateFragment

updateFragment(
    id: string,
    name: string,
    config: Struct,
    makePublic?: boolean,
    visibility?: FragmentVisibility,
): Promise<undefined | Fragment>
Updates an existing fragment.
Parameters
- id: string
  The ID of the fragment to update
- name: string
  The name to update the fragment to
- config: Struct
  The config to update the fragment to
- OptionalmakePublic: boolean
  Optional, 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
- Optionalvisibility: FragmentVisibility
  Optional 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.
Returns Promise<undefined | Fragment>
The updated fragment
Example
```
const fragment = await appClient.updateFragment(
  '12a12ab1-1234-5678-abcd-abcd01234567',
  'better_name'
);
```
For more information, see App API.

updateLocation

updateLocation(
    locId: string,
    name?: string,
    parentLocId?: string,
    region?: string,
): Promise<undefined | Location>
Updates location details.
Parameters
- locId: string
  The ID of the location to update
- Optionalname: string
  Optional string to update the location's name to
- OptionalparentLocId: string
  Optional string to update the location's parent location to
- Optionalregion: string
  Optional string to update the location's region to
Returns Promise<undefined | Location>
The location object
Example
```
const location = await appClient.updateLocation(
  '<YOUR-LOCATION-ID>',
  'newName'
);
```
For more information, see App API.

updateLocationMetadata

updateLocationMetadata(
id: string,
data: Record<string, JsonValue>,
): Promise<void>
Updates user-defined metadata for a location.
Parameters
- id: string
  The ID of the location
- data: Record<string, JsonValue>
  The metadata to update
Returns Promise<void>
Example
```
await appClient.updateLocationMetadata('<YOUR-LOCATION-ID>', {
  key: 'value',
});
```
For more information, see App API.

updateModule

updateModule(
    moduleId: string,
    visibility: Visibility,
    url: string,
    description: string,
    models: Model[],
    entrypoint: string,
): Promise<string>
Updates an existing module.
Parameters
- moduleId: string
  The ID of the module to update
- visibility: Visibility
  The visibility to set for the module
- url: string
  The url to reference for documentation, code, etc.
- description: string
  A short description of the module
- models: Model[]
  A list of models available in the module
- entrypoint: string
  The executable to run to start the module program
Returns Promise<string>
The module URL
Example
```
const module = await appClient.updateModule(
  '<YOUR-MODULE-ID>',
  1,
  'https://example.com',
  'new description',
  [{ model: 'namespace:group:model1', api: 'rdk:component:generic' }],
  'entrypoint'
);
```
For more information, see App API.

updateOrganization

updateOrganization(
    organizationId: string,
    name?: string,
    publicNamespace?: string,
    region?: string,
    cid?: string,
): Promise<undefined | Organization>
Updates organization details.
Parameters
- organizationId: string
  The id of the organization to update
- Optionalname: string
  Optional name to update the organization with
- OptionalpublicNamespace: string
  Optional namespace to update the organization with
- Optionalregion: string
  Optional region to update the organization with
- Optionalcid: string
  Optional CRM ID to update the organization with
Returns Promise<undefined | Organization>
The updated organization details
Example
```
const organization = await appClient.updateOrganization(
  '<YOUR-ORGANIZATION-ID>',
  'newName'
);
```
For more information, see App API.

updateOrganizationInviteAuthorizations

updateOrganizationInviteAuthorizations(
    organizationId: string,
    email: string,
    addAuthsList: Authorization[],
    removeAuthsList: Authorization[],
): Promise<undefined | OrganizationInvite>

Updates authorizations for an existing org invite.

Parameters

organizationId: string
The id of the organization
email: string
The email address associated with the invite
addAuthsList: Authorization[]
List of authorizations to add to the invite
removeAuthsList: Authorization[]
List of authorizations to remove from the invite

Returns Promise<undefined | OrganizationInvite>

The organization invite

Example

const auth = new VIAM.appApi.Authorization({
  authorizationType: 'role',
  authorizationId: 'organization_operator',
  organizationId: '<YOUR-ORGANIZATION-ID>',
  resourceId: '<YOUR-RESOURCE-ID>', // The resource to grant access to
  resourceType: 'organization', // The type of resource to grant access to
  identityId: '<YOUR-USER-ID>', // The user id of the user to grant access to (optional)
  roleId: 'owner', // The role to grant access to
  identityType: 'user',
});
const invite = await appClient.updateOrganizationInviteAuthorizations(
  '<YOUR-ORGANIZATION-ID>',
  'youremail@email.com',
  [auth],
  []
);

For more information, see App API.

updateOrganizationMetadata

updateOrganizationMetadata(
id: string,
data: Record<string, JsonValue>,
): Promise<void>
Updates user-defined metadata for an organization.
Parameters
- id: string
  The ID of the organization
- data: Record<string, JsonValue>
  The metadata to update
Returns Promise<void>
Example
```
await appClient.updateOrganizationMetadata('<YOUR-ORGANIZATION-ID>', {
  key: 'value',
});
```
For more information, see App API.

updateRegistryItem

updateRegistryItem(
    itemId: string,
    type: PackageType,
    description: string,
    visibility: Visibility,
): Promise<void>
Update an existing registry item.
Parameters
- itemId: string
  The ID of the registry item to update
- type: PackageType
  The PackageType to update the item to
- description: string
  A description of the item
- visibility: Visibility
  A visibility value to update to
Returns Promise<void>
Example
```
await appClient.updateRegistryItem(
  '<YOUR-REGISTRY-ITEM-ID>',
  5, // Package: ML Model
  'new description',
  1 // Private
);
```
For more information, see App API.

updateRobot

updateRobot(
    robotId: string,
    locId: string,
    name: string,
): Promise<undefined | appApi.Robot>
Change the name of an existing machine. You can only change the name of the machine, not the location.
Parameters
- robotId: string
  The ID of the robot to update
- locId: string
  The ID of the location where the robot is
- name: string
  The name to update the robot to
Returns Promise<undefined | appApi.Robot>
The newly-modified robot object
Example
```
const robot = await appClient.updateRobot(
  '<YOUR-ROBOT-ID>',
  '<YOUR-LOCATION-ID>',
  'newName'
);
```
For more information, see App API.

updateRobotMetadata

updateRobotMetadata(id: string, data: Record<string, JsonValue>): Promise<void>
Updates user-defined metadata for a robot.
Parameters
- id: string
  The ID of the robot
- data: Record<string, JsonValue>
  The metadata to update
Returns Promise<void>
Example
```
await appClient.updateRobotMetadata('<YOUR-ROBOT-ID>', {
  key: 'value',
});
```
For more information, see App API.

updateRobotPart

updateRobotPart(
    id: string,
    name: string,
    robotConfig: Struct,
): Promise<undefined | RobotPart>
Updates a robot part based on its ID.
Parameters
- id: string
  The ID of the requested robot part
- name: string
  The new name of the robot part
- robotConfig: Struct
  The new config for the robot part
Returns Promise<undefined | RobotPart>
The updated robot part
Example
```
const robotPart = await appClient.updateRobotPart(
  '<YOUR-ROBOT-PART-ID>',
  'newName'
);
```
For more information, see App API.

updateRobotPartMetadata

updateRobotPartMetadata(
id: string,
data: Record<string, JsonValue>,
): Promise<void>
Updates user-defined metadata for a robot part.
Parameters
- id: string
  The ID of the robot part
- data: Record<string, JsonValue>
  The metadata to update
Returns Promise<void>
Example
```
await appClient.updateRobotPartMetadata('<YOUR-ROBOT-PART-ID>', {
  key: 'value',
});
```
For more information, see App API.

Class AppClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AppClient

Methods

addRole

Parameters

Returns Promise<void>

Example

changeRole

Parameters

Returns Promise<void>

Example

checkPermissions

Parameters

Returns Promise<AuthorizedPermissions[]>

createFragment

Parameters

Returns Promise<undefined | Fragment>

Example

createKey

Parameters

Returns Promise<CreateKeyResponse>

createKeyFromExistingKeyAuthorizations

Parameters

Returns Promise<CreateKeyFromExistingKeyAuthorizationsResponse>

Example

createLocation

Parameters

Returns Promise<undefined | Location>

Example

createLocationSecret

Parameters

Returns Promise<undefined | LocationAuth>

Example

createModule

Parameters

Returns Promise<CreateModuleResponse>

Example

createOrganization

Parameters

Returns Promise<undefined | Organization>

createOrganizationInvite

Parameters

Returns Promise<undefined | OrganizationInvite>

Example

createRegistryItem

Parameters

Returns Promise<void>

Example

createRobotPartSecret

Parameters

Returns Promise<undefined | RobotPart>

Example

deleteFragment

Parameters

Returns Promise<void>

Example

deleteKey

Parameters

Returns Promise<DeleteKeyResponse>

Example

deleteLocation

Parameters

Returns Promise<void>

Example

deleteLocationSecret

Parameters

Returns Promise<void>

Example

deleteOrganization

Parameters

Returns Promise<void>

Example

deleteOrganizationInvite

Parameters