twenty-sdk 2.37.0 → 2.38.0

package/dist/define/index.d.ts

@@ -36,6 +36,32 @@ type AgentManifest = SyncableEntityOptions$1 & {
     roleUniversalIdentifier?: string;
 };
 
+declare const USAGE_OPERATION_TYPES: readonly ["AI_CHAT_TOKEN", "AI_WORKFLOW_TOKEN", "WORKFLOW_EXECUTION", "CODE_EXECUTION", "WEB_SEARCH", "CALL_RECORDING", "EMAIL_SEND"];
+type UsageOperationTypeValue = (typeof USAGE_OPERATION_TYPES)[number];
+
+type BillableOperationManifest = {
+    operationType: UsageOperationTypeValue;
+    label: string;
+};
+type BillableOperations = Partial<Record<string, BillableOperationManifest>>;
+
+declare const RECURRING_CHARGE_PERIODS: readonly ["MONTH"];
+type RecurringChargePeriod = (typeof RECURRING_CHARGE_PERIODS)[number];
+declare const RECURRING_CHARGE_UNITS: readonly ["WORKSPACE_MEMBER"];
+type RecurringChargeUnit = (typeof RECURRING_CHARGE_UNITS)[number];
+type RecurringCharge = {
+    period: RecurringChargePeriod;
+    amountMicroCredits: number;
+    per?: RecurringChargeUnit;
+    label: string;
+};
+type RecurringCharges = Partial<Record<string, RecurringCharge>>;
+type ApplicationBilling = {
+    description?: string;
+    recurring?: RecurringCharges;
+    operations?: BillableOperations;
+};
+
 declare const APPLICATION_CATEGORIES: readonly ["Communication", "Productivity", "Product management", "Sales", "Marketing", "Enrichment", "Data", "Search", "Other"];
 type KnownApplicationCategory = (typeof APPLICATION_CATEGORIES)[number];
 type ApplicationCategory = KnownApplicationCategory | (string & {});
