commandbar 1.10.0 → 1.10.2-alpha

package/build/internal/src/middleware/types.d.ts

@@ -11,13 +11,12 @@ import { OrganizationStatusV, KeyEventV, RecordSettingsByContextKeyV, InternalSe
 import { OrganizationSettingsV } from './organizationSettings';
 import { UserV } from './user';
 import { ContextV } from './context';
-import { GuideV } from './guide';
 import { HistoryEventV } from './historyEvent';
 import { HelpDocSyncLogMessageV, HelpDocsSyncV } from './helpDocsSync';
 import { HelpDocsIntegrationV } from './helpDocsIntegration';
 import { EndUserStoreDataV, EndUserV, NudgeInteractionStateV, NudgeInteractionsV, ChecklistInteractionStateV, ChecklistInteractionsV, DecideResponseV } from './endUser';
 import { SkinV } from './skin';
-import { ThemeV, ThemeV2V } from './theme';
+import { ThemeV, ThemeV2V, ThemeModeV } from './theme';
 import { ProfileV } from './profile';
 import { PlaceholderV } from './placeholder';
 import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
@@ -32,7 +31,7 @@ import { AudienceV } from './helpers/audience';
 import { AdditionalResourceV } from './additionalResource';
 import { RecommendationSetV } from './recommendationSet';
 import { BillingProfileV, UsageV } from './billing';
-import { UserMessageV, AIMessageV, MessageV, AIAnswerPayloadV, AIAnswerV, ContinuationsPayloadV, ContinuationV, CreateAnswerFeedbackPayloadV, QuestionSuggestionsPayloadV, QuestionSuggestionsV, ExperienceV, CreateChatPayloadV, ChatV, CopilotSettingsPreviewV } from './chat';
+import { UserMessageV, AIMessageV, AIMessageExtraV, MessageV, AIAnswerPayloadV, AIAnswerV, ContinuationsPayloadV, ContinuationV, CreateAnswerFeedbackPayloadV, QuestionSuggestionsPayloadV, QuestionSuggestionsV, ExperienceV, CreateChatPayloadV, ChatV, CopilotSettingsPreviewV, HandoffPayloadV, ExternalChatPayloadV, ExternalChatHistoryV } from './chat';
 import { HelpDocHitV, SearchHelpDocsPayloadV, SearchHelpDocsResponseV } from './helpDocsSearch';
 import { ExperienceHitV, ExperienceTypeOptions, SearchExperiencesPayloadV, SearchExperiencesResponseV } from './experiencesSearch';
 import { HelpHubLauncherSettingsV } from './helpHub';
@@ -40,13 +39,19 @@ import { EntityChangeV } from './entityChanges';
 import { Flags } from './flags';
 import { CopilotPersonalityAdjectiveV, CopilotPersonalityResponseFormatV, CopilotPersonalityResponseLengthV, CopilotPersonalityV } from './helpers/copilotPersonality';
 import { ExperienceTemplateV } from './experienceTemplate';
+import { APIV } from './api';
+import { LocalizedMessagePatchV, LocalizedMessageV, LocalizedMessages } from './localizedMessage';
+import { WorkflowV } from './workflow';
 /*******************************************************************************/
 export type IInitOptions = {
+    apiOrigin?: string;
+    cdnOrigin?: string;
     debug?: boolean;
     environment?: string;
     version?: string;
     config?: any;
     nonce?: string;
+    silentMode?: boolean;
 };
 /** Additional foobar init options */
 export declare const SUPPORTED_FOOBAR_INIT_DEPLOYMENT_OPTIONS: readonly ["dev", "labs", "prod"];
@@ -63,9 +68,6 @@ export type IEditorCommandTypeLite = t.TypeOf<typeof EditorCommandLiteV> & unkno
 export type ICommandTypeLite = t.TypeOf<typeof CommandLiteV> & unknown;
 export type { ICommandFromClientType } from './ICommandFromClientType';
 export type ICommandCategoryType = t.TypeOf<typeof CommandCategoryV> & unknown;
-export type IGuideType = t.TypeOf<typeof GuideV> & {
-    preview?: boolean;
-} & unknown;
 export type IHistoryEventType = t.TypeOf<typeof HistoryEventV> & unknown;
 export type IEntityChangeType = t.TypeOf<typeof EntityChangeV> & unknown;
 export type IHelpDocsSyncType = t.TypeOf<typeof HelpDocsSyncV> & unknown;
@@ -78,6 +80,7 @@ export type IInternalSettingsType = t.TypeOf<typeof InternalSettingsV> & unknown
 export type ISkinType = t.TypeOf<typeof SkinV> & unknown;
 export type IThemeType = t.TypeOf<typeof ThemeV> & unknown;
 export type IThemeV2Type = t.TypeOf<typeof ThemeV2V> & unknown;
+export type IThemeModeType = t.TypeOf<typeof ThemeModeV> & unknown;
 export type IProfileType = t.TypeOf<typeof ProfileV> & unknown;
 export type IOrganizationSettingsType = t.TypeOf<typeof OrganizationSettingsV> & unknown;
 export type IPlaceholderType = t.TypeOf<typeof PlaceholderV> & unknown;
@@ -123,6 +126,12 @@ export type INudgeTooltipStepType = INudgeStepType & {
         type: 'tooltip';
     };
 };
