@pitcher/canvas-ui 2025.12.5-140640 → 2025.12.5-142623-beta

package/lib/sdk/api/HighLevelApi.d.ts

@@ -237,6 +237,7 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     crmSmartObjectMetadata(payload: import('../payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
     crmSmartUpsertObjects(payload: import('../payload.types').UpsertCRMObjectsPayload): Promise<any>;
     crmSmartObjectValidationRules(payload: import('../payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
+    crmSmartDeleteObjects(payload: import('../payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
     getFolders(payload: import('../payload.types').FolderListRequest): Promise<import('../../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../../main.lib').FolderRetrieve["id"];

package/lib/sdk/api/modules/query.d.ts

@@ -1,4 +1,4 @@
-import { QueryPayload, CRMQueryPayload, UpsertCRMObjectsPayload, CRMSmartObjectValidationRulesPayload, CRMSmartObjectMetadataPayload } from '../../payload.types';
+import { QueryPayload, CRMQueryPayload, UpsertCRMObjectsPayload, CRMSmartObjectValidationRulesPayload, CRMSmartObjectMetadataPayload, CRMSmartDeleteObjectsPayload } from '../../payload.types';
 export declare function query(payload: QueryPayload): Promise<any>;
 export declare function crmQuery(payload: CRMQueryPayload): Promise<any>;
 /**
@@ -88,3 +88,28 @@ export declare function crmSmartUpsertObjects(payload: UpsertCRMObjectsPayload):
  * api.crmSmartObjectValidationRules({ object: 'Contact' })
  */
 export declare function crmSmartObjectValidationRules(payload: CRMSmartObjectValidationRulesPayload): Promise<any>;
+/**
+ * Deletes CRM objects from local CRM data (iOS only).
+ * Uses Salesforce Mobile SDK SmartStore to delete records.
+ * Each object in the payload specifies a table name and an array of IDs to delete.
+ *
+ * @param {CRMSmartDeleteObjectsPayload} payload - The delete payload containing an array of CRMDeleteObject items.
+ * @returns {Promise<any>} - Promise resolving with the result of the delete operation.
+ * @throws {Error} - Throws an error if the payload is invalid.
+ *
+ * @example
+ * // iOS only method to delete CRM objects.
+ * api.crmSmartDeleteObjects({
+ *   objects: [
+ *     {
+ *       table_name: 'Account',
+ *       ids: ['001xx000003DGbQAAW', '001xx000003DGbRABW']
+ *     },
+ *     {
+ *       table_name: 'Contact',
+ *       ids: ['003xx000004TmiQAAS']
+ *     }
+ *   ]
+ * })
+ */
+export declare function crmSmartDeleteObjects(payload: CRMSmartDeleteObjectsPayload): Promise<any>;

package/lib/sdk/main.d.ts

@@ -306,6 +306,7 @@ export declare function useApi(options?: ApiOptions): {
     crmSmartObjectMetadata(payload: import('./payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
     crmSmartUpsertObjects(payload: import('./payload.types').UpsertCRMObjectsPayload): Promise<any>;
     crmSmartObjectValidationRules(payload: import('./payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
+    crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
     getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];
@@ -586,6 +587,7 @@ export declare function useApi(options?: ApiOptions): {
         crmSmartObjectMetadata(payload: import('./payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
         crmSmartUpsertObjects(payload: import('./payload.types').UpsertCRMObjectsPayload): Promise<any>;
         crmSmartObjectValidationRules(payload: import('./payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
+        crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
         getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
         getFolder(payload?: {
             id: import('../main.lib').FolderRetrieve["id"];
@@ -802,6 +804,7 @@ export declare function useApi(options?: ApiOptions): {
     crmSmartObjectMetadata(payload: import('./payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
     crmSmartUpsertObjects(payload: import('./payload.types').UpsertCRMObjectsPayload): Promise<any>;
     crmSmartObjectValidationRules(payload: import('./payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
+    crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
     getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];

package/lib/sdk/payload.types.d.ts

@@ -339,3 +339,25 @@ export interface CRMSmartObjectValidationRulesPayload {
      */
     object: string;
 }
+/**
+ * Represents a single CRM object to be deleted.
+ */
+export interface CRMDeleteObject {
+    /**
+     * Array of IDs of the records to delete.
+     */
+    ids: string[];
+    /**
+     * The name of the CRM table/object to delete from.
+     */
+    table_name: string;
+}
+/**
+ * Payload for deleting CRM objects (iOS only).
+ */
+export interface CRMSmartDeleteObjectsPayload {
+    /**
+     * Array of CRM objects to be deleted.
+     */
+    objects: CRMDeleteObject[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/canvas-ui",
-  "version": "2025.12.5-140640",
+  "version": "2025.12.5-142623-beta",
   "type": "module",
   "publishConfig": {
     "access": "public"