@pitcher/canvas-ui 2025.12.22-81909 → 2025.12.23-94943

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -241,6 +241,7 @@ export declare function createHighLevelApi(options?: ApiOptions): {
241
241
  crmSmartDeleteObjects(payload: import('../payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
242
242
  crmCreate(payload: import('../payload.types').CRMCreatePayload): Promise<any>;
243
243
  crmUpsert(payload: import('../payload.types').CRMUpsertPayload): Promise<any>;
244
+ crmDescribe(payload: import('../payload.types').CRMDescribePayload): Promise<any>;
244
245
  getFolders(payload: import('../payload.types').FolderListRequest): Promise<import('../../main.lib').PaginatedFolderList>;
245
246
  getFolder(payload?: {
246
247
  id: import('../../main.lib').FolderRetrieve["id"];
@@ -1,4 +1,4 @@
1
- import { QueryPayload, CRMQueryPayload, UpsertCRMObjectsPayload, CRMSmartObjectValidationRulesPayload, CRMSmartObjectMetadataPayload, CRMSmartDeleteObjectsPayload, CRMCreatePayload, CRMUpsertPayload } from '../../payload.types';
1
+ import { QueryPayload, CRMQueryPayload, UpsertCRMObjectsPayload, CRMSmartObjectValidationRulesPayload, CRMSmartObjectMetadataPayload, CRMSmartDeleteObjectsPayload, CRMCreatePayload, CRMUpsertPayload, CRMDescribePayload } from '../../payload.types';
2
2
  export declare function query(payload: QueryPayload): Promise<any>;
3
3
  export declare function crmQuery(payload: CRMQueryPayload): Promise<any>;
4
4
  /**
@@ -169,3 +169,23 @@ export declare function crmCreate(payload: CRMCreatePayload): Promise<any>;
169
169
  * })
170
170
  */
171
171
  export declare function crmUpsert(payload: CRMUpsertPayload): Promise<any>;
172
+ /**
173
+ * Retrieves metadata/describe for a CRM object (Web only).
174
+ * Uses Salesforce REST API to fetch object metadata including fields and picklist values.
175
+ *
176
+ * @param {CRMDescribePayload} payload - The describe payload containing the sobject name.
177
+ * @returns {Promise<any>} - Promise resolving with the object metadata including fields and picklist values.
178
+ * @throws {Error} - Throws an error if the payload is invalid.
179
+ *
180
+ * @example
181
+ * // Web only method to get CRM object metadata.
182
+ * api.crmDescribe({ sobject: 'Account' })
183
+ * .then(metadata => {
184
+ * // Access fields
185
+ * console.log(metadata.fields)
186
+ * // Access picklist values for a specific field
187
+ * const industryField = metadata.fields.find(f => f.name === 'Industry')
188
+ * console.log(industryField.picklistValues)
189
+ * })
190
+ */
191
+ export declare function crmDescribe(payload: CRMDescribePayload): Promise<any>;
package/lib/sdk/main.d.ts CHANGED
@@ -312,6 +312,7 @@ export declare function useApi(options?: ApiOptions): {
312
312
  crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
313
313
  crmCreate(payload: import('./payload.types').CRMCreatePayload): Promise<any>;
314
314
  crmUpsert(payload: import('./payload.types').CRMUpsertPayload): Promise<any>;
315
+ crmDescribe(payload: import('./payload.types').CRMDescribePayload): Promise<any>;
315
316
  getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
316
317
  getFolder(payload?: {
317
318
  id: import('../main.lib').FolderRetrieve["id"];
@@ -598,6 +599,7 @@ export declare function useApi(options?: ApiOptions): {
598
599
  crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
599
600
  crmCreate(payload: import('./payload.types').CRMCreatePayload): Promise<any>;
600
601
  crmUpsert(payload: import('./payload.types').CRMUpsertPayload): Promise<any>;
602
+ crmDescribe(payload: import('./payload.types').CRMDescribePayload): Promise<any>;
601
603
  getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
602
604
  getFolder(payload?: {
603
605
  id: import('../main.lib').FolderRetrieve["id"];
@@ -820,6 +822,7 @@ export declare function useApi(options?: ApiOptions): {
820
822
  crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
821
823
  crmCreate(payload: import('./payload.types').CRMCreatePayload): Promise<any>;
822
824
  crmUpsert(payload: import('./payload.types').CRMUpsertPayload): Promise<any>;
825
+ crmDescribe(payload: import('./payload.types').CRMDescribePayload): Promise<any>;
823
826
  getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
824
827
  getFolder(payload?: {
825
828
  id: import('../main.lib').FolderRetrieve["id"];
@@ -404,3 +404,17 @@ export interface CRMUpsertPayload {
404
404
  */
405
405
  service?: CRMServiceType;
406
406
  }
407
+ /**
408
+ * Payload for retrieving CRM object metadata/describe (Web only).
409
+ * Uses Salesforce REST API to fetch object metadata including fields and picklist values.
410
+ */
411
+ export interface CRMDescribePayload {
412
+ /**
413
+ * The Salesforce object type to describe (e.g., 'Account', 'Contact', 'Opportunity').
414
+ */
415
+ sobject: string;
416
+ /**
417
+ * Optional name of the CRM service to use.
418
+ */
419
+ service?: CRMServiceType;
420
+ }
@@ -109,6 +109,8 @@ export interface SfContactBasic {
109
109
  };
110
110
  callId?: string;
111
111
  PersonAccountId?: string;
112
+ AccountName?: string;
113
+ Account?: any;
112
114
  }
113
115
  export type EventsSfList = {
114
116
  done?: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pitcher/canvas-ui",
3
- "version": "2025.12.22-81909",
3
+ "version": "2025.12.23-94943",
4
4
  "type": "module",
5
5
  "publishConfig": {
6
6
  "access": "public"