|
| 1 | +import pipedrive from "../../pipedrive.app.mjs"; |
| 2 | +import { ConfigurationError } from "@pipedream/platform"; |
| 3 | +import { parseObject } from "../../common/utils.mjs"; |
| 4 | + |
| 5 | +export default { |
| 6 | + key: "pipedrive-add-lead", |
| 7 | + name: "Add Lead", |
| 8 | + description: "Create a new lead in Pipedrive. [See the documentation](https://developers.pipedrive.com/docs/api/v1/Leads#addLead)", |
| 9 | + version: "0.0.1", |
| 10 | + type: "action", |
| 11 | + props: { |
| 12 | + pipedrive, |
| 13 | + title: { |
| 14 | + type: "string", |
| 15 | + label: "Title", |
| 16 | + description: "The name of the lead", |
| 17 | + }, |
| 18 | + personId: { |
| 19 | + propDefinition: [ |
| 20 | + pipedrive, |
| 21 | + "personId", |
| 22 | + ], |
| 23 | + description: "The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless organization_id is specified.", |
| 24 | + }, |
| 25 | + organizationId: { |
| 26 | + propDefinition: [ |
| 27 | + pipedrive, |
| 28 | + "organizationId", |
| 29 | + ], |
| 30 | + description: "The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless person_id is specified.", |
| 31 | + }, |
| 32 | + ownerId: { |
| 33 | + propDefinition: [ |
| 34 | + pipedrive, |
| 35 | + "userId", |
| 36 | + ], |
| 37 | + description: "The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used.", |
| 38 | + }, |
| 39 | + leadLabelIds: { |
| 40 | + propDefinition: [ |
| 41 | + pipedrive, |
| 42 | + "leadLabelIds", |
| 43 | + ], |
| 44 | + }, |
| 45 | + value: { |
| 46 | + type: "object", |
| 47 | + label: "Value", |
| 48 | + description: "Potential value of the lead, e.g. `{ \"amount\": 200, \"currency\": \"EUR\" }`", |
| 49 | + optional: true, |
| 50 | + }, |
| 51 | + expectedCloseDate: { |
| 52 | + type: "string", |
| 53 | + label: "Expected Close Date", |
| 54 | + description: "The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.", |
| 55 | + optional: true, |
| 56 | + }, |
| 57 | + visibleTo: { |
| 58 | + type: "string", |
| 59 | + label: "Visible To", |
| 60 | + description: "The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups [here](https://support.pipedrive.com/en/article/visibility-groups).", |
| 61 | + options: [ |
| 62 | + { |
| 63 | + label: "Essential / Advanced plan - Owner & followers, Professional / Enterprise plan - Owner only", |
| 64 | + value: "1", |
| 65 | + }, |
| 66 | + { |
| 67 | + label: "Essential / Advanced plan - Entire company, Professional / Enterprise plan - Owner's visibility group", |
| 68 | + value: "3", |
| 69 | + }, |
| 70 | + { |
| 71 | + label: "Professional / Enterprise plan - Owner's visibility group and sub-groups", |
| 72 | + value: "5", |
| 73 | + }, |
| 74 | + { |
| 75 | + label: "Professional / Enterprise plan - Entire company", |
| 76 | + value: "7", |
| 77 | + }, |
| 78 | + ], |
| 79 | + optional: true, |
| 80 | + }, |
| 81 | + wasSeen: { |
| 82 | + type: "boolean", |
| 83 | + label: "Was Seen", |
| 84 | + description: "A flag indicating whether the lead was seen by someone in the Pipedrive UI", |
| 85 | + optional: true, |
| 86 | + }, |
| 87 | + }, |
| 88 | + async run({ $ }) { |
| 89 | + if (!this.organizationId && !this.personId) { |
| 90 | + throw new ConfigurationError("Either organizationId or personId is required"); |
| 91 | + } |
| 92 | + |
| 93 | + const response = await this.pipedrive.addLead({ |
| 94 | + title: this.title, |
| 95 | + person_id: this.personId, |
| 96 | + organization_id: this.organizationId, |
| 97 | + owner_id: this.ownerId, |
| 98 | + label_ids: this.leadLabelIds, |
| 99 | + value: parseObject(this.value), |
| 100 | + expected_close_date: this.expectedCloseDate, |
| 101 | + visible_to: this.visibleTo, |
| 102 | + was_seen: this.wasSeen, |
| 103 | + }); |
| 104 | + $.export("$summary", `Successfully created lead: ${response.data?.title || response.data?.id}`); |
| 105 | + return response; |
| 106 | + }, |
| 107 | +}; |
0 commit comments