feat(pipedrive): add create deal action

packages/backend/src/apps/pipedrive/actions/create-deal/index.ts

@@ -0,0 +1,245 @@
+import defineAction from '../../../../helpers/define-action';
+
+function filterProvidedFields(body: Record<string, unknown>) {
+  return Object.keys(body).reduce<Record<string, unknown>>((result, key) => {
+    if (body[key]) {
+      result[key] = body[key];
+    }
+    return result;
+  }, {});
+}
+
+export default defineAction({
+  name: 'Create deal',
+  key: 'createDeal',
+  description: 'Creates a new deal.',
+  arguments: [
+    {
+      label: 'Title',
+      key: 'title',
+      type: 'string' as const,
+      required: true,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Creation Date',
+      key: 'addTime',
+      type: 'string' as const,
+      required: false,
+      description:
+        'Requires admin access to Pipedrive account. Format: YYYY-MM-DD HH:MM:SS',
+      variables: true,
+    },
+    {
+      label: 'Status',
+      key: 'status',
+      type: 'dropdown' as const,
+      required: false,
+      description: '',
+      options: [
+        {
+          label: 'Open',
+          value: 'open',
+        },
+        {
+          label: 'Won',
+          value: 'won',
+        },
+        {
+          label: 'Lost',
+          value: 'lost',
+        },
+        {
+          label: 'Deleted',
+          value: 'deleted',
+        },
+      ],
+    },
+    {
+      label: 'Lost Reason',
+      key: 'lostReason',
+      type: 'string' as const,
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Stage',
+      key: 'stageId',
+      type: 'dropdown' as const,
+      required: false,
+      value: '1',
+      description:
+        'The ID of the stage this deal will be added to. If omitted, the deal will be placed in the first stage of the default pipeline.',
+      options: [
+        {
+          label: 'Qualified (Pipeline)',
+          value: 1,
+        },
+        {
+          label: 'Contact Made (Pipeline)',
+          value: 2,
+        },
+        {
+          label: 'Prospect Qualified (Pipeline)',
+          value: 3,
+        },
+        {
+          label: 'Needs Defined (Pipeline)',
+          value: 4,
+        },
+        {
+          label: 'Proposal Made (Pipeline)',
+          value: 5,
+        },
+        {
+          label: 'Negotiations Started (Pipeline)',
+          value: 6,
+        },
+      ],
+    },
+    {
+      label: 'Owner',
+      key: 'userId',
+      type: 'dropdown' as const,
+      required: false,
+      description:
+        'Select user who will be marked as the owner of this deal. If omitted, the authorized user will be used.',
+      variables: true,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listUsers',
+          },
+        ],
+      },
+    },
+    {
+      label: 'Organization',
+      key: 'organizationId',
+      type: 'dropdown' as const,
+      required: false,
+      description: 'Organization this deal will be associated with.',
+      variables: true,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listOrganizations',
+          },
+        ],
+      },
+    },
+    {
+      label: 'Person',
+      key: 'personId',
+      type: 'dropdown' as const,
+      required: false,
+      description: 'Person this deal will be associated with.',
+      variables: true,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listPersons',
+          },
+        ],
+      },
+    },
+    {
+      label: 'Probability',
+      key: 'probability',
+      type: 'string' as const,
+      required: false,
+      description:
+        'The success probability percentage of the deal. Used/shown only when deal_probability for the pipeline of the deal is enabled.',
+      variables: true,
+    },
+    {
+      label: 'Expected Close Date',
+      key: 'expectedCloseDate',
+      type: 'string' as const,
+      required: false,
+      description:
+        'The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD.',
+      variables: true,
+    },
+    {
+      label: 'Value',
+      key: 'value',
+      type: 'string' as const,
+      required: false,
+      description: 'The value of the deal. If omitted, value will be set to 0.',
+      variables: true,
+    },
+    {
+      label: 'Currency',
+      key: 'currency',
+      type: 'dropdown' as const,
+      required: false,
+      description:
+        'The currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.',
+      variables: true,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listCurrencies',
+          },
+        ],
+      },
+    },
+  ],
+
+  async run($) {
+    const {
+      title,
+      addTime,
+      status,
+      lostReason,
+      stageId,
+      userId,
+      organizationId,
+      personId,
+      probability,
+      expectedCloseDate,
+      value,
+      currency,
+    } = $.step.parameters;
+
+    const fields = {
+      title: title as string,
+      value: value as string,
+      add_time: addTime as string,
+      status: status as string,
+      lost_reason: lostReason as string,
+      stage_id: stageId as number,
+      user_id: userId as number,
+      org_id: organizationId as number,
+      person_id: personId as number,
+      probability: probability as number,
+      expected_close_date: expectedCloseDate as string,
+      currency: currency as string,
+    };
+
+    const body = filterProvidedFields(fields);
+
+    const {
+      data: { data },
+    } = await $.http.post(`${$.auth.data.apiDomain}/api/v1/deals`, body);
+
+    $.setActionItem({
+      raw: data,
+    });
+  },
+});