twenty-sdk 2.19.0 → 2.21.0

package/dist/define/index.d.ts

@@ -35,6 +35,19 @@ type AgentManifest = SyncableEntityOptions$1 & {
     responseFormat?: AgentResponseFormat;
 };
 
+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 & {});
+
+type PreInstallLogicFunctionApplicationManifest = SyncableEntityOptions$1 & {
+    universalIdentifier: string;
+    shouldRunOnVersionUpgrade?: boolean;
+};
+
+type PostInstallLogicFunctionApplicationManifest = PreInstallLogicFunctionApplicationManifest & {
+    shouldRunSynchronously?: boolean;
+};
+
 declare enum FieldMetadataType {
     ACTOR = "ACTOR",
     ADDRESS = "ADDRESS",
@@ -95,15 +108,6 @@ type ServerVariableSchema = {
 };
 type ServerVariables = Record<string, ServerVariableSchema>;
 
-type PreInstallLogicFunctionApplicationManifest = SyncableEntityOptions$1 & {
-    universalIdentifier: string;
-    shouldRunOnVersionUpgrade?: boolean;
-};
-
-type PostInstallLogicFunctionApplicationManifest = PreInstallLogicFunctionApplicationManifest & {
-    shouldRunSynchronously?: boolean;
-};
-
 type ApplicationManifest = SyncableEntityOptions$1 & {
     defaultRoleUniversalIdentifier: string;
     displayName: string;
@@ -111,9 +115,17 @@ type ApplicationManifest = SyncableEntityOptions$1 & {
     applicationVariables?: ApplicationVariables;
     serverVariables?: ServerVariables;
     author?: string;
-    category?: string;
+    category?: ApplicationCategory;
+    /**
+     * @deprecated Use `logo` instead.
+     */
     logoUrl?: string;
+    logo?: string;
+    /**
+     * @deprecated Use `galleryImages` instead.
+     */
     screenshots?: string[];
+    galleryImages?: string[];
     aboutDescription?: string;
     websiteUrl?: string;
     termsUrl?: string;
@@ -129,6 +141,7 @@ type ApplicationManifest = SyncableEntityOptions$1 & {
     settingsCustomTabFrontComponentUniversalIdentifier?: string;
     packageJsonChecksum: string | null;
     yarnLockChecksum: string | null;
+    requiredServerVersionRange?: string | null;
 };
 
 type OAuthProviderTokenRequestContentType = 'json' | 'form-urlencoded';
@@ -152,6 +165,12 @@ type ConnectionProviderManifest = SyncableEntityOptions$1 & {
     oauth: OAuthConnectionProviderConfig;
 };
 
+declare const getFieldUniversalIdentifier: ({ applicationUniversalIdentifier, objectUniversalIdentifier, name, }: {
+    applicationUniversalIdentifier: string;
+    objectUniversalIdentifier: string;
+    name: string;
+}) => string;
+
 declare const ALLOWED_ADDRESS_SUBFIELDS: readonly ["addressStreet1", "addressStreet2", "addressCity", "addressState", "addressPostcode", "addressCountry", "addressLat", "addressLng"];
 type AllowedAddressSubField = (typeof ALLOWED_ADDRESS_SUBFIELDS)[number];
 
@@ -1186,7 +1205,7 @@ type ViewManifest = SyncableEntityOptions$1 & {
     sorts?: ViewSortManifest[];
 };
 
-type ApplicationConfig = Omit<ApplicationManifest, 'packageJsonChecksum' | 'yarnLockChecksum' | 'postInstallLogicFunction' | 'preInstallLogicFunction' | 'defaultRoleUniversalIdentifier' | 'aboutDescription'> & {
+type ApplicationConfig = Omit<ApplicationManifest, 'packageJsonChecksum' | 'yarnLockChecksum' | 'requiredServerVersionRange' | 'postInstallLogicFunction' | 'preInstallLogicFunction' | 'defaultRoleUniversalIdentifier' | 'aboutDescription'> & {
     /**
      * @deprecated Use `defineApplicationRole()` in your role file instead.
      */
@@ -1448,12 +1467,6 @@ declare const defineNavigationMenuItem: DefineEntity<NavigationMenuItemManifest>
 
 declare const defineObject: DefineEntity<ObjectConfig>;
 
-declare const generateDefaultFieldUniversalIdentifier: ({ applicationUniversalIdentifier, objectUniversalIdentifier, fieldName, }: {
-    applicationUniversalIdentifier: string;
-    objectUniversalIdentifier: string;
-    fieldName: string;
-}) => string;
-
 declare const STANDARD_OBJECTS: {
     readonly attachment: {
         readonly universalIdentifier: "20202020-bd3d-4c60-8dca-571c71d4447a";
@@ -2426,6 +2439,18 @@ declare const STANDARD_OBJECTS: {
             readonly sentAt: {
                 readonly universalIdentifier: "e2315b4f-9edf-4df2-96b9-961e76368671";
             };
+            readonly sentCount: {
+                readonly universalIdentifier: "2f333d2b-37b8-4ddc-ad0d-c07c6ce066ad";
+            };
+            readonly failedCount: {
+                readonly universalIdentifier: "d373fcd7-b1ce-4c77-8031-a5785c475028";
+            };
+            readonly bouncedCount: {
+                readonly universalIdentifier: "20d884a9-34dd-4667-8ecb-ceec224258e2";
+            };
+            readonly complainedCount: {
+                readonly universalIdentifier: "82842cfa-f12a-4bab-bbde-b2cf587d0406";
+            };
             readonly unsubscribeTopicId: {
                 readonly universalIdentifier: "0648e7ad-1769-4ff6-a4d5-72da79ef169c";
             };
@@ -2477,6 +2502,46 @@ declare const STANDARD_OBJECTS: {
                 readonly universalIdentifier: "975823ad-9b97-4f39-b2c7-fbd7d77f4bd1";
             };
         };
+        readonly views: {
+            readonly allMessageCampaigns: {
+                readonly universalIdentifier: "ffedb368-33f0-43a7-b84e-e622b4e97be9";
+                readonly viewFields: {
+                    readonly subject: {
+                        readonly universalIdentifier: "b017c851-e38d-4a81-ab38-0fb10e9f239e";
+                    };
+                    readonly status: {
+                        readonly universalIdentifier: "ef35df97-b1a5-4f16-8b85-5751e5019f63";
+                    };
+                    readonly list: {
+                        readonly universalIdentifier: "c0bf6a48-8695-4520-81e6-7462d35033b5";
+                    };
+                    readonly fromAddress: {
+                        readonly universalIdentifier: "553a0ea6-1f55-4143-a2d0-8c1ad0cf3dd1";
+                    };
+                    readonly sentAt: {
+                        readonly universalIdentifier: "7f4a9d81-afac-4d27-98de-0a2da65114f7";
+                    };
+                    readonly sentCount: {
+                        readonly universalIdentifier: "0be62e57-3955-49bd-a9ef-8f82f7a6e9aa";
+                    };
+                    readonly failedCount: {
+                        readonly universalIdentifier: "ad346c8e-f462-499e-89c8-da01d5460dc6";
+                    };
+                    readonly bouncedCount: {
+                        readonly universalIdentifier: "135d3fb9-bc45-4426-980b-9836ed792e3a";
+                    };
+                    readonly complainedCount: {
+                        readonly universalIdentifier: "9957dc6d-05ae-4829-ae7d-7cdf9239cdd0";
+                    };
+                    readonly recipients: {
+                        readonly universalIdentifier: "2f99f444-4af3-44fd-b08d-46955c4ac2a2";
+                    };
+                    readonly createdAt: {
+                        readonly universalIdentifier: "6dffa47d-3128-4d54-924a-4f67676116c2";
+                    };
+                };
+            };
+        };
     };
     readonly messageList: {
         readonly universalIdentifier: "826561ea-4816-411c-baa0-eec5e6ca8866";
@@ -2523,6 +2588,25 @@ declare const STANDARD_OBJECTS: {
                 readonly universalIdentifier: "8e205171-ed74-4620-b7d2-674aab85033a";
             };
         };
+        readonly views: {
+            readonly allMessageLists: {
+                readonly universalIdentifier: "c72bae18-75e9-4cb0-baeb-379d3529b98f";
+                readonly viewFields: {
+                    readonly name: {
+                        readonly universalIdentifier: "c9767580-34e6-420b-923d-b4abd8c13d96";
+                    };
+                    readonly members: {
+                        readonly universalIdentifier: "6d314c4b-215a-4094-963a-ff9dd8221aea";
+                    };
+                    readonly campaigns: {
+                        readonly universalIdentifier: "037030a2-9dad-4bfd-957a-313b362172b4";
+                    };
+                    readonly createdAt: {
+                        readonly universalIdentifier: "29f3e7de-c40b-4597-8568-7318c146e4da";
+                    };
+                };
+            };
+        };
     };
     readonly messageListMember: {
         readonly universalIdentifier: "27773d24-8ce3-40f8-aa6c-1f590f2c08d2";
@@ -5343,5 +5427,5 @@ declare const defineView: DefineEntity<ViewConfig>;
 
 declare const defineViewField: DefineEntity<StandaloneViewFieldManifest>;
 
-export { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, NavigationMenuItemType, NumberDataType, 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, 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, defineSkill, defineView, defineViewField, every, everyDefined, everyEquals, favoriteRecordIds, featureFlags, generateDefaultFieldUniversalIdentifier, 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 { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, NavigationMenuItemType, NumberDataType, 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, 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, defineSkill, defineView, defineViewField, every, everyDefined, everyEquals, favoriteRecordIds, featureFlags, getFieldUniversalIdentifier, 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, StandaloneViewFieldManifest, SyncableEntityOptions, TwentyRecord, ValidationResult, ViewConfig, ViewFieldGroupManifest, ViewFieldManifest, ViewFilterGroupManifest, ViewFilterManifest, ViewGroupManifest, ViewManifestFilterValue, ViewSortManifest };