Manage your fleet with Viam's fleet management API

See Use platform APIs from within a module.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• email (string)

Returns:

• (string)
• (error): An error, if one occurred.

Example:

userID, err := cloud.GetUserIDByEmail(context.Background(), "test@example.com")

For more information, see the Go SDK Docs.

Parameters:

• email (string) (required): The email address of the user.

Returns:

• (Promise): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• name (string)

Returns:

• (*Organization)
• (error): An error, if one occurred.

Example:

organization, err := cloud.CreateOrganization(context.Background(), "testOrganization")

For more information, see the Go SDK Docs.

Parameters:

• name (string) (required): The name of the new organization.

Returns:

• (Promise<undefined | Organization>): The new organization.

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.

Returns:

• ([]*Organization)
• (error): An error, if one occurred.

Example:

organizations, err := cloud.ListOrganizations(context.Background())

For more information, see the Go SDK Docs.

Parameters:

• None.

Returns:

• (Promise<Organization[]>): The organization list.

Example:

const organizations = await appClient.listOrganizations();

For more information, see the TypeScript SDK Docs.

Parameters:

• locationId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• userID (string)

Returns:

• ([]*OrgDetails)
• (error): An error, if one occurred.

Example:

organizations, err := cloud.ListOrganizationsByUser(context.Background(), "1234a56b-1234-1a23-1234-a12bcd3ef4a5")

For more information, see the Go SDK Docs.

Parameters:

• userId (string) (required): The ID of the user to query.

Returns:

• (Promise<OrgDetails[]>): The list of locations the requested user has access to.

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (string)

Returns:

• (*Organization)
• (error): An error, if one occurred.

Example:

organization, err := cloud.GetOrganization(context.Background(), "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2")

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• namespace (string)

Returns:

• (bool)
• (error): An error, if one occurred.

Example:

available, err := cloud.GetOrganizationNamespaceAvailability(context.Background(), "test-namespace")

For more information, see the Go SDK Docs.

Parameters:

• namespace (string) (required): The namespace to query for availability.

Returns:

• (Promise): A boolean indicating whether or not the namespace is available.

Example:

const isAvailable =
  await appClient.getOrganizationNamespaceAvailability('name');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (string)
• opts (*UpdateOrganizationOptions)

Returns:

• (*Organization)
• (error): An error, if one occurred.

Example:

 name := "tests-name"
	organization, err := cloud.UpdateOrganization(
		context.Background(),
		"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
		&UpdateOrganizationOptions{
			Name: &name,
		})

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The id of the organization to update.
• name (string) (optional): Optional name to update the organization with.
• publicNamespace (string) (optional): Optional namespace to update the organization with.
• region (string) (optional): Optional region to update the organization with.
• cid (string) (optional): Optional CRM ID to update the organization with.
• defaultFragments (FragmentImportList) (optional): Optional default fragments to set for the organization.

Returns:

• (Promise<undefined | Organization>): The updated organization details.

Example:

