@resconet/qp-bridge 0.0.1-alpha.18 → 0.0.1-alpha.20

package/README.md

@@ -41,6 +41,18 @@ await setAnswer("numericQuestion", 42);
 
 ## Functions
 
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
 - [setAnswer](#setanswer)
 - [getQuestion](#getquestion)
 - [setQuestion](#setquestion)
@@ -52,6 +64,326 @@ await setAnswer("numericQuestion", 42);
 - [completeAndCloseQuestionnaire](#completeandclosequestionnaire)
 - [executeCustomCommand](#executecustomcommand)
 - [onSave](#onsave)
+- [fetchEntities](#fetchentities)
+- [getEntityById](#getentitybyid)
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
 
 ### setAnswer
 
@@ -337,6 +669,63 @@ cancelSubscription();
 ```
 
 
+### fetchEntities
+
+Fetches entities from the CRM system using the provided FetchXML query.
+
+| Function | Type |
+| ---------- | ---------- |
+| `fetchEntities` | `(fetchXml: string) => Promise<{ id: string; entityName: string; attributes: Record<string, unknown>; }[]>` |
+
+Parameters:
+
+* `fetchXml`: - The FetchXML query string to execute.
+
+
+Returns:
+
+A promise that resolves to an array of entities.
+
+Examples:
+
+```typescript
+const fetchXml = `<fetch top="10">
+  <entity name="contact">
+    <attribute name="firstname" />
+    <attribute name="lastname" />
+  </entity>
+</fetch>`;
+const entities = await fetchEntities(fetchXml);
+console.log(entities); // Array of contact entities
+```
+
+
+### getEntityById
+
+Retrieves a single entity by its name and ID from the CRM system.
+
+| Function | Type |
+| ---------- | ---------- |
+| `getEntityById` | `(entityName: string, id: string) => Promise<{ id: string; entityName: string; attributes: Record<string, unknown>; }>` |
+
+Parameters:
+
+* `entityName`: - The name of the entity to retrieve (e.g., "contact", "account").
+* `id`: - The unique identifier of the entity.
+
+
+Returns:
+
+A promise that resolves to the entity object.
+
+Examples:
+
+```typescript
+const contact = await getEntityById('contact', '12345678-1234-1234-1234-123456789abc');
+console.log(contact.attributes.firstname); // Entity firstname attribute
+```
+
+
 
 
 <!-- TSDOC_END -->