twenty-sdk 2.35.0 → 2.37.0

package/dist/define/index.d.ts

@@ -97,6 +97,7 @@ type ApplicationVariableOption = {
 };
 type ApplicationVariableValue = string | number | boolean | string[] | Record<string, unknown> | null;
 type TypedApplicationVariable = {
+    label?: string;
     type?: ApplicationVariableType;
     options?: ApplicationVariableOption[];
     isDeprecated?: boolean;
@@ -334,6 +335,13 @@ type CommandMenuContextApi = {
     objectMetadataLabel: string;
 };
 
+declare enum CommandMenuItemAvailabilityType {
+    GLOBAL = "GLOBAL",
+    GLOBAL_OBJECT_CONTEXT = "GLOBAL_OBJECT_CONTEXT",
+    RECORD_SELECTION = "RECORD_SELECTION",
+    FALLBACK = "FALLBACK"
+}
+
 type IsExactly<T, U> = [T] extends [U] ? [U] extends [T] ? true : false : false;
 
 type TagColor = 'red' | 'ruby' | 'crimson' | 'tomato' | 'orange' | 'amber' | 'yellow' | 'lime' | 'grass' | 'green' | 'jade' | 'mint' | 'turquoise' | 'cyan' | 'sky' | 'blue' | 'iris' | 'violet' | 'purple' | 'plum' | 'pink' | 'bronze' | 'gold' | 'brown' | 'gray';
@@ -626,6 +634,11 @@ declare enum HTTPMethod {
     DELETE = "DELETE"
 }
 
+declare enum IndexType {
+    BTREE = "BTREE",
+    GIN = "GIN"
+}
+
 type LogicFunctionEvent<TBody = object> = {
     headers: Record<string, string | undefined>;
     queryStringParameters: Record<string, string | undefined>;
@@ -701,13 +714,6 @@ type ChartFilter = {
     recordFilterGroups?: ChartRecordFilterGroup[];
 };
 
-type GridPosition = {
-    row: number;
-    column: number;
-    rowSpan: number;
-    columnSpan: number;
-};
-
 type RatioAggregateConfig = {
     fieldMetadataId: SerializedRelation;
     optionValue: string;
@@ -876,14 +882,25 @@ type PageLayoutWidgetConfiguration = AggregateChartConfiguration | PieChartConfi
 declare enum PageLayoutTabLayoutMode {
     GRID = "GRID",
     VERTICAL_LIST = "VERTICAL_LIST",
-    /**
-     * @deprecated Solo full-page tabs are no longer stored as a layout mode.
-     * Presentation (solo vs stack) is derived from the tab's widgets. Kept only to
-     * read layouts persisted before this change; nothing new should write it.
-     */
     CANVAS = "CANVAS"
 }
 
+type PageLayoutWidgetGridPosition = {
+    layoutMode: PageLayoutTabLayoutMode.GRID;
+    row: number;
+    column: number;
+    rowSpan: number;
+    columnSpan: number;
+};
+type PageLayoutWidgetVerticalListPosition = {
+    layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST;
+    index: number;
+};
+type PageLayoutWidgetCanvasPosition = {
+    layoutMode: PageLayoutTabLayoutMode.CANVAS;
+};
+type PageLayoutWidgetPosition = PageLayoutWidgetGridPosition | PageLayoutWidgetVerticalListPosition | PageLayoutWidgetCanvasPosition;
+
 type PageLayoutWidgetUniversalConfiguration = FormatRecordSerializedRelationProperties<PageLayoutWidgetConfiguration>;
 
 declare enum PageLayoutType {
@@ -895,6 +912,32 @@ declare enum PageLayoutType {
 
 type PageLayoutWidgetConditionalDisplay = object;
 
+declare enum WidgetType {
+    VIEW = "VIEW",
+    IFRAME = "IFRAME",
+    FIELD = "FIELD",
+    FIELDS = "FIELDS",
+    GRAPH = "GRAPH",
+    STANDALONE_RICH_TEXT = "STANDALONE_RICH_TEXT",
+    TIMELINE = "TIMELINE",
+    TASKS = "TASKS",
+    NOTES = "NOTES",
+    FILES = "FILES",
+    EMAILS = "EMAILS",
+    CALENDAR = "CALENDAR",
+    FIELD_RICH_TEXT = "FIELD_RICH_TEXT",
+    WORKFLOW = "WORKFLOW",
+    WORKFLOW_VERSION = "WORKFLOW_VERSION",
+    WORKFLOW_RUN = "WORKFLOW_RUN",
+    FRONT_COMPONENT = "FRONT_COMPONENT",
+    RECORD_TABLE = "RECORD_TABLE",
+    EMAIL_THREAD = "EMAIL_THREAD",
+    CALL_RECORDING_SUMMARY = "CALL_RECORDING_SUMMARY",
+    CALL_RECORDING_TRANSCRIPT = "CALL_RECORDING_TRANSCRIPT",
+    MESSAGE_CAMPAIGN_BODY = "MESSAGE_CAMPAIGN_BODY",
+    MESSAGE_CAMPAIGN_DETAILS = "MESSAGE_CAMPAIGN_DETAILS"
+}
+
 type RelationAndMorphRelationFieldMetadataType = FieldMetadataType.RELATION | FieldMetadataType.MORPH_RELATION;
 
 declare enum ViewFilterOperand {
@@ -1000,7 +1043,7 @@ type CommandMenuItemManifest = SyncableEntityOptions$1 & {
     /** @deprecated icon will be ignored in favor of application icon */
     icon?: string;
     isPinned?: boolean;
-    availabilityType?: 'GLOBAL' | 'GLOBAL_OBJECT_CONTEXT' | 'RECORD_SELECTION' | 'FALLBACK';
+    availabilityType?: `${CommandMenuItemAvailabilityType}`;
     availabilityObjectUniversalIdentifier?: string;
     frontComponentUniversalIdentifier: string;
     conditionalAvailabilityExpression?: string;
@@ -1024,7 +1067,7 @@ type IndexFieldManifest = SyncableEntityOptions$1 & {
 
 type IndexManifest = SyncableEntityOptions$1 & {
     objectUniversalIdentifier: string;
-    indexType?: 'BTREE' | 'GIN';
+    indexType?: `${IndexType}`;
     isUnique?: boolean;
     fields: IndexFieldManifest[];
 };
@@ -1150,10 +1193,10 @@ type ObjectManifest = SyncableEntityOptions$1 & {
 
 type PageLayoutWidgetManifest = SyncableEntityOptions$1 & {
     title: string;
-    type: string;
+    type: `${WidgetType}`;
     objectUniversalIdentifier?: string;
     conditionalDisplay?: PageLayoutWidgetConditionalDisplay;
-    gridPosition?: GridPosition;
+    position?: PageLayoutWidgetPosition;
     configuration: PageLayoutWidgetUniversalConfiguration;
 };
 type PageLayoutTabManifest = SyncableEntityOptions$1 & {
@@ -1960,6 +2003,9 @@ declare const STANDARD_OBJECTS: {
             calendarEventParticipants: {
                 universalIdentifier: string;
             };
+            calendarEventTargets: {
+                universalIdentifier: string;
+            };
             callRecordings: {
                 universalIdentifier: string;
             };
@@ -2007,6 +2053,82 @@ declare const STANDARD_OBJECTS: {
             };
         };
     };
+    readonly calendarEventTarget: {
+        readonly universalIdentifier: "6a9b9656-3e23-4234-94a4-b913c5dde668";
+        readonly fields: {
+            calendarEvent: {
+                universalIdentifier: string;
+            };
+            isAutomaticallyAssigned: {
+                universalIdentifier: string;
+            };
+            isManuallyAssigned: {
+                universalIdentifier: string;
+            };
+            targetPerson: {
+                universalIdentifier: string;
+            };
+            targetCompany: {
+                universalIdentifier: string;
+            };
+            targetOpportunity: {
+                universalIdentifier: string;
+            };
+            createdAt: {
+                universalIdentifier: string;
+            };
+            createdBy: {
+                universalIdentifier: string;
+            };
+            deletedAt: {
+                universalIdentifier: string;
+            };
+            id: {
+                universalIdentifier: string;
+            };
+            position: {
+                universalIdentifier: string;
+            };
+            searchVector: {
+                universalIdentifier: string;
+            };
+            updatedAt: {
+                universalIdentifier: string;
+            };
+            updatedBy: {
+                universalIdentifier: string;
+            };
+        };
+        readonly morphIds: {
+            readonly targetMorphId: {
+                readonly morphId: "676e9f68-7b5c-41e6-b46d-2fb9527b7051";
+            };
+        };
+        readonly indexes: {
+            readonly calendarEventIdIndex: {
+                readonly universalIdentifier: "ce1c180c-0236-4673-ad1d-359dddf59f93";
+            };
+            readonly personIdIndex: {
+                readonly universalIdentifier: "f151bc84-ba45-40cb-b064-02ef359ac17b";
+            };
+            readonly companyIdIndex: {
+                readonly universalIdentifier: "30413277-505d-4f08-be38-a56257460f9f";
+            };
+            readonly opportunityIdIndex: {
+                readonly universalIdentifier: "7920092d-281f-473a-8ea4-53c209b36a37";
+            };
+            readonly calendarEventPersonUniqueIndex: {
+                readonly universalIdentifier: "15b9e394-d451-4186-aaf0-612f6be1ea91";
+            };
+            readonly calendarEventCompanyUniqueIndex: {
+                readonly universalIdentifier: "3fa22398-6e7d-47a5-95eb-4971f9d62135";
+            };
+            readonly calendarEventOpportunityUniqueIndex: {
+                readonly universalIdentifier: "c8183b17-5dfe-4e02-8d9d-aef8e54ef07d";
+            };
+        };
+        readonly views: {};
+    };
     readonly callRecording: {
         readonly universalIdentifier: "ce19efb9-710f-45b2-b141-473abbeea60b";
         readonly fields: {
@@ -2127,6 +2249,12 @@ declare const STANDARD_OBJECTS: {
             noteTargets: {
                 universalIdentifier: string;
             };
+            calendarEventTargets: {
+                universalIdentifier: string;
+            };
+            messageThreadTargets: {
+                universalIdentifier: string;
+            };
             opportunities: {
                 universalIdentifier: string;
             };
@@ -2677,6 +2805,9 @@ declare const STANDARD_OBJECTS: {
             subject: {
                 universalIdentifier: string;
             };
+            messageThreadTargets: {
+                universalIdentifier: string;
+            };
             createdAt: {
                 universalIdentifier: string;
             };
@@ -2712,6 +2843,82 @@ declare const STANDARD_OBJECTS: {
             };
         };
     };
+    readonly messageThreadTarget: {
+        readonly universalIdentifier: "378ad1b0-592d-4084-80ee-86fef44725b9";
+        readonly fields: {
+            messageThread: {
+                universalIdentifier: string;
+            };
+            isAutomaticallyAssigned: {
+                universalIdentifier: string;
+            };
+            isManuallyAssigned: {
+                universalIdentifier: string;
+            };
+            targetPerson: {
+                universalIdentifier: string;
+            };
+            targetCompany: {
+                universalIdentifier: string;
+            };
+            targetOpportunity: {
+                universalIdentifier: string;
+            };
+            createdAt: {
+                universalIdentifier: string;
+            };
+            createdBy: {
+                universalIdentifier: string;
+            };
+            deletedAt: {
+                universalIdentifier: string;
+            };
+            id: {
+                universalIdentifier: string;
+            };
+            position: {
+                universalIdentifier: string;
+            };
+            searchVector: {
+                universalIdentifier: string;
+            };
+            updatedAt: {
+                universalIdentifier: string;
+            };
+            updatedBy: {
+                universalIdentifier: string;
+            };
+        };
+        readonly morphIds: {
+            readonly targetMorphId: {
+                readonly morphId: "e85e853d-c26e-41b3-bec0-7afc4bdbc2f7";
+            };
+        };
+        readonly indexes: {
+            readonly messageThreadIdIndex: {
+                readonly universalIdentifier: "222fdd8b-0863-4f2a-816a-29745537b6b6";
+            };
+            readonly personIdIndex: {
+                readonly universalIdentifier: "280ee419-ac3c-4599-bd62-3e5cb268342c";
+            };
+            readonly companyIdIndex: {
+                readonly universalIdentifier: "b98005e4-3811-41b6-82d0-3ccd27757eba";
+            };
+            readonly opportunityIdIndex: {
+                readonly universalIdentifier: "7679ee05-cf6c-40a7-9ee6-c3e8053caca5";
+            };
+            readonly messageThreadPersonUniqueIndex: {
+                readonly universalIdentifier: "087f97cb-8c3c-4ea1-9556-933acde6c83b";
+            };
+            readonly messageThreadCompanyUniqueIndex: {
+                readonly universalIdentifier: "30d4f1af-8b6f-4685-802f-8a7cf29f318b";
+            };
+            readonly messageThreadOpportunityUniqueIndex: {
+                readonly universalIdentifier: "1dc0e37e-afb1-4e90-90b4-052374126a6a";
+            };
+        };
+        readonly views: {};
+    };
     readonly message: {
         readonly universalIdentifier: "20202020-3f6b-4425-80ab-e468899ab4b2";
         readonly fields: {
@@ -2951,6 +3158,12 @@ declare const STANDARD_OBJECTS: {
             noteTargets: {
                 universalIdentifier: string;
             };
+            calendarEventTargets: {
+                universalIdentifier: string;
+            };
+            messageThreadTargets: {
+                universalIdentifier: string;
+            };
             attachments: {
                 universalIdentifier: string;
             };
@@ -3090,6 +3303,12 @@ declare const STANDARD_OBJECTS: {
             noteTargets: {
                 universalIdentifier: string;
             };
+            calendarEventTargets: {
+                universalIdentifier: string;
+            };
+            messageThreadTargets: {
+                universalIdentifier: string;
+            };
             attachments: {
                 universalIdentifier: string;
             };
@@ -3384,9 +3603,6 @@ declare const STANDARD_OBJECTS: {
     readonly timelineActivity: {
         readonly universalIdentifier: "20202020-6736-4337-b5c4-8b39fae325a5";
         readonly fields: {
-            name: {
-                universalIdentifier: string;
-            };
             timelineActivityTypeId: {
                 universalIdentifier: string;
             };
@@ -3674,6 +3890,12 @@ declare const STANDARD_OBJECTS: {
             stepLogs: {
                 universalIdentifier: string;
             };
+            coreWorkflowId: {
+                universalIdentifier: string;
+            };
+            coreWorkflowVersionId: {
+                universalIdentifier: string;
+            };
             timelineActivities: {
                 universalIdentifier: string;
             };
@@ -4427,6 +4649,22 @@ declare const STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS: {
                     };
                 };
             };
+            readonly summary: {
+                universalIdentifier: string;
+                widgets: {
+                    readonly summary: {
+                        universalIdentifier: string;
+                    };
+                };
+            };
+            readonly callRecording: {
+                universalIdentifier: string;
+                widgets: {
+                    readonly transcript: {
+                        universalIdentifier: string;
+                    };
+                };
+            };
         };
     };
     readonly messageChannelMessageAssociationRecordPage: {
@@ -4623,5 +4861,5 @@ declare const defineView: DefineEntity<ViewConfig>;
 
 declare const defineViewField: DefineEntity<StandaloneViewFieldManifest>;
 
-export { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, MetadataWritability, NavigationMenuItemType, NumberDataType, ObjectOpenRecordIn, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordGroupByDateGranularity, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, RelationOnDeleteAction as OnDeleteAction, PageLayoutTabLayoutMode, PageLayoutType, RelationType, RowLevelPermissionPredicateGroupLogicalOperator, RowLevelPermissionPredicateOperand, STANDARD_OBJECTS as STANDARD_OBJECT, STANDARD_OBJECTS as STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS as STANDARD_PAGE_LAYOUT, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS, SYSTEM_VIEW_KEYS, SystemPermissionFlag, ViewCalendarLayout, ViewFilterGroupLogicalOperator, ViewFilterOperand, ViewKey, ViewOpenRecordIn, ViewSortDirection, ViewType, ViewVisibility, canAccessFullAdminPanel, canImpersonate, createValidationResult, defineAgent, defineApplication, defineApplicationRole, defineCommandMenuItem, defineConnectionProvider, defineField, defineFrontComponent, defineIndex, defineLogicFunction, defineNavigationMenuItem, defineObject, definePageLayout, definePageLayoutTab, definePermissionFlag, definePostInstallLogicFunction, definePreInstallLogicFunction, defineRole, defineSettingsFrontComponent, defineSkill, defineTimelineActivityType, defineUninstallLogicFunction, defineView, defineViewField, every, everyDefined, everyEquals, favoriteRecordIds, featureFlags, getFieldUniversalIdentifier, getSystemRelationFieldUniversalIdentifier, getSystemViewFieldUniversalIdentifier, getSystemViewUniversalIdentifier, hasAnySoftDeleteFilterOnView, includes, includesEvery, isDashboardPageLayoutInEditMode, isDefined, isInSidePanel, isLayoutCustomizationModeEnabled, isNonEmptyString, isSelectAll, none, noneDefined, noneEquals, numberOfSelectedRecords, objectMetadataItem, objectMetadataLabel, objectPermissions, pageType, selectedRecords, some, someDefined, someEquals, someNonEmptyString, targetObjectReadPermissions, targetObjectWritePermissions, validateFields };
-export type { ActorMetadata as ActorField, AddressMetadata as AddressField, ApplicationConfig, CommandMenuItemConfig, CommandMenuItemManifest, CronPayload, CurrencyMetadata as CurrencyField, DatabaseEventPayload, DefinableEntity, DefineEntity, EmailsMetadata as EmailsField, FrontComponentConfig, FrontComponentType, FullNameMetadata as FullNameField, GridPosition, IndexConfig, IndexFieldManifest, IndexManifest, InputJsonSchema, InstallHandler, InstallPayload, LinksMetadata as LinksField, LogicFunctionConfig, LogicFunctionHandler, ObjectRecordEvent, PageLayoutConfig, PageLayoutManifest, PageLayoutTabConfig, PageLayoutTabManifest, PageLayoutWidgetConditionalDisplay, PageLayoutWidgetManifest, PageLayoutWidgetUniversalConfiguration, PermissionFlagConfig, PermissionFlagManifest, PermissionFlagPermissionType, PhonesMetadata as PhonesField, RichTextMetadata as RichTextField, LogicFunctionEvent as RoutePayload, RowLevelPermissionPredicateGroupManifest, RowLevelPermissionPredicateManifest, ServerRouteDispatchResult, ServerRouteResolverResult, SettingsFrontComponentConfig, StandaloneViewFieldManifest, SyncableEntityOptions, SystemViewKey, TimelineActivityTypeConfig, TimelineActivityTypeManifest, TwentyRecord, UninstallHandler, UninstallPayload, ValidationResult, ViewConfig, ViewFieldGroupManifest, ViewFieldManifest, ViewFilterGroupManifest, ViewFilterManifest, ViewGroupManifest, ViewManifestFilterValue, ViewSortManifest };
+export { AggregateOperations, CommandMenuItemAvailabilityType, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, IndexType, MetadataWritability, NavigationMenuItemType, NumberDataType, ObjectOpenRecordIn, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordGroupByDateGranularity, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, RelationOnDeleteAction as OnDeleteAction, PageLayoutTabLayoutMode, PageLayoutType, RelationType, RowLevelPermissionPredicateGroupLogicalOperator, RowLevelPermissionPredicateOperand, STANDARD_OBJECTS as STANDARD_OBJECT, STANDARD_OBJECTS as STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS as STANDARD_PAGE_LAYOUT, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS, SYSTEM_VIEW_KEYS, SystemPermissionFlag, ViewCalendarLayout, ViewFilterGroupLogicalOperator, ViewFilterOperand, ViewKey, ViewOpenRecordIn, ViewSortDirection, ViewType, ViewVisibility, WidgetType, canAccessFullAdminPanel, canImpersonate, createValidationResult, defineAgent, defineApplication, defineApplicationRole, defineCommandMenuItem, defineConnectionProvider, defineField, defineFrontComponent, defineIndex, defineLogicFunction, defineNavigationMenuItem, defineObject, definePageLayout, definePageLayoutTab, definePermissionFlag, definePostInstallLogicFunction, definePreInstallLogicFunction, defineRole, defineSettingsFrontComponent, defineSkill, defineTimelineActivityType, defineUninstallLogicFunction, defineView, defineViewField, every, everyDefined, everyEquals, favoriteRecordIds, featureFlags, getFieldUniversalIdentifier, getSystemRelationFieldUniversalIdentifier, getSystemViewFieldUniversalIdentifier, getSystemViewUniversalIdentifier, hasAnySoftDeleteFilterOnView, includes, includesEvery, isDashboardPageLayoutInEditMode, isDefined, isInSidePanel, isLayoutCustomizationModeEnabled, isNonEmptyString, isSelectAll, none, noneDefined, noneEquals, numberOfSelectedRecords, objectMetadataItem, objectMetadataLabel, objectPermissions, pageType, selectedRecords, some, someDefined, someEquals, someNonEmptyString, targetObjectReadPermissions, targetObjectWritePermissions, validateFields };
+export type { ActorMetadata as ActorField, AddressMetadata as AddressField, ApplicationConfig, CommandMenuItemConfig, CommandMenuItemManifest, CronPayload, CurrencyMetadata as CurrencyField, DatabaseEventPayload, DefinableEntity, DefineEntity, EmailsMetadata as EmailsField, FrontComponentConfig, FrontComponentType, FullNameMetadata as FullNameField, IndexConfig, IndexFieldManifest, IndexManifest, InputJsonSchema, InstallHandler, InstallPayload, LinksMetadata as LinksField, LogicFunctionConfig, LogicFunctionHandler, ObjectRecordEvent, PageLayoutConfig, PageLayoutManifest, PageLayoutTabConfig, PageLayoutTabManifest, PageLayoutWidgetCanvasPosition, PageLayoutWidgetConditionalDisplay, PageLayoutWidgetGridPosition, PageLayoutWidgetManifest, PageLayoutWidgetPosition, PageLayoutWidgetUniversalConfiguration, PageLayoutWidgetVerticalListPosition, PermissionFlagConfig, PermissionFlagManifest, PermissionFlagPermissionType, PhonesMetadata as PhonesField, RichTextMetadata as RichTextField, LogicFunctionEvent as RoutePayload, RowLevelPermissionPredicateGroupManifest, RowLevelPermissionPredicateManifest, ServerRouteDispatchResult, ServerRouteResolverResult, SettingsFrontComponentConfig, StandaloneViewFieldManifest, SyncableEntityOptions, SystemViewKey, TimelineActivityTypeConfig, TimelineActivityTypeManifest, TwentyRecord, UninstallHandler, UninstallPayload, ValidationResult, ViewConfig, ViewFieldGroupManifest, ViewFieldManifest, ViewFilterGroupManifest, ViewFilterManifest, ViewGroupManifest, ViewManifestFilterValue, ViewSortManifest };