Class Run

Hierarchy

TagoIOModule<GenericModuleParams>
- Run

Constructors

constructor

new Run(params: GenericModuleParams): Run

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Run

Methods

createCustomDomain

createCustomDomain(profile_id: string, customDomainData: CustomDomainCreate): Promise<string>

- Defined in src/modules/Account/Run.ts:195
Create a TagoRUN custom domain for the profile.

Parameters
- profile_id: string
  
  ID of the profile
- customDomainData: CustomDomainCreate
  
  query params
Returns Promise<string>
Success message.

deleteCustomDomain

deleteCustomDomain(profile_id: string): Promise<string>

- Defined in src/modules/Account/Run.ts:228
delete a TagoRUN custom domain for the profile.

Parameters
- profile_id: string
  
  ID of the profile
Returns Promise<string>
Success message.

edit

edit(data: RecursivePartial<RunInfo>): Promise<string>

- Defined in src/modules/Account/Run.ts:30
Parameters
- data: RecursivePartial<RunInfo>
Returns Promise<string>

emailTest

emailTest(data: { body: string; subject: string }): Promise<string>

- Defined in src/modules/Account/Run.ts:110
Parameters
- data: { body: string; subject: string }
  - body: string
  - subject: string
Returns Promise<string>

getCustomDomain

getCustomDomain(profile_id: string): Promise<CustomDomainInfo>

- Defined in src/modules/Account/Run.ts:211
Get details of TagoRun custom domain for the profile.

Parameters
- profile_id: string
  
  ID of the profile
Returns Promise<CustomDomainInfo>
Data for the profile's custom DNS configuration.

info

info(): Promise<RunInfo>

- Defined in src/modules/Account/Run.ts:21
Returns Promise<RunInfo>

listUsers

listUsers(query: UserQuery): Promise<Partial<UserInfo>[]>

- Defined in src/modules/Account/Run.ts:40
Parameters
- query: UserQuery
Returns Promise<Partial<UserInfo>[]>

loginAsUser

loginAsUser(userID: string, options?: LoginAsUserOptions): Promise<Types.Account.Run.LoginResponse>

- Defined in src/modules/Account/Run.ts:98
Parameters
- userID: string
- Optional options: LoginAsUserOptions
Returns Promise<Types.Account.Run.LoginResponse>

notificationCreate

notificationCreate(userID: string, data: NotificationCreate): Promise<{ id: string }>

- Defined in src/modules/Account/Run.ts:129
Parameters
- userID: string
- data: NotificationCreate
Returns Promise<{ id: string }>

notificationDelete

notificationDelete(notificationID: string): Promise<string>

- Defined in src/modules/Account/Run.ts:152
Parameters
- notificationID: string
Returns Promise<string>

notificationEdit

notificationEdit(notificationID: string, data: Partial<NotificationCreate>): Promise<string>

- Defined in src/modules/Account/Run.ts:142
Parameters
- notificationID: string
- data: Partial<NotificationCreate>
Returns Promise<string>

notificationList

notificationList(userID: string): Promise<NotificationInfo[]>

- Defined in src/modules/Account/Run.ts:120
Parameters
- userID: string
Returns Promise<NotificationInfo[]>

regenerateCustomDomain

regenerateCustomDomain(profile_id: string): Promise<string>

- Defined in src/modules/Account/Run.ts:243
Regenerate a TagoRUN custom domain for the profile.

Parameters
- profile_id: string
  
  ID of the profile
Returns Promise<string>
Success message.

ssoSAMLEdit

ssoSAMLEdit(data: RunSAMLEditInfo): Promise<string>

- Defined in src/modules/Account/Run.ts:178
Edit the SAML Single Sign-On metadata and mappings for the account's RUN.

Parameters
- data: RunSAMLEditInfo
  
  Updated data for a RUN's SAML Single Sign-On configuration.
Returns Promise<string>

ssoSAMLInfo

ssoSAMLInfo(): Promise<RunSAMLInfo>

- Defined in src/modules/Account/Run.ts:164
Get the SAML Single Sign-On information for the account's RUN.

Returns Promise<RunSAMLInfo>

userCreate

userCreate(data: UserCreateInfo): Promise<UserCreateResponse>

- Defined in src/modules/Account/Run.ts:69
Parameters
- data: UserCreateInfo
Returns Promise<UserCreateResponse>

userDelete

userDelete(userID: string): Promise<string>

- Defined in src/modules/Account/Run.ts:89
Parameters
- userID: string
Returns Promise<string>

userEdit

userEdit(userID: string, data: Partial<UserInfo>): Promise<string>

- Defined in src/modules/Account/Run.ts:79
Parameters
- userID: string
- data: Partial<UserInfo>
Returns Promise<string>

userInfo

userInfo(userID: string): Promise<UserInfo>

- Defined in src/modules/Account/Run.ts:58
Parameters
- userID: string
Returns Promise<UserInfo>