Class AppClient

Constructors

Properties

client: Client<{
    methods: {
        addRole: {
            I: typeof AddRoleRequest;
            O: typeof AddRoleResponse;
            kind: Unary;
            name: "AddRole";
        };
        changeRole: {
            I: typeof ChangeRoleRequest;
            O: typeof ChangeRoleResponse;
            kind: Unary;
            name: "ChangeRole";
        };
        checkPermissions: {
            I: typeof CheckPermissionsRequest;
            O: typeof CheckPermissionsResponse;
            kind: Unary;
            name: "CheckPermissions";
        };
        createFragment: {
            I: typeof CreateFragmentRequest;
            O: typeof CreateFragmentResponse;
            kind: Unary;
            name: "CreateFragment";
        };
        createKey: {
            I: typeof CreateKeyRequest;
            O: typeof CreateKeyResponse;
            kind: Unary;
            name: "CreateKey";
        };
        createKeyFromExistingKeyAuthorizations: {
            I: typeof CreateKeyFromExistingKeyAuthorizationsRequest;
            O: typeof CreateKeyFromExistingKeyAuthorizationsResponse;
            kind: Unary;
            name: "CreateKeyFromExistingKeyAuthorizations";
        };
        createLocation: {
            I: typeof CreateLocationRequest;
            O: typeof CreateLocationResponse;
            kind: Unary;
            name: "CreateLocation";
        };
        createLocationSecret: {
            I: typeof CreateLocationSecretRequest;
            O: typeof CreateLocationSecretResponse;
            kind: Unary;
            name: "CreateLocationSecret";
        };
        createModule: {
            I: typeof CreateModuleRequest;
            O: typeof CreateModuleResponse;
            kind: Unary;
            name: "CreateModule";
        };
        createOrganization: {
            I: typeof CreateOrganizationRequest;
            O: typeof CreateOrganizationResponse;
            kind: Unary;
            name: "CreateOrganization";
        };
        createOrganizationInvite: {
            I: typeof CreateOrganizationInviteRequest;
            O: typeof CreateOrganizationInviteResponse;
            kind: Unary;
            name: "CreateOrganizationInvite";
        };
        createRegistryItem: {
            I: typeof CreateRegistryItemRequest;
            O: typeof CreateRegistryItemResponse;
            kind: Unary;
            name: "CreateRegistryItem";
        };
        createRobotPartSecret: {
            I: typeof CreateRobotPartSecretRequest;
            O: typeof CreateRobotPartSecretResponse;
            kind: Unary;
            name: "CreateRobotPartSecret";
        };
        deleteFragment: {
            I: typeof DeleteFragmentRequest;
            O: typeof DeleteFragmentResponse;
            kind: Unary;
            name: "DeleteFragment";
        };
        deleteKey: {
            I: typeof DeleteKeyRequest;
            O: typeof DeleteKeyResponse;
            kind: Unary;
            name: "DeleteKey";
        };
        deleteLocation: {
            I: typeof DeleteLocationRequest;
            O: typeof DeleteLocationResponse;
            kind: Unary;
            name: "DeleteLocation";
        };
        deleteLocationSecret: {
            I: typeof DeleteLocationSecretRequest;
            O: typeof DeleteLocationSecretResponse;
            kind: Unary;
            name: "DeleteLocationSecret";
        };
        deleteOrganization: {
            I: typeof DeleteOrganizationRequest;
            O: typeof DeleteOrganizationResponse;
            kind: Unary;
            name: "DeleteOrganization";
        };
        deleteOrganizationInvite: {
            I: typeof DeleteOrganizationInviteRequest;
            O: typeof DeleteOrganizationInviteResponse;
            kind: Unary;
            name: "DeleteOrganizationInvite";
        };
        deleteOrganizationMember: {
            I: typeof DeleteOrganizationMemberRequest;
            O: typeof DeleteOrganizationMemberResponse;
            kind: Unary;
            name: "DeleteOrganizationMember";
        };
        deleteRegistryItem: {
            I: typeof DeleteRegistryItemRequest;
            O: typeof DeleteRegistryItemResponse;
            kind: Unary;
            name: "DeleteRegistryItem";
        };
        deleteRobot: {
            I: typeof DeleteRobotRequest;
            O: typeof DeleteRobotResponse;
            kind: Unary;
            name: "DeleteRobot";
        };
        deleteRobotPart: {
            I: typeof DeleteRobotPartRequest;
            O: typeof DeleteRobotPartResponse;
            kind: Unary;
            name: "DeleteRobotPart";
        };
        deleteRobotPartSecret: {
            I: typeof DeleteRobotPartSecretRequest;
            O: typeof DeleteRobotPartSecretResponse;
            kind: Unary;
            name: "DeleteRobotPartSecret";
        };
        disableBillingService: {
            I: typeof DisableBillingServiceRequest;
            O: typeof DisableBillingServiceResponse;
            kind: Unary;
            name: "DisableBillingService";
        };
        enableBillingService: {
            I: typeof EnableBillingServiceRequest;
            O: typeof EnableBillingServiceResponse;
            kind: Unary;
            name: "EnableBillingService";
        };
        getFragment: {
            I: typeof GetFragmentRequest;
            O: typeof GetFragmentResponse;
            kind: Unary;
            name: "GetFragment";
        };
        getFragmentHistory: {
            I: typeof GetFragmentHistoryRequest;
            O: typeof GetFragmentHistoryResponse;
            kind: Unary;
            name: "GetFragmentHistory";
        };
        getLocation: {
            I: typeof appApi.GetLocationRequest;
            O: typeof appApi.GetLocationResponse;
            kind: Unary;
            name: "GetLocation";
        };
        getModule: {
            I: typeof GetModuleRequest;
            O: typeof GetModuleResponse;
            kind: Unary;
            name: "GetModule";
        };
        getOrganization: {
            I: typeof GetOrganizationRequest;
            O: typeof GetOrganizationResponse;
            kind: Unary;
            name: "GetOrganization";
        };
        getOrganizationNamespaceAvailability: {
            I: typeof GetOrganizationNamespaceAvailabilityRequest;
            O: typeof GetOrganizationNamespaceAvailabilityResponse;
            kind: Unary;
            name: "GetOrganizationNamespaceAvailability";
        };
        getOrganizationsWithAccessToLocation: {
            I: typeof GetOrganizationsWithAccessToLocationRequest;
            O: typeof GetOrganizationsWithAccessToLocationResponse;
            kind: Unary;
            name: "GetOrganizationsWithAccessToLocation";
        };
        getRegistryItem: {
            I: typeof GetRegistryItemRequest;
            O: typeof GetRegistryItemResponse;
            kind: Unary;
            name: "GetRegistryItem";
        };
        getRobot: {
            I: typeof GetRobotRequest;
            O: typeof GetRobotResponse;
            kind: Unary;
            name: "GetRobot";
        };
        getRobotAPIKeys: {
            I: typeof GetRobotAPIKeysRequest;
            O: typeof GetRobotAPIKeysResponse;
            kind: Unary;
            name: "GetRobotAPIKeys";
        };
        getRobotPart: {
            I: typeof GetRobotPartRequest;
            O: typeof GetRobotPartResponse;
            kind: Unary;
            name: "GetRobotPart";
        };
        getRobotPartHistory: {
            I: typeof GetRobotPartHistoryRequest;
            O: typeof GetRobotPartHistoryResponse;
            kind: Unary;
            name: "GetRobotPartHistory";
        };
        getRobotPartLogs: {
            I: typeof GetRobotPartLogsRequest;
            O: typeof GetRobotPartLogsResponse;
            kind: Unary;
            name: "GetRobotPartLogs";
        };
        getRobotParts: {
            I: typeof GetRobotPartsRequest;
            O: typeof GetRobotPartsResponse;
            kind: Unary;
            name: "GetRobotParts";
        };
        getRoverRentalRobots: {
            I: typeof GetRoverRentalRobotsRequest;
            O: typeof GetRoverRentalRobotsResponse;
            kind: Unary;
            name: "GetRoverRentalRobots";
        };
        getUserIDByEmail: {
            I: typeof GetUserIDByEmailRequest;
            O: typeof GetUserIDByEmailResponse;
            kind: Unary;
            name: "GetUserIDByEmail";
        };
        listAuthorizations: {
            I: typeof ListAuthorizationsRequest;
            O: typeof ListAuthorizationsResponse;
            kind: Unary;
            name: "ListAuthorizations";
        };
        listFragments: {
            I: typeof ListFragmentsRequest;
            O: typeof ListFragmentsResponse;
            kind: Unary;
            name: "ListFragments";
        };
        listKeys: {
            I: typeof ListKeysRequest;
            O: typeof ListKeysResponse;
            kind: Unary;
            name: "ListKeys";
        };
        listLocations: {
            I: typeof ListLocationsRequest;
            O: typeof ListLocationsResponse;
            kind: Unary;
            name: "ListLocations";
        };
        listMachineFragments: {
            I: typeof ListMachineFragmentsRequest;
            O: typeof ListMachineFragmentsResponse;
            kind: Unary;
            name: "ListMachineFragments";
        };
        listModules: {
            I: typeof ListModulesRequest;
            O: typeof ListModulesResponse;
            kind: Unary;
            name: "ListModules";
        };
        listOrganizationMembers: {
            I: typeof ListOrganizationMembersRequest;
            O: typeof ListOrganizationMembersResponse;
            kind: Unary;
            name: "ListOrganizationMembers";
        };
        listOrganizations: {
            I: typeof ListOrganizationsRequest;
            O: typeof ListOrganizationsResponse;
            kind: Unary;
            name: "ListOrganizations";
        };
        listOrganizationsByUser: {
            I: typeof ListOrganizationsByUserRequest;
            O: typeof ListOrganizationsByUserResponse;
            kind: Unary;
            name: "ListOrganizationsByUser";
        };
        listRegistryItems: {
            I: typeof ListRegistryItemsRequest;
            O: typeof ListRegistryItemsResponse;
            kind: Unary;
            name: "ListRegistryItems";
        };
        listRobots: {
            I: typeof ListRobotsRequest;
            O: typeof ListRobotsResponse;
            kind: Unary;
            name: "ListRobots";
        };
        locationAuth: {
            I: typeof LocationAuthRequest;
            O: typeof LocationAuthResponse;
            kind: Unary;
            name: "LocationAuth";
        };
        markPartAsMain: {
            I: typeof MarkPartAsMainRequest;
            O: typeof MarkPartAsMainResponse;
            kind: Unary;
            name: "MarkPartAsMain";
        };
        markPartForRestart: {
            I: typeof MarkPartForRestartRequest;
            O: typeof MarkPartForRestartResponse;
            kind: Unary;
            name: "MarkPartForRestart";
        };
        newRobot: {
            I: typeof NewRobotRequest;
            O: typeof NewRobotResponse;
            kind: Unary;
            name: "NewRobot";
        };
        newRobotPart: {
            I: typeof NewRobotPartRequest;
            O: typeof NewRobotPartResponse;
            kind: Unary;
            name: "NewRobotPart";
        };
        organizationGetSupportEmail: {
            I: typeof OrganizationGetSupportEmailRequest;
            O: typeof OrganizationGetSupportEmailResponse;
            kind: Unary;
            name: "OrganizationGetSupportEmail";
        };
        organizationSetSupportEmail: {
            I: typeof OrganizationSetSupportEmailRequest;
            O: typeof OrganizationSetSupportEmailResponse;
            kind: Unary;
            name: "OrganizationSetSupportEmail";
        };
        removeRole: {
            I: typeof RemoveRoleRequest;
            O: typeof RemoveRoleResponse;
            kind: Unary;
            name: "RemoveRole";
        };
        renameKey: {
            I: typeof RenameKeyRequest;
            O: typeof RenameKeyResponse;
            kind: Unary;
            name: "RenameKey";
        };
        resendOrganizationInvite: {
            I: typeof ResendOrganizationInviteRequest;
            O: typeof ResendOrganizationInviteResponse;
            kind: Unary;
            name: "ResendOrganizationInvite";
        };
        rotateKey: {
            I: typeof RotateKeyRequest;
            O: typeof RotateKeyResponse;
            kind: Unary;
            name: "RotateKey";
        };
        shareLocation: {
            I: typeof ShareLocationRequest;
            O: typeof ShareLocationResponse;
            kind: Unary;
            name: "ShareLocation";
        };
        tailRobotPartLogs: {
            I: typeof TailRobotPartLogsRequest;
            O: typeof TailRobotPartLogsResponse;
            kind: ServerStreaming;
            name: "TailRobotPartLogs";
        };
        transferRegistryItem: {
            I: typeof TransferRegistryItemRequest;
            O: typeof TransferRegistryItemResponse;
            kind: Unary;
            name: "TransferRegistryItem";
        };
        unshareLocation: {
            I: typeof UnshareLocationRequest;
            O: typeof UnshareLocationResponse;
            kind: Unary;
            name: "UnshareLocation";
        };
        updateBillingService: {
            I: typeof UpdateBillingServiceRequest;
            O: typeof UpdateBillingServiceResponse;
            kind: Unary;
            name: "UpdateBillingService";
        };
        updateFragment: {
            I: typeof UpdateFragmentRequest;
            O: typeof UpdateFragmentResponse;
            kind: Unary;
            name: "UpdateFragment";
        };
        updateLocation: {
            I: typeof UpdateLocationRequest;
            O: typeof UpdateLocationResponse;
            kind: Unary;
            name: "UpdateLocation";
        };
        updateModule: {
            I: typeof UpdateModuleRequest;
            O: typeof UpdateModuleResponse;
            kind: Unary;
            name: "UpdateModule";
        };
        updateOrganization: {
            I: typeof UpdateOrganizationRequest;
            O: typeof UpdateOrganizationResponse;
            kind: Unary;
            name: "UpdateOrganization";
        };
        updateOrganizationInviteAuthorizations: {
            I: typeof UpdateOrganizationInviteAuthorizationsRequest;
            O: typeof UpdateOrganizationInviteAuthorizationsResponse;
            kind: Unary;
            name: "UpdateOrganizationInviteAuthorizations";
        };
        updateRegistryItem: {
            I: typeof UpdateRegistryItemRequest;
            O: typeof UpdateRegistryItemResponse;
            kind: Unary;
            name: "UpdateRegistryItem";
        };
        updateRobot: {
            I: typeof UpdateRobotRequest;
            O: typeof UpdateRobotResponse;
            kind: Unary;
            name: "UpdateRobot";
        };
        updateRobotPart: {
            I: typeof UpdateRobotPartRequest;
            O: typeof UpdateRobotPartResponse;
            kind: Unary;
            name: "UpdateRobotPart";
        };
        uploadModuleFile: {
            I: typeof UploadModuleFileRequest;
            O: typeof UploadModuleFileResponse;
            kind: ClientStreaming;
            name: "UploadModuleFile";
        };
    };
    typeName: "viam.app.v1.AppService";
}>