+export type INudgePinStepType = INudgeStepType & {
+    form_factor: {
+        type: 'pin';
+    };
+};
+export type INudgeAnchorableStepType = INudgeTooltipStepType | INudgePinStepType;
 export type INudgeStepContentBlockType = t.TypeOf<typeof NudgeContentBlockV> & unknown;
 export type INudgeStepContentMarkdownBlockType = t.TypeOf<typeof NudgeContentMarkdownBlockV> & unknown;
 export type INudgeStepContentImageBlockType = t.TypeOf<typeof NudgeContentImageBlockV> & unknown;
@@ -166,6 +175,7 @@ export type NudgeInteractions = t.TypeOf<typeof NudgeInteractionsV> & unknown;
 export type IMessageType = t.TypeOf<typeof MessageV> & unknown;
 export type IUserMessageType = t.TypeOf<typeof UserMessageV> & unknown;
 export type IAIMessageType = t.TypeOf<typeof AIMessageV> & unknown;
+export type IAIMessageExtraType = t.TypeOf<typeof AIMessageExtraV> & unknown;
 export type IQuestionSuggestionsType = t.TypeOf<typeof QuestionSuggestionsV> & unknown;
 export type IQuestionSuggestionsPayloadType = t.TypeOf<typeof QuestionSuggestionsPayloadV> & unknown;
 export type ICreateChatPayloadType = t.TypeOf<typeof CreateChatPayloadV> & unknown;
@@ -174,6 +184,9 @@ export type IExperienceType = t.TypeOf<typeof ExperienceV> & unknown;
 export type IContinuationsPayloadType = t.TypeOf<typeof ContinuationsPayloadV> & unknown;
 export type IAIAnswerType = t.TypeOf<typeof AIAnswerV> & unknown;
 export type IAIAnswerPayloadType = t.TypeOf<typeof AIAnswerPayloadV> & unknown;
+export type IHandoffPayloadType = t.TypeOf<typeof HandoffPayloadV> & unknown;
+export type IExternalChatPayloadType = t.TypeOf<typeof ExternalChatPayloadV> & unknown;
+export type IExternalChatHistoryType = t.TypeOf<typeof ExternalChatHistoryV> & unknown;
 export type ICreateAnswerFeedbackPayloadType = t.TypeOf<typeof CreateAnswerFeedbackPayloadV> & unknown;
 export type ISearchHelpDocsPayloadType = t.TypeOf<typeof SearchHelpDocsPayloadV> & unknown;
 export type ISearchHelpDocsResponseType = t.TypeOf<typeof SearchHelpDocsResponseV> & unknown;
@@ -229,6 +242,10 @@ export interface IResourceType extends IUserContext {
 }
 export type IAdditionalResource = t.TypeOf<typeof AdditionalResourceV> & unknown;
 export type IRecommendationSet = t.TypeOf<typeof RecommendationSetV> & unknown;
