@managespace/sdk 0.1.183 → 0.1.184

package/src/extensibility/functions/project/communication-method.ts

@@ -8,10 +8,17 @@ export namespace CommunicationMethod {
     export class SendEmail implements ExtPlugin {
         responseType!: Omit<
             SendEmailPayload,
-            'receiverEmail' | 'senderEmail' | 'contactId' | 'customerId'
+            | 'receiverEmail'
+            | 'senderEmail'
+            | 'contactId'
+            | 'customerId'
+            | 'documentIds'
         >;
 
-        payload!: Omit<SendEmailPayload, 'customerId' | 'contactId'>;
+        payload!: Omit<
+            SendEmailPayload,
+            'customerId' | 'contactId' | 'documentIds'
+        > & { attachmentUrls?: string[] };
     }
     export class SendSms implements ExtPlugin {
         responseType!: Omit<

package/src/generated/apis/default-api.ts

@@ -681,6 +681,10 @@ export interface CancelSubscriptionRequest {
     cancelSubscription: CancelSubscription;
 }
 
+export interface CompleteOnboardRequest {
+    siteId: string;
+}
+
 export interface CreateAssetRequest {
     siteId: string;
     createAssetCustom: CreateAssetCustom;
@@ -1966,6 +1970,45 @@ export class DefaultApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     */
+    async completeOnboardRaw(requestParameters: CompleteOnboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Site>> {
+        if (requestParameters['siteId'] == null) {
+            throw new runtime.RequiredError(
+                'siteId',
+                'Required parameter "siteId" was null or undefined when calling completeOnboard().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/org/sites/{siteId}/complete-onboard`.replace(`{${"siteId"}}`, encodeURIComponent(String(requestParameters['siteId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SiteFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async completeOnboard(requestParameters: CompleteOnboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Site> {
+        const response = await this.completeOnboardRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      */
     async createAssetRaw(requestParameters: CreateAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Asset>> {

package/src/generated/models/send-email.ts

@@ -63,11 +63,11 @@ export interface SendEmail {
      */
     html?: string;
     /**
-     * The attachments of the email being sent.
+     * The IDs of documents to attach to the email.
      * @type {Array<string>}
      * @memberof SendEmail
      */
-    attachmentUrls?: Array<string>;
+    documentIds?: Array<string>;
 }
 
 /**
@@ -99,7 +99,7 @@ export function SendEmailFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'subject': json['subject'],
         'text': json['text'] == null ? undefined : json['text'],
         'html': json['html'] == null ? undefined : json['html'],
-        'attachmentUrls': json['attachmentUrls'] == null ? undefined : json['attachmentUrls'],
+        'documentIds': json['documentIds'] == null ? undefined : json['documentIds'],
     };
 }
 
@@ -121,7 +121,7 @@ export function SendEmailToJSONTyped(value?: SendEmail | null, ignoreDiscriminat
         'subject': value['subject'],
         'text': value['text'],
         'html': value['html'],
-        'attachmentUrls': value['attachmentUrls'],
+        'documentIds': value['documentIds'],
     };
 }
 

package/src/generated/models/site.ts

@@ -309,6 +309,12 @@ export interface Site {
      * @memberof Site
      */
     division: string | null;
+    /**
+     * When onboarding was completed for this site
+     * @type {Date}
+     * @memberof Site
+     */
+    onboardCompletedAt: Date | null;
 }
 
 /**
@@ -324,6 +330,7 @@ export function instanceOfSite(value: object): value is Site {
     if (!('addressId' in value) || value['addressId'] === undefined) return false;
     if (!('siteCode' in value) || value['siteCode'] === undefined) return false;
     if (!('division' in value) || value['division'] === undefined) return false;
+    if (!('onboardCompletedAt' in value) || value['onboardCompletedAt'] === undefined) return false;
     return true;
 }
 
@@ -364,6 +371,7 @@ export function SiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): Site
         'siteRoles': json['siteRoles'] == null ? undefined : ((json['siteRoles'] as Array<any>).map(SiteRoleFromJSON)),
         'siteCode': json['siteCode'],
         'division': json['division'],
+        'onboardCompletedAt': (json['onboardCompletedAt'] == null ? null : new Date(json['onboardCompletedAt'])),
     };
 }
 
@@ -405,6 +413,7 @@ export function SiteToJSONTyped(value?: Site | null, ignoreDiscriminator: boolea
         'siteRoles': value['siteRoles'] == null ? undefined : ((value['siteRoles'] as Array<any>).map(SiteRoleToJSON)),
         'siteCode': value['siteCode'],
         'division': value['division'],
+        'onboardCompletedAt': (value['onboardCompletedAt'] == null ? null : (value['onboardCompletedAt'] as any).toISOString()),
     };
 }
 

package/dist/extensions/host-bridge.d.ts

@@ -1,166 +0,0 @@
-import type { EntityEventHandler, ExtensionContext } from './types';
-/**
- * Get the extension context from the ManageSpace host.
- *
- * This returns a promise that resolves when the context is received from the host.
- * Call this early in your extension's lifecycle to get authentication and org context.
- *
- * @example
- * ```typescript
- * import { getContext } from '@managespace/sdk/extensions';
- *
- * const context = await getContext();
- * console.log('Org ID:', context.orgId);
- * console.log('API URL:', context.apiBaseUrl);
- * ```
- */
-export declare function getContext(): Promise<ExtensionContext>;
-/**
- * Get the current context synchronously.
- *
- * Returns null if the context has not yet been received from the host.
- * Prefer using `getContext()` which waits for the context to be available.
- *
- * @example
- * ```typescript
- * import { getCurrentContext } from '@managespace/sdk/extensions';
- *
- * const context = getCurrentContext();
- * if (context) {
- *     console.log('Already have context:', context.orgId);
- * }
- * ```
- */
-export declare function getCurrentContext(): ExtensionContext | null;
-/**
- * Navigate the ManageSpace host application to a specific path.
- *
- * Use this to navigate users to pages within ManageSpace, such as
- * customer profiles, asset details, or other views.
- *
- * @param path - The path to navigate to (e.g., "/customer/123")
- *
- * @example
- * ```typescript
- * import { navigate } from '@managespace/sdk/extensions';
- *
- * // Navigate to a customer profile
- * navigate('/customer/abc-123');
- *
- * // Navigate to the assets page
- * navigate('/assets');
- * ```
- */
-export declare function navigate(path: string): void;
-/**
- * Show a toast notification in the ManageSpace host application.
- *
- * Use this for user feedback after actions complete.
- *
- * @param message - The message to display
- * @param variant - The toast type: 'success' or 'error' (default: 'success')
- *
- * @example
- * ```typescript
- * import { showToast } from '@managespace/sdk/extensions';
- *
- * // Success notification
- * showToast('Customer updated successfully');
- *
- * // Error notification
- * showToast('Failed to save changes', 'error');
- * ```
- */
-export declare function showToast(message: string, variant?: 'success' | 'error'): void;
-/**
- * Signal to the ManageSpace host that the extension is ready to receive context.
- *
- * Call this after your extension has loaded and set up its message listeners.
- * The host will respond with a CONTEXT_INIT message containing the ExtensionContext.
- *
- * @example
- * ```typescript
- * import { signalReady, getContext } from '@managespace/sdk/extensions';
- *
- * // Signal ready and wait for context
- * signalReady();
- * const context = await getContext();
- * ```
- */
-export declare function signalReady(): void;
-/**
- * Subscribe to entity events from the ManageSpace host.
- *
- * The host sends events when entities (customers, assets, etc.) are
- * created, updated, or deleted. Use this to keep your extension in sync.
- *
- * @param handler - Callback function to handle entity events
- * @returns Unsubscribe function to remove the handler
- *
- * @example
- * ```typescript
- * import { onEntityEvent } from '@managespace/sdk/extensions';
- *
- * const unsubscribe = onEntityEvent((event) => {
- *     if (event.entityType === 'customer' && event.action === 'updated') {
- *         console.log('Customer updated:', event.entityId);
- *         refreshCustomerData();
- *     }
- * });
- *
- * // Later, to stop listening:
- * unsubscribe();
- * ```
- */
-export declare function onEntityEvent(handler: EntityEventHandler): () => void;
-/**
- * Create a configured fetch function for calling the ManageSpace API.
- *
- * This returns a fetch wrapper that automatically includes credentials
- * and sets the correct headers for API calls.
- *
- * @param context - The extension context from getContext()
- * @returns A fetch function configured for ManageSpace API calls
- *
- * @example
- * ```typescript
- * import { getContext, createApiFetch } from '@managespace/sdk/extensions';
- *
- * const context = await getContext();
- * const apiFetch = createApiFetch(context);
- *
- * // Fetch customers
- * const response = await apiFetch('/api/crm/customers/queries', {
- *     method: 'POST',
- *     body: JSON.stringify({
- *         pageOptions: { offset: 0, limit: 20 }
- *     })
- * });
- * const data = await response.json();
- * ```
- */
-export declare function createApiFetch(context: ExtensionContext): (path: string, options?: RequestInit) => Promise<Response>;
-/**
- * Create a configured fetch function for calling your extension's BFF.
- *
- * This returns a fetch wrapper that forwards credentials to your BFF,
- * allowing it to make authenticated calls to the ManageSpace API.
- *
- * @param context - The extension context from getContext()
- * @returns A fetch function configured for BFF calls, or null if no BFF is configured
- *
- * @example
- * ```typescript
- * import { getContext, createBffFetch } from '@managespace/sdk/extensions';
- *
- * const context = await getContext();
- * const bffFetch = createBffFetch(context);
- *
- * if (bffFetch) {
- *     const response = await bffFetch('/api/enriched-customers');
- *     const data = await response.json();
- * }
- * ```
- */
-export declare function createBffFetch(context: ExtensionContext): ((path: string, options?: RequestInit) => Promise<Response>) | null;
-//# sourceMappingURL=host-bridge.d.ts.map

package/dist/extensions/host-bridge.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"host-bridge.d.ts","sourceRoot":"","sources":["../../src/extensions/host-bridge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,kBAAkB,EAClB,gBAAgB,EAGnB,MAAM,SAAS,CAAC;AAiCjB;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAQtD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,iBAAiB,IAAI,gBAAgB,GAAG,IAAI,CAE3D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAM3C;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CACrB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,SAAS,GAAG,OAAmB,GACzC,IAAI,CAMN;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAGlC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,IAAI,CAKrE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,gBAAgB,GAC1B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAY5D;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,gBAAgB,GAC1B,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAgBrE"}

package/dist/extensions/host-bridge.js

@@ -1,259 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getContext = getContext;
-exports.getCurrentContext = getCurrentContext;
-exports.navigate = navigate;
-exports.showToast = showToast;
-exports.signalReady = signalReady;
-exports.onEntityEvent = onEntityEvent;
-exports.createApiFetch = createApiFetch;
-exports.createBffFetch = createBffFetch;
-let contextResolve = null;
-let currentContext = null;
-const entityEventHandlers = new Set();
-// Set up message listener when this module loads
-if (typeof window !== 'undefined') {
-    window.addEventListener('message', (event) => {
-        if (!event.data?.type)
-            return;
-        switch (event.data.type) {
-            case 'CONTEXT_INIT':
-                currentContext = event.data.payload;
-                if (contextResolve) {
-                    contextResolve(event.data.payload);
-                    contextResolve = null;
-                }
-                break;
-            case 'ENTITY_EVENT':
-                for (const handler of entityEventHandlers) {
-                    try {
-                        handler(event.data.payload);
-                    }
-                    catch (error) {
-                        console.error('Entity event handler error:', error);
-                    }
-                }
-                break;
-        }
-    });
-}
-/**
- * Get the extension context from the ManageSpace host.
- *
- * This returns a promise that resolves when the context is received from the host.
- * Call this early in your extension's lifecycle to get authentication and org context.
- *
- * @example
- * ```typescript
- * import { getContext } from '@managespace/sdk/extensions';
- *
- * const context = await getContext();
- * console.log('Org ID:', context.orgId);
- * console.log('API URL:', context.apiBaseUrl);
- * ```
- */
-function getContext() {
-    if (currentContext) {
-        return Promise.resolve(currentContext);
-    }
-    return new Promise((resolve) => {
-        contextResolve = resolve;
-    });
-}
-/**
- * Get the current context synchronously.
- *
- * Returns null if the context has not yet been received from the host.
- * Prefer using `getContext()` which waits for the context to be available.
- *
- * @example
- * ```typescript
- * import { getCurrentContext } from '@managespace/sdk/extensions';
- *
- * const context = getCurrentContext();
- * if (context) {
- *     console.log('Already have context:', context.orgId);
- * }
- * ```
- */
-function getCurrentContext() {
-    return currentContext;
-}
-/**
- * Navigate the ManageSpace host application to a specific path.
- *
- * Use this to navigate users to pages within ManageSpace, such as
- * customer profiles, asset details, or other views.
- *
- * @param path - The path to navigate to (e.g., "/customer/123")
- *
- * @example
- * ```typescript
- * import { navigate } from '@managespace/sdk/extensions';
- *
- * // Navigate to a customer profile
- * navigate('/customer/abc-123');
- *
- * // Navigate to the assets page
- * navigate('/assets');
- * ```
- */
-function navigate(path) {
-    const message = {
-        type: 'NAVIGATE',
-        payload: { path },
-    };
-    window.parent.postMessage(message, '*');
-}
-/**
- * Show a toast notification in the ManageSpace host application.
- *
- * Use this for user feedback after actions complete.
- *
- * @param message - The message to display
- * @param variant - The toast type: 'success' or 'error' (default: 'success')
- *
- * @example
- * ```typescript
- * import { showToast } from '@managespace/sdk/extensions';
- *
- * // Success notification
- * showToast('Customer updated successfully');
- *
- * // Error notification
- * showToast('Failed to save changes', 'error');
- * ```
- */
-function showToast(message, variant = 'success') {
-    const msg = {
-        type: 'SHOW_TOAST',
-        payload: { message, variant },
-    };
-    window.parent.postMessage(msg, '*');
-}
-/**
- * Signal to the ManageSpace host that the extension is ready to receive context.
- *
- * Call this after your extension has loaded and set up its message listeners.
- * The host will respond with a CONTEXT_INIT message containing the ExtensionContext.
- *
- * @example
- * ```typescript
- * import { signalReady, getContext } from '@managespace/sdk/extensions';
- *
- * // Signal ready and wait for context
- * signalReady();
- * const context = await getContext();
- * ```
- */
-function signalReady() {
-    const message = { type: 'READY' };
-    window.parent.postMessage(message, '*');
-}
-/**
- * Subscribe to entity events from the ManageSpace host.
- *
- * The host sends events when entities (customers, assets, etc.) are
- * created, updated, or deleted. Use this to keep your extension in sync.
- *
- * @param handler - Callback function to handle entity events
- * @returns Unsubscribe function to remove the handler
- *
- * @example
- * ```typescript
- * import { onEntityEvent } from '@managespace/sdk/extensions';
- *
- * const unsubscribe = onEntityEvent((event) => {
- *     if (event.entityType === 'customer' && event.action === 'updated') {
- *         console.log('Customer updated:', event.entityId);
- *         refreshCustomerData();
- *     }
- * });
- *
- * // Later, to stop listening:
- * unsubscribe();
- * ```
- */
-function onEntityEvent(handler) {
-    entityEventHandlers.add(handler);
-    return () => {
-        entityEventHandlers.delete(handler);
-    };
-}
-/**
- * Create a configured fetch function for calling the ManageSpace API.
- *
- * This returns a fetch wrapper that automatically includes credentials
- * and sets the correct headers for API calls.
- *
- * @param context - The extension context from getContext()
- * @returns A fetch function configured for ManageSpace API calls
- *
- * @example
- * ```typescript
- * import { getContext, createApiFetch } from '@managespace/sdk/extensions';
- *
- * const context = await getContext();
- * const apiFetch = createApiFetch(context);
- *
- * // Fetch customers
- * const response = await apiFetch('/api/crm/customers/queries', {
- *     method: 'POST',
- *     body: JSON.stringify({
- *         pageOptions: { offset: 0, limit: 20 }
- *     })
- * });
- * const data = await response.json();
- * ```
- */
-function createApiFetch(context) {
-    return (path, options = {}) => {
-        const url = `${context.apiBaseUrl}${path}`;
-        return fetch(url, {
-            ...options,
-            credentials: 'include',
-            headers: {
-                'Content-Type': 'application/json',
-                ...options.headers,
-            },
-        });
-    };
-}
-/**
- * Create a configured fetch function for calling your extension's BFF.
- *
- * This returns a fetch wrapper that forwards credentials to your BFF,
- * allowing it to make authenticated calls to the ManageSpace API.
- *
- * @param context - The extension context from getContext()
- * @returns A fetch function configured for BFF calls, or null if no BFF is configured
- *
- * @example
- * ```typescript
- * import { getContext, createBffFetch } from '@managespace/sdk/extensions';
- *
- * const context = await getContext();
- * const bffFetch = createBffFetch(context);
- *
- * if (bffFetch) {
- *     const response = await bffFetch('/api/enriched-customers');
- *     const data = await response.json();
- * }
- * ```
- */
-function createBffFetch(context) {
-    if (!context.bffUrl) {
-        return null;
-    }
-    return (path, options = {}) => {
-        const url = `${context.bffUrl}${path}`;
-        return fetch(url, {
-            ...options,
-            credentials: 'include',
-            headers: {
-                'Content-Type': 'application/json',
-                ...options.headers,
-            },
-        });
-    };
-}

package/dist/extensions/index.d.ts

@@ -1,40 +0,0 @@
-/**
- * ManageSpace Extension SDK
- *
- * This module provides utilities for building extensions that run within
- * the ManageSpace platform. Extensions are loaded in iframes and communicate
- * with the host application via postMessage.
- *
- * @example
- * ```typescript
- * import {
- *     getContext,
- *     signalReady,
- *     navigate,
- *     showToast,
- *     createApiFetch,
- * } from '@managespace/sdk/extensions';
- *
- * // Signal ready and get context
- * signalReady();
- * const context = await getContext();
- *
- * // Create API client
- * const apiFetch = createApiFetch(context);
- *
- * // Fetch data
- * const response = await apiFetch('/api/crm/customers/queries', {
- *     method: 'POST',
- *     body: JSON.stringify({ pageOptions: { offset: 0, limit: 20 } })
- * });
- *
- * // Navigate and show feedback
- * navigate('/customer/123');
- * showToast('Customer loaded');
- * ```
- *
- * @module extensions
- */
-export * from './types';
-export * from './host-bridge';
-//# sourceMappingURL=index.d.ts.map

package/dist/extensions/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/extensions/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC"}

package/dist/extensions/index.js

@@ -1,55 +0,0 @@
-"use strict";
-/**
- * ManageSpace Extension SDK
- *
- * This module provides utilities for building extensions that run within
- * the ManageSpace platform. Extensions are loaded in iframes and communicate
- * with the host application via postMessage.
- *
- * @example
- * ```typescript
- * import {
- *     getContext,
- *     signalReady,
- *     navigate,
- *     showToast,
- *     createApiFetch,
- * } from '@managespace/sdk/extensions';
- *
- * // Signal ready and get context
- * signalReady();
- * const context = await getContext();
- *
- * // Create API client
- * const apiFetch = createApiFetch(context);
- *
- * // Fetch data
- * const response = await apiFetch('/api/crm/customers/queries', {
- *     method: 'POST',
- *     body: JSON.stringify({ pageOptions: { offset: 0, limit: 20 } })
- * });
- *
- * // Navigate and show feedback
- * navigate('/customer/123');
- * showToast('Customer loaded');
- * ```
- *
- * @module extensions
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./host-bridge"), exports);