@budibase/types 3.2.25 → 3.2.26

package/dist/api/web/auth.d.ts

@@ -2,13 +2,26 @@ export interface LoginRequest {
     username: string;
     password: string;
 }
+export interface LogoutResponse {
+    message: string;
+}
+export interface SetInitInfoRequest extends Record<string, any> {
+}
+export interface GetInitInfoResponse extends Record<string, any> {
+}
 export interface PasswordResetRequest {
     email: string;
 }
+export interface PasswordResetResponse {
+    message: string;
+}
 export interface PasswordResetUpdateRequest {
     resetCode: string;
     password: string;
 }
+export interface PasswordResetUpdateResponse {
+    message: string;
+}
 export interface UpdateSelfRequest {
     firstName?: string;
     lastName?: string;

package/dist/api/web/global/configs.d.ts

@@ -1,4 +1,4 @@
-import { SettingsConfig, SettingsInnerConfig } from "../../../documents";
+import { Config, ConfigType, SettingsBrandingConfig, SettingsConfig, SettingsInnerConfig } from "../../../documents";
 /**
  * Settings that aren't stored in the database - enriched at runtime.
  */
@@ -18,3 +18,31 @@ export interface PublicOIDCConfig {
     uuid?: string;
 }
 export type GetPublicOIDCConfigResponse = PublicOIDCConfig[];
+export interface SaveConfigRequest extends Config {
+}
+export interface SaveConfigResponse {
+    type: ConfigType;
+    _id: string;
+    _rev: string;
+}
+export interface DeleteConfigResponse {
+    message: string;
+}
+interface ChecklistItem {
+    checked: boolean;
+    label: string;
+    link: string;
+}
+export interface ConfigChecklistResponse {
+    apps: ChecklistItem;
+    smtp: ChecklistItem;
+    adminUser: ChecklistItem;
+    sso: ChecklistItem;
+    branding: SettingsBrandingConfig;
+}
+export type FindConfigResponse = Config | {};
+export interface UploadConfigFileResponse {
+    message: string;
+    url: string;
+}
+export {};

package/dist/api/web/global/email.d.ts

@@ -0,0 +1,26 @@
+import { EmailAttachment, EmailInvite } from "../../../documents";
+export declare enum EmailTemplatePurpose {
+    CORE = "core",
+    BASE = "base",
+    PASSWORD_RECOVERY = "password_recovery",
+    INVITATION = "invitation",
+    WELCOME = "welcome",
+    CUSTOM = "custom"
+}
+export interface SendEmailRequest {
+    workspaceId?: string;
+    email: string;
+    userId: string;
+    purpose: EmailTemplatePurpose;
+    contents?: string;
+    from?: string;
+    subject: string;
+    cc?: boolean;
+    bcc?: boolean;
+    automation?: boolean;
+    invite?: EmailInvite;
+    attachments?: EmailAttachment[];
+}
+export interface SendEmailResponse extends Record<string, any> {
+    message: string;
+}

package/dist/api/web/global/index.d.ts

@@ -5,3 +5,7 @@ export * from "./configs";
 export * from "./scim";
 export * from "./license";
 export * from "./oldMigration";
+export * from "./email";
+export * from "./role";
+export * from "./self";
+export * from "./template";

package/dist/api/web/global/license.d.ts

@@ -1,3 +1,4 @@
+import { QuotaUsage } from "../../../documents";
 export interface ActivateLicenseKeyRequest {
     licenseKey: string;
 }
@@ -13,3 +14,5 @@ export interface GetOfflineLicenseTokenResponse {
 export interface GetOfflineIdentifierResponse {
     identifierBase64: string;
 }
+export interface GetQuotaUsageResponse extends QuotaUsage {
+}

package/dist/api/web/global/role.d.ts

@@ -0,0 +1,15 @@
+import { Role } from "../../../documents";
+interface GlobalRoleResponse {
+    roles: Role[];
+    name: string;
+    version: string;
+    url?: string;
+}
+export interface FetchGlobalRolesResponse extends Record<string, GlobalRoleResponse> {
+}
+export interface FindGlobalRoleResponse extends GlobalRoleResponse {
+}
+export interface RemoveAppRoleResponse {
+    message: string;
+}
+export {};

package/dist/api/web/global/self.d.ts

@@ -0,0 +1,11 @@
+import { DevInfo, User } from "../../../documents";
+export interface GenerateAPIKeyRequest {
+    userId: string;
+}
+export interface GenerateAPIKeyResponse extends DevInfo {
+}
+export interface FetchAPIKeyResponse extends DevInfo {
+}
+export interface GetGlobalSelfResponse extends User {
+    flags?: Record<string, string>;
+}

package/dist/api/web/global/template.d.ts

@@ -0,0 +1,26 @@
+import { Template } from "../../../documents";
+export interface GlobalTemplateDefinition {
+    name: string;
+    description: string;
+    category: string;
+}
+export interface GlobalTemplateBinding {
+    name: string;
+    description: string;
+}
+export interface FetchGlobalTemplateDefinitionResponse {
+    info: Record<string, GlobalTemplateDefinition>;
+    bindings: Record<string, GlobalTemplateBinding[]>;
+}
+export interface SaveGlobalTemplateRequest extends Template {
+}
+export interface SaveGlobalTemplateResponse extends Template {
+}
+export type FetchGlobalTemplateResponse = Template[];
+export type FetchGlobalTemplateByTypeResponse = Template[];
+export type FetchGlobalTemplateByOwnerIDResponse = Template[];
+export interface FindGlobalTemplateResponse extends Template {
+}
+export interface DeleteGlobalTemplateResponse {
+    message: string;
+}

package/dist/api/web/system/account.d.ts

@@ -0,0 +1,5 @@
+import { Account, AccountMetadata } from "../../../documents";
+export interface SaveAccountRequest extends Account {
+}
+export interface SaveAccountResponse extends AccountMetadata {
+}

package/dist/api/web/system/environment.d.ts

@@ -1,8 +1,13 @@
 export interface GetEnvironmentResponse {
     multiTenancy: boolean;
+    offlineMode: boolean;
     cloud: boolean;
-    accountPortalUrl: string;
-    baseUrl: string;
+    accountPortalUrl?: string;
     disableAccountPortal: boolean;
+    baseUrl?: string;
     isDev: boolean;
+    maintenance: {
+        type: string;
+    }[];
+    passwordMinLength?: string;
 }

package/dist/api/web/system/index.d.ts

@@ -1,3 +1,8 @@
 export * from "./environment";
 export * from "./status";
 export * from "./ops";
+export * from "./account";
+export * from "./log";
+export * from "./migration";
+export * from "./restore";
+export * from "./tenant";

package/dist/api/web/system/log.d.ts

@@ -0,0 +1 @@
+export type GetLogResponse = Buffer;

package/dist/api/web/system/migration.d.ts

@@ -0,0 +1,4 @@
+import { MigrationDefinition, MigrationOptions } from "../../../sdk";
+export interface RunGlobalMigrationRequest extends MigrationOptions {
+}
+export type FetchMigrationDefinitionsResponse = MigrationDefinition[];

package/dist/api/web/system/restore.d.ts

@@ -0,0 +1,3 @@
+export interface SystemRestoreResponse {
+    message: string;
+}

package/dist/api/web/system/tenant.d.ts

@@ -0,0 +1,3 @@
+export interface GetTenantInfoResponse {
+    exists: boolean;
+}

package/dist/api/web/user.d.ts

@@ -1,5 +1,12 @@
-import { User } from "../../documents";
+import { AccountMetadata, PlatformUser, User } from "../../documents";
 import { SearchFilters } from "../../sdk";
+export interface Invite {
+    email: string;
+    info: any;
+}
+export interface InviteWithCode extends Invite {
+    code: string;
+}
 export interface SaveUserResponse {
     _id: string;
     _rev: string;
@@ -47,11 +54,24 @@ export interface InviteUserRequest {
     email: string;
     userInfo: any;
 }
+export interface InviteUserResponse {
+    message: string;
+    successful: {
+        email: string;
+    }[];
+    unsuccessful: {
+        email: string;
+        reason: string;
+    }[];
+}
 export interface DeleteInviteUserRequest {
     code: string;
 }
 export type InviteUsersRequest = InviteUserRequest[];
 export type DeleteInviteUsersRequest = DeleteInviteUserRequest[];
+export interface DeleteInviteUsersResponse {
+    message: string;
+}
 export interface InviteUsersResponse {
     successful: {
         email: string;
@@ -69,6 +89,15 @@ export interface SearchUsersRequest {
     limit?: number;
     paginate?: boolean;
 }
+export interface SearchUsersResponse {
+    data: User[];
+    hasNextPage?: boolean;
+    nextPage?: string;
+}
+export type FetchUsersResponse = User[];
+export interface FindUserResponse extends User {
+}
+export type LookupTenantUserResponse = PlatformUser;
 export interface CreateAdminUserRequest {
     email: string;
     password?: string;
@@ -101,3 +130,23 @@ export interface AcceptUserInviteResponse {
 export interface SyncUserRequest {
     previousUser?: User;
 }
+export interface DeleteUserResponse {
+    message: string;
+}
+export interface CountUserResponse {
+    userCount: number;
+}
+export interface CheckInviteResponse {
+    email: string;
+}
+export type GetUserInvitesResponse = InviteWithCode[];
+export interface UpdateInviteRequest extends Omit<Invite, "email"> {
+    email?: string;
+    builder?: {
+        apps: string[];
+    };
+    apps: string[];
+}
+export interface UpdateInviteResponse extends Invite {
+}
+export type LookupAccountHolderResponse = AccountMetadata | null;

package/dist/documents/global/devInfo.d.ts

@@ -0,0 +1,5 @@
+import { Document } from "../document";
+export interface DevInfo extends Document {
+    userId: string;
+    apiKey?: string;
+}

package/dist/documents/global/index.d.ts

@@ -8,3 +8,4 @@ export * from "./templates";
 export * from "./environmentVariables";
 export * from "./auditLogs";
 export * from "./apikeys";
+export * from "./devInfo";

package/dist/index.js

@@ -65,6 +65,7 @@ __export(src_exports, {
   DeploymentStatus: () => DeploymentStatus,
   DocumentType: () => DocumentType,
   DocumentTypesToImport: () => DocumentTypesToImport,
+  EmailTemplatePurpose: () => EmailTemplatePurpose,
   EmptyFilterOption: () => EmptyFilterOption,
   Event: () => Event,
   EventPublishType: () => EventPublishType,
@@ -1549,6 +1550,17 @@ var EventPublishType = /* @__PURE__ */ ((EventPublishType2) => {
   return EventPublishType2;
 })(EventPublishType || {});
 
+// src/api/web/global/email.ts
+var EmailTemplatePurpose = /* @__PURE__ */ ((EmailTemplatePurpose2) => {
+  EmailTemplatePurpose2["CORE"] = "core";
+  EmailTemplatePurpose2["BASE"] = "base";
+  EmailTemplatePurpose2["PASSWORD_RECOVERY"] = "password_recovery";
+  EmailTemplatePurpose2["INVITATION"] = "invitation";
+  EmailTemplatePurpose2["WELCOME"] = "welcome";
+  EmailTemplatePurpose2["CUSTOM"] = "custom";
+  return EmailTemplatePurpose2;
+})(EmailTemplatePurpose || {});
+
 // src/api/web/template.ts
 var TemplateType = /* @__PURE__ */ ((TemplateType2) => {
   TemplateType2["APP"] = "app";
@@ -1623,6 +1635,7 @@ var EventType = /* @__PURE__ */ ((EventType2) => {
   DeploymentStatus,
   DocumentType,
   DocumentTypesToImport,
+  EmailTemplatePurpose,
   EmptyFilterOption,
   Event,
   EventPublishType,