@rockrms/obsidian-framework 17.6.1 → 18.2.4

package/types/Core/Utilities/contextEntity.d.ts

@@ -0,0 +1,54 @@
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { Guid } from "@Obsidian/Types";
+/**
+ * Provides functions for accessing and setting context entities.
+ */
+declare class ContextEntityProvider {
+    private bus;
+    /**
+     * Gets the names of all context entity types, which are the full C# class name.
+     *
+     * @returns A promise that resolves to an array of context entity type names.
+     */
+    getTypeNames(): Promise<string[]>;
+    /**
+     * Gets the unique identifiers of all context entity types.
+     *
+     * @returns A promise that resolves to an array of context entity type unique identifiers.
+     */
+    getTypeGuids(): Promise<string[]>;
+    /**
+     * Gets a context entity by its type. This can be either the full class name or
+     * the unique identifier.
+     *
+     * @param entityType The type of the context entity.
+     *
+     * @returns A promise that resolves to the context entity or undefined if not found.
+     */
+    get(entityType: string | Guid): Promise<ListItemBag | undefined>;
+    /**
+     * Sets a context entity for the current session. If the context is null or
+     * undefined, the context entity will be removed.
+     *
+     * @param entityType The type of the context entity as either the full class name or the unique identifier.
+     * @param context The context entity to set. Only the `value` property is required.
+     * @param pageSpecific Whether the context entity is page-specific.
+     *
+     * @returns A promise that resolves when the context entity is set.
+     */
+    set(entityType: string | Guid, context: ListItemBag | null | undefined, pageSpecific?: boolean): Promise<void>;
+    /**
+     * Removes a context entity for the current session.
+     *
+     * @param entityType The type of the context entity as either the full class name or the unique identifier.
+     * @param pageSpecific Whether the context entity is page-specific.
+     */
+    remove(entityType: string | Guid, pageSpecific?: boolean): Promise<void>;
+}
+/**
+ * Provides functions for accessing and setting context entities.
+ *
+ * @returns An object with functions for accessing and setting context entities.
+ */
+export declare function useContextEntities(): ContextEntityProvider;
+export {};

package/types/{Controls/Grid/virtualScroller.partial.d.ts → Core/Utilities/virtualScroll.d.ts}

@@ -1,3 +1,4 @@
+import { Ref } from "vue";
 /**
  * A range of items that should be displayed, including the padding that should
  * be applied before and after the items so everything fits properly.
@@ -48,7 +49,7 @@ export default class VirtualScroller {
     private readonly heights;
     /**
      * When not `undefined` this contains the total height of all known items.
-     * It indicates that we need to keep woring to figure out an average height
+     * It indicates that we need to keep working to figure out an average height
      * until it becomes `undefined.
      */
     private firstRangeTotalHeight?;
@@ -170,3 +171,49 @@ export default class VirtualScroller {
      */
     private getEstimatedItemHeight;
 }
+type VirtualScrollOptions<RowItem> = {
+    /** The data for each row in the list */
+    items: Ref<RowItem[]>;
+    /**
+     * The field that contains the unique identifier for each item. This must
+     * represent a string field value.
+     */
+    itemKey: string;
+    /**
+     * The HTML element that wraps the list, marking the top and bottom of the
+     * list. This is required to determine the scroll container.
+     */
+    container: Ref<HTMLElement | null | undefined>;
+    /** The estimated height of each item in the list. */
+    estimatedItemHeight: number;
+};
+type VirtualScrollReturns<RowItem> = {
+    virtualItems: Ref<RowItem[]>;
+    beforePadStyle: Ref<{
+        height: string;
+    }>;
+    afterPadStyle: Ref<{
+        height: string;
+    }>;
+    range: Ref<Range>;
+    /**
+  * Informs the virtual scroller that the height of a single item has
+  * changed.
+  *
+  * @param id The identifier of the item whose height changed.
+  * @param height The new height of the item.
+  */
+    updateItemHeight(id: string, height: number): void;
+};
+/**
+ * A composable function that provides the actual items to render, along with the spacer sizes above and below the items,
+ * given the options provided to produce a virtual scroller. This allows you to have a massive list of items, but only
+ * render a small subset so there the pure number of DOM elements doesn't bog down the performance of the browser.
+ *
+ * This implementation only works with fixed height items to simplify the logic, but allows it to be used with a 2D grid
+ * by allowing the number of items per row to be specified. This implementation is temporary: we didn't have the time to
+ * generalize it to work in additional scenarios, but it is planned to be generalized in the future and merged with the
+ * implementation used by the VirtualDataRows component.
+ */
+export declare function useVirtualScroller<RowItem>(options: VirtualScrollOptions<RowItem>): VirtualScrollReturns<RowItem>;
+export {};