+export type ILocalizedMessage = t.TypeOf<typeof LocalizedMessageV> & unknown;
+export type ILocalizedMessagePatch = t.TypeOf<typeof LocalizedMessagePatchV> & unknown;
+export type IAPI = t.TypeOf<typeof APIV> & unknown;
+export type IWorkflow = t.TypeOf<typeof WorkflowV> & unknown;
 export type IConfigEndpointResponse = {
     commands: any[];
     categories: any[];
@@ -244,6 +261,7 @@ export type IConfigEndpointResponse = {
     __meta__?: {
         latest_foobar_version?: string;
     };
+    localized_messages: LocalizedMessages;
 };
 export type IConfigType = {
     commands: ICommandType[];
@@ -260,6 +278,7 @@ export type IConfigType = {
         latest_foobar_version?: string;
     };
     flags: Flags;
+    localized_messages: LocalizedMessages;
 };
 export type { IRecordSettings } from './IRecordSettings';
 export type IRecordSettingsByContextKey = t.TypeOf<typeof RecordSettingsByContextKeyV> & unknown;

package/build/internal/src/middleware/user.d.ts

@@ -7,7 +7,15 @@ export declare const UserV: t.IntersectionC<[t.TypeC<{
     organization: t.StringC;
     organization_name: t.StringC;
     api_token: t.UnionC<[t.StringC, t.NullC]>;
-    profile: t.NumberC;
+    profile: t.TypeC<{
+        user: t.StringC;
+        organization: t.StringC;
+        is_active: t.BooleanC;
+        role: t.UnionC<[t.LiteralC<"admin">, t.LiteralC<"editor">, t.LiteralC<"contributor">, t.LiteralC<"viewer">]>;
+        first_name: t.StringC;
+        last_name: t.StringC;
+        email: t.StringC;
+    }>;
     has_updated_password: t.BooleanC;
     is_active: t.BooleanC;
     is_hijacked: t.BooleanC;

package/build/internal/src/middleware/workflow.d.ts

@@ -0,0 +1,69 @@
+import * as t from 'io-ts';
+export declare const WorkflowV: t.TypeC<{
+    id: t.NumberC;
+    archived: t.BooleanC;
+    is_live: t.BooleanC;
+    title: t.StringC;
+    prompt: t.StringC;
+    trigger: t.AnyC;
+}>;
+export declare class Workflow {
+    static decode: (data: any) => {
+        id: number;
+        archived: boolean;
+        is_live: boolean;
+        title: string;
+        prompt: string;
+        trigger: any;
+    };
+    static create: (object: {
+        id: number;
+        archived: boolean;
+        is_live: boolean;
+        title: string;
+        prompt: string;
+        trigger: any;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        archived: boolean;
+        is_live: boolean;
+        title: string;
+        prompt: string;
+        trigger: any;
+    }>;
+    static update: (object: {
+        id: number;
+        archived: boolean;
+        is_live: boolean;
+        title: string;
+        prompt: string;
+        trigger: any;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        archived: boolean;
+        is_live: boolean;
+        title: string;
+        prompt: string;
+        trigger: any;
+    }>;
+    static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
+    static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        archived: boolean;
+        is_live: boolean;
+        title: string;
+        prompt: string;
+        trigger: any;
+    }[]>;
+    static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        id: number;
+        archived: boolean;
+        is_live: boolean;
+        title: string;
+        prompt: string;
+        trigger: any;
+    }>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commandbar",
-  "version": "1.10.0",
+  "version": "1.10.2-alpha",
   "description": "Javascript Utility for CommandBar",
   "main": "build/commandbar-js/src/index.js",
   "types": "build/commandbar-js/src/index.d.ts",
@@ -8,7 +8,7 @@
   "scripts": {
     "clean": "rimraf build",
     "build": "NODE_ENV=production webpack build && tsc",
-    "minify-snippet": "ts-node scripts/minify-snippet.ts",
+    "minify-snippet": "tsx scripts/minify-snippet.ts",
     "prepublishOnly": "yarn run clean && yarn run build",
     "test": "jest --runInBand",
     "test:watch": "jest --watch --verbose false --silent false",
@@ -23,7 +23,10 @@
     "io-ts": "^2.2.14"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.3",
+    "jest": "^29.7.0",
     "rimraf": "3.0.2",
+    "tsx": "^4.9.3",
     "typescript": "5.1.5",
     "webpack": "^5.74.0"
   }

package/src/index.ts

@@ -3,7 +3,6 @@ import type { CommandBarClientSDK } from '@commandbar/internal/src/client/Comman
 
 export { default as init } from './init';
 export { initProxySDK as initProxy } from '@commandbar/internal/src/client/proxy';
-export { snippet } from './snippet';
 export { CommandBarClientSDK };
 export { Launcher, getControlKey };
 

package/src/init.ts

@@ -5,8 +5,8 @@ import { getProxySDK } from '../../internal/src/client/proxy';
 import { _configuration } from '../../internal/src/client/symbols';
 import { IInitOptions } from '../../internal/src/middleware/types';
 
-const getSrc = (org: string, nonce?: string) => {
-  let origin = 'https://api.commandbar.com';
+const getSrc = (org: string, opts: IInitOptions) => {
+  let origin = opts.apiOrigin || 'https://api.commandbar.com';
   const params = [];
 
   const lc = localStorage.getItem('commandbar.lc');
@@ -21,8 +21,16 @@ const getSrc = (org: string, nonce?: string) => {
     params.push('lc=' + lc);
   }
 
-  if (nonce) {
-    params.push('nonce=' + nonce);
+  if (opts.nonce) {
+    params.push('nonce=' + encodeURIComponent(opts.nonce));
+  }
+
+  if (opts.silentMode) {
+    params.push('silent=true');
+  }
+
+  if (opts.cdnOrigin) {
+    params.push('cdn=' + encodeURIComponent(opts.cdnOrigin));
   }
 
   const version = 2;
@@ -32,14 +40,14 @@ const getSrc = (org: string, nonce?: string) => {
   return src;
 };
 
-const loadLatest = (org: string, nonce?: string) => {
+const loadLatest = (org: string, opts: IInitOptions) => {
   if (document.readyState !== 'complete') {
     // NOTE: `once` is not supported by IE11 and this will cause a (minor!) memory leak.
-    window.addEventListener('load', loadLatest.bind(null, org, nonce), { capture: false, once: true });
+    window.addEventListener('load', loadLatest.bind(null, org, opts), { capture: false, once: true });
     return;
   }
 
-  const src = getSrc(org, nonce);
+  const src = getSrc(org, opts);
 
   const el = document.createElement('script');
   el.type = 'text/javascript';
@@ -48,7 +56,10 @@ const loadLatest = (org: string, nonce?: string) => {
   document.head.appendChild(el);
 };
 
-const DEFAULT_OPTS = { debug: false };
+const DEFAULT_OPTS = {
+  debug: false,
+  silentMode: false,
+} as const;
 
 /**
  * Initializes CommandBar and injects the scripts required to load it into the <head> of the document. After calling
@@ -76,13 +87,17 @@ const init = (org: string, opts: IInitOptions = DEFAULT_OPTS) => {
   config.debug && console.log('CommandBar init...', { environment: opts.environment, version: opts.version });
 
   getProxySDK()[_configuration] = {
+    api: config.apiOrigin,
+    cdn: config.cdnOrigin,
     uuid: org,
-    environment: opts.environment,
-    version: opts.version,
-    config: opts.config, // TODO: We should update this type to correctly reflect the structure of the response from /config/ https://cmd-k.slack.com/archives/C0315KNU7FY/p1711558822136239?thread_ts=1711554558.063509&cid=C0315KNU7FY
+    environment: config.environment,
+    version: config.version,
+    config: config.config, // TODO: We should update this type to correctly reflect the structure of the response from /config/ https://cmd-k.slack.com/archives/C0315KNU7FY/p1711558822136239?thread_ts=1711554558.063509&cid=C0315KNU7FY
+    nonce: config.nonce,
+    silent: config.silentMode,
   };
 
-  loadLatest(org, opts.nonce);
+  loadLatest(org, config);
 };
 
 export default init;

package/src/snippet.ts

@@ -2,94 +2,99 @@
 /* eslint-disable prefer-rest-params */
 
 /* eslint-disable @typescript-eslint/no-inferrable-types */
-export const snippet = (org: string) => {
-  const polyfills = ['Object.assign', 'Symbol', 'Symbol.for'].join('%2C');
-  const w = window as unknown as Record<string, unknown>;
+let org = '<org_id>';
+let api = 'https://api.commandbar.com';
+let cdn: string | undefined = undefined;
 
-  function loadScript(src: string, async = false) {
-    if (document.readyState !== 'complete') {
-      window.addEventListener('load', loadScript.bind(null, src, async), { capture: false, once: true });
-    }
-    const el = document.createElement('script');
-    el.type = 'text/javascript';
-    el.async = async;
-    el.src = src;
-    document.head.appendChild(el);
+const polyfills = ['Object.assign', 'Symbol', 'Symbol.for'].join('%2C');
+const w = window as unknown as Record<string, unknown>;
+
+function loadScript(src: string, async = false) {
+  if (document.readyState !== 'complete') {
+    window.addEventListener('load', loadScript.bind(null, src, async), { capture: false, once: true });
   }
+  const el = document.createElement('script');
+  el.type = 'text/javascript';
+  el.async = async;
+  el.src = src;
+  document.head.appendChild(el);
+}
+
+function bootstrap() {
+  if (w.CommandBar !== undefined) return;
+  delete w.__CommandBarBootstrap__;
 
-  function bootstrap() {
-    if (w.CommandBar !== undefined) return;
-    delete w.__CommandBarBootstrap__;
+  const _configuration = Symbol.for('CommandBar::configuration');
+  const _disposed = Symbol.for('CommandBar::disposed');
+  const _isProxy = Symbol.for('CommandBar::isProxy');
+  const _queue = Symbol.for('CommandBar::queue');
+  const _unwrap = Symbol.for('CommandBar::unwrap');
+  const _eventSubscriptions = Symbol.for('CommandBar::eventSubscriptions');
 
-    const _configuration = Symbol.for('CommandBar::configuration');
-    const _orgConfig = Symbol.for('CommandBar::orgConfig');
-    const _disposed = Symbol.for('CommandBar::disposed');
-    const _isProxy = Symbol.for('CommandBar::isProxy');
-    const _queue = Symbol.for('CommandBar::queue');
-    const _unwrap = Symbol.for('CommandBar::unwrap');
-    const _eventSubscriptions = Symbol.for('CommandBar::eventSubscriptions');
+  const params = [];
+  const lc = localStorage.getItem('commandbar.lc');
 
-    const params = [];
-    const lc = localStorage.getItem('commandbar.lc');
-    const origin = lc && lc.includes('local') ? 'http://localhost:8000' : 'https://api.commandbar.com';
+  if (lc && lc.includes('local')) {
+    api = 'http://localhost:8000';
+    cdn = undefined;
+  }
 
-    const proxy = Object.assign(
-      {
-        [_configuration]: { uuid: org },
-        [_orgConfig]: {},
-        [_disposed]: false,
-        [_isProxy]: true,
-        [_queue]: new Array<unknown>(),
-        [_unwrap]: () => proxy,
-        [_eventSubscriptions]: undefined,
-      },
-      w.CommandBar,
-    );
+  const proxy = Object.assign(
+    {
+      [_configuration]: { uuid: org, api, cdn },
+      [_disposed]: false,
+      [_isProxy]: true,
+      [_queue]: new Array<unknown>(),
+      [_unwrap]: () => proxy,
+      [_eventSubscriptions]: undefined,
+    },
+    w.CommandBar,
+  );
 
-    const ASYNC_METHODS_SNIPPET = ['addCommand', 'boot', 'addEventSubscriber', 'addRecordAction', 'setFormFactor'];
+  const ASYNC_METHODS_SNIPPET = ['addCommand', 'boot', 'addEventSubscriber', 'addRecordAction', 'setFormFactor'];
 
-    const sdk = proxy;
+  const sdk = proxy;
 
-    Object.assign(proxy, {
-      shareCallbacks: () => ({}),
-      shareContext: () => ({}),
-    });
+  Object.assign(proxy, {
+    shareCallbacks: () => ({}),
+    shareContext: () => ({}),
+  });
 
-    w.CommandBar = new Proxy(proxy, {
-      get: function (_, prop) {
-        if (prop in sdk) return proxy[prop];
-        if ((prop as any) === 'then') return undefined;
-        if (ASYNC_METHODS_SNIPPET.includes(prop as string)) {
-          return function () {
-            // eslint-disable-next-line prefer-rest-params
-            const a = Array.prototype.slice.call(arguments);
-            return new Promise((resolve, reject) => {
-              a.unshift(prop, resolve, reject);
-              (proxy[_queue] as Array<unknown>).push(a);
-            });
-          };
-        }
+  w.CommandBar = new Proxy(proxy, {
+    get: function (_, prop) {
+      if (prop in sdk) return proxy[prop];
+      if ((prop as any) === 'then') return undefined;
+      if (ASYNC_METHODS_SNIPPET.includes(prop as string)) {
         return function () {
           // eslint-disable-next-line prefer-rest-params
           const a = Array.prototype.slice.call(arguments);
-          a.unshift(prop);
-          (proxy[_queue] as Array<unknown>).push(a);
+          return new Promise((resolve, reject) => {
+            a.unshift(prop, resolve, reject);
+            (proxy[_queue] as Array<unknown>).push(a);
+          });
         };
-      },
-    });
+      }
+      return function () {
+        // eslint-disable-next-line prefer-rest-params
+        const a = Array.prototype.slice.call(arguments);
+        a.unshift(prop);
+        (proxy[_queue] as Array<unknown>).push(a);
+      };
+    },
+  });
 
-    if (lc !== null) params.push(`lc=${lc}`);
-    params.push('version=2');
+  if (lc !== null) params.push(`lc=${lc}`);
+  params.push('version=2');
+  if (cdn) params.push(`cdn=${encodeURIComponent(cdn)}`);
 
-    loadScript(`${origin}/latest/${org}?${params.join('&')}`, true);
-  }
+  loadScript(`${api}/latest/${org}?${params.join('&')}`, true);
+}
 
-  if (typeof Object.assign === 'undefined' || typeof Symbol === 'undefined' || typeof Symbol.for === 'undefined') {
-    w.__CommandBarBootstrap__ = bootstrap;
-    loadScript(
-      'https://polyfill.io/v3/polyfill.min.js?version=3.101.0&callback=__CommandBarBootstrap__&features=' + polyfills,
-    );
-  } else {
-    bootstrap();
-  }
-};
+if (typeof Object.assign === 'undefined' || typeof Symbol === 'undefined' || typeof Symbol.for === 'undefined') {
+  w.__CommandBarBootstrap__ = bootstrap;
+  loadScript(
+    'https://polyfill.io/v3/polyfill.min.js?version=3.101.0&callback=__CommandBarBootstrap__&features=' + polyfills,
+  );
+} else {
+  bootstrap();
+}

package/build/internal/src/client/OrgConfig.d.ts

@@ -1,5 +0,0 @@
-export interface OrgConfig {
-    name?: string;
-    silent?: boolean;
-    eventAttributeBlockList?: string[];
-}

package/build/internal/src/middleware/guide.d.ts

@@ -1,37 +0,0 @@
-import * as t from 'io-ts';
-export declare const GuideV: t.IntersectionC<[t.TypeC<{
-    id: t.NumberC;
-    organization: t.StringC;
-    event: t.StringC;
-    nudge: t.StringC;
-    guidance: t.StringC;
-}>, t.PartialC<{}>]>;
-export declare class Guide {
-    static create: (object: {
-        id: number;
-        organization: string;
-        event: string;
-        nudge: string;
-        guidance: string;
-    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
-        id: number;
-        organization: string;
-        event: string;
-        nudge: string;
-        guidance: string;
-    } & {}>;
-    static update: (object: {
-        id: number;
-        organization: string;
-        event: string;
-        nudge: string;
-        guidance: string;
-    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
-        id: number;
-        organization: string;
-        event: string;
-        nudge: string;
-        guidance: string;
-    } & {}>;
-    static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
-}