@rapidmx/crm-plugin 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +382 -0
- package/README.md +210 -0
- package/apps/admin-crm/_layout.tsx +46 -0
- package/apps/admin-crm/index.tsx +16 -0
- package/apps/crm/_layout.tsx +46 -0
- package/apps/crm/automations/[uid].tsx +16 -0
- package/apps/crm/automations/index.tsx +16 -0
- package/apps/crm/campaigns/[uid].tsx +16 -0
- package/apps/crm/campaigns/index.tsx +16 -0
- package/apps/crm/companies/[uid].tsx +16 -0
- package/apps/crm/companies/index.tsx +16 -0
- package/apps/crm/contacts/[uid].tsx +16 -0
- package/apps/crm/deals/[uid].tsx +16 -0
- package/apps/crm/deals/index.tsx +16 -0
- package/apps/crm/forms/index.tsx +16 -0
- package/apps/crm/imports/index.tsx +16 -0
- package/apps/crm/index.tsx +16 -0
- package/apps/crm/integrations/index.tsx +16 -0
- package/apps/crm/lists/index.tsx +16 -0
- package/apps/crm/pipelines/index.tsx +16 -0
- package/apps/crm/reports/index.tsx +16 -0
- package/apps/crm/scoring/index.tsx +16 -0
- package/apps/crm/segments/index.tsx +16 -0
- package/apps/crm/settings/index.tsx +16 -0
- package/apps/crm/tasks/index.tsx +16 -0
- package/apps/crm/templates/[uid].tsx +16 -0
- package/apps/crm/templates/index.tsx +16 -0
- package/apps/f/[formUid].tsx +11 -0
- package/apps/f/_layout.tsx +33 -0
- package/apps/f/index.tsx +15 -0
- package/apps/shared/components/CrmShell.tsx +229 -0
- package/apps/shared/components/FilterBuilder.tsx +204 -0
- package/apps/shared/components/FormManager.tsx +326 -0
- package/apps/shared/components/ImportWizard.tsx +251 -0
- package/apps/shared/components/Integrations.tsx +401 -0
- package/apps/shared/components/ListManager.tsx +206 -0
- package/apps/shared/components/RecordDetail.tsx +444 -0
- package/apps/shared/components/RecordList.tsx +446 -0
- package/apps/shared/components/ScoringRules.tsx +262 -0
- package/apps/shared/components/SegmentManager.tsx +245 -0
- package/apps/shared/components/TaskList.tsx +140 -0
- package/apps/shared/components/TemplateList.tsx +170 -0
- package/apps/shared/components/WorkspaceSettings.tsx +503 -0
- package/apps/shared/components/admin/CrmAdmin.tsx +129 -0
- package/apps/shared/components/automations/AutomationEditor.tsx +530 -0
- package/apps/shared/components/automations/AutomationList.tsx +147 -0
- package/apps/shared/components/automations/StepInspector.tsx +403 -0
- package/apps/shared/components/automations/flowModel.ts +331 -0
- package/apps/shared/components/campaigns/CampaignEditor.tsx +471 -0
- package/apps/shared/components/campaigns/CampaignList.tsx +164 -0
- package/apps/shared/components/campaigns/CampaignPage.tsx +30 -0
- package/apps/shared/components/campaigns/CampaignReport.tsx +345 -0
- package/apps/shared/components/campaigns/campaignUi.tsx +33 -0
- package/apps/shared/components/deals/ContactDeals.tsx +40 -0
- package/apps/shared/components/deals/DealBoard.tsx +287 -0
- package/apps/shared/components/deals/DealDetail.tsx +363 -0
- package/apps/shared/components/deals/PipelineManager.tsx +207 -0
- package/apps/shared/components/deals/dealUi.ts +24 -0
- package/apps/shared/components/designer/BlockView.tsx +92 -0
- package/apps/shared/components/designer/Canvas.tsx +206 -0
- package/apps/shared/components/designer/Inspector.tsx +339 -0
- package/apps/shared/components/designer/LazyTextBlockEditor.tsx +68 -0
- package/apps/shared/components/designer/MergeTagPicker.tsx +31 -0
- package/apps/shared/components/designer/PreviewModal.tsx +119 -0
- package/apps/shared/components/designer/TemplateDesigner.tsx +408 -0
- package/apps/shared/components/designer/TestSendModal.tsx +75 -0
- package/apps/shared/components/designer/TextBlockEditor.tsx +122 -0
- package/apps/shared/components/designer/designModel.ts +276 -0
- package/apps/shared/components/public/PublicPages.tsx +343 -0
- package/apps/shared/components/public/honeypot.ts +7 -0
- package/apps/shared/components/reports/Charts.tsx +315 -0
- package/apps/shared/components/reports/Reports.tsx +198 -0
- package/apps/shared/crmApi.ts +1046 -0
- package/apps/shared/fields.ts +175 -0
- package/apps/shared/publicApi.ts +50 -0
- package/apps/subscriptions/[token].tsx +11 -0
- package/apps/subscriptions/_layout.tsx +33 -0
- package/apps/subscriptions/confirm/[token].tsx +11 -0
- package/apps/subscriptions/index.tsx +11 -0
- package/apps/subscriptions/unsubscribe/[token].tsx +11 -0
- package/dist/apps/admin-crm/_layout.d.ts +15 -0
- package/dist/apps/admin-crm/_layout.js +8 -0
- package/dist/apps/admin-crm/index.d.ts +4 -0
- package/dist/apps/admin-crm/index.js +7 -0
- package/dist/apps/crm/_layout.d.ts +15 -0
- package/dist/apps/crm/_layout.js +8 -0
- package/dist/apps/crm/automations/[uid].d.ts +8 -0
- package/dist/apps/crm/automations/[uid].js +7 -0
- package/dist/apps/crm/automations/index.d.ts +4 -0
- package/dist/apps/crm/automations/index.js +7 -0
- package/dist/apps/crm/campaigns/[uid].d.ts +8 -0
- package/dist/apps/crm/campaigns/[uid].js +7 -0
- package/dist/apps/crm/campaigns/index.d.ts +4 -0
- package/dist/apps/crm/campaigns/index.js +7 -0
- package/dist/apps/crm/companies/[uid].d.ts +8 -0
- package/dist/apps/crm/companies/[uid].js +7 -0
- package/dist/apps/crm/companies/index.d.ts +4 -0
- package/dist/apps/crm/companies/index.js +7 -0
- package/dist/apps/crm/contacts/[uid].d.ts +8 -0
- package/dist/apps/crm/contacts/[uid].js +7 -0
- package/dist/apps/crm/deals/[uid].d.ts +8 -0
- package/dist/apps/crm/deals/[uid].js +7 -0
- package/dist/apps/crm/deals/index.d.ts +4 -0
- package/dist/apps/crm/deals/index.js +7 -0
- package/dist/apps/crm/forms/index.d.ts +4 -0
- package/dist/apps/crm/forms/index.js +7 -0
- package/dist/apps/crm/imports/index.d.ts +4 -0
- package/dist/apps/crm/imports/index.js +7 -0
- package/dist/apps/crm/index.d.ts +4 -0
- package/dist/apps/crm/index.js +7 -0
- package/dist/apps/crm/integrations/index.d.ts +4 -0
- package/dist/apps/crm/integrations/index.js +7 -0
- package/dist/apps/crm/lists/index.d.ts +4 -0
- package/dist/apps/crm/lists/index.js +7 -0
- package/dist/apps/crm/pipelines/index.d.ts +4 -0
- package/dist/apps/crm/pipelines/index.js +7 -0
- package/dist/apps/crm/reports/index.d.ts +4 -0
- package/dist/apps/crm/reports/index.js +7 -0
- package/dist/apps/crm/scoring/index.d.ts +4 -0
- package/dist/apps/crm/scoring/index.js +7 -0
- package/dist/apps/crm/segments/index.d.ts +4 -0
- package/dist/apps/crm/segments/index.js +7 -0
- package/dist/apps/crm/settings/index.d.ts +4 -0
- package/dist/apps/crm/settings/index.js +7 -0
- package/dist/apps/crm/tasks/index.d.ts +4 -0
- package/dist/apps/crm/tasks/index.js +7 -0
- package/dist/apps/crm/templates/[uid].d.ts +8 -0
- package/dist/apps/crm/templates/[uid].js +7 -0
- package/dist/apps/crm/templates/index.d.ts +4 -0
- package/dist/apps/crm/templates/index.js +7 -0
- package/dist/apps/f/[formUid].d.ts +7 -0
- package/dist/apps/f/[formUid].js +6 -0
- package/dist/apps/f/_layout.d.ts +8 -0
- package/dist/apps/f/_layout.js +8 -0
- package/dist/apps/f/index.d.ts +3 -0
- package/dist/apps/f/index.js +6 -0
- package/dist/apps/shared/components/CrmShell.d.ts +39 -0
- package/dist/apps/shared/components/CrmShell.js +127 -0
- package/dist/apps/shared/components/FilterBuilder.d.ts +34 -0
- package/dist/apps/shared/components/FilterBuilder.js +101 -0
- package/dist/apps/shared/components/FormManager.d.ts +7 -0
- package/dist/apps/shared/components/FormManager.js +132 -0
- package/dist/apps/shared/components/ImportWizard.d.ts +8 -0
- package/dist/apps/shared/components/ImportWizard.js +105 -0
- package/dist/apps/shared/components/Integrations.d.ts +13 -0
- package/dist/apps/shared/components/Integrations.js +164 -0
- package/dist/apps/shared/components/ListManager.d.ts +6 -0
- package/dist/apps/shared/components/ListManager.js +95 -0
- package/dist/apps/shared/components/RecordDetail.d.ts +30 -0
- package/dist/apps/shared/components/RecordDetail.js +244 -0
- package/dist/apps/shared/components/RecordList.d.ts +13 -0
- package/dist/apps/shared/components/RecordList.js +214 -0
- package/dist/apps/shared/components/ScoringRules.d.ts +13 -0
- package/dist/apps/shared/components/ScoringRules.js +128 -0
- package/dist/apps/shared/components/SegmentManager.d.ts +10 -0
- package/dist/apps/shared/components/SegmentManager.js +119 -0
- package/dist/apps/shared/components/TaskList.d.ts +3 -0
- package/dist/apps/shared/components/TaskList.js +62 -0
- package/dist/apps/shared/components/TemplateList.d.ts +3 -0
- package/dist/apps/shared/components/TemplateList.js +81 -0
- package/dist/apps/shared/components/WorkspaceSettings.d.ts +6 -0
- package/dist/apps/shared/components/WorkspaceSettings.js +239 -0
- package/dist/apps/shared/components/admin/CrmAdmin.d.ts +9 -0
- package/dist/apps/shared/components/admin/CrmAdmin.js +56 -0
- package/dist/apps/shared/components/automations/AutomationEditor.d.ts +15 -0
- package/dist/apps/shared/components/automations/AutomationEditor.js +219 -0
- package/dist/apps/shared/components/automations/AutomationList.d.ts +3 -0
- package/dist/apps/shared/components/automations/AutomationList.js +65 -0
- package/dist/apps/shared/components/automations/StepInspector.d.ts +40 -0
- package/dist/apps/shared/components/automations/StepInspector.js +177 -0
- package/dist/apps/shared/components/automations/flowModel.d.ts +67 -0
- package/dist/apps/shared/components/automations/flowModel.js +292 -0
- package/dist/apps/shared/components/campaigns/CampaignEditor.d.ts +11 -0
- package/dist/apps/shared/components/campaigns/CampaignEditor.js +163 -0
- package/dist/apps/shared/components/campaigns/CampaignList.d.ts +3 -0
- package/dist/apps/shared/components/campaigns/CampaignList.js +80 -0
- package/dist/apps/shared/components/campaigns/CampaignPage.d.ts +5 -0
- package/dist/apps/shared/components/campaigns/CampaignPage.js +24 -0
- package/dist/apps/shared/components/campaigns/CampaignReport.d.ts +13 -0
- package/dist/apps/shared/components/campaigns/CampaignReport.js +119 -0
- package/dist/apps/shared/components/campaigns/campaignUi.d.ts +10 -0
- package/dist/apps/shared/components/campaigns/campaignUi.js +24 -0
- package/dist/apps/shared/components/deals/ContactDeals.d.ts +5 -0
- package/dist/apps/shared/components/deals/ContactDeals.js +18 -0
- package/dist/apps/shared/components/deals/DealBoard.d.ts +7 -0
- package/dist/apps/shared/components/deals/DealBoard.js +134 -0
- package/dist/apps/shared/components/deals/DealDetail.d.ts +8 -0
- package/dist/apps/shared/components/deals/DealDetail.js +148 -0
- package/dist/apps/shared/components/deals/PipelineManager.d.ts +7 -0
- package/dist/apps/shared/components/deals/PipelineManager.js +62 -0
- package/dist/apps/shared/components/deals/dealUi.d.ts +7 -0
- package/dist/apps/shared/components/deals/dealUi.js +17 -0
- package/dist/apps/shared/components/designer/BlockView.d.ts +10 -0
- package/dist/apps/shared/components/designer/BlockView.js +37 -0
- package/dist/apps/shared/components/designer/Canvas.d.ts +31 -0
- package/dist/apps/shared/components/designer/Canvas.js +71 -0
- package/dist/apps/shared/components/designer/Inspector.d.ts +27 -0
- package/dist/apps/shared/components/designer/Inspector.js +102 -0
- package/dist/apps/shared/components/designer/LazyTextBlockEditor.d.ts +7 -0
- package/dist/apps/shared/components/designer/LazyTextBlockEditor.js +42 -0
- package/dist/apps/shared/components/designer/MergeTagPicker.d.ts +11 -0
- package/dist/apps/shared/components/designer/MergeTagPicker.js +15 -0
- package/dist/apps/shared/components/designer/PreviewModal.d.ts +15 -0
- package/dist/apps/shared/components/designer/PreviewModal.js +50 -0
- package/dist/apps/shared/components/designer/TemplateDesigner.d.ts +10 -0
- package/dist/apps/shared/components/designer/TemplateDesigner.js +194 -0
- package/dist/apps/shared/components/designer/TestSendModal.d.ts +11 -0
- package/dist/apps/shared/components/designer/TestSendModal.js +35 -0
- package/dist/apps/shared/components/designer/TextBlockEditor.d.ts +16 -0
- package/dist/apps/shared/components/designer/TextBlockEditor.js +81 -0
- package/dist/apps/shared/components/designer/designModel.d.ts +86 -0
- package/dist/apps/shared/components/designer/designModel.js +230 -0
- package/dist/apps/shared/components/public/PublicPages.d.ts +29 -0
- package/dist/apps/shared/components/public/PublicPages.js +155 -0
- package/dist/apps/shared/components/public/honeypot.d.ts +2 -0
- package/dist/apps/shared/components/public/honeypot.js +6 -0
- package/dist/apps/shared/components/reports/Charts.d.ts +32 -0
- package/dist/apps/shared/components/reports/Charts.js +121 -0
- package/dist/apps/shared/components/reports/Reports.d.ts +9 -0
- package/dist/apps/shared/components/reports/Reports.js +61 -0
- package/dist/apps/shared/crmApi.d.ts +909 -0
- package/dist/apps/shared/crmApi.js +240 -0
- package/dist/apps/shared/fields.d.ts +45 -0
- package/dist/apps/shared/fields.js +146 -0
- package/dist/apps/shared/publicApi.d.ts +48 -0
- package/dist/apps/shared/publicApi.js +17 -0
- package/dist/apps/subscriptions/[token].d.ts +7 -0
- package/dist/apps/subscriptions/[token].js +6 -0
- package/dist/apps/subscriptions/_layout.d.ts +8 -0
- package/dist/apps/subscriptions/_layout.js +8 -0
- package/dist/apps/subscriptions/confirm/[token].d.ts +7 -0
- package/dist/apps/subscriptions/confirm/[token].js +6 -0
- package/dist/apps/subscriptions/index.d.ts +3 -0
- package/dist/apps/subscriptions/index.js +6 -0
- package/dist/apps/subscriptions/unsubscribe/[token].d.ts +7 -0
- package/dist/apps/subscriptions/unsubscribe/[token].js +6 -0
- package/dist/lib/automation/Dates.js +85 -0
- package/dist/lib/automation/Dates.js.map +1 -0
- package/dist/lib/automation/Engine.js +384 -0
- package/dist/lib/automation/Engine.js.map +1 -0
- package/dist/lib/automation/Events.js +46 -0
- package/dist/lib/automation/Events.js.map +1 -0
- package/dist/lib/automation/Graph.js +296 -0
- package/dist/lib/automation/Graph.js.map +1 -0
- package/dist/lib/filters/Filter.js +343 -0
- package/dist/lib/filters/Filter.js.map +1 -0
- package/dist/lib/filters/fields.js +71 -0
- package/dist/lib/filters/fields.js.map +1 -0
- package/dist/lib/index.js +86 -0
- package/dist/lib/index.js.map +1 -0
- package/dist/lib/jobs/AutomationRunJob.js +110 -0
- package/dist/lib/jobs/AutomationRunJob.js.map +1 -0
- package/dist/lib/jobs/AutomationTriggerJob.js +126 -0
- package/dist/lib/jobs/AutomationTriggerJob.js.map +1 -0
- package/dist/lib/jobs/CampaignJob.js +285 -0
- package/dist/lib/jobs/CampaignJob.js.map +1 -0
- package/dist/lib/jobs/CrmImportJob.js +218 -0
- package/dist/lib/jobs/CrmImportJob.js.map +1 -0
- package/dist/lib/jobs/CrmJobBase.js +75 -0
- package/dist/lib/jobs/CrmJobBase.js.map +1 -0
- package/dist/lib/jobs/CrmMailEventJob.js +232 -0
- package/dist/lib/jobs/CrmMailEventJob.js.map +1 -0
- package/dist/lib/jobs/DateTriggerJob.js +155 -0
- package/dist/lib/jobs/DateTriggerJob.js.map +1 -0
- package/dist/lib/jobs/ScoringJob.js +75 -0
- package/dist/lib/jobs/ScoringJob.js.map +1 -0
- package/dist/lib/jobs/SegmentRefreshJob.js +84 -0
- package/dist/lib/jobs/SegmentRefreshJob.js.map +1 -0
- package/dist/lib/jobs/SendDispatchJob.js +277 -0
- package/dist/lib/jobs/SendDispatchJob.js.map +1 -0
- package/dist/lib/jobs/TaskReminderJob.js +70 -0
- package/dist/lib/jobs/TaskReminderJob.js.map +1 -0
- package/dist/lib/jobs/WebhookDeliveryJob.js +126 -0
- package/dist/lib/jobs/WebhookDeliveryJob.js.map +1 -0
- package/dist/lib/jobs/mongo/AutomationRunJobMongo.js +12 -0
- package/dist/lib/jobs/mongo/AutomationRunJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/AutomationTriggerJobMongo.js +10 -0
- package/dist/lib/jobs/mongo/AutomationTriggerJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/CampaignJobMongo.js +10 -0
- package/dist/lib/jobs/mongo/CampaignJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/CrmImportJobMongo.js +14 -0
- package/dist/lib/jobs/mongo/CrmImportJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/CrmMailEventJobMongo.js +10 -0
- package/dist/lib/jobs/mongo/CrmMailEventJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/DateTriggerJobMongo.js +10 -0
- package/dist/lib/jobs/mongo/DateTriggerJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/ScoringJobMongo.js +10 -0
- package/dist/lib/jobs/mongo/ScoringJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/SegmentRefreshJobMongo.js +10 -0
- package/dist/lib/jobs/mongo/SegmentRefreshJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/SendDispatchJobMongo.js +10 -0
- package/dist/lib/jobs/mongo/SendDispatchJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/TaskReminderJobMongo.js +10 -0
- package/dist/lib/jobs/mongo/TaskReminderJobMongo.js.map +1 -0
- package/dist/lib/jobs/mongo/WebhookDeliveryJobMongo.js +10 -0
- package/dist/lib/jobs/mongo/WebhookDeliveryJobMongo.js.map +1 -0
- package/dist/lib/jobs/sql/AutomationRunJobSQL.js +12 -0
- package/dist/lib/jobs/sql/AutomationRunJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/AutomationTriggerJobSQL.js +10 -0
- package/dist/lib/jobs/sql/AutomationTriggerJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/CampaignJobSQL.js +10 -0
- package/dist/lib/jobs/sql/CampaignJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/CrmImportJobSQL.js +14 -0
- package/dist/lib/jobs/sql/CrmImportJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/CrmMailEventJobSQL.js +10 -0
- package/dist/lib/jobs/sql/CrmMailEventJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/DateTriggerJobSQL.js +10 -0
- package/dist/lib/jobs/sql/DateTriggerJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/ScoringJobSQL.js +10 -0
- package/dist/lib/jobs/sql/ScoringJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/SegmentRefreshJobSQL.js +10 -0
- package/dist/lib/jobs/sql/SegmentRefreshJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/SendDispatchJobSQL.js +10 -0
- package/dist/lib/jobs/sql/SendDispatchJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/TaskReminderJobSQL.js +10 -0
- package/dist/lib/jobs/sql/TaskReminderJobSQL.js.map +1 -0
- package/dist/lib/jobs/sql/WebhookDeliveryJobSQL.js +10 -0
- package/dist/lib/jobs/sql/WebhookDeliveryJobSQL.js.map +1 -0
- package/dist/lib/models/CrmModelClasses.js +44 -0
- package/dist/lib/models/CrmModelClasses.js.map +1 -0
- package/dist/lib/models/mongo/ApiKeyMongo.js +105 -0
- package/dist/lib/models/mongo/ApiKeyMongo.js.map +1 -0
- package/dist/lib/models/mongo/AutomationMongo.js +126 -0
- package/dist/lib/models/mongo/AutomationMongo.js.map +1 -0
- package/dist/lib/models/mongo/AutomationVersionMongo.js +82 -0
- package/dist/lib/models/mongo/AutomationVersionMongo.js.map +1 -0
- package/dist/lib/models/mongo/CampaignMongo.js +211 -0
- package/dist/lib/models/mongo/CampaignMongo.js.map +1 -0
- package/dist/lib/models/mongo/CrmCompanyMongo.js +126 -0
- package/dist/lib/models/mongo/CrmCompanyMongo.js.map +1 -0
- package/dist/lib/models/mongo/CrmContactMongo.js +156 -0
- package/dist/lib/models/mongo/CrmContactMongo.js.map +1 -0
- package/dist/lib/models/mongo/CrmEventMongo.js +92 -0
- package/dist/lib/models/mongo/CrmEventMongo.js.map +1 -0
- package/dist/lib/models/mongo/CrmFormMongo.js +139 -0
- package/dist/lib/models/mongo/CrmFormMongo.js.map +1 -0
- package/dist/lib/models/mongo/CrmImportMongo.js +190 -0
- package/dist/lib/models/mongo/CrmImportMongo.js.map +1 -0
- package/dist/lib/models/mongo/CrmNoteMongo.js +89 -0
- package/dist/lib/models/mongo/CrmNoteMongo.js.map +1 -0
- package/dist/lib/models/mongo/CrmSettingMongo.js +60 -0
- package/dist/lib/models/mongo/CrmSettingMongo.js.map +1 -0
- package/dist/lib/models/mongo/CrmTaskMongo.js +136 -0
- package/dist/lib/models/mongo/CrmTaskMongo.js.map +1 -0
- package/dist/lib/models/mongo/DealMongo.js +163 -0
- package/dist/lib/models/mongo/DealMongo.js.map +1 -0
- package/dist/lib/models/mongo/EmailTemplateMongo.js +90 -0
- package/dist/lib/models/mongo/EmailTemplateMongo.js.map +1 -0
- package/dist/lib/models/mongo/EngagementEventMongo.js +113 -0
- package/dist/lib/models/mongo/EngagementEventMongo.js.map +1 -0
- package/dist/lib/models/mongo/EnrollmentMongo.js +150 -0
- package/dist/lib/models/mongo/EnrollmentMongo.js.map +1 -0
- package/dist/lib/models/mongo/MailingListMongo.js +104 -0
- package/dist/lib/models/mongo/MailingListMongo.js.map +1 -0
- package/dist/lib/models/mongo/OutboundSendMongo.js +265 -0
- package/dist/lib/models/mongo/OutboundSendMongo.js.map +1 -0
- package/dist/lib/models/mongo/PipelineMongo.js +74 -0
- package/dist/lib/models/mongo/PipelineMongo.js.map +1 -0
- package/dist/lib/models/mongo/PropertyDefinitionMongo.js +105 -0
- package/dist/lib/models/mongo/PropertyDefinitionMongo.js.map +1 -0
- package/dist/lib/models/mongo/PropertyValueMongo.js +101 -0
- package/dist/lib/models/mongo/PropertyValueMongo.js.map +1 -0
- package/dist/lib/models/mongo/SavedBlockMongo.js +67 -0
- package/dist/lib/models/mongo/SavedBlockMongo.js.map +1 -0
- package/dist/lib/models/mongo/ScoringRuleMongo.js +112 -0
- package/dist/lib/models/mongo/ScoringRuleMongo.js.map +1 -0
- package/dist/lib/models/mongo/SegmentMongo.js +113 -0
- package/dist/lib/models/mongo/SegmentMongo.js.map +1 -0
- package/dist/lib/models/mongo/SubscriptionMongo.js +114 -0
- package/dist/lib/models/mongo/SubscriptionMongo.js.map +1 -0
- package/dist/lib/models/mongo/SuppressionMongo.js +77 -0
- package/dist/lib/models/mongo/SuppressionMongo.js.map +1 -0
- package/dist/lib/models/mongo/TimelineEventMongo.js +112 -0
- package/dist/lib/models/mongo/TimelineEventMongo.js.map +1 -0
- package/dist/lib/models/mongo/WebhookDeliveryMongo.js +128 -0
- package/dist/lib/models/mongo/WebhookDeliveryMongo.js.map +1 -0
- package/dist/lib/models/mongo/WebhookEndpointMongo.js +118 -0
- package/dist/lib/models/mongo/WebhookEndpointMongo.js.map +1 -0
- package/dist/lib/models/mongo/WorkspaceMemberMongo.js +92 -0
- package/dist/lib/models/mongo/WorkspaceMemberMongo.js.map +1 -0
- package/dist/lib/models/mongo/WorkspaceMongo.js +117 -0
- package/dist/lib/models/mongo/WorkspaceMongo.js.map +1 -0
- package/dist/lib/models/mongo/WorkspaceSenderMongo.js +100 -0
- package/dist/lib/models/mongo/WorkspaceSenderMongo.js.map +1 -0
- package/dist/lib/models/mongo/index.js +74 -0
- package/dist/lib/models/mongo/index.js.map +1 -0
- package/dist/lib/models/sql/ApiKeySQL.js +105 -0
- package/dist/lib/models/sql/ApiKeySQL.js.map +1 -0
- package/dist/lib/models/sql/AutomationSQL.js +126 -0
- package/dist/lib/models/sql/AutomationSQL.js.map +1 -0
- package/dist/lib/models/sql/AutomationVersionSQL.js +82 -0
- package/dist/lib/models/sql/AutomationVersionSQL.js.map +1 -0
- package/dist/lib/models/sql/CampaignSQL.js +211 -0
- package/dist/lib/models/sql/CampaignSQL.js.map +1 -0
- package/dist/lib/models/sql/CrmCompanySQL.js +126 -0
- package/dist/lib/models/sql/CrmCompanySQL.js.map +1 -0
- package/dist/lib/models/sql/CrmContactSQL.js +156 -0
- package/dist/lib/models/sql/CrmContactSQL.js.map +1 -0
- package/dist/lib/models/sql/CrmEventSQL.js +92 -0
- package/dist/lib/models/sql/CrmEventSQL.js.map +1 -0
- package/dist/lib/models/sql/CrmFormSQL.js +139 -0
- package/dist/lib/models/sql/CrmFormSQL.js.map +1 -0
- package/dist/lib/models/sql/CrmImportSQL.js +190 -0
- package/dist/lib/models/sql/CrmImportSQL.js.map +1 -0
- package/dist/lib/models/sql/CrmNoteSQL.js +89 -0
- package/dist/lib/models/sql/CrmNoteSQL.js.map +1 -0
- package/dist/lib/models/sql/CrmSettingSQL.js +60 -0
- package/dist/lib/models/sql/CrmSettingSQL.js.map +1 -0
- package/dist/lib/models/sql/CrmTaskSQL.js +136 -0
- package/dist/lib/models/sql/CrmTaskSQL.js.map +1 -0
- package/dist/lib/models/sql/DealSQL.js +163 -0
- package/dist/lib/models/sql/DealSQL.js.map +1 -0
- package/dist/lib/models/sql/EmailTemplateSQL.js +90 -0
- package/dist/lib/models/sql/EmailTemplateSQL.js.map +1 -0
- package/dist/lib/models/sql/EngagementEventSQL.js +113 -0
- package/dist/lib/models/sql/EngagementEventSQL.js.map +1 -0
- package/dist/lib/models/sql/EnrollmentSQL.js +150 -0
- package/dist/lib/models/sql/EnrollmentSQL.js.map +1 -0
- package/dist/lib/models/sql/MailingListSQL.js +104 -0
- package/dist/lib/models/sql/MailingListSQL.js.map +1 -0
- package/dist/lib/models/sql/OutboundSendSQL.js +265 -0
- package/dist/lib/models/sql/OutboundSendSQL.js.map +1 -0
- package/dist/lib/models/sql/PipelineSQL.js +74 -0
- package/dist/lib/models/sql/PipelineSQL.js.map +1 -0
- package/dist/lib/models/sql/PropertyDefinitionSQL.js +105 -0
- package/dist/lib/models/sql/PropertyDefinitionSQL.js.map +1 -0
- package/dist/lib/models/sql/PropertyValueSQL.js +101 -0
- package/dist/lib/models/sql/PropertyValueSQL.js.map +1 -0
- package/dist/lib/models/sql/SavedBlockSQL.js +67 -0
- package/dist/lib/models/sql/SavedBlockSQL.js.map +1 -0
- package/dist/lib/models/sql/ScoringRuleSQL.js +112 -0
- package/dist/lib/models/sql/ScoringRuleSQL.js.map +1 -0
- package/dist/lib/models/sql/SegmentSQL.js +113 -0
- package/dist/lib/models/sql/SegmentSQL.js.map +1 -0
- package/dist/lib/models/sql/SubscriptionSQL.js +114 -0
- package/dist/lib/models/sql/SubscriptionSQL.js.map +1 -0
- package/dist/lib/models/sql/SuppressionSQL.js +77 -0
- package/dist/lib/models/sql/SuppressionSQL.js.map +1 -0
- package/dist/lib/models/sql/TimelineEventSQL.js +112 -0
- package/dist/lib/models/sql/TimelineEventSQL.js.map +1 -0
- package/dist/lib/models/sql/WebhookDeliverySQL.js +128 -0
- package/dist/lib/models/sql/WebhookDeliverySQL.js.map +1 -0
- package/dist/lib/models/sql/WebhookEndpointSQL.js +118 -0
- package/dist/lib/models/sql/WebhookEndpointSQL.js.map +1 -0
- package/dist/lib/models/sql/WorkspaceMemberSQL.js +92 -0
- package/dist/lib/models/sql/WorkspaceMemberSQL.js.map +1 -0
- package/dist/lib/models/sql/WorkspaceSQL.js +117 -0
- package/dist/lib/models/sql/WorkspaceSQL.js.map +1 -0
- package/dist/lib/models/sql/WorkspaceSenderSQL.js +100 -0
- package/dist/lib/models/sql/WorkspaceSenderSQL.js.map +1 -0
- package/dist/lib/models/sql/index.js +74 -0
- package/dist/lib/models/sql/index.js.map +1 -0
- package/dist/lib/models/types.js +275 -0
- package/dist/lib/models/types.js.map +1 -0
- package/dist/lib/mongo.js +80 -0
- package/dist/lib/mongo.js.map +1 -0
- package/dist/lib/purge.js +68 -0
- package/dist/lib/purge.js.map +1 -0
- package/dist/lib/routes/BaseAnalyticsRoute.js +217 -0
- package/dist/lib/routes/BaseAnalyticsRoute.js.map +1 -0
- package/dist/lib/routes/BaseApiKeyRoute.js +76 -0
- package/dist/lib/routes/BaseApiKeyRoute.js.map +1 -0
- package/dist/lib/routes/BaseAutomationRoute.js +316 -0
- package/dist/lib/routes/BaseAutomationRoute.js.map +1 -0
- package/dist/lib/routes/BaseCampaignRoute.js +443 -0
- package/dist/lib/routes/BaseCampaignRoute.js.map +1 -0
- package/dist/lib/routes/BaseCompanyRoute.js +106 -0
- package/dist/lib/routes/BaseCompanyRoute.js.map +1 -0
- package/dist/lib/routes/BaseContactRoute.js +162 -0
- package/dist/lib/routes/BaseContactRoute.js.map +1 -0
- package/dist/lib/routes/BaseCrmAdminRoute.js +108 -0
- package/dist/lib/routes/BaseCrmAdminRoute.js.map +1 -0
- package/dist/lib/routes/BaseDealRoute.js +312 -0
- package/dist/lib/routes/BaseDealRoute.js.map +1 -0
- package/dist/lib/routes/BaseFormRoute.js +124 -0
- package/dist/lib/routes/BaseFormRoute.js.map +1 -0
- package/dist/lib/routes/BaseImportRoute.js +231 -0
- package/dist/lib/routes/BaseImportRoute.js.map +1 -0
- package/dist/lib/routes/BaseIntegrationRoute.js +181 -0
- package/dist/lib/routes/BaseIntegrationRoute.js.map +1 -0
- package/dist/lib/routes/BaseListRoute.js +89 -0
- package/dist/lib/routes/BaseListRoute.js.map +1 -0
- package/dist/lib/routes/BaseNoteRoute.js +69 -0
- package/dist/lib/routes/BaseNoteRoute.js.map +1 -0
- package/dist/lib/routes/BasePipelineRoute.js +149 -0
- package/dist/lib/routes/BasePipelineRoute.js.map +1 -0
- package/dist/lib/routes/BasePropertyDefinitionRoute.js +140 -0
- package/dist/lib/routes/BasePropertyDefinitionRoute.js.map +1 -0
- package/dist/lib/routes/BasePublicRoute.js +528 -0
- package/dist/lib/routes/BasePublicRoute.js.map +1 -0
- package/dist/lib/routes/BaseSavedBlockRoute.js +39 -0
- package/dist/lib/routes/BaseSavedBlockRoute.js.map +1 -0
- package/dist/lib/routes/BaseScoringRuleRoute.js +146 -0
- package/dist/lib/routes/BaseScoringRuleRoute.js.map +1 -0
- package/dist/lib/routes/BaseSegmentRoute.js +136 -0
- package/dist/lib/routes/BaseSegmentRoute.js.map +1 -0
- package/dist/lib/routes/BaseSubscriptionRoute.js +92 -0
- package/dist/lib/routes/BaseSubscriptionRoute.js.map +1 -0
- package/dist/lib/routes/BaseSuppressionRoute.js +48 -0
- package/dist/lib/routes/BaseSuppressionRoute.js.map +1 -0
- package/dist/lib/routes/BaseTaggedRecordRoute.js +312 -0
- package/dist/lib/routes/BaseTaggedRecordRoute.js.map +1 -0
- package/dist/lib/routes/BaseTaskRoute.js +116 -0
- package/dist/lib/routes/BaseTaskRoute.js.map +1 -0
- package/dist/lib/routes/BaseTemplateRoute.js +207 -0
- package/dist/lib/routes/BaseTemplateRoute.js.map +1 -0
- package/dist/lib/routes/BaseTimelineRoute.js +47 -0
- package/dist/lib/routes/BaseTimelineRoute.js.map +1 -0
- package/dist/lib/routes/BaseTrackingRoute.js +106 -0
- package/dist/lib/routes/BaseTrackingRoute.js.map +1 -0
- package/dist/lib/routes/BaseWebhookRoute.js +173 -0
- package/dist/lib/routes/BaseWebhookRoute.js.map +1 -0
- package/dist/lib/routes/BaseWorkspaceRecordRoute.js +220 -0
- package/dist/lib/routes/BaseWorkspaceRecordRoute.js.map +1 -0
- package/dist/lib/routes/BaseWorkspaceRoute.js +540 -0
- package/dist/lib/routes/BaseWorkspaceRoute.js.map +1 -0
- package/dist/lib/routes/CrmRouteBase.js +261 -0
- package/dist/lib/routes/CrmRouteBase.js.map +1 -0
- package/dist/lib/routes/mongo/AnalyticsRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/AnalyticsRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/ApiKeyRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/ApiKeyRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/AutomationRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/AutomationRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/CampaignRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/CampaignRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/CompanyRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/CompanyRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/ContactRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/ContactRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/CrmAdminRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/CrmAdminRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/DealRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/DealRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/FormRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/FormRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/ImportRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/ImportRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/IntegrationRouteMongo.js +28 -0
- package/dist/lib/routes/mongo/IntegrationRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/ListRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/ListRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/NoteRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/NoteRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/PipelineRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/PipelineRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/PropertyDefinitionRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/PropertyDefinitionRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/PublicRouteMongo.js +28 -0
- package/dist/lib/routes/mongo/PublicRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/SavedBlockRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/SavedBlockRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/ScoringRuleRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/ScoringRuleRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/SegmentRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/SegmentRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/SubscriptionRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/SubscriptionRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/SuppressionRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/SuppressionRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/TaskRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/TaskRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/TemplateRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/TemplateRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/TimelineRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/TimelineRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/TrackingRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/TrackingRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/WebhookRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/WebhookRouteMongo.js.map +1 -0
- package/dist/lib/routes/mongo/WorkspaceRouteMongo.js +26 -0
- package/dist/lib/routes/mongo/WorkspaceRouteMongo.js.map +1 -0
- package/dist/lib/routes/sql/AnalyticsRouteSQL.js +26 -0
- package/dist/lib/routes/sql/AnalyticsRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/ApiKeyRouteSQL.js +26 -0
- package/dist/lib/routes/sql/ApiKeyRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/AutomationRouteSQL.js +26 -0
- package/dist/lib/routes/sql/AutomationRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/CampaignRouteSQL.js +26 -0
- package/dist/lib/routes/sql/CampaignRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/CompanyRouteSQL.js +26 -0
- package/dist/lib/routes/sql/CompanyRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/ContactRouteSQL.js +26 -0
- package/dist/lib/routes/sql/ContactRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/CrmAdminRouteSQL.js +26 -0
- package/dist/lib/routes/sql/CrmAdminRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/DealRouteSQL.js +26 -0
- package/dist/lib/routes/sql/DealRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/FormRouteSQL.js +26 -0
- package/dist/lib/routes/sql/FormRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/ImportRouteSQL.js +26 -0
- package/dist/lib/routes/sql/ImportRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/IntegrationRouteSQL.js +28 -0
- package/dist/lib/routes/sql/IntegrationRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/ListRouteSQL.js +26 -0
- package/dist/lib/routes/sql/ListRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/NoteRouteSQL.js +26 -0
- package/dist/lib/routes/sql/NoteRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/PipelineRouteSQL.js +26 -0
- package/dist/lib/routes/sql/PipelineRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/PropertyDefinitionRouteSQL.js +26 -0
- package/dist/lib/routes/sql/PropertyDefinitionRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/PublicRouteSQL.js +28 -0
- package/dist/lib/routes/sql/PublicRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/SavedBlockRouteSQL.js +26 -0
- package/dist/lib/routes/sql/SavedBlockRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/ScoringRuleRouteSQL.js +26 -0
- package/dist/lib/routes/sql/ScoringRuleRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/SegmentRouteSQL.js +26 -0
- package/dist/lib/routes/sql/SegmentRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/SubscriptionRouteSQL.js +26 -0
- package/dist/lib/routes/sql/SubscriptionRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/SuppressionRouteSQL.js +26 -0
- package/dist/lib/routes/sql/SuppressionRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/TaskRouteSQL.js +26 -0
- package/dist/lib/routes/sql/TaskRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/TemplateRouteSQL.js +26 -0
- package/dist/lib/routes/sql/TemplateRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/TimelineRouteSQL.js +26 -0
- package/dist/lib/routes/sql/TimelineRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/TrackingRouteSQL.js +26 -0
- package/dist/lib/routes/sql/TrackingRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/WebhookRouteSQL.js +26 -0
- package/dist/lib/routes/sql/WebhookRouteSQL.js.map +1 -0
- package/dist/lib/routes/sql/WorkspaceRouteSQL.js +26 -0
- package/dist/lib/routes/sql/WorkspaceRouteSQL.js.map +1 -0
- package/dist/lib/scoring/Scoring.js +105 -0
- package/dist/lib/scoring/Scoring.js.map +1 -0
- package/dist/lib/segments/Segments.js +125 -0
- package/dist/lib/segments/Segments.js.map +1 -0
- package/dist/lib/sending/Audience.js +87 -0
- package/dist/lib/sending/Audience.js.map +1 -0
- package/dist/lib/sending/CampaignRenderer.js +123 -0
- package/dist/lib/sending/CampaignRenderer.js.map +1 -0
- package/dist/lib/sending/Engagement.js +216 -0
- package/dist/lib/sending/Engagement.js.map +1 -0
- package/dist/lib/sending/Stats.js +70 -0
- package/dist/lib/sending/Stats.js.map +1 -0
- package/dist/lib/sending/Tracking.js +98 -0
- package/dist/lib/sending/Tracking.js.map +1 -0
- package/dist/lib/sql.js +80 -0
- package/dist/lib/sql.js.map +1 -0
- package/dist/lib/templates/Design.js +278 -0
- package/dist/lib/templates/Design.js.map +1 -0
- package/dist/lib/templates/MergeContext.js +57 -0
- package/dist/lib/templates/MergeContext.js.map +1 -0
- package/dist/lib/templates/Render.js +147 -0
- package/dist/lib/templates/Render.js.map +1 -0
- package/dist/lib/templates/Sanitize.js +98 -0
- package/dist/lib/templates/Sanitize.js.map +1 -0
- package/dist/lib/util/Csv.js +128 -0
- package/dist/lib/util/Csv.js.map +1 -0
- package/dist/lib/util/ImportMapping.js +206 -0
- package/dist/lib/util/ImportMapping.js.map +1 -0
- package/dist/lib/util/Mailer.js +43 -0
- package/dist/lib/util/Mailer.js.map +1 -0
- package/dist/lib/util/PropertyValues.js +145 -0
- package/dist/lib/util/PropertyValues.js.map +1 -0
- package/dist/lib/util/Secrets.js +31 -0
- package/dist/lib/util/Secrets.js.map +1 -0
- package/dist/lib/util/Tokens.js +58 -0
- package/dist/lib/util/Tokens.js.map +1 -0
- package/dist/lib/util/Validation.js +194 -0
- package/dist/lib/util/Validation.js.map +1 -0
- package/dist/lib/util/WorkspaceAccess.js +55 -0
- package/dist/lib/util/WorkspaceAccess.js.map +1 -0
- package/dist/lib/webhooks/Deliveries.js +47 -0
- package/dist/lib/webhooks/Deliveries.js.map +1 -0
- package/dist/lib/webhooks/Webhooks.js +132 -0
- package/dist/lib/webhooks/Webhooks.js.map +1 -0
- package/dist/types/automation/Dates.d.ts +42 -0
- package/dist/types/automation/Engine.d.ts +63 -0
- package/dist/types/automation/Events.d.ts +43 -0
- package/dist/types/automation/Graph.d.ts +77 -0
- package/dist/types/filters/Filter.d.ts +83 -0
- package/dist/types/filters/fields.d.ts +9 -0
- package/dist/types/index.d.ts +81 -0
- package/dist/types/jobs/AutomationRunJob.d.ts +18 -0
- package/dist/types/jobs/AutomationTriggerJob.d.ts +23 -0
- package/dist/types/jobs/CampaignJob.d.ts +45 -0
- package/dist/types/jobs/CrmImportJob.d.ts +44 -0
- package/dist/types/jobs/CrmJobBase.d.ts +26 -0
- package/dist/types/jobs/CrmMailEventJob.d.ts +102 -0
- package/dist/types/jobs/DateTriggerJob.d.ts +21 -0
- package/dist/types/jobs/ScoringJob.d.ts +13 -0
- package/dist/types/jobs/SegmentRefreshJob.d.ts +16 -0
- package/dist/types/jobs/SendDispatchJob.d.ts +52 -0
- package/dist/types/jobs/TaskReminderJob.d.ts +12 -0
- package/dist/types/jobs/WebhookDeliveryJob.d.ts +22 -0
- package/dist/types/jobs/mongo/AutomationRunJobMongo.d.ts +7 -0
- package/dist/types/jobs/mongo/AutomationTriggerJobMongo.d.ts +6 -0
- package/dist/types/jobs/mongo/CampaignJobMongo.d.ts +6 -0
- package/dist/types/jobs/mongo/CrmImportJobMongo.d.ts +8 -0
- package/dist/types/jobs/mongo/CrmMailEventJobMongo.d.ts +6 -0
- package/dist/types/jobs/mongo/DateTriggerJobMongo.d.ts +6 -0
- package/dist/types/jobs/mongo/ScoringJobMongo.d.ts +6 -0
- package/dist/types/jobs/mongo/SegmentRefreshJobMongo.d.ts +6 -0
- package/dist/types/jobs/mongo/SendDispatchJobMongo.d.ts +6 -0
- package/dist/types/jobs/mongo/TaskReminderJobMongo.d.ts +6 -0
- package/dist/types/jobs/mongo/WebhookDeliveryJobMongo.d.ts +6 -0
- package/dist/types/jobs/sql/AutomationRunJobSQL.d.ts +7 -0
- package/dist/types/jobs/sql/AutomationTriggerJobSQL.d.ts +6 -0
- package/dist/types/jobs/sql/CampaignJobSQL.d.ts +6 -0
- package/dist/types/jobs/sql/CrmImportJobSQL.d.ts +8 -0
- package/dist/types/jobs/sql/CrmMailEventJobSQL.d.ts +6 -0
- package/dist/types/jobs/sql/DateTriggerJobSQL.d.ts +6 -0
- package/dist/types/jobs/sql/ScoringJobSQL.d.ts +6 -0
- package/dist/types/jobs/sql/SegmentRefreshJobSQL.d.ts +6 -0
- package/dist/types/jobs/sql/SendDispatchJobSQL.d.ts +6 -0
- package/dist/types/jobs/sql/TaskReminderJobSQL.d.ts +6 -0
- package/dist/types/jobs/sql/WebhookDeliveryJobSQL.d.ts +6 -0
- package/dist/types/models/CrmModelClasses.d.ts +63 -0
- package/dist/types/models/mongo/ApiKeyMongo.d.ts +19 -0
- package/dist/types/models/mongo/AutomationMongo.d.ts +22 -0
- package/dist/types/models/mongo/AutomationVersionMongo.d.ts +16 -0
- package/dist/types/models/mongo/CampaignMongo.d.ts +34 -0
- package/dist/types/models/mongo/CrmCompanyMongo.d.ts +22 -0
- package/dist/types/models/mongo/CrmContactMongo.d.ts +26 -0
- package/dist/types/models/mongo/CrmEventMongo.d.ts +17 -0
- package/dist/types/models/mongo/CrmFormMongo.d.ts +24 -0
- package/dist/types/models/mongo/CrmImportMongo.d.ts +31 -0
- package/dist/types/models/mongo/CrmNoteMongo.d.ts +17 -0
- package/dist/types/models/mongo/CrmSettingMongo.d.ts +13 -0
- package/dist/types/models/mongo/CrmTaskMongo.d.ts +23 -0
- package/dist/types/models/mongo/DealMongo.d.ts +27 -0
- package/dist/types/models/mongo/EmailTemplateMongo.d.ts +17 -0
- package/dist/types/models/mongo/EngagementEventMongo.d.ts +20 -0
- package/dist/types/models/mongo/EnrollmentMongo.d.ts +25 -0
- package/dist/types/models/mongo/MailingListMongo.d.ts +19 -0
- package/dist/types/models/mongo/OutboundSendMongo.d.ts +41 -0
- package/dist/types/models/mongo/PipelineMongo.d.ts +15 -0
- package/dist/types/models/mongo/PropertyDefinitionMongo.d.ts +19 -0
- package/dist/types/models/mongo/PropertyValueMongo.d.ts +18 -0
- package/dist/types/models/mongo/SavedBlockMongo.d.ts +14 -0
- package/dist/types/models/mongo/ScoringRuleMongo.d.ts +20 -0
- package/dist/types/models/mongo/SegmentMongo.d.ts +20 -0
- package/dist/types/models/mongo/SubscriptionMongo.d.ts +20 -0
- package/dist/types/models/mongo/SuppressionMongo.d.ts +15 -0
- package/dist/types/models/mongo/TimelineEventMongo.d.ts +20 -0
- package/dist/types/models/mongo/WebhookDeliveryMongo.d.ts +22 -0
- package/dist/types/models/mongo/WebhookEndpointMongo.d.ts +21 -0
- package/dist/types/models/mongo/WorkspaceMemberMongo.d.ts +17 -0
- package/dist/types/models/mongo/WorkspaceMongo.d.ts +21 -0
- package/dist/types/models/mongo/WorkspaceSenderMongo.d.ts +18 -0
- package/dist/types/models/mongo/index.d.ts +3 -0
- package/dist/types/models/sql/ApiKeySQL.d.ts +19 -0
- package/dist/types/models/sql/AutomationSQL.d.ts +22 -0
- package/dist/types/models/sql/AutomationVersionSQL.d.ts +16 -0
- package/dist/types/models/sql/CampaignSQL.d.ts +34 -0
- package/dist/types/models/sql/CrmCompanySQL.d.ts +22 -0
- package/dist/types/models/sql/CrmContactSQL.d.ts +26 -0
- package/dist/types/models/sql/CrmEventSQL.d.ts +17 -0
- package/dist/types/models/sql/CrmFormSQL.d.ts +24 -0
- package/dist/types/models/sql/CrmImportSQL.d.ts +31 -0
- package/dist/types/models/sql/CrmNoteSQL.d.ts +17 -0
- package/dist/types/models/sql/CrmSettingSQL.d.ts +13 -0
- package/dist/types/models/sql/CrmTaskSQL.d.ts +23 -0
- package/dist/types/models/sql/DealSQL.d.ts +27 -0
- package/dist/types/models/sql/EmailTemplateSQL.d.ts +17 -0
- package/dist/types/models/sql/EngagementEventSQL.d.ts +20 -0
- package/dist/types/models/sql/EnrollmentSQL.d.ts +25 -0
- package/dist/types/models/sql/MailingListSQL.d.ts +19 -0
- package/dist/types/models/sql/OutboundSendSQL.d.ts +41 -0
- package/dist/types/models/sql/PipelineSQL.d.ts +15 -0
- package/dist/types/models/sql/PropertyDefinitionSQL.d.ts +19 -0
- package/dist/types/models/sql/PropertyValueSQL.d.ts +18 -0
- package/dist/types/models/sql/SavedBlockSQL.d.ts +14 -0
- package/dist/types/models/sql/ScoringRuleSQL.d.ts +20 -0
- package/dist/types/models/sql/SegmentSQL.d.ts +20 -0
- package/dist/types/models/sql/SubscriptionSQL.d.ts +20 -0
- package/dist/types/models/sql/SuppressionSQL.d.ts +15 -0
- package/dist/types/models/sql/TimelineEventSQL.d.ts +20 -0
- package/dist/types/models/sql/WebhookDeliverySQL.d.ts +22 -0
- package/dist/types/models/sql/WebhookEndpointSQL.d.ts +21 -0
- package/dist/types/models/sql/WorkspaceMemberSQL.d.ts +17 -0
- package/dist/types/models/sql/WorkspaceSQL.d.ts +21 -0
- package/dist/types/models/sql/WorkspaceSenderSQL.d.ts +18 -0
- package/dist/types/models/sql/index.d.ts +3 -0
- package/dist/types/models/types.d.ts +902 -0
- package/dist/types/mongo.d.ts +75 -0
- package/dist/types/purge.d.ts +32 -0
- package/dist/types/routes/BaseAnalyticsRoute.d.ts +87 -0
- package/dist/types/routes/BaseApiKeyRoute.d.ts +31 -0
- package/dist/types/routes/BaseAutomationRoute.d.ts +56 -0
- package/dist/types/routes/BaseCampaignRoute.d.ts +66 -0
- package/dist/types/routes/BaseCompanyRoute.d.ts +30 -0
- package/dist/types/routes/BaseContactRoute.d.ts +42 -0
- package/dist/types/routes/BaseCrmAdminRoute.d.ts +41 -0
- package/dist/types/routes/BaseDealRoute.d.ts +65 -0
- package/dist/types/routes/BaseFormRoute.d.ts +25 -0
- package/dist/types/routes/BaseImportRoute.d.ts +39 -0
- package/dist/types/routes/BaseIntegrationRoute.d.ts +46 -0
- package/dist/types/routes/BaseListRoute.d.ts +26 -0
- package/dist/types/routes/BaseNoteRoute.d.ts +15 -0
- package/dist/types/routes/BasePipelineRoute.d.ts +31 -0
- package/dist/types/routes/BasePropertyDefinitionRoute.d.ts +24 -0
- package/dist/types/routes/BasePublicRoute.d.ts +129 -0
- package/dist/types/routes/BaseSavedBlockRoute.d.ts +16 -0
- package/dist/types/routes/BaseScoringRuleRoute.d.ts +33 -0
- package/dist/types/routes/BaseSegmentRoute.d.ts +36 -0
- package/dist/types/routes/BaseSubscriptionRoute.d.ts +20 -0
- package/dist/types/routes/BaseSuppressionRoute.d.ts +17 -0
- package/dist/types/routes/BaseTaggedRecordRoute.d.ts +85 -0
- package/dist/types/routes/BaseTaskRoute.d.ts +18 -0
- package/dist/types/routes/BaseTemplateRoute.d.ts +52 -0
- package/dist/types/routes/BaseTimelineRoute.d.ts +10 -0
- package/dist/types/routes/BaseTrackingRoute.d.ts +21 -0
- package/dist/types/routes/BaseWebhookRoute.d.ts +49 -0
- package/dist/types/routes/BaseWorkspaceRecordRoute.d.ts +78 -0
- package/dist/types/routes/BaseWorkspaceRoute.d.ts +78 -0
- package/dist/types/routes/CrmRouteBase.d.ts +95 -0
- package/dist/types/routes/mongo/AnalyticsRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/ApiKeyRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/AutomationRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/CampaignRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/CompanyRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/ContactRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/CrmAdminRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/DealRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/FormRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/ImportRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/IntegrationRouteMongo.d.ts +7 -0
- package/dist/types/routes/mongo/ListRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/NoteRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/PipelineRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/PropertyDefinitionRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/PublicRouteMongo.d.ts +7 -0
- package/dist/types/routes/mongo/SavedBlockRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/ScoringRuleRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/SegmentRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/SubscriptionRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/SuppressionRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/TaskRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/TemplateRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/TimelineRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/TrackingRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/WebhookRouteMongo.d.ts +6 -0
- package/dist/types/routes/mongo/WorkspaceRouteMongo.d.ts +6 -0
- package/dist/types/routes/sql/AnalyticsRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/ApiKeyRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/AutomationRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/CampaignRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/CompanyRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/ContactRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/CrmAdminRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/DealRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/FormRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/ImportRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/IntegrationRouteSQL.d.ts +7 -0
- package/dist/types/routes/sql/ListRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/NoteRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/PipelineRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/PropertyDefinitionRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/PublicRouteSQL.d.ts +7 -0
- package/dist/types/routes/sql/SavedBlockRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/ScoringRuleRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/SegmentRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/SubscriptionRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/SuppressionRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/TaskRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/TemplateRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/TimelineRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/TrackingRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/WebhookRouteSQL.d.ts +6 -0
- package/dist/types/routes/sql/WorkspaceRouteSQL.d.ts +6 -0
- package/dist/types/scoring/Scoring.d.ts +14 -0
- package/dist/types/segments/Segments.d.ts +46 -0
- package/dist/types/sending/Audience.d.ts +39 -0
- package/dist/types/sending/CampaignRenderer.d.ts +40 -0
- package/dist/types/sending/Engagement.d.ts +50 -0
- package/dist/types/sending/Stats.d.ts +17 -0
- package/dist/types/sending/Tracking.d.ts +39 -0
- package/dist/types/sql.d.ts +75 -0
- package/dist/types/templates/Design.d.ts +138 -0
- package/dist/types/templates/MergeContext.d.ts +27 -0
- package/dist/types/templates/Render.d.ts +46 -0
- package/dist/types/templates/Sanitize.d.ts +18 -0
- package/dist/types/util/Csv.d.ts +26 -0
- package/dist/types/util/ImportMapping.d.ts +23 -0
- package/dist/types/util/Mailer.d.ts +24 -0
- package/dist/types/util/PropertyValues.d.ts +31 -0
- package/dist/types/util/Secrets.d.ts +10 -0
- package/dist/types/util/Tokens.d.ts +30 -0
- package/dist/types/util/Validation.d.ts +59 -0
- package/dist/types/util/WorkspaceAccess.d.ts +24 -0
- package/dist/types/webhooks/Deliveries.d.ts +26 -0
- package/dist/types/webhooks/Webhooks.d.ts +43 -0
- package/package.json +226 -0
|
@@ -0,0 +1,1046 @@
|
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
/**
|
|
6
|
+
* Typed wrappers over this plugin's API (`/api/mail/crm/...`). The shapes mirror the server's (`src/models/types.ts`), with dates as
|
|
7
|
+
* ISO strings the way JSON carries them.
|
|
8
|
+
*/
|
|
9
|
+
import { ApiRequestError, apiFetch, apiUrl, withCsrfHeader } from "@rapidmx/web-client/lib/util/api.js";
|
|
10
|
+
|
|
11
|
+
export type WorkspaceRole = "owner" | "admin" | "editor" | "viewer";
|
|
12
|
+
export type CrmObjectType = "contact" | "company";
|
|
13
|
+
/** What notes, tasks and timelines can be about. */
|
|
14
|
+
export type SubjectType = CrmObjectType | "deal";
|
|
15
|
+
|
|
16
|
+
interface Stored {
|
|
17
|
+
uid: string;
|
|
18
|
+
version: number;
|
|
19
|
+
dateCreated: string;
|
|
20
|
+
dateModified: string;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export interface Workspace extends Stored {
|
|
24
|
+
name: string;
|
|
25
|
+
description?: string;
|
|
26
|
+
timezone: string;
|
|
27
|
+
postalAddress?: string;
|
|
28
|
+
website?: string;
|
|
29
|
+
createdByUserUid: string;
|
|
30
|
+
/** The caller's own role. */
|
|
31
|
+
role: WorkspaceRole;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export interface WorkspaceMember extends Stored {
|
|
35
|
+
workspaceUid: string;
|
|
36
|
+
userUid: string;
|
|
37
|
+
role: WorkspaceRole;
|
|
38
|
+
address?: string;
|
|
39
|
+
displayName?: string;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface WorkspaceSender extends Stored {
|
|
43
|
+
workspaceUid: string;
|
|
44
|
+
mailboxUid: string;
|
|
45
|
+
fromAddress: string;
|
|
46
|
+
fromName: string;
|
|
47
|
+
replyToAddress?: string;
|
|
48
|
+
/** Mail its mailbox exchanges with contacts goes on their timelines. */
|
|
49
|
+
logEmail?: boolean;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export type PropertyViewValue = string | number | boolean | string[];
|
|
53
|
+
|
|
54
|
+
export interface Contact extends Stored {
|
|
55
|
+
workspaceUid: string;
|
|
56
|
+
email: string;
|
|
57
|
+
firstName?: string;
|
|
58
|
+
lastName?: string;
|
|
59
|
+
phone?: string;
|
|
60
|
+
jobTitle?: string;
|
|
61
|
+
companyUid?: string;
|
|
62
|
+
ownerUserUid?: string;
|
|
63
|
+
lifecycleStage: string;
|
|
64
|
+
leadStatus?: string;
|
|
65
|
+
score: number;
|
|
66
|
+
tags: string[];
|
|
67
|
+
source?: string;
|
|
68
|
+
emailStatus: string;
|
|
69
|
+
lastEngagedAt?: string;
|
|
70
|
+
properties: Record<string, PropertyViewValue>;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export interface Company extends Stored {
|
|
74
|
+
workspaceUid: string;
|
|
75
|
+
name: string;
|
|
76
|
+
domain?: string;
|
|
77
|
+
industry?: string;
|
|
78
|
+
employeeCount?: number;
|
|
79
|
+
phone?: string;
|
|
80
|
+
website?: string;
|
|
81
|
+
city?: string;
|
|
82
|
+
country?: string;
|
|
83
|
+
ownerUserUid?: string;
|
|
84
|
+
tags: string[];
|
|
85
|
+
properties: Record<string, PropertyViewValue>;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export type CrmRecord = Contact | Company;
|
|
89
|
+
|
|
90
|
+
export type PropertyType = "text" | "number" | "date" | "boolean" | "select" | "multi_select";
|
|
91
|
+
|
|
92
|
+
export interface PropertyDefinition extends Stored {
|
|
93
|
+
workspaceUid: string;
|
|
94
|
+
objectType: CrmObjectType;
|
|
95
|
+
key: string;
|
|
96
|
+
label: string;
|
|
97
|
+
type: PropertyType;
|
|
98
|
+
options: { value: string; label: string }[];
|
|
99
|
+
group?: string;
|
|
100
|
+
description?: string;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
export interface Note extends Stored {
|
|
104
|
+
subjectType: SubjectType;
|
|
105
|
+
subjectUid: string;
|
|
106
|
+
body: string;
|
|
107
|
+
authorUserUid: string;
|
|
108
|
+
pinned: boolean;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export type TaskStatus = "open" | "done";
|
|
112
|
+
export type TaskPriority = "low" | "normal" | "high";
|
|
113
|
+
|
|
114
|
+
export interface Task extends Stored {
|
|
115
|
+
title: string;
|
|
116
|
+
notes?: string;
|
|
117
|
+
status: TaskStatus;
|
|
118
|
+
priority: TaskPriority;
|
|
119
|
+
dueAt?: string;
|
|
120
|
+
assigneeUserUid?: string;
|
|
121
|
+
subjectType?: SubjectType;
|
|
122
|
+
subjectUid?: string;
|
|
123
|
+
completedAt?: string;
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
export interface TimelineEvent extends Stored {
|
|
127
|
+
kind: string;
|
|
128
|
+
occurredAt: string;
|
|
129
|
+
actorUserUid?: string;
|
|
130
|
+
summary: string;
|
|
131
|
+
data: Record<string, unknown>;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
export interface ImportColumnMapping {
|
|
135
|
+
column: string;
|
|
136
|
+
target?: string;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
export interface CrmImport extends Stored {
|
|
140
|
+
objectType: CrmObjectType;
|
|
141
|
+
fileName: string;
|
|
142
|
+
columns: string[];
|
|
143
|
+
mapping: ImportColumnMapping[];
|
|
144
|
+
updateExisting: boolean;
|
|
145
|
+
tags: string[];
|
|
146
|
+
status: "uploaded" | "queued" | "running" | "done" | "failed";
|
|
147
|
+
totalRows: number;
|
|
148
|
+
processedRows: number;
|
|
149
|
+
createdCount: number;
|
|
150
|
+
updatedCount: number;
|
|
151
|
+
skippedCount: number;
|
|
152
|
+
errors: { row: number; message: string }[];
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
export interface ImportUpload {
|
|
156
|
+
import: CrmImport;
|
|
157
|
+
targets: string[];
|
|
158
|
+
preview: string[][];
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/** A filter condition or group, as `POST .../search` takes it. */
|
|
162
|
+
export interface FilterCondition {
|
|
163
|
+
field: string;
|
|
164
|
+
op: string;
|
|
165
|
+
value?: unknown;
|
|
166
|
+
}
|
|
167
|
+
export interface FilterGroup {
|
|
168
|
+
and?: FilterNode[];
|
|
169
|
+
or?: FilterNode[];
|
|
170
|
+
}
|
|
171
|
+
export type FilterNode = FilterCondition | FilterGroup;
|
|
172
|
+
|
|
173
|
+
export interface SearchRequest {
|
|
174
|
+
filter?: FilterNode;
|
|
175
|
+
q?: string;
|
|
176
|
+
sort?: { field: string; direction: "asc" | "desc" };
|
|
177
|
+
limit?: number;
|
|
178
|
+
page?: number;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
export interface SearchResult<T> {
|
|
182
|
+
items: T[];
|
|
183
|
+
total: number;
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
const enc = encodeURIComponent;
|
|
187
|
+
const json = (method: string, body?: unknown): RequestInit => ({ method, ...(body === undefined ? {} : { body: JSON.stringify(body) }) });
|
|
188
|
+
|
|
189
|
+
/** The API path of one kind of record: `contacts` or `companies`. */
|
|
190
|
+
export function recordPath(objectType: CrmObjectType): string {
|
|
191
|
+
return objectType === "contact" ? "contacts" : "companies";
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
// Workspaces
|
|
195
|
+
|
|
196
|
+
export const listWorkspaces = (): Promise<Workspace[]> => apiFetch("/mail/crm/workspaces");
|
|
197
|
+
export const getWorkspace = (uid: string): Promise<Workspace> => apiFetch(`/mail/crm/workspaces/${enc(uid)}`);
|
|
198
|
+
export const createWorkspace = (input: Partial<Workspace>): Promise<Workspace> => apiFetch("/mail/crm/workspaces", json("POST", input));
|
|
199
|
+
export const updateWorkspace = (uid: string, input: Partial<Workspace>): Promise<Workspace> => apiFetch(`/mail/crm/workspaces/${enc(uid)}`, json("PUT", input));
|
|
200
|
+
export const deleteWorkspace = (uid: string): Promise<void> => apiFetch(`/mail/crm/workspaces/${enc(uid)}`, json("DELETE"));
|
|
201
|
+
export const listMembers = (uid: string): Promise<WorkspaceMember[]> => apiFetch(`/mail/crm/workspaces/${enc(uid)}/members`);
|
|
202
|
+
export const addMember = (uid: string, input: { address?: string; userUid?: string; role: WorkspaceRole }): Promise<WorkspaceMember> =>
|
|
203
|
+
apiFetch(`/mail/crm/workspaces/${enc(uid)}/members`, json("POST", input));
|
|
204
|
+
export const updateMember = (uid: string, userUid: string, role: WorkspaceRole): Promise<WorkspaceMember> =>
|
|
205
|
+
apiFetch(`/mail/crm/workspaces/${enc(uid)}/members/${enc(userUid)}`, json("PUT", { role }));
|
|
206
|
+
export const removeMember = (uid: string, userUid: string): Promise<void> => apiFetch(`/mail/crm/workspaces/${enc(uid)}/members/${enc(userUid)}`, json("DELETE"));
|
|
207
|
+
export const listSenders = (uid: string): Promise<WorkspaceSender[]> => apiFetch(`/mail/crm/workspaces/${enc(uid)}/senders`);
|
|
208
|
+
export const updateSender = (uid: string, senderUid: string, input: { fromName?: string; replyToAddress?: string | null; logEmail?: boolean }): Promise<WorkspaceSender> =>
|
|
209
|
+
apiFetch(`/mail/crm/workspaces/${enc(uid)}/senders/${enc(senderUid)}`, json("PUT", input));
|
|
210
|
+
export const addSender = (uid: string, input: { fromAddress: string; fromName?: string; replyToAddress?: string; logEmail?: boolean }): Promise<WorkspaceSender> =>
|
|
211
|
+
apiFetch(`/mail/crm/workspaces/${enc(uid)}/senders`, json("POST", input));
|
|
212
|
+
export const removeSender = (uid: string, senderUid: string): Promise<void> => apiFetch(`/mail/crm/workspaces/${enc(uid)}/senders/${enc(senderUid)}`, json("DELETE"));
|
|
213
|
+
|
|
214
|
+
// Contacts and companies
|
|
215
|
+
|
|
216
|
+
export function searchRecords<T extends CrmRecord>(objectType: CrmObjectType, workspaceUid: string, request: SearchRequest): Promise<SearchResult<T>> {
|
|
217
|
+
return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/search`, json("POST", request));
|
|
218
|
+
}
|
|
219
|
+
export function getRecord<T extends CrmRecord>(objectType: CrmObjectType, workspaceUid: string, uid: string): Promise<T> {
|
|
220
|
+
return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/${enc(uid)}`);
|
|
221
|
+
}
|
|
222
|
+
export function createRecord<T extends CrmRecord>(objectType: CrmObjectType, workspaceUid: string, input: Record<string, unknown>): Promise<T> {
|
|
223
|
+
return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}`, json("POST", input));
|
|
224
|
+
}
|
|
225
|
+
export function updateRecord<T extends CrmRecord>(objectType: CrmObjectType, workspaceUid: string, uid: string, input: Record<string, unknown>): Promise<T> {
|
|
226
|
+
return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
227
|
+
}
|
|
228
|
+
export function deleteRecord(objectType: CrmObjectType, workspaceUid: string, uid: string): Promise<void> {
|
|
229
|
+
return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
230
|
+
}
|
|
231
|
+
export function bulkRecords(
|
|
232
|
+
objectType: CrmObjectType,
|
|
233
|
+
workspaceUid: string,
|
|
234
|
+
input: { uids: string[]; action: "delete" | "addTags" | "removeTags" | "setOwner"; tags?: string[]; ownerUserUid?: string | null },
|
|
235
|
+
): Promise<{ changed: number }> {
|
|
236
|
+
return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/bulk`, json("POST", input));
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/** Downloads the records matching `request` as a CSV file. Browser only. */
|
|
240
|
+
export async function exportRecords(objectType: CrmObjectType, workspaceUid: string, request: SearchRequest): Promise<void> {
|
|
241
|
+
const response: Response = await fetch(apiUrl(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/export`), {
|
|
242
|
+
method: "POST",
|
|
243
|
+
credentials: "include",
|
|
244
|
+
headers: withCsrfHeader({ "Content-Type": "application/json" }),
|
|
245
|
+
body: JSON.stringify(request),
|
|
246
|
+
});
|
|
247
|
+
if (!response.ok) {
|
|
248
|
+
throw await responseError(response);
|
|
249
|
+
}
|
|
250
|
+
const link: HTMLAnchorElement = document.createElement("a");
|
|
251
|
+
link.href = URL.createObjectURL(await response.blob());
|
|
252
|
+
link.download = `${recordPath(objectType)}.csv`;
|
|
253
|
+
link.click();
|
|
254
|
+
URL.revokeObjectURL(link.href);
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
// Properties, notes, tasks, timeline
|
|
258
|
+
|
|
259
|
+
export const listProperties = (workspaceUid: string, objectType?: CrmObjectType): Promise<PropertyDefinition[]> =>
|
|
260
|
+
apiFetch(`/mail/crm/properties/${enc(workspaceUid)}?limit=200${objectType ? `&objectType=${objectType}` : ""}`);
|
|
261
|
+
export const createProperty = (workspaceUid: string, input: Omit<Partial<PropertyDefinition>, "options"> & { options?: (string | { value: string; label?: string })[] }): Promise<PropertyDefinition> =>
|
|
262
|
+
apiFetch(`/mail/crm/properties/${enc(workspaceUid)}`, json("POST", input));
|
|
263
|
+
export const deleteProperty = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/properties/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
264
|
+
|
|
265
|
+
export const listNotes = (workspaceUid: string, subjectUid: string): Promise<Note[]> =>
|
|
266
|
+
apiFetch(`/mail/crm/notes/${enc(workspaceUid)}?limit=200&subjectUid=${enc(subjectUid)}`);
|
|
267
|
+
export const createNote = (workspaceUid: string, input: { subjectType: SubjectType; subjectUid: string; body: string }): Promise<Note> =>
|
|
268
|
+
apiFetch(`/mail/crm/notes/${enc(workspaceUid)}`, json("POST", input));
|
|
269
|
+
export const deleteNote = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/notes/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
270
|
+
|
|
271
|
+
export function listTasks(workspaceUid: string, query: { status?: TaskStatus; assigneeUserUid?: string; subjectUid?: string } = {}): Promise<Task[]> {
|
|
272
|
+
const params: string = Object.entries(query)
|
|
273
|
+
.filter(([, value]) => value)
|
|
274
|
+
.map(([key, value]) => `&${key}=${enc(value)}`)
|
|
275
|
+
.join("");
|
|
276
|
+
return apiFetch(`/mail/crm/tasks/${enc(workspaceUid)}?limit=200${params}`);
|
|
277
|
+
}
|
|
278
|
+
export const createTask = (workspaceUid: string, input: Partial<Task>): Promise<Task> => apiFetch(`/mail/crm/tasks/${enc(workspaceUid)}`, json("POST", input));
|
|
279
|
+
export const updateTask = (workspaceUid: string, uid: string, input: Partial<Task>): Promise<Task> =>
|
|
280
|
+
apiFetch(`/mail/crm/tasks/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
281
|
+
export const deleteTask = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/tasks/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
282
|
+
|
|
283
|
+
export const listTimeline = (workspaceUid: string, subjectType: SubjectType, subjectUid: string): Promise<TimelineEvent[]> =>
|
|
284
|
+
apiFetch(`/mail/crm/timeline/${enc(workspaceUid)}/${subjectType}/${enc(subjectUid)}?limit=100`);
|
|
285
|
+
|
|
286
|
+
// Lists, subscriptions, suppressions, forms
|
|
287
|
+
|
|
288
|
+
export interface MailingList extends Stored {
|
|
289
|
+
name: string;
|
|
290
|
+
description?: string;
|
|
291
|
+
publicName: string;
|
|
292
|
+
publicDescription?: string;
|
|
293
|
+
doubleOptIn: boolean;
|
|
294
|
+
visible: boolean;
|
|
295
|
+
senderUid?: string;
|
|
296
|
+
subscribedCount: number;
|
|
297
|
+
pendingCount: number;
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
export type SubscriptionStatus = "pending" | "subscribed" | "unsubscribed";
|
|
301
|
+
|
|
302
|
+
export interface Subscription extends Stored {
|
|
303
|
+
listUid: string;
|
|
304
|
+
contactUid: string;
|
|
305
|
+
status: SubscriptionStatus;
|
|
306
|
+
source: string;
|
|
307
|
+
consentAt?: string;
|
|
308
|
+
unsubscribedAt?: string;
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
export interface Suppression extends Stored {
|
|
312
|
+
email: string;
|
|
313
|
+
reason: "hard_bounce" | "complaint" | "manual";
|
|
314
|
+
note?: string;
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
export interface FormField {
|
|
318
|
+
target: string;
|
|
319
|
+
label: string;
|
|
320
|
+
required: boolean;
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
export interface CrmForm extends Stored {
|
|
324
|
+
name: string;
|
|
325
|
+
title: string;
|
|
326
|
+
description?: string;
|
|
327
|
+
fields: FormField[];
|
|
328
|
+
listUids: string[];
|
|
329
|
+
doubleOptIn: boolean;
|
|
330
|
+
senderUid?: string;
|
|
331
|
+
successMessage: string;
|
|
332
|
+
redirectUrl?: string;
|
|
333
|
+
tags: string[];
|
|
334
|
+
enabled: boolean;
|
|
335
|
+
submissionCount: number;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
export const listLists = (workspaceUid: string): Promise<MailingList[]> => apiFetch(`/mail/crm/lists/${enc(workspaceUid)}?limit=200`);
|
|
339
|
+
export const createList = (workspaceUid: string, input: Partial<MailingList>): Promise<MailingList> => apiFetch(`/mail/crm/lists/${enc(workspaceUid)}`, json("POST", input));
|
|
340
|
+
export const updateList = (workspaceUid: string, uid: string, input: Partial<MailingList>): Promise<MailingList> =>
|
|
341
|
+
apiFetch(`/mail/crm/lists/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
342
|
+
export const deleteList = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/lists/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
343
|
+
|
|
344
|
+
export const listSubscriptions = (workspaceUid: string, contactUid: string): Promise<Subscription[]> =>
|
|
345
|
+
apiFetch(`/mail/crm/subscriptions/${enc(workspaceUid)}?limit=500&contactUid=${enc(contactUid)}`);
|
|
346
|
+
export const setSubscriptions = (workspaceUid: string, input: { listUid: string; contactUids: string[]; status: "subscribed" | "unsubscribed" }): Promise<{ changed: number }> =>
|
|
347
|
+
apiFetch(`/mail/crm/subscriptions/${enc(workspaceUid)}`, json("POST", input));
|
|
348
|
+
|
|
349
|
+
export const listSuppressions = (workspaceUid: string): Promise<Suppression[]> => apiFetch(`/mail/crm/suppressions/${enc(workspaceUid)}?limit=200`);
|
|
350
|
+
export const createSuppression = (workspaceUid: string, input: { email: string; note?: string }): Promise<Suppression> =>
|
|
351
|
+
apiFetch(`/mail/crm/suppressions/${enc(workspaceUid)}`, json("POST", input));
|
|
352
|
+
export const deleteSuppression = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/suppressions/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
353
|
+
|
|
354
|
+
export const listForms = (workspaceUid: string): Promise<CrmForm[]> => apiFetch(`/mail/crm/forms/${enc(workspaceUid)}?limit=200`);
|
|
355
|
+
export const createForm = (workspaceUid: string, input: Partial<CrmForm>): Promise<CrmForm> => apiFetch(`/mail/crm/forms/${enc(workspaceUid)}`, json("POST", input));
|
|
356
|
+
export const updateForm = (workspaceUid: string, uid: string, input: Partial<CrmForm>): Promise<CrmForm> =>
|
|
357
|
+
apiFetch(`/mail/crm/forms/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
358
|
+
export const deleteForm = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/forms/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
359
|
+
|
|
360
|
+
// Imports
|
|
361
|
+
|
|
362
|
+
export const listImports = (workspaceUid: string): Promise<CrmImport[]> => apiFetch(`/mail/crm/imports/${enc(workspaceUid)}?limit=50`);
|
|
363
|
+
export const getImport = (workspaceUid: string, uid: string): Promise<CrmImport> => apiFetch(`/mail/crm/imports/${enc(workspaceUid)}/${enc(uid)}`);
|
|
364
|
+
export const startImport = (
|
|
365
|
+
workspaceUid: string,
|
|
366
|
+
uid: string,
|
|
367
|
+
input: { mapping: ImportColumnMapping[]; updateExisting: boolean; tags: string[]; listUid?: string },
|
|
368
|
+
): Promise<CrmImport> =>
|
|
369
|
+
apiFetch(`/mail/crm/imports/${enc(workspaceUid)}/${enc(uid)}/start`, json("POST", input));
|
|
370
|
+
export const deleteImport = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/imports/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
371
|
+
|
|
372
|
+
/** Uploads a CSV file for import. */
|
|
373
|
+
export async function uploadImport(workspaceUid: string, objectType: CrmObjectType, file: File): Promise<ImportUpload> {
|
|
374
|
+
const response: Response = await fetch(apiUrl(`/mail/crm/imports/${enc(workspaceUid)}?objectType=${objectType}&fileName=${enc(file.name)}`), {
|
|
375
|
+
method: "POST",
|
|
376
|
+
credentials: "include",
|
|
377
|
+
headers: withCsrfHeader({ "Content-Type": "text/csv" }),
|
|
378
|
+
body: file,
|
|
379
|
+
});
|
|
380
|
+
if (!response.ok) {
|
|
381
|
+
throw await responseError(response);
|
|
382
|
+
}
|
|
383
|
+
return (await response.json()) as ImportUpload;
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
/** An `ApiRequestError` from a failed raw `fetch()`, with the server's message when it sent one. */
|
|
387
|
+
async function responseError(response: Response): Promise<ApiRequestError> {
|
|
388
|
+
let message: string = `Request failed (${response.status}).`;
|
|
389
|
+
try {
|
|
390
|
+
const body: any = await response.json();
|
|
391
|
+
message = typeof body?.message === "string" ? body.message : message;
|
|
392
|
+
} catch {
|
|
393
|
+
// Not JSON: keep the generic message.
|
|
394
|
+
}
|
|
395
|
+
return new ApiRequestError(message, response.status);
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
/** A readable message for a failed call. */
|
|
399
|
+
export function errorMessage(err: unknown, fallback: string): string {
|
|
400
|
+
return err instanceof ApiRequestError ? err.message : fallback;
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
// Templates
|
|
404
|
+
|
|
405
|
+
export type Align = "left" | "center" | "right";
|
|
406
|
+
export type SocialNetwork = "facebook" | "x" | "linkedin" | "instagram" | "youtube" | "github" | "web";
|
|
407
|
+
|
|
408
|
+
interface BlockBase {
|
|
409
|
+
id: string;
|
|
410
|
+
align?: Align;
|
|
411
|
+
padding?: number;
|
|
412
|
+
}
|
|
413
|
+
export interface TextBlock extends BlockBase {
|
|
414
|
+
type: "text";
|
|
415
|
+
html: string;
|
|
416
|
+
color?: string;
|
|
417
|
+
fontSize?: number;
|
|
418
|
+
}
|
|
419
|
+
export interface HeadingBlock extends BlockBase {
|
|
420
|
+
type: "heading";
|
|
421
|
+
text: string;
|
|
422
|
+
level: 1 | 2 | 3;
|
|
423
|
+
color?: string;
|
|
424
|
+
}
|
|
425
|
+
export interface ImageBlock extends BlockBase {
|
|
426
|
+
type: "image";
|
|
427
|
+
src: string;
|
|
428
|
+
alt: string;
|
|
429
|
+
href?: string;
|
|
430
|
+
width?: number;
|
|
431
|
+
}
|
|
432
|
+
export interface ButtonBlock extends BlockBase {
|
|
433
|
+
type: "button";
|
|
434
|
+
text: string;
|
|
435
|
+
href: string;
|
|
436
|
+
color?: string;
|
|
437
|
+
backgroundColor?: string;
|
|
438
|
+
borderRadius?: number;
|
|
439
|
+
}
|
|
440
|
+
export interface DividerBlock extends BlockBase {
|
|
441
|
+
type: "divider";
|
|
442
|
+
color?: string;
|
|
443
|
+
thickness?: number;
|
|
444
|
+
}
|
|
445
|
+
export interface SpacerBlock extends BlockBase {
|
|
446
|
+
type: "spacer";
|
|
447
|
+
height: number;
|
|
448
|
+
}
|
|
449
|
+
export interface SocialBlock extends BlockBase {
|
|
450
|
+
type: "social";
|
|
451
|
+
links: { network: SocialNetwork; href: string }[];
|
|
452
|
+
}
|
|
453
|
+
export interface HtmlBlock extends BlockBase {
|
|
454
|
+
type: "html";
|
|
455
|
+
html: string;
|
|
456
|
+
}
|
|
457
|
+
export interface FooterBlock extends BlockBase {
|
|
458
|
+
type: "footer";
|
|
459
|
+
note?: string;
|
|
460
|
+
color?: string;
|
|
461
|
+
}
|
|
462
|
+
export type DesignBlock = TextBlock | HeadingBlock | ImageBlock | ButtonBlock | DividerBlock | SpacerBlock | SocialBlock | HtmlBlock | FooterBlock;
|
|
463
|
+
export type BlockType = DesignBlock["type"];
|
|
464
|
+
|
|
465
|
+
export interface DesignColumn {
|
|
466
|
+
id: string;
|
|
467
|
+
blocks: DesignBlock[];
|
|
468
|
+
}
|
|
469
|
+
export interface DesignSection {
|
|
470
|
+
id: string;
|
|
471
|
+
columns: DesignColumn[];
|
|
472
|
+
backgroundColor?: string;
|
|
473
|
+
padding?: number;
|
|
474
|
+
}
|
|
475
|
+
export interface DesignTheme {
|
|
476
|
+
width: number;
|
|
477
|
+
backgroundColor: string;
|
|
478
|
+
contentBackgroundColor: string;
|
|
479
|
+
textColor: string;
|
|
480
|
+
linkColor: string;
|
|
481
|
+
buttonColor: string;
|
|
482
|
+
buttonTextColor: string;
|
|
483
|
+
fontFamily: string;
|
|
484
|
+
}
|
|
485
|
+
export interface TemplateDesign {
|
|
486
|
+
version?: number;
|
|
487
|
+
theme: DesignTheme;
|
|
488
|
+
sections: DesignSection[];
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
export interface EmailTemplate extends Stored {
|
|
492
|
+
workspaceUid: string;
|
|
493
|
+
name: string;
|
|
494
|
+
category?: string | null;
|
|
495
|
+
subject: string;
|
|
496
|
+
preheader?: string | null;
|
|
497
|
+
design: TemplateDesign;
|
|
498
|
+
/** The design has an unsubscribe link (a footer block, or a `{{ links.unsubscribe }}` link); campaigns require one. */
|
|
499
|
+
hasUnsubscribeLink: boolean;
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
export interface SavedBlock extends Stored {
|
|
503
|
+
workspaceUid: string;
|
|
504
|
+
name: string;
|
|
505
|
+
blocks: DesignBlock[];
|
|
506
|
+
}
|
|
507
|
+
|
|
508
|
+
export interface RenderedEmail {
|
|
509
|
+
subject: string;
|
|
510
|
+
html: string;
|
|
511
|
+
text: string;
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
export interface MergeTag {
|
|
515
|
+
tag: string;
|
|
516
|
+
label: string;
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
/** A template's changes; `version` refuses the change when the template was saved elsewhere since. */
|
|
520
|
+
export type TemplateInput = Partial<Pick<EmailTemplate, "name" | "category" | "subject" | "preheader" | "design" | "version">>;
|
|
521
|
+
|
|
522
|
+
/** A page of the workspace's templates, by name. */
|
|
523
|
+
export const searchTemplates = (workspaceUid: string, page: number, limit: number = 100): Promise<SearchResult<EmailTemplate>> =>
|
|
524
|
+
apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/search`, json("POST", { sort: { field: "name", direction: "asc" }, limit, page }));
|
|
525
|
+
export const getTemplate = (workspaceUid: string, uid: string): Promise<EmailTemplate> => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}`);
|
|
526
|
+
export const createTemplate = (workspaceUid: string, input: TemplateInput): Promise<EmailTemplate> =>
|
|
527
|
+
apiFetch(`/mail/crm/templates/${enc(workspaceUid)}`, json("POST", input));
|
|
528
|
+
export const updateTemplate = (workspaceUid: string, uid: string, input: TemplateInput): Promise<EmailTemplate> =>
|
|
529
|
+
apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
530
|
+
export const deleteTemplate = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
531
|
+
export const duplicateTemplate = (workspaceUid: string, uid: string): Promise<EmailTemplate> =>
|
|
532
|
+
apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}/duplicate`, json("POST", {}));
|
|
533
|
+
export const renderTemplate = (
|
|
534
|
+
workspaceUid: string,
|
|
535
|
+
input: { design: TemplateDesign; subject: string; preheader?: string; contactUid?: string },
|
|
536
|
+
): Promise<RenderedEmail> => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/render`, json("POST", input));
|
|
537
|
+
export const sendTestTemplate = (workspaceUid: string, uid: string, input: { to: string; senderUid: string; contactUid?: string }): Promise<{ sent: string }> =>
|
|
538
|
+
apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}/test`, json("POST", input));
|
|
539
|
+
export const listMergeTags = (workspaceUid: string): Promise<MergeTag[]> => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/merge-tags`);
|
|
540
|
+
export const listSavedBlocks = (workspaceUid: string): Promise<SavedBlock[]> => apiFetch(`/mail/crm/saved-blocks/${enc(workspaceUid)}?limit=200`);
|
|
541
|
+
export const createSavedBlock = (workspaceUid: string, input: { name: string; blocks: DesignBlock[] }): Promise<SavedBlock> =>
|
|
542
|
+
apiFetch(`/mail/crm/saved-blocks/${enc(workspaceUid)}`, json("POST", input));
|
|
543
|
+
export const deleteSavedBlock = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/saved-blocks/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
544
|
+
|
|
545
|
+
// Campaigns
|
|
546
|
+
|
|
547
|
+
export type CampaignStatus = "draft" | "scheduled" | "preparing" | "sending" | "paused" | "sent" | "cancelled" | "failed";
|
|
548
|
+
export type AbMetric = "open" | "click" | "reply";
|
|
549
|
+
|
|
550
|
+
export interface CampaignVariant {
|
|
551
|
+
id: string;
|
|
552
|
+
subject?: string;
|
|
553
|
+
templateUid?: string;
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
export interface AbTest {
|
|
557
|
+
variants: CampaignVariant[];
|
|
558
|
+
testPercent: number;
|
|
559
|
+
metric: AbMetric;
|
|
560
|
+
testHours: number;
|
|
561
|
+
winnerId?: string;
|
|
562
|
+
decidedAt?: string;
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
export interface CampaignCounts {
|
|
566
|
+
recipients: number;
|
|
567
|
+
sent: number;
|
|
568
|
+
failed: number;
|
|
569
|
+
suppressed: number;
|
|
570
|
+
bounced: number;
|
|
571
|
+
opened: number;
|
|
572
|
+
clicked: number;
|
|
573
|
+
replied: number;
|
|
574
|
+
unsubscribed: number;
|
|
575
|
+
complained: number;
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
export interface CampaignStats extends CampaignCounts {
|
|
579
|
+
variants?: Record<string, CampaignCounts>;
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
export interface Campaign extends Stored {
|
|
583
|
+
workspaceUid: string;
|
|
584
|
+
name: string;
|
|
585
|
+
status: CampaignStatus;
|
|
586
|
+
templateUid?: string | null;
|
|
587
|
+
senderUid?: string | null;
|
|
588
|
+
listUids: string[];
|
|
589
|
+
excludeListUids: string[];
|
|
590
|
+
segmentUids: string[];
|
|
591
|
+
excludeSegmentUids: string[];
|
|
592
|
+
trackOpens: boolean;
|
|
593
|
+
trackClicks: boolean;
|
|
594
|
+
abTest?: AbTest | null;
|
|
595
|
+
scheduledAt?: string | null;
|
|
596
|
+
startedAt?: string | null;
|
|
597
|
+
finishedAt?: string | null;
|
|
598
|
+
recipientCount: number;
|
|
599
|
+
stats: CampaignStats;
|
|
600
|
+
error?: string | null;
|
|
601
|
+
}
|
|
602
|
+
|
|
603
|
+
export interface CampaignProblem {
|
|
604
|
+
field: string;
|
|
605
|
+
message: string;
|
|
606
|
+
}
|
|
607
|
+
|
|
608
|
+
export type SendStatus = "queued" | "held" | "sent" | "failed" | "suppressed" | "cancelled";
|
|
609
|
+
|
|
610
|
+
/** One message of a campaign, as its recipients list shows it. */
|
|
611
|
+
export interface CampaignRecipient extends Stored {
|
|
612
|
+
contactUid: string;
|
|
613
|
+
email: string;
|
|
614
|
+
variantId: string;
|
|
615
|
+
status: SendStatus;
|
|
616
|
+
sentAt?: string;
|
|
617
|
+
error?: string;
|
|
618
|
+
firstOpenedAt?: string;
|
|
619
|
+
openCount: number;
|
|
620
|
+
firstClickedAt?: string;
|
|
621
|
+
clickCount: number;
|
|
622
|
+
repliedAt?: string;
|
|
623
|
+
bouncedAt?: string;
|
|
624
|
+
bounceType?: string;
|
|
625
|
+
complainedAt?: string;
|
|
626
|
+
unsubscribedAt?: string;
|
|
627
|
+
}
|
|
628
|
+
|
|
629
|
+
export interface LinkClicks {
|
|
630
|
+
url: string;
|
|
631
|
+
clicks: number;
|
|
632
|
+
uniqueClicks: number;
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
export interface CampaignReport {
|
|
636
|
+
campaign: Campaign;
|
|
637
|
+
stats: CampaignStats;
|
|
638
|
+
links: LinkClicks[];
|
|
639
|
+
}
|
|
640
|
+
|
|
641
|
+
export type CampaignInput = Partial<
|
|
642
|
+
Pick<Campaign, "name" | "templateUid" | "senderUid" | "listUids" | "excludeListUids" | "segmentUids" | "excludeSegmentUids" | "trackOpens" | "trackClicks" | "abTest" | "version">
|
|
643
|
+
>;
|
|
644
|
+
|
|
645
|
+
const campaignPath = (workspaceUid: string, suffix: string = "") => `/mail/crm/campaigns/${enc(workspaceUid)}${suffix}`;
|
|
646
|
+
|
|
647
|
+
/** A page of the workspace's campaigns, newest first. */
|
|
648
|
+
export const searchCampaigns = (workspaceUid: string, page: number, limit: number = 50): Promise<SearchResult<Campaign>> =>
|
|
649
|
+
apiFetch(campaignPath(workspaceUid, "/search"), json("POST", { limit, page }));
|
|
650
|
+
export const getCampaign = (workspaceUid: string, uid: string): Promise<Campaign> => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}`));
|
|
651
|
+
export const createCampaign = (workspaceUid: string, input: CampaignInput): Promise<Campaign> => apiFetch(campaignPath(workspaceUid), json("POST", input));
|
|
652
|
+
export const updateCampaign = (workspaceUid: string, uid: string, input: CampaignInput): Promise<Campaign> =>
|
|
653
|
+
apiFetch(campaignPath(workspaceUid, `/${enc(uid)}`), json("PUT", input));
|
|
654
|
+
export const deleteCampaign = (workspaceUid: string, uid: string): Promise<void> => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}`), json("DELETE"));
|
|
655
|
+
export const duplicateCampaign = (workspaceUid: string, uid: string): Promise<Campaign> => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/duplicate`), json("POST", {}));
|
|
656
|
+
export const campaignChecklist = (workspaceUid: string, uid: string): Promise<CampaignProblem[]> => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/checklist`));
|
|
657
|
+
export const scheduleCampaign = (workspaceUid: string, uid: string, sendAt?: string): Promise<Campaign> =>
|
|
658
|
+
apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/schedule`), json("POST", sendAt ? { sendAt } : {}));
|
|
659
|
+
/** Moves a campaign along: back to a draft, paused, resumed or cancelled. */
|
|
660
|
+
export const changeCampaign = (workspaceUid: string, uid: string, action: "unschedule" | "pause" | "resume" | "cancel"): Promise<Campaign> =>
|
|
661
|
+
apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/${action}`), json("POST", {}));
|
|
662
|
+
export const campaignAudience = (
|
|
663
|
+
workspaceUid: string,
|
|
664
|
+
input: { listUids: string[]; excludeListUids: string[]; segmentUids?: string[]; excludeSegmentUids?: string[] },
|
|
665
|
+
): Promise<{ count: number; capped: boolean }> =>
|
|
666
|
+
apiFetch(campaignPath(workspaceUid, "/audience"), json("POST", input));
|
|
667
|
+
export const campaignReport = (workspaceUid: string, uid: string): Promise<CampaignReport> => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/report`));
|
|
668
|
+
export const campaignRecipients = (
|
|
669
|
+
workspaceUid: string,
|
|
670
|
+
uid: string,
|
|
671
|
+
query: { status?: SendStatus; engagement?: string; q?: string; page: number; limit?: number },
|
|
672
|
+
): Promise<SearchResult<CampaignRecipient>> => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/recipients`), json("POST", query));
|
|
673
|
+
|
|
674
|
+
// Segments and lead scoring
|
|
675
|
+
|
|
676
|
+
export type SegmentKind = "dynamic" | "static";
|
|
677
|
+
|
|
678
|
+
export interface Segment extends Stored {
|
|
679
|
+
workspaceUid: string;
|
|
680
|
+
name: string;
|
|
681
|
+
description?: string | null;
|
|
682
|
+
kind: SegmentKind;
|
|
683
|
+
filter: FilterNode;
|
|
684
|
+
memberCount: number;
|
|
685
|
+
capped: boolean;
|
|
686
|
+
refreshedAt?: string | null;
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
export interface SegmentPreview {
|
|
690
|
+
count: number;
|
|
691
|
+
capped: boolean;
|
|
692
|
+
contacts: Pick<Contact, "uid" | "email" | "firstName" | "lastName">[];
|
|
693
|
+
}
|
|
694
|
+
|
|
695
|
+
export type ScoringKind = "property" | "activity";
|
|
696
|
+
export type ScoringActivity = "opened" | "clicked" | "replied" | "form_submitted" | "subscribed" | "unsubscribed" | "bounced";
|
|
697
|
+
|
|
698
|
+
export interface ScoringRule extends Stored {
|
|
699
|
+
workspaceUid: string;
|
|
700
|
+
name: string;
|
|
701
|
+
enabled: boolean;
|
|
702
|
+
kind: ScoringKind;
|
|
703
|
+
filter?: FilterNode | null;
|
|
704
|
+
activity?: ScoringActivity | null;
|
|
705
|
+
points: number;
|
|
706
|
+
maxPoints?: number | null;
|
|
707
|
+
withinDays?: number | null;
|
|
708
|
+
}
|
|
709
|
+
|
|
710
|
+
export type SegmentInput = Partial<Pick<Segment, "name" | "description" | "kind" | "filter">>;
|
|
711
|
+
export type ScoringRuleInput = Partial<Pick<ScoringRule, "name" | "enabled" | "kind" | "filter" | "activity" | "points" | "maxPoints" | "withinDays">>;
|
|
712
|
+
|
|
713
|
+
export const listSegments = (workspaceUid: string): Promise<Segment[]> => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}?limit=200`);
|
|
714
|
+
export const createSegment = (workspaceUid: string, input: SegmentInput): Promise<Segment> => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}`, json("POST", input));
|
|
715
|
+
export const updateSegment = (workspaceUid: string, uid: string, input: SegmentInput): Promise<Segment> =>
|
|
716
|
+
apiFetch(`/mail/crm/segments/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
717
|
+
export const deleteSegment = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
718
|
+
export const refreshSegment = (workspaceUid: string, uid: string): Promise<Segment> => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}/${enc(uid)}/refresh`, json("POST", {}));
|
|
719
|
+
export const previewSegment = (workspaceUid: string, filter: FilterNode): Promise<SegmentPreview> =>
|
|
720
|
+
apiFetch(`/mail/crm/segments/${enc(workspaceUid)}/preview`, json("POST", { filter }));
|
|
721
|
+
|
|
722
|
+
export const listScoringRules = (workspaceUid: string): Promise<ScoringRule[]> => apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}?limit=50`);
|
|
723
|
+
export const createScoringRule = (workspaceUid: string, input: ScoringRuleInput): Promise<ScoringRule> =>
|
|
724
|
+
apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}`, json("POST", input));
|
|
725
|
+
export const updateScoringRule = (workspaceUid: string, uid: string, input: ScoringRuleInput): Promise<ScoringRule> =>
|
|
726
|
+
apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
727
|
+
export const deleteScoringRule = (workspaceUid: string, uid: string): Promise<void> =>
|
|
728
|
+
apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
729
|
+
export const recalculateScores = (workspaceUid: string): Promise<{ changed: number }> =>
|
|
730
|
+
apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}/recalculate`, json("POST", {}));
|
|
731
|
+
|
|
732
|
+
// Automations
|
|
733
|
+
|
|
734
|
+
export type NodeType =
|
|
735
|
+
| "trigger"
|
|
736
|
+
| "delay"
|
|
737
|
+
| "wait"
|
|
738
|
+
| "condition"
|
|
739
|
+
| "split"
|
|
740
|
+
| "send_email"
|
|
741
|
+
| "set_field"
|
|
742
|
+
| "add_tag"
|
|
743
|
+
| "remove_tag"
|
|
744
|
+
| "subscribe"
|
|
745
|
+
| "unsubscribe"
|
|
746
|
+
| "create_task"
|
|
747
|
+
| "notify"
|
|
748
|
+
| "enroll"
|
|
749
|
+
| "webhook"
|
|
750
|
+
| "exit";
|
|
751
|
+
|
|
752
|
+
export interface AutomationNode {
|
|
753
|
+
id: string;
|
|
754
|
+
type: NodeType;
|
|
755
|
+
config: Record<string, any>;
|
|
756
|
+
}
|
|
757
|
+
|
|
758
|
+
export interface AutomationEdge {
|
|
759
|
+
from: string;
|
|
760
|
+
to: string;
|
|
761
|
+
port: string;
|
|
762
|
+
}
|
|
763
|
+
|
|
764
|
+
export interface AutomationGraph {
|
|
765
|
+
nodes: AutomationNode[];
|
|
766
|
+
edges: AutomationEdge[];
|
|
767
|
+
}
|
|
768
|
+
|
|
769
|
+
export type AutomationStatus = "draft" | "active" | "paused";
|
|
770
|
+
export type AutomationReentry = "never" | "after_exit";
|
|
771
|
+
export type EnrollmentState = "active" | "waiting" | "completed" | "exited" | "failed";
|
|
772
|
+
|
|
773
|
+
export interface Automation extends Stored {
|
|
774
|
+
workspaceUid: string;
|
|
775
|
+
name: string;
|
|
776
|
+
description?: string | null;
|
|
777
|
+
status: AutomationStatus;
|
|
778
|
+
graph: AutomationGraph;
|
|
779
|
+
reentry: AutomationReentry;
|
|
780
|
+
goalFilter?: FilterNode | null;
|
|
781
|
+
publishedVersionUid?: string | null;
|
|
782
|
+
publishedAt?: string | null;
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
export interface AutomationReport {
|
|
786
|
+
states: Record<EnrollmentState, number>;
|
|
787
|
+
nodes: Record<string, { current: number; sent?: number; opened?: number; clicked?: number; replied?: number }>;
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
export interface Enrollment extends Stored {
|
|
791
|
+
automationUid: string;
|
|
792
|
+
contactUid: string;
|
|
793
|
+
email?: string;
|
|
794
|
+
state: EnrollmentState;
|
|
795
|
+
currentNodeId: string;
|
|
796
|
+
nextRunAt: string;
|
|
797
|
+
enteredAt: string;
|
|
798
|
+
finishedAt?: string | null;
|
|
799
|
+
error?: string | null;
|
|
800
|
+
history: { nodeId: string; at: string; outcome: string }[];
|
|
801
|
+
}
|
|
802
|
+
|
|
803
|
+
export type AutomationInput = Partial<Pick<Automation, "name" | "description" | "graph" | "reentry" | "goalFilter" | "version">>;
|
|
804
|
+
|
|
805
|
+
const automationPath = (workspaceUid: string, suffix: string = "") => `/mail/crm/automations/${enc(workspaceUid)}${suffix}`;
|
|
806
|
+
|
|
807
|
+
export const listAutomations = (workspaceUid: string): Promise<Automation[]> => apiFetch(automationPath(workspaceUid, "?limit=200"));
|
|
808
|
+
export const getAutomation = (workspaceUid: string, uid: string): Promise<Automation> => apiFetch(automationPath(workspaceUid, `/${enc(uid)}`));
|
|
809
|
+
export const createAutomation = (workspaceUid: string, input: AutomationInput): Promise<Automation> => apiFetch(automationPath(workspaceUid), json("POST", input));
|
|
810
|
+
export const updateAutomation = (workspaceUid: string, uid: string, input: AutomationInput): Promise<Automation> =>
|
|
811
|
+
apiFetch(automationPath(workspaceUid, `/${enc(uid)}`), json("PUT", input));
|
|
812
|
+
export const deleteAutomation = (workspaceUid: string, uid: string): Promise<void> => apiFetch(automationPath(workspaceUid, `/${enc(uid)}`), json("DELETE"));
|
|
813
|
+
/** Publishes, pauses or resumes an automation. */
|
|
814
|
+
export const changeAutomation = (workspaceUid: string, uid: string, action: "publish" | "pause" | "resume"): Promise<Automation> =>
|
|
815
|
+
apiFetch(automationPath(workspaceUid, `/${enc(uid)}/${action}`), json("POST", {}));
|
|
816
|
+
export const enrollInAutomation = (workspaceUid: string, uid: string, contactUids: string[]): Promise<{ enrolled: number }> =>
|
|
817
|
+
apiFetch(automationPath(workspaceUid, `/${enc(uid)}/enroll`), json("POST", { contactUids }));
|
|
818
|
+
export const automationReport = (workspaceUid: string, uid: string): Promise<AutomationReport> => apiFetch(automationPath(workspaceUid, `/${enc(uid)}/report`));
|
|
819
|
+
export const listEnrollments = (
|
|
820
|
+
workspaceUid: string,
|
|
821
|
+
uid: string,
|
|
822
|
+
query: { state?: EnrollmentState; contactUid?: string; page: number; limit?: number },
|
|
823
|
+
): Promise<SearchResult<Enrollment>> => apiFetch(automationPath(workspaceUid, `/${enc(uid)}/enrollments`), json("POST", query));
|
|
824
|
+
export const exitEnrollment = (workspaceUid: string, uid: string, enrollmentUid: string): Promise<Enrollment> =>
|
|
825
|
+
apiFetch(automationPath(workspaceUid, `/${enc(uid)}/enrollments/${enc(enrollmentUid)}/exit`), json("POST", {}));
|
|
826
|
+
|
|
827
|
+
// Pipelines and deals
|
|
828
|
+
|
|
829
|
+
export type StageKind = "open" | "won" | "lost";
|
|
830
|
+
export type DealStatus = "open" | "won" | "lost";
|
|
831
|
+
|
|
832
|
+
export interface PipelineStage {
|
|
833
|
+
id: string;
|
|
834
|
+
name: string;
|
|
835
|
+
probability: number;
|
|
836
|
+
kind: StageKind;
|
|
837
|
+
rottingDays?: number | null;
|
|
838
|
+
}
|
|
839
|
+
|
|
840
|
+
export interface Pipeline extends Stored {
|
|
841
|
+
workspaceUid: string;
|
|
842
|
+
name: string;
|
|
843
|
+
stages: PipelineStage[];
|
|
844
|
+
isDefault: boolean;
|
|
845
|
+
}
|
|
846
|
+
|
|
847
|
+
export interface Deal extends Stored {
|
|
848
|
+
workspaceUid: string;
|
|
849
|
+
name: string;
|
|
850
|
+
amount: number;
|
|
851
|
+
currency: string;
|
|
852
|
+
pipelineUid: string;
|
|
853
|
+
stageId: string;
|
|
854
|
+
status: DealStatus;
|
|
855
|
+
ownerUserUid?: string | null;
|
|
856
|
+
contactUids: string[];
|
|
857
|
+
companyUid?: string | null;
|
|
858
|
+
expectedCloseDate?: string | null;
|
|
859
|
+
closedAt?: string | null;
|
|
860
|
+
lostReason?: string | null;
|
|
861
|
+
stageChangedAt: string;
|
|
862
|
+
stageHistory: { stageId: string; at: string; userUid?: string }[];
|
|
863
|
+
}
|
|
864
|
+
|
|
865
|
+
export interface Forecast {
|
|
866
|
+
stages: { stageId: string; count: number; amount: number; weighted: number }[];
|
|
867
|
+
open: { count: number; amount: number; weighted: number };
|
|
868
|
+
won: { count: number; amount: number };
|
|
869
|
+
lost: { count: number; amount: number };
|
|
870
|
+
winRate?: number;
|
|
871
|
+
averageDaysToWin?: number;
|
|
872
|
+
}
|
|
873
|
+
|
|
874
|
+
export type PipelineInput = Partial<Pick<Pipeline, "name" | "isDefault">> & { stages?: Partial<PipelineStage>[] };
|
|
875
|
+
export type DealInput = Partial<
|
|
876
|
+
Pick<Deal, "name" | "amount" | "currency" | "pipelineUid" | "stageId" | "ownerUserUid" | "contactUids" | "companyUid" | "expectedCloseDate" | "lostReason" | "version">
|
|
877
|
+
>;
|
|
878
|
+
|
|
879
|
+
export const listPipelines = (workspaceUid: string): Promise<Pipeline[]> => apiFetch(`/mail/crm/pipelines/${enc(workspaceUid)}?limit=50`);
|
|
880
|
+
export const createPipeline = (workspaceUid: string, input: PipelineInput): Promise<Pipeline> => apiFetch(`/mail/crm/pipelines/${enc(workspaceUid)}`, json("POST", input));
|
|
881
|
+
export const updatePipeline = (workspaceUid: string, uid: string, input: PipelineInput): Promise<Pipeline> =>
|
|
882
|
+
apiFetch(`/mail/crm/pipelines/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
883
|
+
export const deletePipeline = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/pipelines/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
884
|
+
|
|
885
|
+
/** A pipeline's deals, or a contact's (`contactUid`). */
|
|
886
|
+
export function listDeals(workspaceUid: string, query: { pipelineUid?: string; status?: DealStatus; ownerUserUid?: string; contactUid?: string } = {}): Promise<Deal[]> {
|
|
887
|
+
const params = new URLSearchParams({ limit: "200" });
|
|
888
|
+
for (const [key, value] of Object.entries(query)) {
|
|
889
|
+
if (value) {
|
|
890
|
+
params.set(key, value);
|
|
891
|
+
}
|
|
892
|
+
}
|
|
893
|
+
return apiFetch(`/mail/crm/deals/${enc(workspaceUid)}?${params.toString()}`);
|
|
894
|
+
}
|
|
895
|
+
export const getDeal = (workspaceUid: string, uid: string): Promise<Deal> => apiFetch(`/mail/crm/deals/${enc(workspaceUid)}/${enc(uid)}`);
|
|
896
|
+
export const createDeal = (workspaceUid: string, input: DealInput): Promise<Deal> => apiFetch(`/mail/crm/deals/${enc(workspaceUid)}`, json("POST", input));
|
|
897
|
+
export const updateDeal = (workspaceUid: string, uid: string, input: DealInput): Promise<Deal> => apiFetch(`/mail/crm/deals/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
898
|
+
export const deleteDeal = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/deals/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
899
|
+
export const dealForecast = (workspaceUid: string, pipelineUid: string, days: number = 90): Promise<Forecast> =>
|
|
900
|
+
apiFetch(`/mail/crm/deals/${enc(workspaceUid)}/forecast?pipelineUid=${enc(pipelineUid)}&days=${days}`);
|
|
901
|
+
|
|
902
|
+
// Reports
|
|
903
|
+
|
|
904
|
+
export interface EmailDay {
|
|
905
|
+
date: string;
|
|
906
|
+
sent: number;
|
|
907
|
+
opened: number;
|
|
908
|
+
clicked: number;
|
|
909
|
+
replied: number;
|
|
910
|
+
bounced: number;
|
|
911
|
+
unsubscribed: number;
|
|
912
|
+
}
|
|
913
|
+
|
|
914
|
+
export interface EmailReport {
|
|
915
|
+
days: EmailDay[];
|
|
916
|
+
totals: { sent: number; opened: number; clicked: number; replied: number; bounced: number; unsubscribed: number; complained: number };
|
|
917
|
+
domains: { domain: string; sent: number; opened: number; clicked: number }[];
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
export interface GrowthReport {
|
|
921
|
+
days: { date: string; contacts: number; subscribed: number; unsubscribed: number }[];
|
|
922
|
+
contacts: number;
|
|
923
|
+
lists: { uid: string; name: string; subscribed: number }[];
|
|
924
|
+
}
|
|
925
|
+
|
|
926
|
+
export interface SalesReport {
|
|
927
|
+
days: { date: string; created: number; won: number; wonAmount: number; lost: number }[];
|
|
928
|
+
open: { count: number; amount: number };
|
|
929
|
+
won: { count: number; amount: number };
|
|
930
|
+
lost: number;
|
|
931
|
+
}
|
|
932
|
+
|
|
933
|
+
export const emailReport = (workspaceUid: string, days: number): Promise<EmailReport> => apiFetch(`/mail/crm/analytics/${enc(workspaceUid)}/email?days=${days}`);
|
|
934
|
+
export const growthReport = (workspaceUid: string, days: number): Promise<GrowthReport> => apiFetch(`/mail/crm/analytics/${enc(workspaceUid)}/growth?days=${days}`);
|
|
935
|
+
export const salesReport = (workspaceUid: string, days: number, pipelineUid?: string): Promise<SalesReport> =>
|
|
936
|
+
apiFetch(`/mail/crm/analytics/${enc(workspaceUid)}/sales?days=${days}${pipelineUid ? `&pipelineUid=${enc(pipelineUid)}` : ""}`);
|
|
937
|
+
|
|
938
|
+
// Webhooks and API keys
|
|
939
|
+
|
|
940
|
+
export interface WebhookEndpoint extends Stored {
|
|
941
|
+
workspaceUid: string;
|
|
942
|
+
url: string;
|
|
943
|
+
events: string[];
|
|
944
|
+
enabled: boolean;
|
|
945
|
+
description?: string | null;
|
|
946
|
+
failureCount: number;
|
|
947
|
+
lastDeliveryAt?: string;
|
|
948
|
+
lastError?: string | null;
|
|
949
|
+
secretHint: string;
|
|
950
|
+
/** Only when it was just made. */
|
|
951
|
+
secret?: string;
|
|
952
|
+
}
|
|
953
|
+
|
|
954
|
+
export type WebhookDeliveryStatus = "pending" | "delivered" | "failed";
|
|
955
|
+
|
|
956
|
+
export interface WebhookDelivery extends Stored {
|
|
957
|
+
endpointUid: string;
|
|
958
|
+
eventType: string;
|
|
959
|
+
status: WebhookDeliveryStatus;
|
|
960
|
+
attempts: number;
|
|
961
|
+
responseStatus?: number;
|
|
962
|
+
lastError?: string | null;
|
|
963
|
+
deliveredAt?: string;
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
/** The event types an endpoint can take (besides `*`, all of them). */
|
|
967
|
+
export const WEBHOOK_EVENTS: readonly string[] = [
|
|
968
|
+
"contact.created",
|
|
969
|
+
"contact.updated",
|
|
970
|
+
"list.subscribed",
|
|
971
|
+
"list.unsubscribed",
|
|
972
|
+
"form.submitted",
|
|
973
|
+
"segment.entered",
|
|
974
|
+
"segment.left",
|
|
975
|
+
"email.sent",
|
|
976
|
+
"email.opened",
|
|
977
|
+
"email.clicked",
|
|
978
|
+
"email.replied",
|
|
979
|
+
"email.bounced",
|
|
980
|
+
"email.unsubscribed",
|
|
981
|
+
"deal.created",
|
|
982
|
+
"deal.stage_changed",
|
|
983
|
+
"deal.won",
|
|
984
|
+
"deal.lost",
|
|
985
|
+
"custom",
|
|
986
|
+
"automation.webhook",
|
|
987
|
+
];
|
|
988
|
+
|
|
989
|
+
export type WebhookInput = { url?: string; events?: string[]; enabled?: boolean; description?: string | null };
|
|
990
|
+
|
|
991
|
+
export const listWebhooks = (workspaceUid: string): Promise<WebhookEndpoint[]> => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}?limit=50`);
|
|
992
|
+
export const createWebhook = (workspaceUid: string, input: WebhookInput): Promise<WebhookEndpoint> => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}`, json("POST", input));
|
|
993
|
+
export const updateWebhook = (workspaceUid: string, uid: string, input: WebhookInput): Promise<WebhookEndpoint> =>
|
|
994
|
+
apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
995
|
+
export const deleteWebhook = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
996
|
+
export const rotateWebhookSecret = (workspaceUid: string, uid: string): Promise<{ secret: string }> =>
|
|
997
|
+
apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}/secret`, json("POST"));
|
|
998
|
+
export const testWebhook = (workspaceUid: string, uid: string): Promise<{ status?: number; error?: string }> =>
|
|
999
|
+
apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}/test`, json("POST"));
|
|
1000
|
+
export const webhookDeliveries = (workspaceUid: string, uid: string): Promise<WebhookDelivery[]> => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}/deliveries`);
|
|
1001
|
+
|
|
1002
|
+
export type ApiKeyScope = "contacts" | "subscriptions" | "events";
|
|
1003
|
+
export const API_KEY_SCOPES: readonly ApiKeyScope[] = ["contacts", "subscriptions", "events"];
|
|
1004
|
+
|
|
1005
|
+
export interface ApiKey extends Stored {
|
|
1006
|
+
workspaceUid: string;
|
|
1007
|
+
name: string;
|
|
1008
|
+
prefix: string;
|
|
1009
|
+
scopes: ApiKeyScope[];
|
|
1010
|
+
lastUsedAt?: string;
|
|
1011
|
+
createdByUserUid: string;
|
|
1012
|
+
/** Only when it was just made. */
|
|
1013
|
+
key?: string;
|
|
1014
|
+
}
|
|
1015
|
+
|
|
1016
|
+
export const listApiKeys = (workspaceUid: string): Promise<ApiKey[]> => apiFetch(`/mail/crm/api-keys/${enc(workspaceUid)}?limit=50`);
|
|
1017
|
+
export const createApiKey = (workspaceUid: string, input: { name: string; scopes: ApiKeyScope[] }): Promise<ApiKey> =>
|
|
1018
|
+
apiFetch(`/mail/crm/api-keys/${enc(workspaceUid)}`, json("POST", input));
|
|
1019
|
+
export const updateApiKey = (workspaceUid: string, uid: string, input: { name?: string; scopes?: ApiKeyScope[] }): Promise<ApiKey> =>
|
|
1020
|
+
apiFetch(`/mail/crm/api-keys/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
|
|
1021
|
+
export const deleteApiKey = (workspaceUid: string, uid: string): Promise<void> => apiFetch(`/mail/crm/api-keys/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
|
|
1022
|
+
|
|
1023
|
+
// Deployment administration
|
|
1024
|
+
|
|
1025
|
+
export interface AdminWorkspace {
|
|
1026
|
+
uid: string;
|
|
1027
|
+
name: string;
|
|
1028
|
+
dateCreated: string;
|
|
1029
|
+
members: number;
|
|
1030
|
+
contacts: number;
|
|
1031
|
+
campaignsSent: number;
|
|
1032
|
+
sendingDisabled: boolean;
|
|
1033
|
+
}
|
|
1034
|
+
|
|
1035
|
+
export interface AdminStats {
|
|
1036
|
+
workspaces: number;
|
|
1037
|
+
contacts: number;
|
|
1038
|
+
sentLastDay: number;
|
|
1039
|
+
queued: number;
|
|
1040
|
+
}
|
|
1041
|
+
|
|
1042
|
+
export const adminStats = (): Promise<AdminStats> => apiFetch("/mail/crm/admin/stats");
|
|
1043
|
+
export const adminWorkspaces = (page: number, limit: number = 50): Promise<{ items: AdminWorkspace[]; total: number }> =>
|
|
1044
|
+
apiFetch(`/mail/crm/admin/workspaces?limit=${limit}&page=${page}`);
|
|
1045
|
+
export const setWorkspaceSending = (uid: string, sendingDisabled: boolean): Promise<{ uid: string; sendingDisabled: boolean }> =>
|
|
1046
|
+
apiFetch(`/mail/crm/admin/workspaces/${enc(uid)}`, json("PUT", { sendingDisabled }));
|