package/types/Directives/dragDrop.d.ts

@@ -12,7 +12,7 @@ export interface IDragSourceOptions {
     /**
      * Defines the query selector that specifies which elements may act as drag
      * handles. By default all elements are allowed. This value will be ignored
-     * if you defined a value for canStartDrag.
+     * if you defined a value for startDrag.
      */
     handleSelector?: string;
     /**

package/types/Enums/AI/Agent/agentType.d.ts

@@ -0,0 +1,14 @@
+/** The type of functionality the agent is configured to provide. */
+export declare const AgentType: {
+    /** The agent will provide chat services through a backend AI provider. */
+    readonly Chat: 0;
+    /**
+     * The agent will act as an MCP server and provide tools to other AI
+     * clients.
+     */
+    readonly Mcp: 1;
+};
+/** The type of functionality the agent is configured to provide. */
+export declare const AgentTypeDescription: Record<number, string>;
+/** The type of functionality the agent is configured to provide. */
+export type AgentType = typeof AgentType[keyof typeof AgentType];

package/types/Enums/AI/Agent/audienceType.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The type of audience the agent is configured to serve. This gives a hint
+ * to skills and tools about how to behave, such as disabling certain
+ * functionality that is not appropriate for the audience.
+ */
+export declare const AudienceType: {
+    /** The agent is configured to be used internally by Rock staff. */
+    readonly Internal: 0;
+    /** The agent is configured to be used by the general public. */
+    readonly Public: 1;
+};
+/**
+ * The type of audience the agent is configured to serve. This gives a hint
+ * to skills and tools about how to behave, such as disabling certain
+ * functionality that is not appropriate for the audience.
+ */
+export declare const AudienceTypeDescription: Record<number, string>;
+/**
+ * The type of audience the agent is configured to serve. This gives a hint
+ * to skills and tools about how to behave, such as disabling certain
+ * functionality that is not appropriate for the audience.
+ */
+export type AudienceType = typeof AudienceType[keyof typeof AudienceType];

package/types/Enums/AI/Agent/authorRole.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The role of the author in the AI agent's chat history. Each message in
+ * the chat history is associated with an author role to indicate where
+ * it came from.
+ */
+export declare const AuthorRole: {
+    /** The message is from the individual interacting with the agent. */
+    readonly User: 0;
+    /** The message is a response from the assistant (the AI agent). */
+    readonly Assistant: 1;
+    /** The message is a tool result, indicating that a tool was called. */
+    readonly Tool: 2;
+};
+/**
+ * The role of the author in the AI agent's chat history. Each message in
+ * the chat history is associated with an author role to indicate where
+ * it came from.
+ */
+export declare const AuthorRoleDescription: Record<number, string>;
+/**
+ * The role of the author in the AI agent's chat history. Each message in
+ * the chat history is associated with an author role to indicate where
+ * it came from.
+ */
+export type AuthorRole = typeof AuthorRole[keyof typeof AuthorRole];

package/types/Enums/AI/Agent/modelServiceRole.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The role of the model service in the AI agent's architecture. This is used
+ * to determine which AI model to use for different types of tasks.
+ */
+export declare const ModelServiceRole: {
+    /** Fast, low-cost, general-purpose model for chat and standard tasks. */
+    readonly Default: 0;
+    /** Optimized for code generation, structured output, and logic-heavy tasks. */
+    readonly Code: 1;
+    /** High-quality, reasoning-focused model used for writing, summarization, and complex queries. */
+    readonly Research: 2;
+};
+/**
+ * The role of the model service in the AI agent's architecture. This is used
+ * to determine which AI model to use for different types of tasks.
+ */
+export declare const ModelServiceRoleDescription: Record<number, string>;
+/**
+ * The role of the model service in the AI agent's architecture. This is used
+ * to determine which AI model to use for different types of tasks.
+ */
+export type ModelServiceRole = typeof ModelServiceRole[keyof typeof ModelServiceRole];

package/types/Enums/AI/Agent/parameterSchemaDataType.d.ts

@@ -0,0 +1,26 @@
+/** The data type of a parameter to use in a JSON schema. */
+export declare const ParameterSchemaDataType: {
+    /** The parameter is defined as a string type. */
+    readonly String: 0;
+    /**
+     * The parameter is defined as a numeric type. This will be represented
+     * as a double-precision value in Lava.
+     */
+    readonly Number: 1;
+    /** The parameter is defined as a boolean type. */
+    readonly Boolean: 2;
+    /**
+     * The parameter is defined as a Date type. This will be represented
+     * as a DateTime value in Lava if possible, otherwise as a string.
+     */
+    readonly Date: 3;
+    /**
+     * The parameter is defined as a DateTime type. This will be represented
+     * as a DateTime value in Lava if possible, otherwise as a string.
+     */
+    readonly DateTime: 4;
+};
+/** The data type of a parameter to use in a JSON schema. */
+export declare const ParameterSchemaDataTypeDescription: Record<number, string>;
+/** The data type of a parameter to use in a JSON schema. */
+export type ParameterSchemaDataType = typeof ParameterSchemaDataType[keyof typeof ParameterSchemaDataType];

package/types/Enums/AI/Agent/toolStatus.d.ts

@@ -0,0 +1,13 @@
+/** Indicates the overall outcome of a tool call. */
+export declare const ToolStatus: {
+    /** The lookup executed successfully and returned one or more items. */
+    readonly Success: 0;
+    /** The lookup executed successfully but returned no items. */
+    readonly NoData: 1;
+    /** The lookup failed. See the error message on the result for details. */
+    readonly Error: 2;
+};
+/** Indicates the overall outcome of a tool call. */
+export declare const ToolStatusDescription: Record<number, string>;
+/** Indicates the overall outcome of a tool call. */
+export type ToolStatus = typeof ToolStatus[keyof typeof ToolStatus];

package/types/Enums/AI/Agent/toolType.d.ts

@@ -0,0 +1,13 @@
+/** Defines the type of tool that can be executed by an AI agent. */
+export declare const ToolType: {
+    /** The tool is native C# code that will be executed. */
+    readonly ExecuteCode: 0;
+    /** The tool will use a Lava template to generate content. */
+    readonly ExecuteLava: 1;
+    /** The tool will use a semantic tool to generate content. */
+    readonly AIPrompt: 2;
+};
+/** Defines the type of tool that can be executed by an AI agent. */
+export declare const ToolTypeDescription: Record<number, string>;
+/** Defines the type of tool that can be executed by an AI agent. */
+export type ToolType = typeof ToolType[keyof typeof ToolType];

package/types/Enums/Blocks/Communication/CommunicationDetail/pushOpenAction.d.ts

@@ -0,0 +1,15 @@
+/** The Push Open Action used by the Communication Detail block. */
+export declare const PushOpenAction: {
+    /** The no action */
+    readonly NoAction: 0;
+    /** The show details */
+    readonly ShowDetails: 1;
+    /** The link to mobile page */
+    readonly LinkToMobilePage: 2;
+    /** The link to URL */
+    readonly LinkToUrl: 3;
+};
+/** The Push Open Action used by the Communication Detail block. */
+export declare const PushOpenActionDescription: Record<number, string>;
+/** The Push Open Action used by the Communication Detail block. */
+export type PushOpenAction = typeof PushOpenAction[keyof typeof PushOpenAction];

package/types/Enums/Blocks/Communication/CommunicationFlowDetail/pushOpenAction.d.ts

@@ -0,0 +1,15 @@
+/** The Push Open Action used by the Communication Flow Detail block. */
+export declare const PushOpenAction: {
+    /** The no action */
+    readonly NoAction: 0;
+    /** The show details */
+    readonly ShowDetails: 1;
+    /** The link to mobile page */
+    readonly LinkToMobilePage: 2;
+    /** The link to URL */
+    readonly LinkToUrl: 3;
+};
+/** The Push Open Action used by the Communication Flow Detail block. */
+export declare const PushOpenActionDescription: Record<number, string>;
+/** The Push Open Action used by the Communication Flow Detail block. */
+export type PushOpenAction = typeof PushOpenAction[keyof typeof PushOpenAction];

package/types/Enums/Blocks/Communication/EmailPreferenceEntry/communicationChannelType.d.ts

@@ -0,0 +1,11 @@
+/** A communication channel type that can be managed within the Email Preference Entry block. */
+export declare const CommunicationChannelType: {
+    /** A subscription to a communication list. */
+    readonly List: 0;
+    /** A subscription to a communication flow. */
+    readonly Flow: 1;
+};
+/** A communication channel type that can be managed within the Email Preference Entry block. */
+export declare const CommunicationChannelTypeDescription: Record<number, string>;
+/** A communication channel type that can be managed within the Email Preference Entry block. */
+export type CommunicationChannelType = typeof CommunicationChannelType[keyof typeof CommunicationChannelType];

package/types/Enums/CheckIn/adultsOrChildrenSelectionMode.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The different ways to select adults or children in check-in. This provides
+ * a standard set of options to select all possible combinations of adults
+ * and children.
+ */
+export declare const AdultsOrChildrenSelectionMode: {
+    /** Neither adults nor children are valid. */
+    readonly None: 0;
+    /** Both adults and children are valid. */
+    readonly AdultsAndChildren: 1;
+    /** Only adults are valid. */
+    readonly AdultsOnly: 2;
+    /** Only children are valid. */
+    readonly ChildrenOnly: 3;
+};
+/**
+ * The different ways to select adults or children in check-in. This provides
+ * a standard set of options to select all possible combinations of adults
+ * and children.
+ */
+export declare const AdultsOrChildrenSelectionModeDescription: Record<number, string>;
+/**
+ * The different ways to select adults or children in check-in. This provides
+ * a standard set of options to select all possible combinations of adults
+ * and children.
+ */
+export type AdultsOrChildrenSelectionMode = typeof AdultsOrChildrenSelectionMode[keyof typeof AdultsOrChildrenSelectionMode];

package/types/Enums/Cms/Personalization/PersonalizationRequestFilters/browserFamily.d.ts

@@ -0,0 +1,24 @@
+export declare const BrowserFamily: {
+    /** Other Browser */
+    readonly Other: 0;
+    /** Chrome Browser */
+    readonly Chrome: 1;
+    /** Chrome Mobile Browser */
+    readonly ChromeMobile: 2;
+    /** Firefox Browser */
+    readonly Firefox: 3;
+    /** Firefox Mobile Browser */
+    readonly FirefoxMobile: 4;
+    /** Safari Browser */
+    readonly Safari: 5;
+    /** Opera Browser */
+    readonly Opera: 6;
+    /** Opera Mini Browser */
+    readonly OperaMini: 7;
+    /** Edge Browser */
+    readonly Edge: 8;
+    /** Internet Explorer Browser */
+    readonly IE: 9;
+};
+export declare const BrowserFamilyDescription: Record<number, string>;
+export type BrowserFamily = typeof BrowserFamily[keyof typeof BrowserFamily];

package/types/Enums/Cms/Personalization/PersonalizationRequestFilters/deviceType.d.ts

@@ -0,0 +1,13 @@
+/** Enum DeviceType */
+export declare const DeviceType: {
+    /** The desktop */
+    readonly Desktop: 0;
+    /** The tablet */
+    readonly Tablet: 1;
+    /** The mobile */
+    readonly Mobile: 2;
+};
+/** Enum DeviceType */
+export declare const DeviceTypeDescription: Record<number, string>;
+/** Enum DeviceType */
+export type DeviceType = typeof DeviceType[keyof typeof DeviceType];

package/types/Enums/Cms/Personalization/PersonalizationRequestFilters/geolocationLocationComponent.d.ts

@@ -0,0 +1,14 @@
+export declare const GeolocationLocationComponent: {
+    /** Country Code */
+    readonly CountryCode: 0;
+    /** Region Code */
+    readonly RegionCode: 1;
+    /** Region Name */
+    readonly RegionName: 2;
+    /** City */
+    readonly City: 3;
+    /** Postal Code */
+    readonly PostalCode: 4;
+};
+export declare const GeolocationLocationComponentDescription: Record<number, string>;
+export type GeolocationLocationComponent = typeof GeolocationLocationComponent[keyof typeof GeolocationLocationComponent];

package/types/Enums/Cms/Personalization/PersonalizationRequestFilters/previousActivityType.d.ts

@@ -0,0 +1,11 @@
+/** Options on whether filter on New or Returning visitor */
+export declare const PreviousActivityType: {
+    /** The new */
+    readonly New: 0;
+    /** The returning */
+    readonly Return: 1;
+};
+/** Options on whether filter on New or Returning visitor */
+export declare const PreviousActivityTypeDescription: Record<number, string>;
+/** Options on whether filter on New or Returning visitor */
+export type PreviousActivityType = typeof PreviousActivityType[keyof typeof PreviousActivityType];

package/types/Enums/Cms/blockRole.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Specifies the role of a block within a page, defining its purpose and
+ * how it contributes to the page's functionality.
+ */
+export declare const BlockRole: {
+    /**
+     * The block provides core functionality for the system on the page.
+     * This is typically used for blocks that are essential for the page's
+     * operation, such as the Notifications block or Universal Search
+     * block on the internal site.
+     */
+    readonly System: 0;
+    /**
+     * The block provides navigation features for the page. This is
+     * typically used for blocks that would cause the individual to
+     * navigate away from the current page. But it could also apply to
+     * blocks that change the context of the current page in a way that
+     * would be considered a navigation action.
+     */
+    readonly Navigation: 1;
+    /**
+     * The block provides content for the page. This is typically used
+     * for blocks that display static content on the page, although the
+     * content might be dynamic in nature. An example would be a copyright
+     * footer that uses Lava to display the current year.
+     */
+    readonly Content: 2;
+    /**
+     * The block provides primary functionality for the page. This is
+     * typically used for list and detail blocks that provide the primary
+     * interaction for the individual on the page.
+     */
+    readonly Primary: 3;
+    /**
+     * The block provides secondary functionality for the page. This is
+     * typically used for blocks that provide additional features or
+     * information that is not essential to the primary interaction. These
+     * are often hidden when the primary block enters an edit mode.
+     */
+    readonly Secondary: 4;
+};
+/**
+ * Specifies the role of a block within a page, defining its purpose and
+ * how it contributes to the page's functionality.
+ */
+export declare const BlockRoleDescription: Record<number, string>;
+/**
+ * Specifies the role of a block within a page, defining its purpose and
+ * how it contributes to the page's functionality.
+ */
+export type BlockRole = typeof BlockRole[keyof typeof BlockRole];

package/types/Enums/Cms/lavaEndpointHttpMethod.d.ts

@@ -0,0 +1,15 @@
+/** Represents the Security Mode. */
+export declare const LavaEndpointHttpMethod: {
+    /** Get */
+    readonly Get: 0;
+    /** Post */
+    readonly Post: 1;
+    /** Put */
+    readonly Put: 2;
+    /** Delete */
+    readonly Delete: 3;
+};
+/** Represents the Security Mode. */
+export declare const LavaEndpointHttpMethodDescription: Record<number, string>;
+/** Represents the Security Mode. */
+export type LavaEndpointHttpMethod = typeof LavaEndpointHttpMethod[keyof typeof LavaEndpointHttpMethod];

package/types/Enums/Cms/lavaEndpointSecurityMode.d.ts

@@ -0,0 +1,15 @@
+/** Represents the Security Mode. */
+export declare const LavaEndpointSecurityMode: {
+    /** Endpoint Execute */
+    readonly EndpointExecute: 0;
+    /** Application View */
+    readonly ApplicationView: 1;
+    /** Application Edit */
+    readonly ApplicationEdit: 2;
+    /** Application Administrate */
+    readonly ApplicationAdministrate: 3;
+};
+/** Represents the Security Mode. */
+export declare const LavaEndpointSecurityModeDescription: Record<number, string>;
+/** Represents the Security Mode. */
+export type LavaEndpointSecurityMode = typeof LavaEndpointSecurityMode[keyof typeof LavaEndpointSecurityMode];

package/types/Enums/Communication/Chat/chatMessageEventType.d.ts

@@ -0,0 +1,11 @@
+/** The types of chat messages events that can be reported by the external chat system. */
+export declare const ChatMessageEventType: {
+    /** A new message was added. */
+    readonly New: 0;
+    /** An existing message was updated. */
+    readonly Update: 1;
+};
+/** The types of chat messages events that can be reported by the external chat system. */
+export declare const ChatMessageEventTypeDescription: Record<number, string>;
+/** The types of chat messages events that can be reported by the external chat system. */
+export type ChatMessageEventType = typeof ChatMessageEventType[keyof typeof ChatMessageEventType];

package/types/Enums/Communication/Chat/chatViewStyle.d.ts

@@ -0,0 +1,20 @@
+/** Represents the visual style of the chat experience. */
+export declare const ChatViewStyle: {
+    /**
+     * A simple, text-message-style layout.
+     * This mode emphasizes linear conversations and is ideal for one-on-one or small group chats.
+     * Messages appear in a flowing, bubble-style format similar to traditional SMS or mobile messaging.
+     */
+    readonly Conversational: 0;
+    /**
+     * A more structured layout for larger group communication.
+     * This mode supports organized discussions with clear visual separation,
+     * making it easier to follow multiple topics or conversations within a group.
+     * Best suited for teams, communities, or discussions with multiple participants.
+     */
+    readonly Community: 1;
+};
+/** Represents the visual style of the chat experience. */
+export declare const ChatViewStyleDescription: Record<number, string>;
+/** Represents the visual style of the chat experience. */
+export type ChatViewStyle = typeof ChatViewStyle[keyof typeof ChatViewStyle];

package/types/Enums/Communication/communicationFlowInstanceRecipientInactiveReason.d.ts

@@ -0,0 +1,23 @@
+/** The inactive reason of a Communication Flow Instance Recipient. */
+export declare const CommunicationFlowInstanceRecipientInactiveReason: {
+    /** The recipient's inactive reason is unknown or not set. */
+    readonly Unknown: 0;
+    /** The recipient is inactive because they have unsubscribed from the communication. */
+    readonly Unsubscribed: 1;
+    /** The recipient is inactive because they have met the conversion goal of the communication flow instance. */
+    readonly ConversionGoalMet: 2;
+    /** The recipient is inactive because they have opened a communication. */
+    readonly OpenedCommunication: 3;
+    /** The recipient is inactive because they have clicked a communication link. */
+    readonly ClickedCommunication: 4;
+    /** The recipient is inactive because the last communication of the flow has been sent. */
+    readonly LastCommunicationSent: 5;
+    /** The recipient is inactive because the person associated with the recipient has been inactivated. */
+    readonly PersonInactivated: 6;
+    /** The recipient is inactive because they have unsubscribed from the entire flow (not a specific communication). */
+    readonly UnsubscribedFromFlow: 7;
+};
+/** The inactive reason of a Communication Flow Instance Recipient. */
+export declare const CommunicationFlowInstanceRecipientInactiveReasonDescription: Record<number, string>;
+/** The inactive reason of a Communication Flow Instance Recipient. */
+export type CommunicationFlowInstanceRecipientInactiveReason = typeof CommunicationFlowInstanceRecipientInactiveReason[keyof typeof CommunicationFlowInstanceRecipientInactiveReason];

package/types/Enums/Communication/communicationFlowInstanceRecipientStatus.d.ts

@@ -0,0 +1,11 @@
+/** The recipient status in a Communication Flow Instance. */
+export declare const CommunicationFlowInstanceRecipientStatus: {
+    /** The recipient is still active to receive communications in the communication flow instance. */
+    readonly Active: 1;
+    /** The recipient is inactive and will no longer receive communications in the communication flow instance. */
+    readonly Inactive: 2;
+};
+/** The recipient status in a Communication Flow Instance. */
+export declare const CommunicationFlowInstanceRecipientStatusDescription: Record<number, string>;
+/** The recipient status in a Communication Flow Instance. */
+export type CommunicationFlowInstanceRecipientStatus = typeof CommunicationFlowInstanceRecipientStatus[keyof typeof CommunicationFlowInstanceRecipientStatus];

package/types/Enums/Communication/communicationFlowInstanceRecipientUnsubscribeScope.d.ts

@@ -0,0 +1,11 @@
+/** The unsubscibe scope for a Communication Flow Instance Recipient. */
+export declare const CommunicationFlowInstanceRecipientUnsubscribeScope: {
+    /** The recipient unsubscribed from a Communication Flow Instance. They will not receive subsequent communications from this instance. */
+    readonly CommunicationFlowInstance: 1;
+    /** The recipient has unsubscribed from a Communication Flow. They will not receive any communications from this instance, including any other instances of the flow. */
+    readonly CommunicationFlow: 2;
+};
+/** The unsubscibe scope for a Communication Flow Instance Recipient. */
+export declare const CommunicationFlowInstanceRecipientUnsubscribeScopeDescription: Record<number, string>;
+/** The unsubscibe scope for a Communication Flow Instance Recipient. */
+export type CommunicationFlowInstanceRecipientUnsubscribeScope = typeof CommunicationFlowInstanceRecipientUnsubscribeScope[keyof typeof CommunicationFlowInstanceRecipientUnsubscribeScope];

package/types/Enums/Communication/communicationFlowTriggerType.d.ts

@@ -0,0 +1,13 @@
+/** Represents the types of triggers that determine when a Communication Flow is executed. */
+export declare const CommunicationFlowTriggerType: {
+    /** The Communication Flow runs on a recurring schedule (e.g., weekly, monthly). */
+    readonly Recurring: 1;
+    /** The Communication Flow runs on demand, such as by a Workflow or manual event. */
+    readonly OnDemand: 2;
+    /** The Communication Flow is scheduled to run only once at a specific date and time. */
+    readonly OneTime: 3;
+};
+/** Represents the types of triggers that determine when a Communication Flow is executed. */
+export declare const CommunicationFlowTriggerTypeDescription: Record<number, string>;
+/** Represents the types of triggers that determine when a Communication Flow is executed. */
+export type CommunicationFlowTriggerType = typeof CommunicationFlowTriggerType[keyof typeof CommunicationFlowTriggerType];

package/types/Enums/Communication/communicationInteractionOperation.d.ts

@@ -0,0 +1,11 @@
+/** Enumeration for the type of interaction operation performed on a communication. */
+export declare const CommunicationInteractionOperation: {
+    /** Interaction representing a person opening a communication. */
+    readonly Opened: 0;
+    /** Interaction representing a person clicking a link within a communication. */
+    readonly Click: 1;
+};
+/** Enumeration for the type of interaction operation performed on a communication. */
+export declare const CommunicationInteractionOperationDescription: Record<number, string>;
+/** Enumeration for the type of interaction operation performed on a communication. */
+export type CommunicationInteractionOperation = typeof CommunicationInteractionOperation[keyof typeof CommunicationInteractionOperation];

package/types/Enums/Communication/communicationRecipientActivity.d.ts

@@ -0,0 +1,25 @@
+/** The activity that can occur for a communication recipient. */
+export declare const CommunicationRecipientActivity: {
+    /** The communication is pending and has not yet been sent. */
+    readonly Pending: 0;
+    /** The communication was cancelled prior to sending to the recipient. */
+    readonly Cancelled: 1;
+    /** The communication was sent to the recipient. */
+    readonly Sent: 2;
+    /** The communication was delivered to the recipient. */
+    readonly Delivered: 3;
+    /** The communication failed to be delivered to the recipient. */
+    readonly DeliveryFailed: 4;
+    /** The recipient opened the communication. */
+    readonly Opened: 5;
+    /** The recipient clicked on a link within the communication. */
+    readonly Clicked: 6;
+    /** The recipient marked the communication as spam. */
+    readonly MarkedAsSpam: 7;
+    /** The recipient unsubscribed from the communication. */
+    readonly Unsubscribed: 8;
+};
+/** The activity that can occur for a communication recipient. */
+export declare const CommunicationRecipientActivityDescription: Record<number, string>;
+/** The activity that can occur for a communication recipient. */
+export type CommunicationRecipientActivity = typeof CommunicationRecipientActivity[keyof typeof CommunicationRecipientActivity];