const organization = await appClient.updateOrganization(
  '<YOUR-ORGANIZATION-ID>',
  'newName'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteOrganization(context.Background(), "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2")

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The id of the organization to delete.

Returns:

• (Promise)

Example:

await appClient.deleteOrganization('<YOUR-ORGANIZATION-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (string)

Returns:

• ([]*OrganizationMember)
• ([]*OrganizationInvite)
• (error): An error, if one occurred.

Example:

members, invites, err := cloud.ListOrganizationMembers(context.Background(), "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2")

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• email (string)
• authorizations ([]*Authorization)
• opts (*CreateOrganizationInviteOptions)

Returns:

• (*OrganizationInvite)
• (error): An error, if one occurred.

Example:

func boolPtr(b bool) *bool {
	return &b
}

invite, err := cloud.CreateOrganizationInvite(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	"test@example.com",
	[]*Authorization{&Authorization{}},
	&app.CreateOrganizationInviteOptions{
		SendEmailInvite: boolPtr(true),
	})

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The id of the organization to create the invite for.
• email (string) (required): The email address of the user to generate an invite for.
• authorizations (Authorization) (required): The authorizations to associate with the new invite.
• sendEmailInvite (boolean) (optional): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• email (string)
• addAuthorizations
• removeAuthorizations ([]*Authorization)

Returns:

• (*OrganizationInvite)
• (error): An error, if one occurred.

Example:

invite, err := cloud.UpdateOrganizationInviteAuthorizations(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	"test@example.com",
	[]*app.Authorization{
		AuthorizationType: "role",
		AuthorizationID:   "location_owner",
		ResourceType:      "location",
		ResourceID:        LOCATION_ID,
		OrganizationID:    ORG_ID,
		IdentityID:        "",
	},
	[]*app.Authorization{})

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The id of the organization.
• email (string) (required): The email address associated with the invite.
• addAuthsList (Authorization) (required): List of authorizations to add to the invite.
• removeAuthsList (Authorization) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• userID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteOrganizationMember(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	"1234a56b-1234-1a23-1234-a12bcd3ef4a5")

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization.
• userId (string) (required): The ID of the user.

Returns:

• (Promise)

Example:

await appClient.deleteOrganizationMember(
  '<YOUR-ORGANIZATION-ID>',
  '<YOUR-USER-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• email (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteOrganizationInvite(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	"test@example.com")

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization.
• email (string) (required): The email associated with the invite to delete.

Returns:

• (Promise)

Example:

await appClient.deleteOrganizationInvite(
  '<YOUR-ORGANIZATION-ID>',
  'youremail@email.com'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• email (string)

Returns:

• (*OrganizationInvite)
• (error): An error, if one occurred.

Example:

invite, err := cloud.ResendOrganizationInvite(context.Background(), "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2", "test@example.com")

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization.
• email (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• organizationID (string)

Returns:

• (map[string]interface{})
• (error): An error, if one occurred.

Example:

metadata, err := cloud.GetOrganizationMetadata(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• organizationID (string)
• data (interface{})

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.UpdateOrganizationMetadata(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	map[string]interface{}{
		"key": "value",
	},
)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the organization.
• data (Record) (required): The metadata to update.

Returns:

• (Promise)

Example:

await appClient.updateOrganizationMetadata('<YOUR-ORGANIZATION-ID>', {
  key: 'value',
});

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• name (string)
• opts (*CreateLocationOptions)

Returns:

• (*Location)
• (error): An error, if one occurred.

Example:

 locationID := "ab1c2d3e45"
	err := cloud.CreateLocation(
		context.Background(),
		"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
		"test-location",
		&app.CreateLocationOptions{
			ParentLocationID: &locationID,
	})

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to create the location under.
• name (string) (required): The name of the location to create.
• parentLocationId (string) (optional): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID (string)

Returns:

• (*Location)
• (error): An error, if one occurred.

Example:

location, err := cloud.GetLocation(context.Background(), "ab1c2d3e45")

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID (string)
• opts (*UpdateLocationOptions)

Returns:

• (*Location)
• (error): An error, if one occurred.

Example:

 locationID := "ab1c2d3e45"
 name := "test-name"
	err := cloud.UpdateLocation(
		context.Background(),
		"ab1c2d3e45",
		&app.UpdateLocationOptions{
			Name: &name,
			ParentLocationID: &locationID,
		})

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): The ID of the location to update.
• name (string) (optional): Optional string to update the location’s name to.
• parentLocId (string) (optional): Optional string to update the location’s parent location to.
• region (string) (optional): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteLocation(context.Background(), "ab1c2d3e45")

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): The ID of the location to delete.

Returns:

• (Promise)

Example:

await appClient.deleteLocation('<YOUR-LOCATION-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (string)

Returns:

• ([]*Location)
• (error): An error, if one occurred.

Example:

locations, err := cloud.ListLocations(context.Background(), "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2")

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID
• orgID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.ShareLocation(context.Background(), "ab1c2d3e45", "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2")

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to share with.
• locId (string) (required): The ID of the location to share.

Returns:

• (Promise)

Example:

await appClient.shareLocation(
  '<OTHER-ORGANIZATION-ID>',
  '<YOUR-LOCATION-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID
• orgID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.UnshareLocation(context.Background(), "ab1c2d3e45", "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2")

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to unshare with.
• locId (string) (required): The ID of the location to unshare.

Returns:

• (Promise)

Example:

await appClient.unshareLocation(
  '<OTHER-ORGANIZATION-ID>',
  '<YOUR-LOCATION-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID (string)

Returns:

• (*LocationAuth)
• (error): An error, if one occurred.

Example:

auth, err := cloud.LocationAuth(context.Background(), "ab1c2d3e45")

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID (string)

Returns:

• (*LocationAuth)
• (error): An error, if one occurred.

Example:

auth, err := cloud.CreateLocationSecret(context.Background(), "ab1c2d3e45")

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID
• secretID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteLocationSecret(
	context.Background(),
	"ab1c2d3e45",
	"a12bcd3e-a12b-1234-1ab2-abc123d4e5f6")
)

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): The ID of the location to delete the LocationAuth from.
• secretId (string) (required): The ID of the location secret to delete.

Returns:

• (Promise)

Example:

await appClient.deleteLocationSecret(
  '<YOUR-LOCATION-ID>',
  '<YOUR-SECRET-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID (string)

Returns:

• (map[string]interface{})
• (error): An error, if one occurred.

Example:

metadata, err := cloud.GetLocationMetadata(context.Background(), "ab1c2d3e45")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID (string)
• data (interface{})

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.UpdateLocationMetadata(
	context.Background(),
	"ab1c2d3e45",
	map[string]interface{}{
		"key": "value",
	},
)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the location.
• data (Record) (required): The metadata to update.

Returns:

• (Promise)

Example:

await appClient.updateLocationMetadata('<YOUR-LOCATION-ID>', {
  key: 'value',
});

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)

Returns:

• (*Robot)
• (error): An error, if one occurred.

Example:

robot, err := cloud.GetRobot(context.Background(), "1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• robotID (string)

Returns:

• ([]*APIKeyWithAuthorizations)
• (error): An error, if one occurred.

Example:

keys, err := cloud.GetRobotAPIKeys(context.Background(), "1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• robotId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• robotID (string)

Returns:

• ([]*RobotPart)
• (error): An error, if one occurred.

Example:

parts, err := cloud.GetRobotParts(context.Background(), "1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• robotId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)

Returns:

• (*RobotPart)
• (string)
• (error): An error, if one occurred.

Example:

part, config, err := cloud.GetRobotPart(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12",
)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)
• opts (*GetRobotPartLogsOptions)

Returns:

• ([]*LogEntry)
• (string)
• (error): An error, if one occurred.

Example:

	filter := ""
	pageToken := ""
	startTime := time.Now().Add(-720 * time.Hour)
	endTime := time.Now()
	limit := 5
	source := ""
	partLogs, _, err := cloud.GetRobotPartLogs(
        ctx,
        PART_ID,
       &GetRobotPartLogsOptions{
			Filter: &filter,
			PageToken: &pageToken,
			Levels: []string{"INFO", "WARN", "ERROR"},
			Start: &startTime,
			End: &endTime,
			Limit: &limit,
			Source: &source,
		},
	)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the requested robot part.
• filter (string) (optional): Optional string to filter logs on.
• levels (string) (optional): Optional array of log levels to return. Defaults to returning all log levels.
• start (Date) (optional): Optional start time for log retrieval. Only logs created after this time will be returned.
• end (Date) (optional): Optional end time for log retrieval. Only logs created before this time will be returned.
• pageToken (string) (optional): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)
• errorsOnly (bool)
• opts (*TailRobotPartLogsOptions)

Returns:

• (*RobotPartLogStream)
• (error): An error, if one occurred.

Example:

logFilter := "error"
stream, err := cloud.TailRobotPartLogs(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12",
	true,
	&app.TailRobotPartLogsOptions{
		Filter: &logFilter,
	},
)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the requested robot part.
• queue (LogEntry) (required): A queue to put the log entries into.
• filter (string) (optional): Optional string to filter logs on.
• errorsOnly (boolean) (optional): Optional bool to indicate whether or not only error-level logs should be returned. Defaults to true.

Returns:

• (Promise)

Example:

const robotPartLogs = await appClient.tailRobotPartLogs(
  '<YOUR-ROBOT-PART-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)

Returns:

• ([]*RobotPartHistoryEntry)
• (error): An error, if one occurred.

Example:

history, err := cloud.GetRobotPartHistory(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id
• name (string)
• robotConfig (interface{})

Returns:

• (*RobotPart)
• (error): An error, if one occurred.

Example:

robotConfig := map[string]interface{}{
	"components": []map[string]interface{}{
		{
			"name":       "camera-1",
			"api":        "rdk:component:camera",
			"model":      "rdk:builtin:fake",
			"attributes": map[string]interface{}{},
		},
	},
}

part, err := cloud.UpdateRobotPart(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12",
	"part_name",
	map[string]interface{}{
		"key": "value",
	},
)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the requested robot part.
• name (string) (required): The new name of the robot part.
• robotConfig (Struct) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• robotID
• partName (string)

Returns:

• (string)
• (error): An error, if one occurred.

Example:

partID, err := cloud.NewRobotPart(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12",
	"part_name")

For more information, see the Go SDK Docs.

Parameters:

• robotId (string) (required): The ID of the robot to create a part for.
• partName (string) (required): The name for the new robot part.

Returns:

• (Promise): The ID of the newly-created robot part.

Example:

const robotPartId = await appClient.newRobotPart(
  '<YOUR-ROBOT-ID>',
  'newPart'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• partID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteRobotPart(context.Background(), "1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• partId (string) (required): The ID of the part to delete.

Returns:

• (Promise)

Example:

await appClient.deleteRobotPart('<YOUR-ROBOT-PART-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• partID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.MarkPartAsMain(context.Background(), "1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• partId (string) (required): The ID of the part to mark as main.

Returns:

• (Promise)

Example:

await appClient.markPartAsMain('<YOUR-ROBOT-PART-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• partID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.MarkPartForRestart(context.Background(), "1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• partId (string) (required): The ID of the part to mark for restart.

Returns:

• (Promise)

Example:

await appClient.markPartForRestart('<YOUR-ROBOT-PART-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• partID (string)

Returns:

• (*RobotPart)
• (error): An error, if one occurred.

Example:

part, err := cloud.CreateRobotPartSecret(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• partId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• partID
• secretID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteRobotPartSecret(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12",
	"a12bcd34-1234-12ab-1ab2-123a4567890b")

For more information, see the Go SDK Docs.

Parameters:

• partId (string) (required): The ID of the part to delete a secret from.
• secretId (string) (required): The ID of the secret to delete.

Returns:

• (Promise)

Example:

await appClient.deleteRobotPartSecret(
  '<YOUR-ROBOT-PART-ID>',
  '<YOUR-SECRET-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• locationID (string)

Returns:

• ([]*Robot)
• (error): An error, if one occurred.

Example:

robots, err := cloud.ListRobots(context.Background(), "ab1c2d3e45")

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• name
• location (string)

Returns:

• (string)
• (error): An error, if one occurred.

Example:

robotID, err := cloud.NewRobot(context.Background(), "robot_name", "ab1c2d3e45")

For more information, see the Go SDK Docs.

Parameters:

• locId (string) (required): The ID of the location to create the robot in.
• name (string) (required): The name of the new robot.

Returns:

• (Promise): The new robot’s ID.

Example:

const robotId = await appClient.newRobot(
  '<YOUR-LOCATION-ID>',
  'newRobot'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id
• name
• location (string)

Returns:

• (*Robot)
• (error): An error, if one occurred.

Example:

robot, err := cloud.UpdateRobot(context.Background(), "1ab2345c-a123-1ab2-1abc-1ab234567a12", "robot_name", "ab1c2d3e45")

For more information, see the Go SDK Docs.

Parameters:

• robotId (string) (required): The ID of the robot to update.
• locId (string) (required): The ID of the location where the robot is.
• name (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteRobot(context.Background(), "1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the robot to delete.

Returns:

• (Promise)

Example:

await appClient.deleteRobot('<YOUR-ROBOT-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• robotID (string)

Returns:

• (map[string]interface{})
• (error): An error, if one occurred.

Example:

metadata, err := cloud.GetRobotMetadata(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• robotID (string)

Returns:

• (map[string]interface{})
• (error): An error, if one occurred.

Example:

metadata, err := cloud.GetRobotPartMetadata(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• robotID (string)
• data (interface{})

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.UpdateRobotMetadata(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12",
	map[string]interface{}{
		"key": "value",
	},
)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the robot.
• data (Record) (required): The metadata to update.

Returns:

• (Promise)

Example:

await appClient.updateRobotMetadata('<YOUR-ROBOT-ID>', {
  key: 'value',
});

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• robotID (string)
• data (interface{})

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.UpdateRobotPartMetadata(
	context.Background(),
	"1ab2345c-a123-1ab2-1abc-1ab234567a12",
	map[string]interface{}{
		"key": "value",
	},
)

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the robot part.
• data (Record) (required): The metadata to update.

Returns:

• (Promise)

Example:

await appClient.updateRobotPartMetadata('<YOUR-ROBOT-PART-ID>', {
  key: 'value',
});

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (string)
• showPublic (bool)
• fragmentVisibility ([]FragmentVisibility)

Returns:

• ([]*Fragment)
• (error): An error, if one occurred.

Example:

fragments, err := cloud.ListFragments(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	true,
	[]app.FragmentVisibility{app.FragmentVisibilityPublic},
)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to list fragments for.
• publicOnly (boolean) (optional): Optional, deprecated boolean. Use fragmentVisibilities instead. If true then only public fragments will be listed. Defaults to true.
• fragmentVisibility (FragmentVisibility) (optional)

Returns:

• (Promise<Fragment[]>): The list of fragment objects.

Example:

const fragments = await appClient.listFragments(
  '<YOUR-ORGANIZATION-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• machineId (string) (required): The machine ID used to filter fragments defined in a machine’s parts. Also returns any fragments nested within the fragments defined in parts.
• additionalFragmentIds (string) (optional): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id
• version (string)

Returns:

• (*Fragment)
• (error): An error, if one occurred.

Example:

fragment, err := cloud.GetFragment(context.Background(), "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2", "")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• name (string)
• config (map[string]interface{})
• opts (*CreateFragmentOptions)

Returns:

• (*Fragment)
• (error): An error, if one occurred.

Example:

fragmentConfig := map[string]interface{}{
	"components": []map[string]interface{}{
		{
			"name":       "camera-1",
			"api":        "rdk:component:camera",
			"model":      "rdk:builtin:fake",
			"attributes": map[string]interface{}{},
		},
	},
}

fragment, err := cloud.CreateFragment(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	"My Fragment",
	fragmentConfig,
	&app.CreateFragmentOptions{Visibility: &app.FragmentVisibilityPublic},
)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to create the fragment under.
• name (string) (required): The name of the new fragment.
• config (Struct) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id
• name (string)
• config (map[string]interface{})
• opts (*UpdateFragmentOptions)

Returns:

• (*Fragment)
• (error): An error, if one occurred.

Example:

fragmentConfig := map[string]interface{}{
	"components": []map[string]interface{}{
		{
			"name":       "camera-1",
			"api":        "rdk:component:camera",
			"model":      "rdk:builtin:fake",
			"attributes": map[string]interface{}{},
		},
	},
}

fragment, err := cloud.UpdateFragment(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	"My Fragment",
	fragmentConfig,
	&app.UpdateFragmentOptions{Visibility: &app.FragmentVisibilityPublic})

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the fragment to update.
• name (string) (required): The name to update the fragment to.
• config (Struct) (required): The config to update the fragment to.
• makePublic (boolean) (optional): 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.
• visibility (FragmentVisibility) (optional): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteFragment(context.Background(), "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the fragment to delete.

Returns:

• (Promise)

Example:

await appClient.deleteFragment('12a12ab1-1234-5678-abcd-abcd01234567');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)
• opts (*GetFragmentHistoryOptions)

Returns:

• ([]*FragmentHistoryEntry)
• (string)
• (error): An error, if one occurred.

Example:

 limit := 10
	history, token, err := cloud.GetFragmentHistory(
		context.Background(),
		"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
		&app.GetFragmentHistoryOptions{PageLimit: &limit})

For more information, see the Go SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• identityID (string)
• role (AuthRole)
• resourceType (AuthResourceType)
• resourceID (string)

Returns:

• (error): An error, if one occurred.

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to create the role under.
• entityId (string) (required): The ID of the entity the role belongs to (for example a user ID).
• role (string) (required): The role to add (“owner” or “operator”).
• resourceType (string) (required): The type of resource to create the role for (“robot”, “location”, or “organization”).
• resourceId (string) (required): The ID of the resource the role is being created for.

Returns:

• (Promise)

Example:

await appClient.addRole(
  '<YOUR-ORGANIZATION-ID>',
  '<YOUR-USER-ID>',
  'owner',
  'robot',
  '<YOUR-ROBOT-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• authorization (*Authorization)

Returns:

• (error): An error, if one occurred.

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to remove the role from.
• entityId (string) (required): The ID of the entity the role belongs to (for example a user ID).
• role (string) (required): The role to remove (“owner” or “operator”).
• resourceType (string) (required): The type of resource to remove the role from (“robot”, “location”, or “organization”).
• resourceId (string) (required): The ID of the resource the role is being removes from.

Returns:

• (Promise)

Example:

await appClient.removeRole(
  '<YOUR-ORGANIZATION-ID>',
  '<YOUR-USER-ID>',
  'owner',
  'robot',
  '<YOUR-ROBOT-ID>'
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• oldAuthorization (*Authorization)
• newOrgID
• newIdentityID (string)
• newRole (AuthRole)
• newResourceType (AuthResourceType)
• newResourceID (string)

Returns:

• (error): An error, if one occurred.

For more information, see the Go SDK Docs.

Parameters:

• oldAuthorization (Authorization) (required): The existing authorization.
• newAuthorization (Authorization) (required): The new authorization to change to.

Returns:

• (Promise)

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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (string)
• resourceIDs ([]string)

Returns:

• ([]*Authorization)
• (error): An error, if one occurred.

Example:

err := cloud.ListAuthorizations(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	[]string{"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2"},
)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to list authorizations for.
• resourceIds (string) (optional): 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.

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• permissions ([]*AuthorizedPermissions)

Returns:

• ([]*AuthorizedPermissions)
• (error): An error, if one occurred.

Example:

err := cloud.CheckPermissions(
	context.Background(),
	[]*app.AuthorizedPermissions{
		{
			ResourceType: app.AuthResourceTypeLocation,
			ResourceID:   "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
			Permissions:  []string{"control_robot", "read_robot_logs"},
		},
	},
)

For more information, see the Go SDK Docs.

Parameters:

• permissions (AuthorizedPermissions) (required): A list of permissions to check.

Returns:

• (Promise<AuthorizedPermissions[]>): A filtered list of the authorized permissions.

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• itemID (string)

Returns:

• (*RegistryItem)
• (error): An error, if one occurred.

Example:

registryItem, err := cloud.GetRegistryItem(context.Background(), "namespace:name")

For more information, see the Go SDK Docs.

Parameters:

• itemId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• name (string)
• packageType (PackageType)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.CreateRegistryItem(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	"registry_item_name",
	app.PackageTypeMLModel)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to create the registry item under.
• name (string) (required): The name of the registry item.
• type (PackageType) (required): The type of the item in the registry.

Returns:

• (Promise)

Example:

await appClient.createRegistryItem(
  '<YOUR-ORGANIZATION-ID>',
  'newRegistryItemName',
  5
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• itemID (string)
• packageType (PackageType)
• description (string)
• visibility (Visibility)
• opts (*UpdateRegistryItemOptions)

Returns:

• (error): An error, if one occurred.

Example:

siteURL := "https://example.com"
err := cloud.UpdateRegistryItem(
	context.Background(),
	"namespace:name",
	app.PackageTypeMLModel,
	"description",
	app.VisibilityPrivate,
	&app.UpdateRegistryItemOptions{URL: &siteURL},
)

For more information, see the Go SDK Docs.

Parameters:

• itemId (string) (required): The ID of the registry item to update.
• type (PackageType) (required): The PackageType to update the item to.
• description (string) (required): A description of the item.
• visibility (Visibility) (required): A visibility value to update to.

Returns:

• (Promise)

Example:

await appClient.updateRegistryItem(
  '<YOUR-REGISTRY-ITEM-ID>',
  5, // Package: ML Model
  'new description',
  1 // Private
);

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (*string)
• types ([]PackageType)
• visibilities ([]Visibility)
• platforms ([]string)
• statuses ([]RegistryItemStatus)
• opts (*ListRegistryItemsOptions)

Returns:

• ([]*RegistryItem)
• (error): An error, if one occurred.

Example:

organizationID := "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2"
searchTerm := ""
pageToken := ""
namespaces := []string{}
items, err := cloud.ListRegistryItems(
	context.Background(),
	&organizationID,
	[]app.PackageType{app.PackageTypeModule},
	[]app.Visibility{app.VisibilityPublic},
	[]string{"linux/any"},
	[]app.RegistryItemStatus{app.RegistryItemStatusPublished},
	&app.ListRegistryItemsOptions{
		SearchTerm: &searchTerm,
		PageToken: &pageToken,
		PublicNamespaces: namespaces,
	},
)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to query registry items for.
• types (PackageType) (required): A list of types to query. If empty, will not filter on type.
• visibilities (Visibility) (required): A list of visibilities to query for. If empty, will not filter on visibility.
• platforms (string) (required): A list of platforms to query for. If empty, will not filter on platform.
• statuses (RegistryItemStatus) (required): A list of statuses to query for. If empty, will not filter on status.
• searchTerm (string) (optional): Optional search term to filter on.
• pageToken (string) (optional): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• itemID (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteRegistryItem(context.Background(), "namespace:name")

For more information, see the Go SDK Docs.

Parameters:

• itemId (string) (required): The ID of the item to delete.

Returns:

• (Promise)

Example:

await appClient.deleteRegistryItem('<YOUR-REGISTRY-ITEM-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID
• name (string)

Returns:

• (string)
• (string)
• (error): An error, if one occurred.

Example:

moduleID, url, err := cloud.CreateModule(
	context.Background(),
	"a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2",
	"module_name",
)

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization to create the module under.
• name (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• moduleID (string)
• visibility (Visibility)
• url
• description (string)
• models ([]*Model)
• apps ([]*App)
• entrypoint (string)
• opts (*UpdateModuleOptions)

Returns:

• (string)
• (error): An error, if one occurred.

Example:

model := &app.Model{
	API:   "rdk:service:generic",
	Model: "docs-test:new_test_module:test_model",
}
app := &app.App{
	Name:       "app_name",
	Type:       "app_type",
	Entrypoint: "entrypoint",
}
firstRun := "first_run.sh"
url, err := cloud.UpdateModule(
	context.Background(),
	"namespace:name",
	app.VisibilityPublic,
	"https://example.com",
	"description",
	[]*app.Model{model},
	[]*app.App{app},
	"entrypoint",
	&app.UpdateModuleOptions{FirstRun: &firstRun},
)

For more information, see the Go SDK Docs.

Parameters:

• moduleId (string) (required): The ID of the module to update.
• visibility (Visibility) (required): The visibility to set for the module.
• url (string) (required): The url to reference for documentation, code, etc.
• description (string) (required): A short description of the module.
• models (Model) (required): A list of models available in the module.
• entrypoint (string) (required): The executable to run to start the module program.

Returns:

• (Promise): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• fileInfo (ModuleFileInfo)
• file ([]byte)

Returns:

• (string)
• (error): An error, if one occurred.

Example:

moduleFileInfo := app.ModuleFileInfo{
	ModuleID: "namespace:name",
	Version:  "1.0.0",
	Platform: "darwin/arm64",
}
fileURL, err := cloud.UploadModuleFile(context.Background(), fileInfo, []byte("empty.txt"))

For more information, see the Go SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• moduleID (string)

Returns:

• (*Module)
• (error): An error, if one occurred.

Example:

module, err := cloud.GetModule(context.Background(), "namespace:name")

For more information, see the Go SDK Docs.

Parameters:

• moduleId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• opts (*ListModulesOptions)

Returns:

• ([]*Module)
• (error): An error, if one occurred.

Example:

orgID := "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2"
modules, err := cloud.ListModules(context.Background(), &app.ListModulesOptions{OrgID: &orgID})

For more information, see the Go SDK Docs.

Parameters:

• organizationId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (string)
• keyAuthorizations ([]APIKeyAuthorization)
• name (string)

Returns:

• (string)
• (string)
• (error): An error, if one occurred.

For more information, see the Go SDK Docs.

Parameters:

• authorizations (Authorization) (required): The list of authorizations to provide for the API key.
• name (string) (optional): An optional name for the key. If none is passed, defaults to present timestamp.

Returns:

• (Promise<CreateKeyResponse>): The new key and ID.

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)

Returns:

• (error): An error, if one occurred.

Example:

err := cloud.DeleteKey(context.Background(), "a1bcdefghi2jklmnopqrstuvw3xyzabc")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): The ID of the key to delete.

Returns:

• (Promise<DeleteKeyResponse>)

Example:

await appClient.deleteKey('<YOUR-KEY-ID>');

For more information, see the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• id (string)

Returns:

• (string)
• (string)
• (error): An error, if one occurred.

Example:

id, key, err := cloud.RotateKey(context.Background(), "a1bcdefghi2jklmnopqrstuvw3xyzabc")

For more information, see the Go SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• orgID (string)

Returns:

• ([]*APIKeyWithAuthorizations)
• (error): An error, if one occurred.

Example:

keys, err := cloud.ListKeys(context.Background(), "a1b2c345-abcd-1a2b-abc1-a1b23cd4561e2")

For more information, see the Go SDK Docs.

Parameters:

• orgId (string) (required): 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 the TypeScript SDK Docs.

Parameters:

• id (string) (required): 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 the TypeScript SDK Docs.