TagoIO SDK for JavaScript and TypeScript
    Preparing search index...

    Class Run

    Hierarchy

    Index

    Constructors

    Methods

    • Parameters

      • data: { body: string; subject: string }

      Returns Promise<string>

      Tests the email configuration by sending a test message.

      const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
      const result = await resources.run.emailTest({ subject: "Test Email", body: "This is a test message" });
      console.log(result); // E-mail sent to example@email.com
    • Type Parameters

      Parameters

      • query: T

      Returns Promise<
          UserListItem<
              T["fields"] extends (keyof UserInfo)[]
                  ? any[any][number]
                  : "name" | "id",
          >[],
      >

      Retrieves a paginated list of Run users with customizable fields and filtering options.

      If receive an error "Authorization Denied", or return empty list check policy Run User / Access in Access Management.

      const result = await Resources.run.listUsers({
      page: 1,
      fields: ["id", "name", "email"],
      amount: 20
      });
      console.log(result); // [ { id: 'user-id-123', name: 'John Doe', email: 'example@email.com' } ]
    • Parameters

      Returns Promise<LoginResponseRun>

      Generates a login token to authenticate as a specific Run user.

      If receive an error "Authorization Denied", check policy Run User / Login as user in Access Management.

      const result = await Resources.run.loginAsUser("user-id-123");
      console.log(result.token); // "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."
    • Parameters

      Returns Promise<{ id: string }>

      Creates a new notification for a Run user.

      If receive an error "Authorization Denied", check policy Run User / Create notification in Access Management.

      const result = await Resources.run.notificationCreate("user-id-123", { title: "Update", message: "New feature available" });
      console.log(result); // { id: 'notification-id-123' }
    • Parameters

      • notificationID: string

      Returns Promise<string>

      Deletes a notification from the Run environment.

      If receive an error "Authorization Denied", check policy Run User / Delete notification in Access Management.

      const result = await Resources.run.notificationDelete("notification-id-123");
      console.log(result); // Successfully Removed
    • Parameters

      Returns Promise<string>

      Updates an existing notification in the Run environment.

      If receive an error "Authorization Denied", check policy Run User / Edit notification in Access Management.

      const result = await Resources.run.notificationEdit("notification-id-123", { title: "Updated Title" });
      console.log(result); // TagoIO Notification User Successfully Updated
    • Parameters

      • profile_id: string

      Returns Promise<string>

      Regenerates the custom domain configuration for a Run profile.

      const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
      const result = await resources.run.regenerateCustomDomain("profile-id-123");
      console.log(result);
    • Parameters

      • userID: string

      Returns Promise<string>

      Permanently deletes a user from the Run environment.

      If receive an error "Authorization Denied", check policy Run User / Delete in Access Management.

      const result = await Resources.run.userDelete("user-id-123");
      console.log(result); // Successfully Removed
    • Parameters

      Returns Promise<string>

      Updates information for an existing Run user.

      If receive an error "Authorization Denied", check policy Run User / Edit in Access Management.

      const userData = ;
      const result = await Resources.run.userEdit("user-id-123", { name: "Updated Name" });
      console.log(result); // TagoIO Run User Successfully Updated
    • Parameters

      • userID: string

      Returns Promise<UserInfo>

      Retrieves detailed information about a specific Run user.

      If receive an error "Authorization Denied", check policy Run User / Access in Access Management.

      const result = await Resources.run.userInfo("user-id-123");
      console.log(result); // { id: 'user-id-123', name: 'John Doe', email: 'example@email.com', ... }