@twentyhq/people-data-labs 1.0.4 → 1.0.7

package/src/logic-functions/enrich-companies.function.ts

@@ -0,0 +1,77 @@
+import { defineLogicFunction, STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS } from 'twenty-sdk/define';
+
+import { UPDATE_FIELDS_OPTION_VALUES } from 'src/constants/update-fields-option-values';
+import { PDL_LOGIC_FUNCTION_CONSTANTS } from 'src/constants/universal-identifiers';
+import { enrichCompaniesCore } from 'src/logic-functions/handlers/enrich-companies';
+import { type EnrichInput, toBulkEnrichInput } from 'src/logic-functions/utils/to-bulk-enrich-input';
+
+const handler = (input: EnrichInput) => {
+  return enrichCompaniesCore({ input: toBulkEnrichInput(input) });
+}
+
+export default defineLogicFunction({
+  universalIdentifier: PDL_LOGIC_FUNCTION_CONSTANTS.enrichCompanies.universalIdentifier,
+  name: 'enrich-companies',
+  description: 'Enrich one or more Company records with People Data Labs data',
+  timeoutSeconds: 300,
+  handler,
+  httpRouteTriggerSettings: {
+    path: PDL_LOGIC_FUNCTION_CONSTANTS.enrichCompanies.path,
+    httpMethod: 'POST',
+    isAuthRequired: true
+  },
+  workflowActionTriggerSettings: {
+    label: 'Enrich Companies',
+    icon: 'IconSparkles',
+    inputSchema: [
+      {
+        type: 'object',
+        properties: {
+          records: {
+            type: 'records',
+            objectUniversalIdentifier:
+              STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier,
+            label: 'Records',
+          },
+          updateFields: {
+            type: 'string',
+            label: 'Update fields',
+            enum: [...UPDATE_FIELDS_OPTION_VALUES],
+          },
+        },
+      },
+    ],
+    outputSchema: [
+      {
+        type: 'object',
+        properties: {
+          success: { type: 'boolean', label: 'Success' },
+          total: { type: 'number', label: 'Total' },
+          matched: { type: 'number', label: 'Matched' },
+          notFound: { type: 'number', label: 'Not Found' },
+          skipped: { type: 'number', label: 'Skipped' },
+          errored: { type: 'number', label: 'Errored' },
+          results: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                success: { type: 'boolean', label: 'Success' },
+                recordId: { type: 'string', label: 'Record Id' },
+                status: { type: 'string', label: 'Status' },
+                updatedFields: {
+                  type: 'array',
+                  items: { type: 'string' },
+                  label: 'Updated Fields',
+                },
+                data: { type: 'object', label: 'Data' },
+                message: { type: 'string', label: 'Message' },
+              },
+            },
+            label: 'Results',
+          },
+        },
+      },
+    ],
+  },
+});