Type declaration

Methods

  • 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 (e.g., 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>

  • Changes an existing role.

    Parameters

    Returns Promise<void>

  • 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

  • Creates a new API key.

    Parameters

    • authorizations: Authorization[]

      The list of authorizations to provide for the API key

    • Optional name: string

      An optional name for the key. If none is passed, defaults to present timestamp

    Returns Promise<CreateKeyResponse>

    The new key and ID

  • 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

    • Optional parentLocationId: string

      Optional name of a parent location to create the new location under

    Returns Promise<undefined | Location>

    The location object

  • 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

  • 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

  • Create a new organization.

    Parameters

    • name: string

      The name of the new organization

    Returns Promise<undefined | Organization>

    The new organization

  • 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

  • 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>

  • 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

  • Deletes a fragment.

    Parameters

    • id: string

      The ID of the fragment to delete

    Returns Promise<void>

  • Deletes a location

    Parameters

    • locId: string

      The ID of the location to delete

    Returns 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>

  • Deletes an organization.

    Parameters

    • organizationId: string

      The id of the organization to delete

    Returns 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>

  • Removes a member from an organization.

    Parameters

    • organizationId: string

      The ID of the organization

    • userId: string

      The ID of the user

    Returns Promise<void>

  • Deletes a registry item.

    Parameters

    • itemId: string

      The ID of the item to delete

    Returns Promise<void>

  • Deletes a robot.

    Parameters

    • id: string

      The ID of the robot to delete

    Returns Promise<void>

  • Deletes a robot part.

    Parameters

    • partId: string

      The ID of the part to delete

    Returns 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>

  • Looks up a fragment by ID.

    Parameters

    • id: string

      The ID of the fragment to look up

    Returns Promise<undefined | Fragment>

    The requested fragment

  • Looks up a location.

    Parameters

    • locId: string

      The ID of the location to query.

    Returns Promise<undefined | Location>

    The location object

  • Looks up a particular module.

    Parameters

    • moduleId: string

      The ID of the module

    Returns Promise<undefined | Module>

    The requested module

  • Get details about an organization.

    Parameters

    • organizationId: string

      The ID of the organization

    Returns Promise<undefined | Organization>

    Details about the organization, if it exists

  • 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

  • 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

  • Get an item from the registry.

    Parameters

    • itemId: string

      The ID of the item to get

    Returns Promise<undefined | RegistryItem>

    The requested item

  • Queries a robot by its ID.

    Parameters

    • id: string

      The ID of the robot

    Returns Promise<undefined | appApi.Robot>

    The Robot object

  • 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

  • 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

  • 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

    • Optional filter: string

      Optional string to filter logs on

    • Optional levels: 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

  • 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

  • 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

  • Obain a user's ID from their email address.

    Parameters

    • email: string

      The email address of the user

    Returns Promise<string>

    The user's ID

  • List all authorizations for an organization.

    Parameters

    • organizationId: string

      The ID of the organization to list authorizations for

    • Optional resourceIds: string[]

      Optional list of IDs of resources to list authorizations for. If not provided, all resources will be included

    Returns Promise<Authorization[]>

    The list of authorizations

  • 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

  • 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

  • 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.

    • Optional additionalFragmentIds: string[]

      Additional fragment IDs to append to the response. Useful when needing to view fragments that will be provisionally added to the machine alongside existing fragments.

    Returns Promise<Fragment[]>

    The list of top level and nested fragments for a machine, as well as additionally specified fragment IDs.

  • Lists all modules for an organization.

    Parameters

    • organizationId: string

      The ID of the organization to query

    Returns Promise<Module[]>

    The organization's modules

  • 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

  • List all organizations.

    Returns Promise<Organization[]>

    The organization list

  • List all organizations associated with a user.

    Parameters

    • userId: string

      The ID of the user to query

    Returns Promise<OrgDetails[]>

    The list of locations the requested user has access to

  • 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

    • Optional searchTerm: string

      Optional search term to filter on

    • Optional pageToken: string

      Optional page token for results. If not provided, will return all results

    Returns Promise<RegistryItem[]>

    The list of registry items

  • 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

  • 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.

  • Marks a robot part as the main part.

    Parameters

    • partId: string

      The ID of the part to mark as main

    Returns Promise<void>

  • Marks a robot part for restart.

    Parameters

    • partId: string

      The ID of the part to mark for restart

    Returns Promise<void>

  • 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

  • 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

  • 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 (e.g., 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>

  • 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

  • Rotates an existing API key.

    Parameters

    • id: string

      The ID of the key to rotate

    Returns Promise<RotateKeyResponse>

    The updated key and ID

  • 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>

  • 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

    • Optional filter: 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>

  • 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>

  • 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

    • Optional makePublic: 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

    • Optional visibility: 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

  • Updates location details.

    Parameters

    • locId: string

      The ID of the location to update

    • Optional name: string

      Optional string to update the location's name to

    • Optional parentLocId: string

      Optional string to update the location's parent location to

    • Optional region: string

      Optional string to update the location's region to

    Returns Promise<undefined | Location>

    The location object

  • 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

  • Updates organization details.

    Parameters

    • organizationId: string

      The id of the organization to update

    • Optional name: string

      Optional name to update the organization with

    • Optional publicNamespace: string

      Optional namespace to update the organization with

    • Optional region: string

      Optional region to update the organization with

    • Optional cid: string

      Optional CRM ID to update the organization with

    Returns Promise<undefined | Organization>

    The updated organization details

  • 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

  • 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>

  • Updates an existing robot's name and/or location.

    Parameters

    • robotId: string

      The ID of the robot to update

    • locId: string

      The ID of the location to move the robot to

    • name: string

      The name to update the robot to

    Returns Promise<undefined | appApi.Robot>

    The newly-modified robot object

  • 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

Generated using TypeDoc