Class Run

Hierarchy

TagoIOModule<GenericModuleParams>
- Run

Constructors

constructor

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

Methods

createCustomDomain

createCustomDomain(profile_id, customDomainData): Promise<string>
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.
- Defined in modules/Resources/Run.ts:198

deleteCustomDomain

deleteCustomDomain(profile_id): Promise<string>
delete a TagoRUN custom domain for the profile.
Parameters
- profile_id: string
  ID of the profile
Returns Promise<string>
Success message.
- Defined in modules/Resources/Run.ts:231

edit

edit(data): Promise<string>
Parameters
- data: RecursivePartial<RunInfo>
Returns Promise<string>
- Defined in modules/Resources/Run.ts:31

emailTest

emailTest(data): Promise<string>
Parameters
- data: {
  body: string;
  subject: string;
  }
  - body: string
  - subject: string
Returns Promise<string>
- Defined in modules/Resources/Run.ts:113

getCustomDomain

getCustomDomain(profile_id): Promise<CustomDomainInfo>
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.
- Defined in modules/Resources/Run.ts:214

info

info(): Promise<RunInfo>
Returns Promise<RunInfo>
- Defined in modules/Resources/Run.ts:22

listUsers

listUsers<T>(query): Promise<UserListItem<T["fields"] extends (keyof UserInfo)[]
? any[any][number]
: "id" | "name">[]>
Type Parameters
- T extends UserQuery
Parameters
- query: T
Returns Promise<UserListItem<T["fields"] extends (keyof UserInfo)[]
? any[any][number]
: "id" | "name">[]>
- Defined in modules/Resources/Run.ts:41

loginAsUser

loginAsUser(userID, options?): Promise<LoginResponseRun>
Parameters
- userID: string
- Optional options: LoginAsUserOptions
Returns Promise<LoginResponseRun>
- Defined in modules/Resources/Run.ts:101

notificationCreate

notificationCreate(userID, data): Promise<{
id: string;
}>
Parameters
- userID: string
- data: NotificationCreate
Returns Promise<{
id: string;
}>
- Defined in modules/Resources/Run.ts:132

notificationDelete

notificationDelete(notificationID): Promise<string>
Parameters
- notificationID: string
Returns Promise<string>
- Defined in modules/Resources/Run.ts:155

notificationEdit

notificationEdit(notificationID, data): Promise<string>
Parameters
- notificationID: string
- data: Partial<NotificationCreate>
Returns Promise<string>
- Defined in modules/Resources/Run.ts:145

notificationList

notificationList(userID): Promise<NotificationInfo[]>
Parameters
- userID: string
Returns Promise<NotificationInfo[]>
- Defined in modules/Resources/Run.ts:123

regenerateCustomDomain

regenerateCustomDomain(profile_id): Promise<string>
Regenerate a TagoRUN custom domain for the profile.
Parameters
- profile_id: string
  ID of the profile
Returns Promise<string>
Success message.
- Defined in modules/Resources/Run.ts:246

ssoSAMLEdit

ssoSAMLEdit(data): Promise<string>
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>
- Defined in modules/Resources/Run.ts:181

ssoSAMLInfo

ssoSAMLInfo(): Promise<RunSAMLInfo>
Get the SAML Single Sign-On information for the account's RUN.

Returns Promise<RunSAMLInfo>
- Defined in modules/Resources/Run.ts:167

userCreate

userCreate(data): Promise<UserCreateResponse>
Parameters
- data: UserCreateInfo
Returns Promise<UserCreateResponse>
- Defined in modules/Resources/Run.ts:72

userDelete

userDelete(userID): Promise<string>
Parameters
- userID: string
Returns Promise<string>
- Defined in modules/Resources/Run.ts:92

userEdit

userEdit(userID, data): Promise<string>
Parameters
- userID: string
- data: Partial<UserInfo>
Returns Promise<string>
- Defined in modules/Resources/Run.ts:82

userInfo

userInfo(userID): Promise<UserInfo>
Parameters
- userID: string
Returns Promise<UserInfo>
- Defined in modules/Resources/Run.ts:61