@@ -129,6 +155,7 @@ type ApplicationManifest = SyncableEntityOptions$1 & {
     displayName: string;
     description: string;
     applicationVariables?: ApplicationVariables;
+    billing?: ApplicationBilling;
     serverVariables?: ServerVariables;
     author?: string;
     category?: ApplicationCategory;
@@ -566,6 +593,8 @@ declare enum DateDisplayFormat {
 }
 type FieldNumberVariant = 'number' | 'percentage';
 type FieldCurrencyFormat = 'short' | 'full';
+declare const FIELD_LINKS_VARIANTS: readonly ["url", "domain"];
+type FieldLinksVariant = (typeof FIELD_LINKS_VARIANTS)[number];
 type FieldMetadataNumberSettings = {
     dataType?: NumberDataType;
     decimals?: number;
@@ -593,6 +622,9 @@ type FieldMetadataRelationSettings = {
 type FieldMetadataAddressSettings = {
     subFields?: AllowedAddressSubField[];
 };
+type FieldMetadataLinksSettings = FieldMetadataMultiItemSettings & {
+    type?: FieldLinksVariant;
+};
 type FieldMetadataFilesSettings = {
     maxNumberOfValues: number;
 };
@@ -608,7 +640,7 @@ type FieldMetadataSettingsMapping = {
     [FieldMetadataType.TS_VECTOR]: null;
     [FieldMetadataType.PHONES]: FieldMetadataMultiItemSettings | null;
     [FieldMetadataType.EMAILS]: FieldMetadataMultiItemSettings | null;
-    [FieldMetadataType.LINKS]: FieldMetadataMultiItemSettings | null;
+    [FieldMetadataType.LINKS]: FieldMetadataLinksSettings | null;
     [FieldMetadataType.ARRAY]: FieldMetadataMultiItemSettings | null;
     [FieldMetadataType.FILES]: FieldMetadataFilesSettings;
 };
@@ -802,6 +834,7 @@ type RecordTableConfiguration = {
     configurationType: 'RECORD_TABLE';
     viewId?: SerializedRelation | null;
     recordLimit?: number;
+    isUIEditable?: boolean;
 };
 type FieldConfiguration = {
     configurationType: 'FIELD';
@@ -809,6 +842,11 @@ type FieldConfiguration = {
     fieldDisplayMode: 'CARD' | 'EDITOR' | 'FIELD' | 'VIEW' | 'TABLE';
     viewId?: string;
     nestedRelationFieldMetadataId?: string | null;
+    isUIEditable?: boolean;
+};
+type FormFieldConfiguration = {
+    configurationType: 'FORM_FIELD';
+    fieldMetadataId: string;
 };
 type FieldsConfiguration = {
     configurationType: 'FIELDS';
@@ -877,7 +915,7 @@ type WorkflowVersionConfiguration = {
 type WorkflowRunConfiguration = {
     configurationType: 'WORKFLOW_RUN';
 };
-type PageLayoutWidgetConfiguration = AggregateChartConfiguration | PieChartConfiguration | BarChartConfiguration | LineChartConfiguration | ViewConfiguration | RecordTableConfiguration | FieldConfiguration | FieldsConfiguration | FieldRichTextConfiguration | StandaloneRichTextConfiguration | IframeConfiguration | FrontComponentConfiguration | TimelineConfiguration | TasksConfiguration | NotesConfiguration | FilesConfiguration | EmailsConfiguration | CalendarConfiguration | WorkflowConfiguration | WorkflowVersionConfiguration | WorkflowRunConfiguration | EmailThreadConfiguration | MessageCampaignBodyConfiguration | MessageCampaignDetailsConfiguration | CallRecordingSummaryConfiguration | CallRecordingTranscriptConfiguration;
+type PageLayoutWidgetConfiguration = AggregateChartConfiguration | PieChartConfiguration | BarChartConfiguration | LineChartConfiguration | ViewConfiguration | RecordTableConfiguration | FieldConfiguration | FieldsConfiguration | FormFieldConfiguration | FieldRichTextConfiguration | StandaloneRichTextConfiguration | IframeConfiguration | FrontComponentConfiguration | TimelineConfiguration | TasksConfiguration | NotesConfiguration | FilesConfiguration | EmailsConfiguration | CalendarConfiguration | WorkflowConfiguration | WorkflowVersionConfiguration | WorkflowRunConfiguration | EmailThreadConfiguration | MessageCampaignBodyConfiguration | MessageCampaignDetailsConfiguration | CallRecordingSummaryConfiguration | CallRecordingTranscriptConfiguration;
 
 declare enum PageLayoutTabLayoutMode {
     GRID = "GRID",
@@ -907,7 +945,8 @@ declare enum PageLayoutType {
     RECORD_INDEX = "RECORD_INDEX",
     RECORD_PAGE = "RECORD_PAGE",
     DASHBOARD = "DASHBOARD",
-    STANDALONE_PAGE = "STANDALONE_PAGE"
+    STANDALONE_PAGE = "STANDALONE_PAGE",
+    RECORD_FORM = "RECORD_FORM"
 }
 
 type PageLayoutWidgetConditionalDisplay = object;
@@ -935,7 +974,8 @@ declare enum WidgetType {
     CALL_RECORDING_SUMMARY = "CALL_RECORDING_SUMMARY",
     CALL_RECORDING_TRANSCRIPT = "CALL_RECORDING_TRANSCRIPT",
     MESSAGE_CAMPAIGN_BODY = "MESSAGE_CAMPAIGN_BODY",
-    MESSAGE_CAMPAIGN_DETAILS = "MESSAGE_CAMPAIGN_DETAILS"
+    MESSAGE_CAMPAIGN_DETAILS = "MESSAGE_CAMPAIGN_DETAILS",
+    FORM_FIELD = "FORM_FIELD"
 }
 
 type RelationAndMorphRelationFieldMetadataType = FieldMetadataType.RELATION | FieldMetadataType.MORPH_RELATION;
@@ -1287,6 +1327,7 @@ type TimelineActivityAction = (typeof TIMELINE_ACTIVITY_ACTIONS)[number];
 type TimelineActivityTypeEmitThroughManifest = {
     relationFieldUniversalIdentifier: string;
     triggerFieldUniversalIdentifiers?: string[];
+    happensAtFieldUniversalIdentifier?: string;
 };
 type TimelineActivityTypeEmitManifest = {
     on: TimelineActivityAction;
@@ -1763,6 +1804,9 @@ declare const STANDARD_OBJECTS: {
             handle: {
                 universalIdentifier: string;
             };
+            scope: {
+                universalIdentifier: string;
+            };
             workspaceMember: {
                 universalIdentifier: string;
             };
@@ -2044,7 +2088,7 @@ declare const STANDARD_OBJECTS: {
             };
             readonly calendarEventRecordPageFields: {
                 universalIdentifier: string;
-                viewFields: Record<"conferenceLink" | "conferenceSolution" | "description" | "endsAt" | "externalCreatedAt" | "externalUpdatedAt" | "iCalUid" | "isCanceled" | "isFullDay" | "location" | "startsAt" | "title", {
+                viewFields: Record<"calendarEventTargets" | "conferenceLink" | "conferenceSolution" | "description" | "endsAt" | "externalCreatedAt" | "externalUpdatedAt" | "iCalUid" | "isCanceled" | "isFullDay" | "location" | "startsAt" | "title", {
                     universalIdentifier: string;
                 }>;
                 viewFieldGroups: Record<"general" | "system", {
@@ -2396,6 +2440,9 @@ declare const STANDARD_OBJECTS: {
             sentCount: {
                 universalIdentifier: string;
             };
+            deliveredCount: {
+                universalIdentifier: string;
+            };
             failedCount: {
                 universalIdentifier: string;
             };
@@ -2405,6 +2452,9 @@ declare const STANDARD_OBJECTS: {
             complainedCount: {
                 universalIdentifier: string;
             };
+            skippedCount: {
+                universalIdentifier: string;
+            };
             unsubscribeTopicId: {
                 universalIdentifier: string;
             };
@@ -2459,13 +2509,13 @@ declare const STANDARD_OBJECTS: {
         readonly views: {
             readonly allMessageCampaigns: {
                 universalIdentifier: string;
-                viewFields: Record<"bouncedCount" | "complainedCount" | "createdAt" | "failedCount" | "fromAddress" | "list" | "name" | "recipients" | "sentAt" | "sentCount" | "status" | "subject", {
+                viewFields: Record<"bouncedCount" | "complainedCount" | "createdAt" | "deliveredCount" | "failedCount" | "fromAddress" | "list" | "name" | "recipients" | "sentAt" | "sentCount" | "skippedCount" | "status" | "subject", {
                     universalIdentifier: string;
                 }>;
             };
             readonly messageCampaignRecordPageFields: {
                 universalIdentifier: string;
-                viewFields: Record<"bouncedCount" | "complainedCount" | "failedCount" | "sentAt" | "sentCount" | "status", {
+                viewFields: Record<"bouncedCount" | "complainedCount" | "deliveredCount" | "failedCount" | "sentAt" | "sentCount" | "skippedCount" | "status", {
                     universalIdentifier: string;
                 }>;
                 viewFieldGroups: Record<"stats", {
@@ -2946,9 +2996,6 @@ declare const STANDARD_OBJECTS: {
             messageCampaign: {
                 universalIdentifier: string;
             };
-            deliveryStatus: {
-                universalIdentifier: string;
-            };
             isDraft: {
                 universalIdentifier: string;
             };
@@ -2984,6 +3031,9 @@ declare const STANDARD_OBJECTS: {
             readonly messageCampaignIdIndex: {
                 readonly universalIdentifier: "79e777ca-7008-46c5-b3a6-3108b7c7dfb6";
             };
+            readonly headerMessageIdIndex: {
+                readonly universalIdentifier: "0904b3e4-6052-4a8d-bf41-f12a27c7e34a";
+            };
         };
         readonly views: {
             readonly allMessages: {
@@ -3051,10 +3101,10 @@ declare const STANDARD_OBJECTS: {
             };
             readonly noteRecordPageFields: {
                 universalIdentifier: string;
-                viewFields: Record<"attachments" | "bodyV2" | "createdAt" | "createdBy" | "noteTargets" | "timelineActivities" | "updatedAt" | "updatedBy", {
+                viewFields: Record<"attachments" | "noteTargets" | "timelineActivities", {
                     universalIdentifier: string;
                 }>;
-                viewFieldGroups: Record<"general" | "system", {
+                viewFieldGroups: Record<"general", {
                     universalIdentifier: string;
                 }>;
             };
@@ -3118,6 +3168,15 @@ declare const STANDARD_OBJECTS: {
             readonly opportunityIdIndex: {
                 readonly universalIdentifier: "0d1a59b4-cc87-4b7d-804a-656e8504f371";
             };
+            readonly notePersonUniqueIndex: {
+                readonly universalIdentifier: "29be76d1-ff4f-4f0f-b05c-f679a234e90a";
+            };
+            readonly noteCompanyUniqueIndex: {
+                readonly universalIdentifier: "e3b92659-04cf-4496-8fd4-4f32c747c26a";
+            };
+            readonly noteOpportunityUniqueIndex: {
+                readonly universalIdentifier: "58002741-8aa7-4812-b7af-f4cf98dd2433";
+            };
         };
         readonly views: {
             readonly allNoteTargets: {
@@ -3523,10 +3582,10 @@ declare const STANDARD_OBJECTS: {
             };
             readonly taskRecordPageFields: {
                 universalIdentifier: string;
-                viewFields: Record<"assignee" | "attachments" | "bodyV2" | "createdAt" | "createdBy" | "dueAt" | "status" | "taskTargets" | "timelineActivities" | "updatedAt" | "updatedBy", {
+                viewFields: Record<"assignee" | "attachments" | "dueAt" | "status" | "taskTargets" | "timelineActivities", {
                     universalIdentifier: string;
                 }>;
-                viewFieldGroups: Record<"general" | "system", {
+                viewFieldGroups: Record<"general", {
                     universalIdentifier: string;
                 }>;
             };
@@ -3590,6 +3649,15 @@ declare const STANDARD_OBJECTS: {
             readonly opportunityIdIndex: {
                 readonly universalIdentifier: "6942e0ba-90f6-4c33-bf40-7f00b1ec35ab";
             };
+            readonly taskPersonUniqueIndex: {
+                readonly universalIdentifier: "4adf4d5a-ad69-4c5c-bc62-2807816b3aa8";
+            };
+            readonly taskCompanyUniqueIndex: {
+                readonly universalIdentifier: "637dce5e-f609-49f4-89e3-c0ef9e330d3a";
+            };
+            readonly taskOpportunityUniqueIndex: {
+                readonly universalIdentifier: "eb5422ff-7a41-48d2-a2df-3de1cbf7bced";
+            };
         };
         readonly views: {
             readonly allTaskTargets: {