@corsair-dev/activecampaign 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +334 -0
  2. package/package.json +9 -3
package/README.md ADDED
@@ -0,0 +1,334 @@
1
+ # @corsair-dev/activecampaign
2
+
3
+ ActiveCampaign plugin for Corsair.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ pnpm add @corsair-dev/activecampaign
9
+ ```
10
+
11
+ ## Endpoints
12
+
13
+ | Operation | Operation ID | Risk | Description |
14
+ |-----------|--------------|------|-------------|
15
+ | `accountContacts.create` | `activecampaign.api.accountContacts.create` | `write` | Link a contact to an account with an optional job title |
16
+ | `accountContacts.delete` | `activecampaign.api.accountContacts.delete` | `destructive` | Remove the link between an account and a contact |
17
+ | `accountContacts.get` | `activecampaign.api.accountContacts.get` | `read` | Retrieve an account-contact association by its ID |
18
+ | `accountContacts.list` | `activecampaign.api.accountContacts.list` | `read` | List associations between accounts and contacts |
19
+ | `accountContacts.update` | `activecampaign.api.accountContacts.update` | `write` | Update an account-contact association |
20
+ | `accountCustomFieldData.create` | `activecampaign.api.accountCustomFieldData.create` | `write` | Set a custom field value on an account |
21
+ | `accountCustomFieldData.createBulk` | `activecampaign.api.accountCustomFieldData.createBulk` | `write` | Set many account custom field values in one request |
22
+ | `accountCustomFieldData.delete` | `activecampaign.api.accountCustomFieldData.delete` | `destructive` | Delete a custom field value from an account |
23
+ | `accountCustomFieldData.get` | `activecampaign.api.accountCustomFieldData.get` | `read` | Retrieve an account custom field value by its ID |
24
+ | `accountCustomFieldData.list` | `activecampaign.api.accountCustomFieldData.list` | `read` | List custom field values stored against accounts |
25
+ | `accountCustomFieldData.update` | `activecampaign.api.accountCustomFieldData.update` | `write` | Update a custom field value on an account |
26
+ | `accountCustomFieldData.updateBulk` | `activecampaign.api.accountCustomFieldData.updateBulk` | `write` | Update many account custom field values in one request |
27
+ | `accountCustomFieldMeta.create` | `activecampaign.api.accountCustomFieldMeta.create` | `write` | Define a new custom field for accounts |
28
+ | `accountCustomFieldMeta.delete` | `activecampaign.api.accountCustomFieldMeta.delete` | `destructive` | Delete an account custom field definition |
29
+ | `accountCustomFieldMeta.get` | `activecampaign.api.accountCustomFieldMeta.get` | `read` | Retrieve an account custom field definition by its ID |
30
+ | `accountCustomFieldMeta.list` | `activecampaign.api.accountCustomFieldMeta.list` | `read` | List custom field definitions for accounts |
31
+ | `accountCustomFieldMeta.update` | `activecampaign.api.accountCustomFieldMeta.update` | `write` | Update an account custom field definition |
32
+ | `accounts.create` | `activecampaign.api.accounts.create` | `write` | Create a CRM account with a unique name |
33
+ | `accounts.delete` | `activecampaign.api.accounts.delete` | `destructive` | Delete a CRM account and its associated data |
34
+ | `accounts.deleteBulk` | `activecampaign.api.accounts.deleteBulk` | `destructive` | Delete many CRM accounts in one request |
35
+ | `accounts.get` | `activecampaign.api.accounts.get` | `read` | Retrieve a CRM account by its ID |
36
+ | `accounts.list` | `activecampaign.api.accounts.list` | `read` | List CRM accounts, optionally filtered by name |
37
+ | `accounts.update` | `activecampaign.api.accounts.update` | `write` | Update an existing CRM account by its ID |
38
+ | `accounts.upsert` | `activecampaign.api.accounts.upsert` | `write` | Create a CRM account, or update the one with the same name |
39
+ | `activities.list` | `activecampaign.api.activities.list` | `read` | List account activity, optionally narrowed to one contact |
40
+ | `addresses.create` | `activecampaign.api.addresses.create` | `write` | Create a company address for campaign footers |
41
+ | `addresses.delete` | `activecampaign.api.addresses.delete` | `destructive` | Delete a company address by its ID |
42
+ | `addresses.get` | `activecampaign.api.addresses.get` | `read` | Retrieve a company address by its ID |
43
+ | `addresses.list` | `activecampaign.api.addresses.list` | `read` | List the company addresses used in campaigns |
44
+ | `addresses.update` | `activecampaign.api.addresses.update` | `write` | Update an existing company address |
45
+ | `addressGroups.delete` | `activecampaign.api.addressGroups.delete` | `destructive` | Delete an address group by its ID |
46
+ | `automations.list` | `activecampaign.api.automations.list` | `read` | List automation workflows |
47
+ | `brandings.get` | `activecampaign.api.brandings.get` | `read` | Retrieve a branding configuration by its ID |
48
+ | `brandings.update` | `activecampaign.api.brandings.update` | `write` | Update branding such as site name, logo and favicon |
49
+ | `browseSessions.addToCart` | `activecampaign.api.browseSessions.addToCart` | `write` | Flag a browse session as having items added to cart |
50
+ | `browseSessions.save` | `activecampaign.api.browseSessions.save` | `write` | Create a browse session in a specified state |
51
+ | `browseSessions.search` | `activecampaign.api.browseSessions.search` | `read` | Search browse sessions for a contact and connection |
52
+ | `browseSessions.testEvent` | `activecampaign.api.browseSessions.testEvent` | `write` | Simulate a tracking event and return its debug output |
53
+ | `calendars.create` | `activecampaign.api.calendars.create` | `write` | Create a calendar feed for external calendar apps |
54
+ | `calendars.delete` | `activecampaign.api.calendars.delete` | `destructive` | Delete a calendar feed by its ID |
55
+ | `calendars.get` | `activecampaign.api.calendars.get` | `read` | Retrieve a calendar feed by its ID |
56
+ | `calendars.list` | `activecampaign.api.calendars.list` | `read` | List calendar feeds configured on the account |
57
+ | `calendars.update` | `activecampaign.api.calendars.update` | `write` | Update a calendar feed by its ID |
58
+ | `campaigns.create` | `activecampaign.api.campaigns.create` | `write` | Create a broadcast or automation campaign |
59
+ | `campaigns.duplicate` | `activecampaign.api.campaigns.duplicate` | `write` | Duplicate a campaign with its content and configuration |
60
+ | `campaigns.get` | `activecampaign.api.campaigns.get` | `read` | Retrieve a campaign by its ID with engagement metrics |
61
+ | `campaigns.getAutomationLists` | `activecampaign.api.campaigns.getAutomationLists` | `read` | List the lists a campaign automation sends to |
62
+ | `campaigns.getAutomations` | `activecampaign.api.campaigns.getAutomations` | `read` | List automations linked to a campaign |
63
+ | `campaigns.getLinks` | `activecampaign.api.campaigns.getLinks` | `read` | List the tracked links belonging to a campaign |
64
+ | `campaigns.getMessages` | `activecampaign.api.campaigns.getMessages` | `read` | List the messages attached to a campaign |
65
+ | `campaigns.getUser` | `activecampaign.api.campaigns.getUser` | `read` | Retrieve the user who owns a campaign |
66
+ | `campaigns.list` | `activecampaign.api.campaigns.list` | `read` | List campaigns with pagination and filters |
67
+ | `campaigns.update` | `activecampaign.api.campaigns.update` | `write` | Edit an existing campaign, such as its name |
68
+ | `configs.update` | `activecampaign.api.configs.update` | `write` | Update an account configuration value |
69
+ | `connections.create` | `activecampaign.api.connections.create` | `write` | Create a connection to an external e-commerce service |
70
+ | `connections.delete` | `activecampaign.api.connections.delete` | `destructive` | Delete a connection by its ID |
71
+ | `connections.get` | `activecampaign.api.connections.get` | `read` | Retrieve a connection by its ID |
72
+ | `connections.list` | `activecampaign.api.connections.list` | `read` | List Deep Data connections to external services |
73
+ | `connections.update` | `activecampaign.api.connections.update` | `write` | Update an existing connection |
74
+ | `contactAutomations.add` | `activecampaign.api.contactAutomations.add` | `write` | Enrol a contact in an automation by email address |
75
+ | `contactAutomations.entryCounts` | `activecampaign.api.contactAutomations.entryCounts` | `read` | Count how many times a contact entered each automation |
76
+ | `contactAutomations.get` | `activecampaign.api.contactAutomations.get` | `read` | Retrieve a contact automation enrolment by its ID |
77
+ | `contactAutomations.list` | `activecampaign.api.contactAutomations.list` | `read` | List contact enrolments across automations |
78
+ | `contactAutomations.remove` | `activecampaign.api.contactAutomations.remove` | `destructive` | Remove a contact from an automation, one run or all |
79
+ | `contactDeals.create` | `activecampaign.api.contactDeals.create` | `write` | Add a secondary contact to a deal |
80
+ | `contactDeals.delete` | `activecampaign.api.contactDeals.delete` | `destructive` | Remove a secondary contact from a deal |
81
+ | `contactDeals.get` | `activecampaign.api.contactDeals.get` | `read` | Retrieve a secondary contact association by its ID |
82
+ | `contactDeals.list` | `activecampaign.api.contactDeals.list` | `read` | List secondary contacts associated with deals |
83
+ | `contactDeals.update` | `activecampaign.api.contactDeals.update` | `write` | Update a secondary contact association |
84
+ | `contactLists.list` | `activecampaign.api.contactLists.list` | `read` | List all contact-to-list memberships |
85
+ | `contacts.createOrUpdate` | `activecampaign.api.contacts.createOrUpdate` | `write` | Create a contact, or update it if the email already exists |
86
+ | `contacts.delete` | `activecampaign.api.contacts.delete` | `destructive` | Delete a contact by its ID |
87
+ | `contacts.find` | `activecampaign.api.contacts.find` | `read` | Find a contact by email address |
88
+ | `contacts.get` | `activecampaign.api.contacts.get` | `read` | Retrieve a contact by its ID |
89
+ | `contacts.getAccountContacts` | `activecampaign.api.contacts.getAccountContacts` | `read` | List the accounts a contact is associated with |
90
+ | `contacts.getAutomations` | `activecampaign.api.contacts.getAutomations` | `read` | List the automations a contact is enrolled in |
91
+ | `contacts.getData` | `activecampaign.api.contacts.getData` | `read` | Retrieve the geographic and tracking data of a contact |
92
+ | `contacts.getDeals` | `activecampaign.api.contacts.getDeals` | `read` | List the deals associated with a contact |
93
+ | `contacts.getFieldValues` | `activecampaign.api.contacts.getFieldValues` | `read` | List the custom field values of a contact |
94
+ | `contacts.getGeoIps` | `activecampaign.api.contacts.getGeoIps` | `read` | List the geo IP records associated with a contact |
95
+ | `contacts.getGoals` | `activecampaign.api.contacts.getGoals` | `read` | List the automation goals a contact has completed |
96
+ | `contacts.getLists` | `activecampaign.api.contacts.getLists` | `read` | List the list memberships of a contact |
97
+ | `contacts.getLogs` | `activecampaign.api.contacts.getLogs` | `read` | List the activity log entries for a contact |
98
+ | `contacts.getNotes` | `activecampaign.api.contacts.getNotes` | `read` | List the notes attached to a contact |
99
+ | `contacts.getOrganization` | `activecampaign.api.contacts.getOrganization` | `read` | Retrieve the organization a contact belongs to |
100
+ | `contacts.getPlusAppend` | `activecampaign.api.contacts.getPlusAppend` | `read` | Retrieve third-party enrichment data for a contact |
101
+ | `contacts.getScoreValues` | `activecampaign.api.contacts.getScoreValues` | `read` | List the score values of a contact |
102
+ | `contacts.getTags` | `activecampaign.api.contacts.getTags` | `read` | List the tags applied to a contact |
103
+ | `contacts.getTrackingLogs` | `activecampaign.api.contacts.getTrackingLogs` | `read` | List site and event tracking records for a contact |
104
+ | `contacts.list` | `activecampaign.api.contacts.list` | `read` | List contacts with pagination and filters |
105
+ | `contacts.update` | `activecampaign.api.contacts.update` | `write` | Update an existing contact by its ID |
106
+ | `contactTags.list` | `activecampaign.api.contactTags.list` | `read` | List all contact-to-tag associations |
107
+ | `contactTasks.create` | `activecampaign.api.contactTasks.create` | `write` | Create a task against a contact |
108
+ | `contactTasks.find` | `activecampaign.api.contactTasks.find` | `read` | Find contact tasks by title, optionally for one contact |
109
+ | `customObjectRecords.delete` | `activecampaign.api.customObjectRecords.delete` | `destructive` | Delete a custom object record by its ID |
110
+ | `customObjectRecords.deleteByExternalId` | `activecampaign.api.customObjectRecords.deleteByExternalId` | `destructive` | Delete a custom object record by its external ID |
111
+ | `customObjectRecords.get` | `activecampaign.api.customObjectRecords.get` | `read` | Retrieve a custom object record by its ID |
112
+ | `customObjectRecords.getByExternalId` | `activecampaign.api.customObjectRecords.getByExternalId` | `read` | Retrieve a custom object record by its external ID |
113
+ | `customObjectRecords.list` | `activecampaign.api.customObjectRecords.list` | `read` | List the records belonging to a custom object schema |
114
+ | `customObjectRecords.upsert` | `activecampaign.api.customObjectRecords.upsert` | `write` | Create or update a custom object record by external ID |
115
+ | `customObjectSchemas.create` | `activecampaign.api.customObjectSchemas.create` | `write` | Create a custom object schema |
116
+ | `customObjectSchemas.createChild` | `activecampaign.api.customObjectSchemas.createChild` | `write` | Create a child schema under a public parent schema |
117
+ | `customObjectSchemas.delete` | `activecampaign.api.customObjectSchemas.delete` | `destructive` | Delete a custom object schema and all its records |
118
+ | `customObjectSchemas.get` | `activecampaign.api.customObjectSchemas.get` | `read` | Retrieve a custom object schema by its ID |
119
+ | `customObjectSchemas.list` | `activecampaign.api.customObjectSchemas.list` | `read` | List custom object schema definitions |
120
+ | `customObjectSchemas.update` | `activecampaign.api.customObjectSchemas.update` | `write` | Update a custom object schema or add field options |
121
+ | `dealActivities.list` | `activecampaign.api.dealActivities.list` | `read` | List recent activity across deals |
122
+ | `dealCustomFieldData.delete` | `activecampaign.api.dealCustomFieldData.delete` | `destructive` | Delete a custom field value from a deal |
123
+ | `dealCustomFieldData.get` | `activecampaign.api.dealCustomFieldData.get` | `read` | Retrieve a deal custom field value by its ID |
124
+ | `dealCustomFieldData.list` | `activecampaign.api.dealCustomFieldData.list` | `read` | List custom field values stored against deals |
125
+ | `dealCustomFieldData.update` | `activecampaign.api.dealCustomFieldData.update` | `write` | Update a custom field value on a deal |
126
+ | `dealCustomFieldMeta.create` | `activecampaign.api.dealCustomFieldMeta.create` | `write` | Create a custom field definition for deals |
127
+ | `dealCustomFieldMeta.delete` | `activecampaign.api.dealCustomFieldMeta.delete` | `destructive` | Delete a deal custom field definition |
128
+ | `dealCustomFieldMeta.get` | `activecampaign.api.dealCustomFieldMeta.get` | `read` | Retrieve a deal custom field definition by its ID |
129
+ | `dealCustomFieldMeta.list` | `activecampaign.api.dealCustomFieldMeta.list` | `read` | List custom field definitions for deals |
130
+ | `dealCustomFieldMeta.update` | `activecampaign.api.dealCustomFieldMeta.update` | `write` | Update a deal custom field definition |
131
+ | `dealGroups.create` | `activecampaign.api.dealGroups.create` | `write` | Create a deal pipeline with its three default stages |
132
+ | `dealGroups.delete` | `activecampaign.api.dealGroups.delete` | `destructive` | Delete a pipeline and every stage and deal in it |
133
+ | `dealGroups.get` | `activecampaign.api.dealGroups.get` | `read` | Retrieve a deal pipeline by its ID |
134
+ | `dealGroups.list` | `activecampaign.api.dealGroups.list` | `read` | List deal pipelines, optionally filtered by title |
135
+ | `dealGroups.update` | `activecampaign.api.dealGroups.update` | `write` | Update a deal pipeline by its ID |
136
+ | `dealRoles.create` | `activecampaign.api.dealRoles.create` | `write` | Create a deal role such as Decision Maker |
137
+ | `dealRoles.delete` | `activecampaign.api.dealRoles.delete` | `destructive` | Delete a deal role by its ID |
138
+ | `dealRoles.list` | `activecampaign.api.dealRoles.list` | `read` | List the roles a contact can hold on a deal |
139
+ | `deals.delete` | `activecampaign.api.deals.delete` | `destructive` | Delete a deal by its ID |
140
+ | `deals.get` | `activecampaign.api.deals.get` | `read` | Retrieve a deal by its ID |
141
+ | `deals.list` | `activecampaign.api.deals.list` | `read` | List deals with pagination and filters |
142
+ | `deals.listFiltered` | `activecampaign.api.deals.listFiltered` | `read` | Search deals by title or filter by stage, pipeline, owner or status |
143
+ | `deals.update` | `activecampaign.api.deals.update` | `write` | Update an existing deal by its ID |
144
+ | `deals.updateOwnersBulk` | `activecampaign.api.deals.updateOwnersBulk` | `write` | Reassign many deals to new owners in one request |
145
+ | `dealStages.create` | `activecampaign.api.dealStages.create` | `write` | Create a stage in a deal pipeline |
146
+ | `dealStages.delete` | `activecampaign.api.dealStages.delete` | `destructive` | Delete a pipeline stage by its ID |
147
+ | `dealStages.deleteWithDeals` | `activecampaign.api.dealStages.deleteWithDeals` | `destructive` | Delete a stage, optionally relocating its deals first |
148
+ | `dealStages.get` | `activecampaign.api.dealStages.get` | `read` | Retrieve a pipeline stage by its ID |
149
+ | `dealStages.list` | `activecampaign.api.dealStages.list` | `read` | List deal pipeline stages |
150
+ | `dealStages.moveDeals` | `activecampaign.api.dealStages.moveDeals` | `write` | Move every deal in one stage to another stage |
151
+ | `dealStages.update` | `activecampaign.api.dealStages.update` | `write` | Update a pipeline stage by its ID |
152
+ | `dealTasks.create` | `activecampaign.api.dealTasks.create` | `write` | Create a task against a deal, contact or account |
153
+ | `dealTasks.delete` | `activecampaign.api.dealTasks.delete` | `destructive` | Delete a deal task by its ID |
154
+ | `dealTasks.get` | `activecampaign.api.dealTasks.get` | `read` | Retrieve a deal task by its ID |
155
+ | `dealTasks.list` | `activecampaign.api.dealTasks.list` | `read` | List deal tasks with pagination |
156
+ | `dealTasks.update` | `activecampaign.api.dealTasks.update` | `write` | Update an existing deal task by its ID |
157
+ | `dealTaskTypes.create` | `activecampaign.api.dealTaskTypes.create` | `write` | Create a task type for categorising deal tasks |
158
+ | `dealTaskTypes.get` | `activecampaign.api.dealTaskTypes.get` | `read` | Retrieve a deal task type by its ID |
159
+ | `dealTaskTypes.list` | `activecampaign.api.dealTaskTypes.list` | `read` | List the task types available for deals |
160
+ | `dealTaskTypes.update` | `activecampaign.api.dealTaskTypes.update` | `write` | Update a deal task type by its ID |
161
+ | `ecomCustomers.create` | `activecampaign.api.ecomCustomers.create` | `write` | Register an e-commerce customer against a connection |
162
+ | `ecomCustomers.delete` | `activecampaign.api.ecomCustomers.delete` | `destructive` | Delete an e-commerce customer and its data |
163
+ | `ecomCustomers.get` | `activecampaign.api.ecomCustomers.get` | `read` | Retrieve an e-commerce customer by its ID |
164
+ | `ecomCustomers.list` | `activecampaign.api.ecomCustomers.list` | `read` | List e-commerce customers with revenue metrics |
165
+ | `ecomCustomers.update` | `activecampaign.api.ecomCustomers.update` | `write` | Update an e-commerce customer record |
166
+ | `ecomOrderProducts.get` | `activecampaign.api.ecomOrderProducts.get` | `read` | Retrieve an order product line by its ID |
167
+ | `ecomOrderProducts.list` | `activecampaign.api.ecomOrderProducts.list` | `read` | List the products attached to e-commerce orders |
168
+ | `ecomOrderProducts.listForOrder` | `activecampaign.api.ecomOrderProducts.listForOrder` | `read` | List the product lines belonging to one order |
169
+ | `ecomOrders.create` | `activecampaign.api.ecomOrders.create` | `write` | Record an e-commerce order for automation triggers |
170
+ | `ecomOrders.delete` | `activecampaign.api.ecomOrders.delete` | `destructive` | Delete an e-commerce order by its ID |
171
+ | `ecomOrders.find` | `activecampaign.api.ecomOrders.find` | `read` | Find one order by its store order ID within a connection |
172
+ | `ecomOrders.get` | `activecampaign.api.ecomOrders.get` | `read` | Retrieve an e-commerce order by its ID |
173
+ | `ecomOrders.list` | `activecampaign.api.ecomOrders.list` | `read` | List e-commerce orders with pagination |
174
+ | `ecomOrders.update` | `activecampaign.api.ecomOrders.update` | `write` | Update an existing e-commerce order |
175
+ | `ecomOrders.upsert` | `activecampaign.api.ecomOrders.upsert` | `write` | Create an order, or update the one with the same store order ID. Concurrent upserts for the same connectionid and externalid can duplicate; serialize them or use orders.upsertBulk |
176
+ | `emailActivities.list` | `activecampaign.api.emailActivities.list` | `read` | List email activity for a subscriber or deal |
177
+ | `eventTrackingEvents.create` | `activecampaign.api.eventTrackingEvents.create` | `write` | Whitelist a new event name for tracking |
178
+ | `eventTrackingEvents.delete` | `activecampaign.api.eventTrackingEvents.delete` | `destructive` | Remove an event name from the tracking whitelist |
179
+ | `eventTrackingEvents.list` | `activecampaign.api.eventTrackingEvents.list` | `read` | List the whitelisted event tracking event names |
180
+ | `fieldOptions.createBulk` | `activecampaign.api.fieldOptions.createBulk` | `write` | Create options in bulk for a dropdown or listbox field |
181
+ | `fieldRels.create` | `activecampaign.api.fieldRels.create` | `write` | Associate a custom field with a list |
182
+ | `fieldRels.delete` | `activecampaign.api.fieldRels.delete` | `destructive` | Remove the association between a custom field and a list |
183
+ | `fieldRels.list` | `activecampaign.api.fieldRels.list` | `read` | List relationships between custom fields and lists |
184
+ | `fields.create` | `activecampaign.api.fields.create` | `write` | Create a new custom contact field |
185
+ | `fields.delete` | `activecampaign.api.fields.delete` | `destructive` | Delete a custom field and every value stored against it |
186
+ | `fields.get` | `activecampaign.api.fields.get` | `read` | Retrieve a custom field definition by its ID |
187
+ | `fields.list` | `activecampaign.api.fields.list` | `read` | List custom field definitions with pagination |
188
+ | `fields.update` | `activecampaign.api.fields.update` | `write` | Update an existing custom field definition |
189
+ | `fieldValues.delete` | `activecampaign.api.fieldValues.delete` | `destructive` | Delete a custom field value by its ID |
190
+ | `fieldValues.get` | `activecampaign.api.fieldValues.get` | `read` | Retrieve a single custom field value by its ID |
191
+ | `fieldValues.list` | `activecampaign.api.fieldValues.list` | `read` | List custom field values across all contacts |
192
+ | `fieldValues.setForContact` | `activecampaign.api.fieldValues.setForContact` | `write` | Set a custom field value on a contact |
193
+ | `fieldValues.update` | `activecampaign.api.fieldValues.update` | `write` | Update an existing custom field value by its ID |
194
+ | `forms.createOptin` | `activecampaign.api.forms.createOptin` | `write` | Record a form opt-in on behalf of a contact |
195
+ | `forms.delete` | `activecampaign.api.forms.delete` | `destructive` | Delete a form and its associated data |
196
+ | `forms.get` | `activecampaign.api.forms.get` | `read` | Retrieve a form by its ID |
197
+ | `forms.list` | `activecampaign.api.forms.list` | `read` | List forms with their field configuration |
198
+ | `groupLimits.list` | `activecampaign.api.groupLimits.list` | `read` | List the resource limits configured per group |
199
+ | `groupMembers.create` | `activecampaign.api.groupMembers.create` | `write` | Add a custom field to a display group so it becomes visible |
200
+ | `groupMembers.delete` | `activecampaign.api.groupMembers.delete` | `destructive` | Remove a custom field from its display group |
201
+ | `groupMembers.list` | `activecampaign.api.groupMembers.list` | `read` | List which custom fields belong to which display groups |
202
+ | `groupMembers.update` | `activecampaign.api.groupMembers.update` | `write` | Change the display group or ordering of a custom field |
203
+ | `groups.create` | `activecampaign.api.groups.create` | `write` | Create a permission group |
204
+ | `groups.delete` | `activecampaign.api.groups.delete` | `destructive` | Delete a permission group by its ID |
205
+ | `groups.get` | `activecampaign.api.groups.get` | `read` | Retrieve a permission group by its ID |
206
+ | `groups.list` | `activecampaign.api.groups.list` | `read` | List permission groups with their settings |
207
+ | `groups.update` | `activecampaign.api.groups.update` | `write` | Update a permission group title or description |
208
+ | `imports.createBulk` | `activecampaign.api.imports.createBulk` | `write` | Queue up to 250 contacts per call (payload under 400 KB) for asynchronous import |
209
+ | `imports.getStatus` | `activecampaign.api.imports.getStatus` | `read` | Retrieve the progress of a single import batch by its ID |
210
+ | `imports.list` | `activecampaign.api.imports.list` | `read` | List outstanding and recently completed import batches |
211
+ | `imports.listAggregate` | `activecampaign.api.imports.listAggregate` | `read` | Retrieve aggregate progress across all bulk import batches |
212
+ | `listGroups.create` | `activecampaign.api.listGroups.create` | `write` | Grant a user group permissions over a mailing list |
213
+ | `lists.create` | `activecampaign.api.lists.create` | `write` | Create a new mailing list |
214
+ | `lists.delete` | `activecampaign.api.lists.delete` | `destructive` | Delete a mailing list by its ID |
215
+ | `lists.get` | `activecampaign.api.lists.get` | `read` | Retrieve a mailing list by its ID |
216
+ | `lists.list` | `activecampaign.api.lists.list` | `read` | List mailing lists with pagination |
217
+ | `lists.updateSubscription` | `activecampaign.api.lists.updateSubscription` | `write` | Subscribe or unsubscribe a contact to or from a list |
218
+ | `messages.create` | `activecampaign.api.messages.create` | `write` | Create an email message with subject, sender and content |
219
+ | `messages.delete` | `activecampaign.api.messages.delete` | `destructive` | Delete an email message by its ID |
220
+ | `messages.get` | `activecampaign.api.messages.get` | `read` | Retrieve an email message by its ID |
221
+ | `messages.list` | `activecampaign.api.messages.list` | `read` | List email messages with pagination |
222
+ | `messages.update` | `activecampaign.api.messages.update` | `write` | Update an existing email message |
223
+ | `notes.addToContact` | `activecampaign.api.notes.addToContact` | `write` | Add a note to a contact identified by email address |
224
+ | `notes.create` | `activecampaign.api.notes.create` | `write` | Create a note against a contact, deal or account |
225
+ | `notes.createForAccount` | `activecampaign.api.notes.createForAccount` | `write` | Add a note to a CRM account |
226
+ | `notes.createForDeal` | `activecampaign.api.notes.createForDeal` | `write` | Add a note to a deal |
227
+ | `notes.delete` | `activecampaign.api.notes.delete` | `destructive` | Delete a note by its ID |
228
+ | `notes.get` | `activecampaign.api.notes.get` | `read` | Retrieve a note by its ID |
229
+ | `notes.list` | `activecampaign.api.notes.list` | `read` | List notes across contacts, deals and accounts |
230
+ | `notes.update` | `activecampaign.api.notes.update` | `write` | Update the body of an existing note |
231
+ | `notes.updateForAccount` | `activecampaign.api.notes.updateForAccount` | `write` | Update a note attached to a CRM account |
232
+ | `notes.updateForDeal` | `activecampaign.api.notes.updateForDeal` | `write` | Update a note attached to a deal |
233
+ | `orders.upsertBulk` | `activecampaign.api.orders.upsertBulk` | `write` | Create or update many orders synchronously |
234
+ | `orders.upsertBulkAsync` | `activecampaign.api.orders.upsertBulkAsync` | `write` | Create or update many orders asynchronously |
235
+ | `personalizations.create` | `activecampaign.api.personalizations.create` | `write` | Create a personalization variable |
236
+ | `personalizations.delete` | `activecampaign.api.personalizations.delete` | `destructive` | Delete a personalization variable |
237
+ | `personalizations.deleteBulk` | `activecampaign.api.personalizations.deleteBulk` | `destructive` | Delete many personalization variables at once |
238
+ | `personalizations.get` | `activecampaign.api.personalizations.get` | `read` | Retrieve a personalization variable by its ID |
239
+ | `personalizations.list` | `activecampaign.api.personalizations.list` | `read` | List personalization variables |
240
+ | `personalizations.lock` | `activecampaign.api.personalizations.lock` | `write` | Lock a personalization variable against edits |
241
+ | `personalizations.unlock` | `activecampaign.api.personalizations.unlock` | `write` | Unlock a personalization variable for editing |
242
+ | `personalizations.update` | `activecampaign.api.personalizations.update` | `write` | Edit an existing personalization variable |
243
+ | `products.create` | `activecampaign.api.products.create` | `write` | Create a product in the e-commerce catalog |
244
+ | `products.delete` | `activecampaign.api.products.delete` | `destructive` | Delete a product from the e-commerce catalog |
245
+ | `products.get` | `activecampaign.api.products.get` | `read` | Retrieve a catalog product by its ID |
246
+ | `products.search` | `activecampaign.api.products.search` | `read` | Search the e-commerce product catalog |
247
+ | `products.update` | `activecampaign.api.products.update` | `write` | Update a catalog product |
248
+ | `products.upsertBulk` | `activecampaign.api.products.upsertBulk` | `write` | Create or update many catalog products in one request |
249
+ | `recurringPayments.search` | `activecampaign.api.recurringPayments.search` | `read` | Search recurring payment records by filter |
250
+ | `recurringPayments.upsertBulk` | `activecampaign.api.recurringPayments.upsertBulk` | `write` | Create or update many recurring payments at once |
251
+ | `savedResponses.create` | `activecampaign.api.savedResponses.create` | `write` | Create a reusable saved response template |
252
+ | `savedResponses.delete` | `activecampaign.api.savedResponses.delete` | `destructive` | Delete a saved response template |
253
+ | `savedResponses.get` | `activecampaign.api.savedResponses.get` | `read` | Retrieve a saved response by its ID |
254
+ | `savedResponses.list` | `activecampaign.api.savedResponses.list` | `read` | List saved response templates |
255
+ | `savedResponses.update` | `activecampaign.api.savedResponses.update` | `write` | Update a saved response template |
256
+ | `scores.list` | `activecampaign.api.scores.list` | `read` | List the scoring rules configured on the account |
257
+ | `segments.create` | `activecampaign.api.segments.create` | `write` | Create a segment with filtering conditions |
258
+ | `segments.delete` | `activecampaign.api.segments.delete` | `destructive` | Delete a segment and its history |
259
+ | `segments.get` | `activecampaign.api.segments.get` | `read` | Retrieve a segment by its ID |
260
+ | `segments.list` | `activecampaign.api.segments.list` | `read` | List contact segments |
261
+ | `segments.listAudiences` | `activecampaign.api.segments.listAudiences` | `read` | List saved segment summaries, known as audiences |
262
+ | `segments.update` | `activecampaign.api.segments.update` | `write` | Update a segment definition |
263
+ | `segmentsV2.countAtTimestamp` | `activecampaign.api.segmentsV2.countAtTimestamp` | `read` | Retrieve segment counts recorded before a timestamp |
264
+ | `segmentsV2.countHistory` | `activecampaign.api.segmentsV2.countHistory` | `read` | List historic result counts for one segment |
265
+ | `segmentsV2.create` | `activecampaign.api.segmentsV2.create` | `write` | Create an advanced segment with filtering conditions |
266
+ | `segmentsV2.delete` | `activecampaign.api.segmentsV2.delete` | `destructive` | Delete a segment and every historic version of it |
267
+ | `segmentsV2.get` | `activecampaign.api.segmentsV2.get` | `read` | Retrieve a V2 segment by its UUID |
268
+ | `segmentsV2.getAtTimestamp` | `activecampaign.api.segmentsV2.getAtTimestamp` | `read` | Retrieve a segment as it stood at a point in time |
269
+ | `segmentsV2.match` | `activecampaign.api.segmentsV2.match` | `read` | Check whether a contact matches a segment |
270
+ | `segmentsV2.matchAll` | `activecampaign.api.segmentsV2.matchAll` | `write` | Start a match-all evaluation for every contact in a segment |
271
+ | `segmentsV2.matchAllResult` | `activecampaign.api.segmentsV2.matchAllResult` | `read` | Fetch a match-all result set by its run ID |
272
+ | `segmentsV2.matchByExternalId` | `activecampaign.api.segmentsV2.matchByExternalId` | `read` | Check segment membership using an external contact ID |
273
+ | `segmentsV2.matchSomeResult` | `activecampaign.api.segmentsV2.matchSomeResult` | `read` | Fetch a partial segment match result set by run ID |
274
+ | `segmentsV2.recentCounts` | `activecampaign.api.segmentsV2.recentCounts` | `read` | Retrieve the most recent result count per segment |
275
+ | `segmentsV2.revertToTimestamp` | `activecampaign.api.segmentsV2.revertToTimestamp` | `write` | Revert a segment to how it looked at a point in time |
276
+ | `segmentsV2.update` | `activecampaign.api.segmentsV2.update` | `write` | Update a V2 segment definition |
277
+ | `smsBroadcastLists.list` | `activecampaign.api.smsBroadcastLists.list` | `read` | List the SMS broadcast lists available on the account |
278
+ | `smsBroadcasts.createSnapshot` | `activecampaign.api.smsBroadcasts.createSnapshot` | `write` | Request a metrics snapshot for specific SMS broadcasts |
279
+ | `smsBroadcasts.getFailures` | `activecampaign.api.smsBroadcasts.getFailures` | `read` | Group and count SMS delivery failures for a broadcast |
280
+ | `smsBroadcasts.getMetrics` | `activecampaign.api.smsBroadcasts.getMetrics` | `read` | Retrieve delivery metrics for specific SMS broadcasts |
281
+ | `smsBroadcasts.getRecipients` | `activecampaign.api.smsBroadcasts.getRecipients` | `read` | List the contacts an SMS broadcast was sent to |
282
+ | `smsBroadcasts.getSnapshot` | `activecampaign.api.smsBroadcasts.getSnapshot` | `read` | Retrieve aggregate metrics across all SMS broadcasts |
283
+ | `smsBroadcasts.list` | `activecampaign.api.smsBroadcasts.list` | `read` | List SMS broadcasts with optional name and status filters |
284
+ | `smsCredits.get` | `activecampaign.api.smsCredits.get` | `read` | Retrieve SMS credit usage and remaining balance |
285
+ | `tags.addToContact` | `activecampaign.api.tags.addToContact` | `write` | Apply a tag to a contact |
286
+ | `tags.create` | `activecampaign.api.tags.create` | `write` | Create a new tag |
287
+ | `tags.delete` | `activecampaign.api.tags.delete` | `destructive` | Delete a tag by its ID |
288
+ | `tags.get` | `activecampaign.api.tags.get` | `read` | Retrieve a tag by its ID |
289
+ | `tags.list` | `activecampaign.api.tags.list` | `read` | List tags with pagination and search |
290
+ | `tags.removeFromContact` | `activecampaign.api.tags.removeFromContact` | `destructive` | Remove a tag from a contact by its contactTag ID |
291
+ | `tags.update` | `activecampaign.api.tags.update` | `write` | Update an existing tag by its ID |
292
+ | `taskOutcomes.create` | `activecampaign.api.taskOutcomes.create` | `write` | Create a task outcome with an associated sentiment |
293
+ | `taskOutcomes.get` | `activecampaign.api.taskOutcomes.get` | `read` | Retrieve a task outcome by its ID |
294
+ | `taskOutcomes.list` | `activecampaign.api.taskOutcomes.list` | `read` | List the outcomes that can be assigned to tasks |
295
+ | `taskReminders.create` | `activecampaign.api.taskReminders.create` | `write` | Create a reminder ahead of a deal task due date |
296
+ | `templates.createShareLink` | `activecampaign.api.templates.createShareLink` | `write` | Create a shareable link for a campaign template |
297
+ | `templates.get` | `activecampaign.api.templates.get` | `read` | Retrieve a campaign template by its ID |
298
+ | `tracking.addWhitelist` | `activecampaign.api.tracking.addWhitelist` | `write` | Add a domain to the site tracking whitelist |
299
+ | `tracking.getCode` | `activecampaign.api.tracking.getCode` | `read` | Retrieve the site tracking JavaScript snippet |
300
+ | `tracking.getEventStatus` | `activecampaign.api.tracking.getEventStatus` | `read` | Check whether event tracking is enabled |
301
+ | `tracking.getSiteStatus` | `activecampaign.api.tracking.getSiteStatus` | `read` | Check whether site tracking is enabled |
302
+ | `tracking.listWhitelist` | `activecampaign.api.tracking.listWhitelist` | `read` | List the domains allowed for site tracking |
303
+ | `tracking.removeWhitelist` | `activecampaign.api.tracking.removeWhitelist` | `destructive` | Remove a domain from the site tracking whitelist |
304
+ | `tracking.setEventStatus` | `activecampaign.api.tracking.setEventStatus` | `write` | Enable or disable event tracking for the account |
305
+ | `tracking.setSiteStatus` | `activecampaign.api.tracking.setSiteStatus` | `write` | Enable or disable site tracking for the account |
306
+ | `tracking.trackEvent` | `activecampaign.api.tracking.trackEvent` | `write` | Record a custom event against a contact |
307
+ | `users.create` | `activecampaign.api.users.create` | `write` | Create an account user who can sign in |
308
+ | `users.delete` | `activecampaign.api.users.delete` | `destructive` | Delete an account user by their ID |
309
+ | `users.get` | `activecampaign.api.users.get` | `read` | Retrieve an account user by their ID |
310
+ | `users.getByUsername` | `activecampaign.api.users.getByUsername` | `read` | Retrieve an account user by their username |
311
+ | `users.getMe` | `activecampaign.api.users.getMe` | `read` | Retrieve the user the API token belongs to |
312
+ | `users.list` | `activecampaign.api.users.list` | `read` | List account users with pagination and sorting |
313
+ | `users.update` | `activecampaign.api.users.update` | `write` | Update an account user, including group assignment |
314
+ | `webhooks.create` | `activecampaign.api.webhooks.create` | `write` | Create a webhook subscription for account events |
315
+ | `webhooks.delete` | `activecampaign.api.webhooks.delete` | `destructive` | Delete a webhook subscription by its ID |
316
+ | `webhooks.get` | `activecampaign.api.webhooks.get` | `read` | Retrieve a webhook subscription by its ID |
317
+ | `webhooks.list` | `activecampaign.api.webhooks.list` | `read` | List configured webhook subscriptions |
318
+ | `webhooks.update` | `activecampaign.api.webhooks.update` | `write` | Update a webhook subscription |
319
+
320
+ ## Auth
321
+
322
+ Auth: API key. Corsair prompts your tenant for credentials on first use.
323
+
324
+ ## Webhooks
325
+
326
+ No webhooks.
327
+
328
+ ## Reference
329
+
330
+ Full docs, types, and examples: https://docs.corsair.dev/plugins/activecampaign
331
+
332
+ ## License
333
+
334
+ Apache-2.0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@corsair-dev/activecampaign",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "ActiveCampaign plugin for Corsair",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -24,18 +24,24 @@
24
24
  "typescript": "^5.9.3",
25
25
  "zod": "^4.1.13",
26
26
  "jest": "^29.7.0",
27
- "corsair": "0.1.117"
27
+ "corsair": "0.1.129"
28
28
  },
29
29
  "keywords": [
30
30
  "corsair",
31
31
  "activecampaign",
32
32
  "plugin"
33
33
  ],
34
- "author": "",
34
+ "author": "Corsair (https://corsair.dev)",
35
35
  "license": "Apache-2.0",
36
36
  "files": [
37
37
  "dist"
38
38
  ],
39
+ "repository": {
40
+ "type": "git",
41
+ "url": "git+https://github.com/corsairdev/corsair.git",
42
+ "directory": "packages/activecampaign"
43
+ },
44
+ "homepage": "https://docs.corsair.dev/plugins/activecampaign",
39
45
  "scripts": {
40
46
  "build": "rm -rf dist && tsc --build --force && tsup",
41
47
  "typecheck": "tsc --noEmit",