-
Hello from Vue
-
{{ message }}
+
-
diff --git a/assets/vue/api.js b/assets/vue/api.js
new file mode 100644
index 0000000..7cc9e77
--- /dev/null
+++ b/assets/vue/api.js
@@ -0,0 +1,58 @@
+import {
+ CampaignClient,
+ Client,
+ ListMessagesClient,
+ ListClient,
+ StatisticsClient,
+ SubscribersClient,
+ SubscriptionClient,
+ SubscriberAttributesClient,
+ TemplatesClient
+} from '@tatevikgr/rest-api-client';
+
+const appElement = document.getElementById('vue-app');
+const apiToken = appElement?.dataset.apiToken;
+const apiBaseUrl = appElement?.dataset.apiBaseUrl;
+
+if (!apiBaseUrl) {
+ console.error('API Base URL is not configured.');
+}
+
+const client = new Client(apiBaseUrl || '');
+
+if (apiToken) {
+ client.setSessionId(apiToken);
+}
+
+export const subscribersClient = new SubscribersClient(client);
+export const listClient = new ListClient(client);
+export const campaignClient = new CampaignClient(client);
+export const listMessagesClient = new ListMessagesClient(client);
+export const statisticsClient = new StatisticsClient(client);
+export const subscriptionClient = new SubscriptionClient(client);
+export const subscriberAttributesClient = new SubscriberAttributesClient(client);
+export const templateClient = new TemplatesClient(client);
+
+export const fetchAllLists = async ({ limit = 100, maxPages = 100 } = {}) => {
+ const lists = [];
+ let afterId = null;
+
+ for (let pageIndex = 0; pageIndex < maxPages; pageIndex += 1) {
+ const response = await listClient.getLists(afterId, limit);
+ const items = Array.isArray(response?.items) ? response.items : [];
+ lists.push(...items);
+
+ const hasMore = response?.pagination?.hasMore === true;
+ const nextCursor = response?.pagination?.nextCursor;
+
+ if (!hasMore || !Number.isFinite(nextCursor) || nextCursor === afterId) {
+ break;
+ }
+
+ afterId = nextCursor;
+ }
+
+ return lists;
+};
+
+export default client;
diff --git a/assets/vue/components/base/BaseBadge.spec.js b/assets/vue/components/base/BaseBadge.spec.js
new file mode 100644
index 0000000..df0507a
--- /dev/null
+++ b/assets/vue/components/base/BaseBadge.spec.js
@@ -0,0 +1,33 @@
+import { mount } from '@vue/test-utils'
+import BaseBadge from './BaseBadge.vue'
+
+describe('BaseBadge', () => {
+ it('renders neutral variant by default', () => {
+ const wrapper = mount(BaseBadge, {
+ slots: {
+ default: 'All',
+ },
+ })
+
+ const classes = wrapper.get('span').classes()
+ expect(wrapper.text()).toContain('All')
+ expect(classes).toContain('bg-gray-100')
+ expect(classes).toContain('text-gray-800')
+ })
+
+ it('renders counter variant styles', () => {
+ const wrapper = mount(BaseBadge, {
+ props: {
+ variant: 'counter',
+ },
+ slots: {
+ default: '10',
+ },
+ })
+
+ const classes = wrapper.get('span').classes()
+ expect(classes).toContain('bg-indigo-50')
+ expect(classes).toContain('text-ext-wf3')
+ expect(wrapper.text()).toContain('10')
+ })
+})
diff --git a/assets/vue/components/base/BaseBadge.vue b/assets/vue/components/base/BaseBadge.vue
new file mode 100644
index 0000000..217fd1b
--- /dev/null
+++ b/assets/vue/components/base/BaseBadge.vue
@@ -0,0 +1,28 @@
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/components/base/BaseButton.spec.js b/assets/vue/components/base/BaseButton.spec.js
new file mode 100644
index 0000000..5a0106b
--- /dev/null
+++ b/assets/vue/components/base/BaseButton.spec.js
@@ -0,0 +1,47 @@
+import { mount } from '@vue/test-utils'
+import BaseButton from './BaseButton.vue'
+
+describe('BaseButton', () => {
+ it('renders slot content', () => {
+ const wrapper = mount(BaseButton, {
+ slots: {
+ default: 'Save',
+ },
+ })
+
+ expect(wrapper.text()).toContain('Save')
+ })
+
+ it('uses primary styles by default', () => {
+ const wrapper = mount(BaseButton)
+ const classes = wrapper.get('button').classes()
+
+ expect(classes).toContain('text-white')
+ expect(classes).toContain('bg-blue-600')
+ })
+
+ it('uses secondary styles when variant is secondary', () => {
+ const wrapper = mount(BaseButton, {
+ props: {
+ variant: 'secondary',
+ },
+ })
+
+ const classes = wrapper.get('button').classes()
+ expect(classes).toContain('text-gray-700')
+ expect(classes).toContain('bg-white')
+ })
+
+ it('forwards attributes to button', () => {
+ const wrapper = mount(BaseButton, {
+ attrs: {
+ disabled: true,
+ 'data-testid': 'submit-button',
+ },
+ })
+
+ const button = wrapper.get('button')
+ expect(button.attributes('disabled')).toBeDefined()
+ expect(button.attributes('data-testid')).toBe('submit-button')
+ })
+})
diff --git a/assets/vue/components/base/BaseButton.vue b/assets/vue/components/base/BaseButton.vue
new file mode 100644
index 0000000..aaeb2e8
--- /dev/null
+++ b/assets/vue/components/base/BaseButton.vue
@@ -0,0 +1,35 @@
+
+
+
+
+
+
+
diff --git a/assets/vue/components/base/BaseCard.vue b/assets/vue/components/base/BaseCard.vue
new file mode 100644
index 0000000..2278c74
--- /dev/null
+++ b/assets/vue/components/base/BaseCard.vue
@@ -0,0 +1,34 @@
+
+
+
+
+
+
diff --git a/assets/vue/components/base/BaseIcon.spec.js b/assets/vue/components/base/BaseIcon.spec.js
new file mode 100644
index 0000000..047d803
--- /dev/null
+++ b/assets/vue/components/base/BaseIcon.spec.js
@@ -0,0 +1,36 @@
+import { mount } from '@vue/test-utils'
+import BaseIcon from './BaseIcon.vue'
+
+describe('BaseIcon', () => {
+ it('renders icon svg for known icon name', () => {
+ const wrapper = mount(BaseIcon, {
+ props: {
+ name: 'users',
+ },
+ })
+
+ expect(wrapper.html()).toContain('
{
+ const wrapper = mount(BaseIcon, {
+ props: {
+ name: 'does-not-exist',
+ },
+ })
+
+ expect(wrapper.html()).not.toContain(' {
+ const wrapper = mount(BaseIcon, {
+ props: {
+ name: 'users',
+ active: true,
+ },
+ })
+
+ expect(wrapper.get('span').classes()).toContain('text-ext-wf3')
+ })
+})
diff --git a/assets/vue/components/base/BaseIcon.vue b/assets/vue/components/base/BaseIcon.vue
new file mode 100644
index 0000000..2955106
--- /dev/null
+++ b/assets/vue/components/base/BaseIcon.vue
@@ -0,0 +1,118 @@
+
+
+
+
+
+
diff --git a/assets/vue/components/base/BaseProgressBar.spec.js b/assets/vue/components/base/BaseProgressBar.spec.js
new file mode 100644
index 0000000..bc4a6fd
--- /dev/null
+++ b/assets/vue/components/base/BaseProgressBar.spec.js
@@ -0,0 +1,32 @@
+import { mount } from '@vue/test-utils'
+import BaseProgressBar from './BaseProgressBar.vue'
+
+describe('BaseProgressBar', () => {
+ it('applies default height and progress attributes', () => {
+ const wrapper = mount(BaseProgressBar, {
+ props: {
+ value: 35,
+ },
+ })
+
+ const wrapperStyle = wrapper.get('.progress').attributes('style')
+ const bar = wrapper.get('[role="progressbar"]')
+
+ expect(wrapperStyle).toContain('height: 6px;')
+ expect(bar.attributes('style')).toContain('width: 35%;')
+ expect(bar.attributes('aria-valuenow')).toBe('35')
+ expect(bar.attributes('aria-valuemin')).toBe('0')
+ expect(bar.attributes('aria-valuemax')).toBe('100')
+ })
+
+ it('uses custom height when provided', () => {
+ const wrapper = mount(BaseProgressBar, {
+ props: {
+ value: 80,
+ height: '10px',
+ },
+ })
+
+ expect(wrapper.get('.progress').attributes('style')).toContain('height: 10px;')
+ })
+})
diff --git a/assets/vue/components/base/BaseProgressBar.vue b/assets/vue/components/base/BaseProgressBar.vue
new file mode 100644
index 0000000..91ac7a7
--- /dev/null
+++ b/assets/vue/components/base/BaseProgressBar.vue
@@ -0,0 +1,30 @@
+
+
+
+
+
+
diff --git a/assets/vue/components/base/CkEditorField.vue b/assets/vue/components/base/CkEditorField.vue
new file mode 100644
index 0000000..9a56ad6
--- /dev/null
+++ b/assets/vue/components/base/CkEditorField.vue
@@ -0,0 +1,138 @@
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/components/campaigns/CampaignDirectory.vue b/assets/vue/components/campaigns/CampaignDirectory.vue
new file mode 100644
index 0000000..91bedec
--- /dev/null
+++ b/assets/vue/components/campaigns/CampaignDirectory.vue
@@ -0,0 +1,974 @@
+
+
+
+
Campaigns
+
+
+
+
+
+
+
+
+
+
+ | Subject |
+ Status |
+ Lists |
+ Processed |
+ Statistics |
+ Actions |
+
+
+
+
+
+ | Loading campaigns... |
+
+
+
+ | {{ errorMessage }} |
+
+
+
+ | No campaigns for this filter. |
+
+
+
+ | {{ campaign.subject }} |
+
+
+ {{ campaign.statusLabel }}
+
+ |
+
+ Loading lists...
+ -
+
+
+ {{ list.name }}
+
+
+ |
+
+ Started: {{ campaign.startedAt }}
+ Time to send: {{ campaign.timeToSend }}
+ Total: {{ campaign.processedTotal }}
+ Text: {{ campaign.processedText }}
+ HTML: {{ campaign.processedHtml }}
+ |
+
+ Total views: {{ campaign.totalViews }}
+ Unique views: {{ campaign.uniqueViews }}
+ Bounced: {{ campaign.bounced }}
+ |
+
+
+
+
+
+
+
+
+
+
+ {{ getActionFeedback(campaign.id)?.message }}
+
+ |
+
+
+
+
+
+
+ Loading campaigns...
+
+
+
+ {{ errorMessage }}
+
+
+
+ No campaigns for this filter.
+
+
+
+
+
+
{{ campaign.subject }}
+
+
+ {{ campaign.statusLabel }}
+
+
+
+
+
+ Lists:
+
+
+
+ {{ list.name }}
+
+ ,
+
+
+
+
Started: {{ campaign.startedAt }}
+
Time to send: {{ campaign.timeToSend }}
+
Processed: {{ campaign.processedTotal }} (Text: {{ campaign.processedText }}, HTML: {{ campaign.processedHtml }})
+
Statistics: Total views {{ campaign.totalViews }}, Unique views {{ campaign.uniqueViews }}, Bounced {{ campaign.bounced }}
+
+
+
+
+
+
+
+
+
+
+
+ {{ getActionFeedback(campaign.id)?.message }}
+
+
+
+
+
+
+
+ Showing {{ rangeStart }}-{{ rangeEnd }} of {{ filteredCampaigns.length }}
+
+
+
+
+
+
+
+
+
+
+
+
Campaign details: {{ campaign?.id || '-' }}
+
+
+
+
+
+ Loading campaign...
+
+
+
+ {{ viewErrorMessage }}
+
+
+
+
+ Subject:
+ {{ campaign?.messageContent?.subject || '-' }}
+
+
+
+ Entered:
+ {{ formatDate(campaign?.messageMetadata?.entered || null) }}
+
+
+
+ From:
+ {{ campaign?.messageOptions?.fromField || '-' }}
+
+
+
+
HTML content
+
{{
+ campaign?.messageContent?.text || '-'
+ }}
+
+
+
+
Text content
+
{{
+ campaign?.messageContent?.textMessage || '-'
+ }}
+
+
+
+
Footer
+
{{
+ campaign?.messageContent?.footer || '-'
+ }}
+
+
+
+ Requeueing:
+ {{ getMessage(campaign?.messageSchedule) }}
+
+
+
+
+ Resend campaign
+
+ Choose mailing lists
+
+
+
+
+
+
+
+
+
+ No mailing lists found.
+
+
+
+
+
+
+
+
+ {{ resendErrorMessage }}
+
+
+
+
+
+ No campaign selected.
+
+
+
+
+
+
+ | Campaign Name |
+ Status |
+ Date |
+ Open Rate |
+ Click Rate |
+
+
+
+
+
+ |
+ {{ row.name }}
+ |
+
+
+
+ {{ row.status }}
+
+ |
+
+ {{ row.date }} |
+ {{ row.openRate ?? '—' }} |
+ {{ row.clickRate ?? '—' }} |
+
+
+
+
+ |
+ No campaigns yet.
+ |
+
+
+
+
+
+
diff --git a/assets/vue/components/dashboard/KpiCard.vue b/assets/vue/components/dashboard/KpiCard.vue
new file mode 100644
index 0000000..57df775
--- /dev/null
+++ b/assets/vue/components/dashboard/KpiCard.vue
@@ -0,0 +1,39 @@
+
+
+
+
+
+ {{ value }}
+
+
+ {{ change }} vs last month
+
+
+
+
+
diff --git a/assets/vue/components/dashboard/KpiGrid.vue b/assets/vue/components/dashboard/KpiGrid.vue
new file mode 100644
index 0000000..4835163
--- /dev/null
+++ b/assets/vue/components/dashboard/KpiGrid.vue
@@ -0,0 +1,79 @@
+
+
+
+
+
diff --git a/assets/vue/components/dashboard/PerformanceChartCard.vue b/assets/vue/components/dashboard/PerformanceChartCard.vue
new file mode 100644
index 0000000..4dd02a2
--- /dev/null
+++ b/assets/vue/components/dashboard/PerformanceChartCard.vue
@@ -0,0 +1,128 @@
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/components/dashboard/QuickActionsCard.vue b/assets/vue/components/dashboard/QuickActionsCard.vue
new file mode 100644
index 0000000..ba403f4
--- /dev/null
+++ b/assets/vue/components/dashboard/QuickActionsCard.vue
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/components/dashboard/RecentCampaignsCard.vue b/assets/vue/components/dashboard/RecentCampaignsCard.vue
new file mode 100644
index 0000000..0f6f010
--- /dev/null
+++ b/assets/vue/components/dashboard/RecentCampaignsCard.vue
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/components/lists/AddSubscribersModal.vue b/assets/vue/components/lists/AddSubscribersModal.vue
new file mode 100644
index 0000000..b54f3f8
--- /dev/null
+++ b/assets/vue/components/lists/AddSubscribersModal.vue
@@ -0,0 +1,165 @@
+
+
+
+
+
diff --git a/assets/vue/components/lists/CreateListModal.vue b/assets/vue/components/lists/CreateListModal.vue
new file mode 100644
index 0000000..dcd58ca
--- /dev/null
+++ b/assets/vue/components/lists/CreateListModal.vue
@@ -0,0 +1,177 @@
+
+
+
+
+
diff --git a/assets/vue/components/lists/EditListModal.vue b/assets/vue/components/lists/EditListModal.vue
new file mode 100644
index 0000000..41d5981
--- /dev/null
+++ b/assets/vue/components/lists/EditListModal.vue
@@ -0,0 +1,230 @@
+
+
+
+
+
diff --git a/assets/vue/components/lists/ListDirectory.vue b/assets/vue/components/lists/ListDirectory.vue
new file mode 100644
index 0000000..082f47b
--- /dev/null
+++ b/assets/vue/components/lists/ListDirectory.vue
@@ -0,0 +1,349 @@
+
+
+
+
Mailing Lists
+
+
+
+
+
+
+
+
+ | ID |
+ Name |
+ Public/Active |
+ Actions |
+
+
+
+
+ | {{ list.id }} |
+ {{ list.name }} |
+
+
+ {{ isPublic(list) ? 'Yes' : 'No' }}
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+ |
+
+
+
+ |
+ No mailing lists found.
+ |
+
+
+ |
+ Loading mailing lists...
+ |
+
+
+
+ |
+ {{ loadError }}
+ |
+
+
+
+ |
+ No mailing lists found.
+ |
+
+
+
+
+
+
+
+
+
#{{ list.id }}
+
{{ list.name }}
+
+
+
+ {{ isPublic(list) ? 'Public' : 'Private' }}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Loading mailing lists...
+
+
+
+ {{ loadError }}
+
+
+
+ No mailing lists found.
+
+
+
+
+
+
+
+
What date needs to be used:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Columns
+
+
+
+
+
+
+
+
+
+
{{ exportError }}
+
+
+
+
+
+
+
+
![Logo]()
+
+
+
+ {{ item.label }}
+
+
+
+ {{ item.badge }}
+
+
+
+
+
+
+
diff --git a/assets/vue/components/sidebar/SidebarNavSection.vue b/assets/vue/components/sidebar/SidebarNavSection.vue
new file mode 100644
index 0000000..e9497f4
--- /dev/null
+++ b/assets/vue/components/sidebar/SidebarNavSection.vue
@@ -0,0 +1,20 @@
+
+
+
+
+
diff --git a/assets/vue/components/subscribers/ImportResult.vue b/assets/vue/components/subscribers/ImportResult.vue
new file mode 100644
index 0000000..f3eb82f
--- /dev/null
+++ b/assets/vue/components/subscribers/ImportResult.vue
@@ -0,0 +1,83 @@
+
+
+
+
+
Import Result
+
+
+
+
+
+
+
Imported
+
+ {{ importResult.imported }}
+
+
+
+
+
Skipped
+
+ {{ importResult.skipped }}
+
+
+
+
+
+
+
+ Import completed without errors.
+
+
+
+
+
+
+
+
+
+
+
Subscribers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Showing {{ subscribers.length }} of {{ pagination.total }} subscribers
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/components/subscribers/SubscriberModal.vue b/assets/vue/components/subscribers/SubscriberModal.vue
new file mode 100644
index 0000000..a1745a3
--- /dev/null
+++ b/assets/vue/components/subscribers/SubscriberModal.vue
@@ -0,0 +1,205 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Subscriber Details ID: {{ subscriber.id ?? '' }}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ | ID |
+ Email |
+ Status |
+ Lists |
+ Created |
+ Actions |
+
+
+
+
+ |
+ {{ subscriber.id }}
+ |
+
+ {{ subscriber.email }}
+ |
+
+
+
+ {{ subscriber.confirmed ? 'Confirmed' : 'Unconfirmed' }}
+
+
+ Blacklisted
+
+
+ |
+
+ {{ subscriber.listCount }}
+ |
+
+ {{ subscriber.createdAt }}
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+
+ {{ subscriber.email.split('@')[0] }}
+
+
+
+ {{ subscriber.confirmed ? 'active' : 'unconfirmed' }}
+
+
+ blacklisted
+
+
+
+
+
+
{{ subscriber.email }}
+
+
+
+ {{ subscriber.listCount }} Lists
+
+
+ {{ subscriber.createdAt }}
+
+
+
+
+
+
Templates
+
+
+
+
+
+ Loading templates...
+
+
+
+ {{ errorMessage }}
+
+
+
+ No templates found.
+
+
+
+
+
+
![]()
+
+
{{ templateItem.title || `Template #${templateItem.id}` }}
+
+ {{ getTemplateType(templateItem) }}
+
+
+
+ ID {{ templateItem.id }}
+ Order {{ templateItem.listOrder ?? '-' }}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Create Campaign
+
+
+
+
+
+
+
+ {{ adminData.login_name || 'Admin User' }}
+
+
+ {{ adminData.super_user ? 'Super Admin' : 'Administrator' }}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Campaign
+
{{ pageTitle }}
+
+
+
+ Back to Campaigns
+
+
+
+
+
+ Loading campaign...
+
+
+
+ {{ loadError }}
+
+
+
+
+
+
+
+
+
+
+
+ Content
+
+
+
+
+
+
+
+
+
+
+
+
Campaign content will be saved as [URL:YOUR_URL].
+
+
+
+
+
+
+
+
+
+
+
+
+ Format
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Lists
+
+ Please select the lists you want to send this campaign to.
+
+
+
+
+
No mailing lists found.
+
+
+
+ Send test
+
+ Test send to email address(es).
+
+ (comma separate addresses - all must be existing subscribers)
+
+
+
+
+
+
+
+
+
+
+ Finish
+
+
+
+
+
+ {{ warnings.length ? 'Please review before saving' : 'Campaign is ready to save' }}
+
+
+ {{ warning }}
+
+
+
+
+
+
+
+
+
Please fix the following fields:
+
+
+
{{ saveError }}
+
{{ saveSuccess }}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/views/DashboardView.vue b/assets/vue/views/DashboardView.vue
new file mode 100644
index 0000000..16dff3d
--- /dev/null
+++ b/assets/vue/views/DashboardView.vue
@@ -0,0 +1,63 @@
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/views/ListSubscribersView.vue b/assets/vue/views/ListSubscribersView.vue
new file mode 100644
index 0000000..762483f
--- /dev/null
+++ b/assets/vue/views/ListSubscribersView.vue
@@ -0,0 +1,568 @@
+
+
+
+
+
+
+
Mailing List
+
+ {{ listName || `List #${listId}` }}
+
+
+
+
+ Back to Lists
+
+
+
+
+
+
+
Subscribers
+
+
+
+
+
+
+
+
+
+ Selected: {{ selectedSubscribers.length }}
+
+
+
+
+
+
+
+
+
+
+
+
+
{{ actionError }}
+
{{ actionMessage }}
+
+
+
+
+
+
+
Loading...
+
{{ errorMessage }}
+
+
+
+
+
+
+
+
+
+
+
+
{{ subscriber.email }}
+
+ {{ subscriber.confirmed ? 'Confirmed' : 'Unconfirmed' }}
+
+
+
#{{ subscriber.id }} · {{formatDate(subscriber.createdAt) }}
+
+
+
+
+
+
+ No subscribers for this filter.
+
+
+
+
+
+
Showing {{ filteredSubscribers.length }} on page · Total: {{ total }}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/views/SubscribersView.vue b/assets/vue/views/SubscribersView.vue
new file mode 100644
index 0000000..5a8fdea
--- /dev/null
+++ b/assets/vue/views/SubscribersView.vue
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
diff --git a/assets/vue/views/TemplateEditView.vue b/assets/vue/views/TemplateEditView.vue
new file mode 100644
index 0000000..7e2b1ba
--- /dev/null
+++ b/assets/vue/views/TemplateEditView.vue
@@ -0,0 +1,308 @@
+
+
+
+
+
+
+
Template
+
{{ pageTitle }}
+
+
+
+ Back to Templates
+
+
+
+
+
+ Loading template...
+
+
+
+ {{ loadError }}
+
+
+
+
+
+
+
+
+
+
diff --git a/composer.json b/composer.json
index 55a4de6..af06be9 100755
--- a/composer.json
+++ b/composer.json
@@ -15,6 +15,10 @@
{
"type": "vcs",
"url": "https://github.com/tatevikgr/phplist-api-client"
+ },
+ {
+ "type": "vcs",
+ "url": "https://github.com/tatevikgr/rss-bundle.git"
}
],
"minimum-stability": "dev",
@@ -43,10 +47,11 @@
},
"require": {
"php": "^8.1",
- "phplist/core": "dev-main",
+ "phplist/core": "dev-dev",
"symfony/twig-bundle": "^6.4",
"symfony/webpack-encore-bundle": "^2.2",
- "tatevikgr/rest-api-client": "dev-ISSUE-357"
+ "symfony/security-bundle": "^6.4",
+ "tatevikgr/rest-api-client": "dev-dev"
},
"require-dev": {
"phpunit/phpunit": "^9.5",
@@ -103,7 +108,8 @@
"symfony-tests-dir": "tests",
"phplist/core": {
"bundles": [
- "PhpList\\WebFrontend\\PhpListFrontendBundle"
+ "PhpList\\WebFrontend\\PhpListFrontendBundle",
+ "Symfony\\Bundle\\SecurityBundle\\SecurityBundle"
],
"routes": {
"rest-api": {
@@ -113,5 +119,10 @@
}
}
}
+ },
+ "config": {
+ "allow-plugins": {
+ "php-http/discovery": true
+ }
}
}
diff --git a/config/packages/framework.yaml b/config/packages/framework.yaml
index a851121..d7dbf70 100644
--- a/config/packages/framework.yaml
+++ b/config/packages/framework.yaml
@@ -3,3 +3,8 @@ framework:
http_method_override: false
php_errors:
log: true
+ session:
+ enabled: true
+ handler_id: null
+ cookie_secure: auto
+ cookie_samesite: lax
diff --git a/config/packages/security.yaml b/config/packages/security.yaml
new file mode 100644
index 0000000..4219501
--- /dev/null
+++ b/config/packages/security.yaml
@@ -0,0 +1,24 @@
+security:
+ enable_authenticator_manager: true
+
+ providers:
+ # Minimal provider; authenticator builds the user from the session token
+ in_memory: { memory: null }
+
+ firewalls:
+ api:
+ pattern: ^/api/v2
+ security: false
+
+ main:
+ pattern: ^/
+ lazy: true
+ provider: in_memory
+ custom_authenticators:
+ - PhpList\WebFrontend\Security\SessionAuthenticator
+ entry_point: PhpList\WebFrontend\Security\SessionAuthenticator
+
+ access_control:
+ - { path: ^/(?:app(?:_test)?\.php/)?login(?:/|$), roles: PUBLIC_ACCESS }
+ - { path: ^/(?:app(?:_test)?\.php/)?api/v2(?:/|$), roles: PUBLIC_ACCESS }
+ - { path: ^/, roles: ROLE_ADMIN }
diff --git a/config/services.yml b/config/services.yml
index 3b2181b..106c9c3 100755
--- a/config/services.yml
+++ b/config/services.yml
@@ -1,7 +1,7 @@
# config/services.yaml
parameters:
api_base_url: '%env(API_BASE_URL)%'
- env(API_BASE_URL): 'http://api.phplist.local/api/v2/'
+ env(API_BASE_URL): 'http://api.phplist.local/'
services:
_defaults:
@@ -16,12 +16,6 @@ services:
- '../src/Entity/'
- '../src/Kernel.php'
- PhpList\WebFrontend\Service\ApiClient:
- arguments:
- $baseUrl: '%api_base_url%'
- # calls:
-# - setAuthToken: ['%session.auth_token%']
-
PhpList\WebFrontend\Controller\:
resource: '../src/Controller'
public: true
@@ -33,6 +27,6 @@ services:
PhpList\RestApiClient\Client:
$baseUrl: '%api_base_url%'
- PhpList\RestApiClient\Endpoint\AuthClient:
- autoconfigure: true
- autowire: true
+ PhpList\WebFrontend\EventListener\ApiSessionListener:
+ tags:
+ - { name: kernel.event_subscriber }
diff --git a/openapi.json b/openapi.json
new file mode 100644
index 0000000..61d88bd
--- /dev/null
+++ b/openapi.json
@@ -0,0 +1,8182 @@
+{
+ "openapi": "3.0.0",
+ "info": {
+ "title": "phpList API Documentation",
+ "description": "This is the OpenAPI documentation for phpList API.",
+ "contact": {
+ "email": "support@phplist.com"
+ },
+ "license": {
+ "name": "AGPL-3.0-or-later",
+ "url": "https://www.gnu.org/licenses/agpl.txt"
+ },
+ "version": "1.0.0"
+ },
+ "servers": [
+ {
+ "url": "https://www.phplist.com/api/v2",
+ "description": "Production server"
+ }
+ ],
+ "paths": {
+ "/api/v2/administrators/attributes": {
+ "get": {
+ "tags": [
+ "admin-attributes"
+ ],
+ "summary": "Gets a list of all admin attribute definitions.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all admin attribute definitions.",
+ "operationId": "68b7d9433a6358436de121484f402e3b",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AdminAttributeDefinition"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "admin-attributes"
+ ],
+ "summary": "Create an admin attribute definition.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created admin attribute definition.",
+ "operationId": "5bee92e632fc1245eba1d29f00558a80",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass parameters to create admin attribute.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminAttributeDefinitionRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminAttributeDefinition"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/administrators/attributes/{definitionId}": {
+ "get": {
+ "tags": [
+ "admin-attributes"
+ ],
+ "summary": "Gets attribute with specified ID.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute with specified ID.",
+ "operationId": "9e57fc1f6a265beac32eb349f5c730f0",
+ "parameters": [
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "Definition ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminAttributeDefinition"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "There is no attribute with that ID."
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "admin-attributes"
+ ],
+ "summary": "Update an admin attribute definition.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns updated admin attribute definition.",
+ "operationId": "f9808a1d30aebafde1426e19dae9e8cf",
+ "parameters": [
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "Definition ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass parameters to update admin attribute.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminAttributeDefinitionRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminAttributeDefinition"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "admin-attributes"
+ ],
+ "summary": "Deletes an attribute definition.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single admin attribute definition.",
+ "operationId": "5e22c902d069355dd7b6ee6fac9309af",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "Definition ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/administrators/{adminId}/attributes/{definitionId}": {
+ "get": {
+ "tags": [
+ "admin-attributes"
+ ],
+ "summary": "Gets admin attribute.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute.",
+ "operationId": "c78ef2b0910f4e150dbcd2a6cd0ea27e",
+ "parameters": [
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "attribute definition id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "adminId",
+ "in": "path",
+ "description": "Administrator id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminAttributeValue"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "There is no attribute with that ID."
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "admin-attributes"
+ ],
+ "summary": "Create/update an admin attribute.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created/updated admin attribute.",
+ "operationId": "3cc645e3d26cc49501ad67adda844712",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "attribute definition id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "adminId",
+ "in": "path",
+ "description": "Administrator id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass parameters to create admin attribute.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "example": "United States"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminAttributeValue"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "admin-attributes"
+ ],
+ "summary": "Deletes an attribute.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single admin attribute.",
+ "operationId": "7e8b9cefb17ef3cbb69501820e0d0f6c",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "attribute definition id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "adminId",
+ "in": "path",
+ "description": "Administrator id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/administrators/{adminId}/attributes": {
+ "get": {
+ "tags": [
+ "admin-attributes"
+ ],
+ "summary": "Gets a list of all admin attributes.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all admin attributes.",
+ "operationId": "d6a09a4d6f2451e72c2a8b23e2fd1911",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "adminId",
+ "in": "path",
+ "description": "Administrator id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AdminAttributeValue"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/administrators": {
+ "get": {
+ "tags": [
+ "administrators"
+ ],
+ "summary": "Get Administrators",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Get list of administrators.",
+ "operationId": "dfc888f94f2ce46ce7a2ae8e1d55ebbc",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Administrator"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid input"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "administrators"
+ ],
+ "summary": "Create Administrator",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Create a new administrator.",
+ "operationId": "62e1c82af2ab59be7300fa99f73bc354",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Administrator data",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateAdministratorRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Administrator created successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Administrator"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Invalid input"
+ }
+ }
+ }
+ },
+ "/api/v2/administrators/{adminId}": {
+ "get": {
+ "tags": [
+ "administrators"
+ ],
+ "summary": "Get Administrator",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Get administrator by ID.",
+ "operationId": "71a302c638b746ec7169b15da4ae7c9a",
+ "parameters": [
+ {
+ "name": "adminId",
+ "in": "path",
+ "description": "Administrator ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Administrator found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Administrator"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Administrator not found"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "administrators"
+ ],
+ "summary": "Update Administrator",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Update an administrator.",
+ "operationId": "53023c81474020aca57ac09031e1c49c",
+ "parameters": [
+ {
+ "name": "adminId",
+ "in": "path",
+ "description": "Administrator ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Administrator update data",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateAdministratorRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Administrator updated successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Administrator"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Administrator not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "administrators"
+ ],
+ "summary": "Delete Administrator",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete an administrator.",
+ "operationId": "52cdf4ca32e2fe304993bdac19c1bc92",
+ "parameters": [
+ {
+ "name": "adminId",
+ "in": "path",
+ "description": "Administrator ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Administrator deleted successfully"
+ },
+ "404": {
+ "description": "Administrator not found"
+ }
+ }
+ }
+ },
+ "/api/v2/password-reset/request": {
+ "post": {
+ "tags": [
+ "password-reset"
+ ],
+ "summary": "Request a password reset.",
+ "description": "Request a password reset token for an administrator account.",
+ "operationId": "7725789cb52ab5de77489011d4c43928",
+ "requestBody": {
+ "description": "Administrator email",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "required": [
+ "email"
+ ],
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "admin@example.com"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Password reset token generated"
+ },
+ "400": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BadRequestResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/password-reset/validate": {
+ "post": {
+ "tags": [
+ "password-reset"
+ ],
+ "summary": "Validate a password reset token.",
+ "description": "Validate a password reset token.",
+ "operationId": "336b157137fc4c4bd95714810f934ef8",
+ "requestBody": {
+ "description": "Password reset token",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "required": [
+ "token"
+ ],
+ "properties": {
+ "token": {
+ "type": "string",
+ "example": "a1b2c3d4e5f6"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "valid": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BadRequestResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/password-reset/reset": {
+ "post": {
+ "tags": [
+ "password-reset"
+ ],
+ "summary": "Reset password with token.",
+ "description": "Reset an administrator password using a token.",
+ "operationId": "19b7cbd6a10c9636a579b35028d1b1fc",
+ "requestBody": {
+ "description": "Password reset information",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "required": [
+ "token",
+ "newPassword"
+ ],
+ "properties": {
+ "token": {
+ "type": "string",
+ "example": "a1b2c3d4e5f6"
+ },
+ "newPassword": {
+ "type": "string",
+ "format": "password",
+ "example": "newSecurePassword123"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "Password updated successfully"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid or expired token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BadRequestResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/sessions": {
+ "post": {
+ "tags": [
+ "sessions"
+ ],
+ "summary": "Log in or create new session.",
+ "description": "✅ **Status: Stable** – This method is stable and safe for production use. Given valid login data, this will generate a login token that will be valid for 1 hour.",
+ "operationId": "8ecb80a8846ff88c2cc875960f7268c1",
+ "requestBody": {
+ "description": "Pass session credentials",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "required": [
+ "login_name",
+ "password"
+ ],
+ "properties": {
+ "login_name": {
+ "type": "string",
+ "format": "string",
+ "example": "admin"
+ },
+ "password": {
+ "type": "string",
+ "format": "password",
+ "example": "eetIc/Gropvoc1"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1234
+ },
+ "key": {
+ "type": "string",
+ "example": "2cfe100561473c6cdd99c9e2f26fa974"
+ },
+ "expiry": {
+ "type": "string",
+ "example": "2017-07-20T18:22:48+00:00"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BadRequestResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "Not authorized."
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/sessions/{sessionId}": {
+ "delete": {
+ "tags": [
+ "sessions"
+ ],
+ "summary": "Delete a session.",
+ "description": "✅ **Status: Stable** – This method is stable and safe for production use. Delete the session passed as a parameter.",
+ "operationId": "a6b4f29398d881badfa190dd11326fc9",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sessionId",
+ "in": "path",
+ "description": "Session id (not key as for authentication) obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/sessions/me": {
+ "get": {
+ "tags": [
+ "sessions"
+ ],
+ "summary": "Get auth user data.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Get auth user data.",
+ "operationId": "17c16a66c3e6fc44535253b7234f3727",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Administrator found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Administrator"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "Not authorized."
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/attachments/download/{id}": {
+ "get": {
+ "tags": [
+ "attachments"
+ ],
+ "summary": "Download attachment",
+ "description": "Download an attachment by ID. `uid` query parameter is required.",
+ "operationId": "adf9081332610a149939c162b95e5286",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Attachment ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "uid",
+ "in": "query",
+ "description": "Download token (subscriber email or word \"forwarded\")",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "File stream"
+ },
+ "403": {
+ "description": "Unauthorized"
+ },
+ "404": {
+ "description": "Not found"
+ }
+ }
+ }
+ },
+ "/api/v2/bounces/regex": {
+ "get": {
+ "tags": [
+ "bounces"
+ ],
+ "summary": "Gets a list of all bounce regex rules.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all bounce regex rules.",
+ "operationId": "6449bb00e5412ff3d0bf9731a49fd172",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/BounceRegex"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "bounces"
+ ],
+ "summary": "Create or update a bounce regex",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Creates a new bounce regex or updates an existing one (matched by regex hash).",
+ "operationId": "91f09d8583ea3629b39c328464961dd8",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Create or update a bounce regex rule.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "required": [
+ "regex"
+ ],
+ "properties": {
+ "regex": {
+ "type": "string",
+ "example": "/mailbox is full/i"
+ },
+ "action": {
+ "type": "string",
+ "example": "delete",
+ "nullable": true
+ },
+ "list_order": {
+ "type": "integer",
+ "example": 0,
+ "nullable": true
+ },
+ "admin": {
+ "type": "integer",
+ "example": 1,
+ "nullable": true
+ },
+ "comment": {
+ "type": "string",
+ "example": "Auto-generated",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "example": "active",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BounceRegex"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/bounces/regex/{regexHash}": {
+ "get": {
+ "tags": [
+ "bounces"
+ ],
+ "summary": "Get a bounce regex by its hash",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a bounce regex by its hash.",
+ "operationId": "be73154c156c45440b3b3f47513d8e86",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "regexHash",
+ "in": "path",
+ "description": "Regex hash",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BounceRegex"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "bounces"
+ ],
+ "summary": "Delete a bounce regex by its hash",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete a bounce regex by its hash.",
+ "operationId": "47b3de553732c5de46647709a42d2ced",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "regexHash",
+ "in": "path",
+ "description": "Regex hash",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/campaigns/{messageId}/copy": {
+ "post": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Copies campaign/message by id.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Copies campaign/message by id into a draft message.",
+ "operationId": "858216f8617f37fd5f4d40d4f84632d0",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "message ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/campaigns/{messageId}/status": {
+ "patch": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Update campaign status by id.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Updates campaign/message status by id.",
+ "operationId": "8b4d780c2f00df2eddca6244cbfc45d8",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "message ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Update message status.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MessageMetadataRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/campaigns/{messageId}/send": {
+ "post": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Processes/sends campaign/message by id.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id.",
+ "operationId": "8f1cd9b2882cd23e38fb481096e95658",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "message ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/campaigns/{messageId}/resend": {
+ "post": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Processes/sends campaign/message by id to lists.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id to specified mailing lists.",
+ "operationId": "e83ae5f0557b149d31889770ae75b36b",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "message ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "List ids to send this campaign to.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResendMessageToListsRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/campaigns/{messageId}/test-send": {
+ "post": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Processes/sends campaign/message by id to specified subscribers.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id to specified subscribers.",
+ "operationId": "6503953d7fcf631b0582053a57d2f2a8",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "message ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Subscribers email to send this campaign to.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResendMessageToListsRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/campaigns": {
+ "get": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Gets a list of all campaigns.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all campaigns/messages.",
+ "operationId": "ea24d861841d2dbccb639a4d2918aebc",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "subject",
+ "in": "query",
+ "description": "Filter campaigns by subject (partial match)",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "maxLength": 50
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Message"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Create a message for campaign.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created message.",
+ "operationId": "4509477a54e9a738a3ff9ad71f8a7b00",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Create a new message.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "required": [
+ "content",
+ "format",
+ "metadata",
+ "schedule",
+ "options"
+ ],
+ "properties": {
+ "template_id": {
+ "type": "integer",
+ "example": 1
+ },
+ "content": {
+ "$ref": "#/components/schemas/MessageContentRequest"
+ },
+ "format": {
+ "$ref": "#/components/schemas/MessageFormatRequest"
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/MessageMetadataRequest"
+ },
+ "schedule": {
+ "$ref": "#/components/schemas/MessageScheduleRequest"
+ },
+ "options": {
+ "$ref": "#/components/schemas/MessageOptionsRequest"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/campaigns/{messageId}": {
+ "get": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Gets a campaign by id.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns campaign/message by id.",
+ "operationId": "f1c98ff78ce3d1ce528257de4ce3da07",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "message ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Update campaign by id.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Updates campaign/message by id.",
+ "operationId": "442ec1af3bc897d7b2daf7d0013ea367",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "message ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Update message.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "required": [
+ "content",
+ "format",
+ "schedule",
+ "options"
+ ],
+ "properties": {
+ "template_id": {
+ "type": "integer",
+ "example": 1
+ },
+ "content": {
+ "$ref": "#/components/schemas/MessageContentRequest"
+ },
+ "format": {
+ "$ref": "#/components/schemas/MessageFormatRequest"
+ },
+ "schedule": {
+ "$ref": "#/components/schemas/MessageScheduleRequest"
+ },
+ "options": {
+ "$ref": "#/components/schemas/MessageOptionsRequest"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Delete campaign by id.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete campaign/message by id.",
+ "operationId": "f13a1efd58d8cfb8bc67807adcec2d8e",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "message ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/email-forward/{messageId}": {
+ "post": {
+ "tags": [
+ "campaigns"
+ ],
+ "summary": "Forward a message to recipients.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Queues forwarding of a campaign/message to provided recipient emails.",
+ "operationId": "c41e27bcaf3409ec2efda8660574850e",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "message ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Forwarding payload",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ForwardMessageRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ForwardResult"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/list-messages/message/{messageId}/lists": {
+ "get": {
+ "tags": [
+ "list-messages"
+ ],
+ "summary": "Returns a list of subscriber lists associated with a message.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "13859632a920ab15c277632e3a389f91",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "Message ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubscriberList"
+ }
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Message not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "list-messages"
+ ],
+ "summary": "Removes all list associations for a message.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "8ac8602531b6160bfdde282f8f2c4834",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "Message ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success, no content"
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Message not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/list-messages/list/{listId}/messages": {
+ "get": {
+ "tags": [
+ "list-messages"
+ ],
+ "summary": "Returns a list of message IDs associated with a subscriber list.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "9e91d7505c692a51336a4b85fa846a74",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "Subscriber List ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Subscriber list not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/list-messages/message/{messageId}/list/{listId}": {
+ "post": {
+ "tags": [
+ "list-messages"
+ ],
+ "summary": "Associates a message with a subscriber list.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "3648ea88a78c86a041538105202d1702",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "Message ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "Subscriber List ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ListMessage"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Message or subscriber list not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "list-messages"
+ ],
+ "summary": "Disassociates a message from a subscriber list.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "00b8276ae19641062b5bbba1ef8aa247",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "Message ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "Subscriber List ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success, no content"
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Message or subscriber list not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/list-messages/message/{messageId}/list/{listId}/check": {
+ "get": {
+ "tags": [
+ "list-messages"
+ ],
+ "summary": "Checks if a message is associated with a subscriber list.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "c98f2361f7c4b2270c1046570d2d491e",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "description": "Message ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "Subscriber List ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "is_associated": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Message or subscriber list not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/templates": {
+ "get": {
+ "tags": [
+ "templates"
+ ],
+ "summary": "Gets a list of all templates.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all templates.",
+ "operationId": "087039999e07f0b831aca77cb1f8bb1c",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Template"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "templates"
+ ],
+ "summary": "Create a new template.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON response of created template.",
+ "operationId": "1b4a0dd67dd9c65cd62ca500b7837a1d",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass session credentials",
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateTemplateRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Template"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/templates/{templateId}": {
+ "get": {
+ "tags": [
+ "templates"
+ ],
+ "summary": "Gets a templateI by id.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns template by id.",
+ "operationId": "399ceead91ad931b306c585e3728027a",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "templateId",
+ "in": "path",
+ "description": "template ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Template"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "templates"
+ ],
+ "summary": "Deletes a template.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes template by id.",
+ "operationId": "fde16eb99758ec7a4deb05a597c25178",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "templateId",
+ "in": "path",
+ "description": "Template ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/analytics/campaigns": {
+ "get": {
+ "tags": [
+ "analytics"
+ ],
+ "summary": "Gets campaign statistics.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics overview for campaigns.",
+ "operationId": "8a10d30d0e428611a077196e18382f1e",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum number of campaigns to return",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 20,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last seen campaign ID for pagination",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "minimum": 0
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CampaignStatistics"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/analytics/view-opens": {
+ "get": {
+ "tags": [
+ "analytics"
+ ],
+ "summary": "Gets view opens statistics.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics for view opens.",
+ "operationId": "37095a7af610f1e0927dd04f772295db",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum number of campaigns to return",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 20,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last seen campaign ID for pagination",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 0,
+ "minimum": 0
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ViewOpensStatistics"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/analytics/domains/top": {
+ "get": {
+ "tags": [
+ "analytics"
+ ],
+ "summary": "Gets top domains statistics.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics for the top domains with more than 5 subscribers.",
+ "operationId": "089df16cf97551967e12b2f3207f2cb3",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum number of domains to return",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 20,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "min_subscribers",
+ "in": "query",
+ "description": "Minimum number of subscribers per domain",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 5,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TopDomainStats"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/analytics/domains/confirmation": {
+ "get": {
+ "tags": [
+ "analytics"
+ ],
+ "summary": "Gets domain confirmation statistics.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics for domains showing confirmation status.",
+ "operationId": "8843c53978f1c83a02802678a5af54cd",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum number of domains to return",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 50,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DetailedDomainStats"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/analytics/local-parts/top": {
+ "get": {
+ "tags": [
+ "analytics"
+ ],
+ "summary": "Gets top local-parts statistics.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics for the top local-parts of email addresses.",
+ "operationId": "d9a575680a590b572c4607909b3cbfb0",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Maximum number of local-parts to return",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LocalPartsStats"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/analytics/dashboard": {
+ "get": {
+ "tags": [
+ "analytics"
+ ],
+ "summary": "Gets dashboard analytics statistics.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns dashboard cards with aggregate analytics metrics.",
+ "operationId": "9d12b324dd31b9672eb96506e88a4147",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "summary_statistics": {
+ "properties": {
+ "total_subscribers": {
+ "properties": {
+ "value": {
+ "type": "integer",
+ "example": 48294
+ },
+ "change_vs_last_month": {
+ "type": "number",
+ "format": "float",
+ "example": 12.5
+ }
+ },
+ "type": "object"
+ },
+ "active_campaigns": {
+ "properties": {
+ "value": {
+ "type": "integer",
+ "example": 12
+ },
+ "change_vs_last_month": {
+ "type": "number",
+ "format": "float",
+ "example": 0
+ }
+ },
+ "type": "object"
+ },
+ "open_rate": {
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "float",
+ "example": 12
+ },
+ "change_vs_last_month": {
+ "type": "number",
+ "format": "float",
+ "example": 0
+ }
+ },
+ "type": "object"
+ },
+ "bounce_rate": {
+ "properties": {
+ "value": {
+ "type": "number",
+ "format": "float",
+ "example": 12
+ },
+ "change_vs_last_month": {
+ "type": "number",
+ "format": "float",
+ "example": 0
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "recent_campaigns": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "example": "March Newsletter"
+ },
+ "status": {
+ "type": "string",
+ "example": "sent",
+ "nullable": true
+ },
+ "date": {
+ "type": "string",
+ "format": "date",
+ "example": "2026-03-15",
+ "nullable": true
+ },
+ "open_rate": {
+ "type": "string",
+ "example": "42.50%"
+ },
+ "click_rate": {
+ "type": "string",
+ "example": "8.10%"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "campaign_performance": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date",
+ "example": "2026-03-19"
+ },
+ "opens": {
+ "type": "integer",
+ "example": 234
+ },
+ "clicks": {
+ "type": "integer",
+ "example": 57
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/t/open.gif": {
+ "get": {
+ "tags": [
+ "tracking"
+ ],
+ "summary": "Track user message open",
+ "description": "1x1 tracking pixel endpoint that records a message view. Requires `u` (subscriber UID) and `m` (message ID) as query parameters.",
+ "operationId": "bc130b3f141501cd88e212b74a9b58c5",
+ "parameters": [
+ {
+ "name": "u",
+ "in": "query",
+ "description": "Subscriber unique identifier (UID)",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "m",
+ "in": "query",
+ "description": "Message ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Transparent 1x1 GIF"
+ }
+ }
+ }
+ },
+ "/api/v2/blacklist/check/{email}": {
+ "get": {
+ "tags": [
+ "blacklist"
+ ],
+ "summary": "Check if email is blacklisted",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "8f5aba09fc00fd3dc8cc76e65a7daf95",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "email",
+ "in": "path",
+ "description": "Email address to check",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "blacklisted": {
+ "type": "boolean"
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/blacklist/add": {
+ "post": {
+ "tags": [
+ "blacklist"
+ ],
+ "summary": "Adds an email address to the blacklist.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "7f78f4b5d64027dc48350d0fcaa638bb",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Email to blacklist",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "success": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/blacklist/remove/{email}": {
+ "delete": {
+ "tags": [
+ "blacklist"
+ ],
+ "summary": "Removes an email address from the blacklist.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "38e6653f87e655e0f8f2a64eb9506f73",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "email",
+ "in": "path",
+ "description": "Email address to remove from blacklist",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "success": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/blacklist/info/{email}": {
+ "get": {
+ "tags": [
+ "blacklist"
+ ],
+ "summary": "Gets detailed information about a blacklisted email.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "ad7bb11ee621df03163c16daf9b7d24d",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "email",
+ "in": "path",
+ "description": "Email address to get information for",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "added": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BadRequestResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/lists/{listId}/subscribers": {
+ "get": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Gets a list of all subscribers of a subscriber list.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscribers for a subscriber list.",
+ "operationId": "a02c94c74a195fd2ad0443d9c32547d8",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "List ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Subscriber"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Create subscription",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Subscribe subscriber to a list.",
+ "operationId": "2339631c4103a324c9938c05d00c7e31",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "List ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass session credentials",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriptionRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Subscription"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BadRequestResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AlreadyExistsResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Delete subscription",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete subscription.",
+ "operationId": "3077470b8b4830d18ff3c14f51a5b06d",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "List ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "emails",
+ "in": "query",
+ "description": "emails of subscribers to delete from list.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/lists/{listId}/count": {
+ "get": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Gets the total number of subscribers of a list",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a count of all subscribers in a given list.",
+ "operationId": "8be6d0b47d8fd6570b56c7cb3861e2ec",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "List ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "subscribers_count": {
+ "type": "integer",
+ "example": 42
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribe-pages/{id}": {
+ "get": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Get subscribe page",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "390db83b1de32e07d2d52b310eb0c1ea",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Subscribe page ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscribePage"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Update subscribe page",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "a82a0cbe52063758b55279ce7b96657b",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Subscribe page ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "type": "string",
+ "nullable": true
+ },
+ "active": {
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscribePage"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Delete subscribe page",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "2881b5de1d076caa070f2b9a1c8487fe",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Subscribe page ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribe-pages": {
+ "post": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Create subscribe page",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "314286c5d8ef80c845f5dfd2d671bad3",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscribePage"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribe-pages/{id}/data": {
+ "get": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Get subscribe page data",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "ffe22f26936614a0e853e7c44e5a0fca",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Subscribe page ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "data": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "subscriptions"
+ ],
+ "summary": "Set subscribe page data item",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "a71571132947a19d862eac4baf7a98a7",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Subscribe page ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "data": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/attributes": {
+ "get": {
+ "tags": [
+ "subscriber-attributes"
+ ],
+ "summary": "Gets a list of all subscriber attribute definitions.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscriber attribute definitions.",
+ "operationId": "32f8f5612d7efb526f1aa56f194d3102",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttributeDefinition"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "subscriber-attributes"
+ ],
+ "summary": "Create a subscriber attribute definition.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created subscriber attribute definition.",
+ "operationId": "8cf0c6bd315d14348f6fcc7733bdee5e",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass parameters to create subscriber attribute.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriberAttributeDefinitionRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttributeDefinition"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AlreadyExistsResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/attributes/{definitionId}": {
+ "get": {
+ "tags": [
+ "subscriber-attributes"
+ ],
+ "summary": "Gets attribute with specified ID.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute with specified ID.",
+ "operationId": "395c35f21b4e9b58cf674f2d7388fc5d",
+ "parameters": [
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "Definition ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttributeDefinition"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "There is no attribute with that ID."
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "subscriber-attributes"
+ ],
+ "summary": "Update a subscriber attribute definition.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns updated subscriber attribute definition.",
+ "operationId": "6c4a7b00c41b0f4f93d434ef503bb095",
+ "parameters": [
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "Definition ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass parameters to update subscriber attribute.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriberAttributeDefinitionRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttributeDefinition"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "subscriber-attributes"
+ ],
+ "summary": "Deletes an attribute definition.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single subscriber attribute definition.",
+ "operationId": "762041f6be129fd4436092cf05e4ade3",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "Definition ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribers/{subscriberId}/attributes/{definitionId}": {
+ "get": {
+ "tags": [
+ "subscriber-attributes"
+ ],
+ "summary": "Gets subscriber attribute.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute.",
+ "operationId": "67a8bd1d1ba2fcbe8f7f6e40dff6e310",
+ "parameters": [
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "attribute definition id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "subscriberId",
+ "in": "path",
+ "description": "Subscriber id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriberAttributeValue"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "There is no attribute with that ID."
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "subscriber-attributes"
+ ],
+ "summary": "Create/update a subscriber attribute value.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created/updated subscriber attribute.",
+ "operationId": "556382bb314fde54677216acec2dc57f",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "attribute definition id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "subscriberId",
+ "in": "path",
+ "description": "Subscriber id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass parameters to create subscriber attribute.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "example": "United States"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriberAttributeValue"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "subscriber-attributes"
+ ],
+ "summary": "Deletes an attribute.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single subscriber attribute.",
+ "operationId": "14e2f0f832da2c5561c43bcbaa133846",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "definitionId",
+ "in": "path",
+ "description": "attribute definition id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "subscriberId",
+ "in": "path",
+ "description": "Subscriber id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribers/{subscriberId}/attributes": {
+ "get": {
+ "tags": [
+ "subscriber-attributes"
+ ],
+ "summary": "Gets a list of all subscriber attributes.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscriber attributes.",
+ "operationId": "60f45d54bafdebc6701d65a3152b2ca9",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subscriberId",
+ "in": "path",
+ "description": "Subscriber id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubscriberAttributeValue"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribers": {
+ "get": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Gets a list of all subscribers.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscribers.",
+ "operationId": "6e0a4ae724df948b624a52b8349fa9df",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "is_confirmed",
+ "in": "query",
+ "description": "Filter by confirmed status",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "true",
+ "false",
+ "0",
+ "1"
+ ],
+ "example": "1"
+ }
+ },
+ {
+ "name": "is_blacklisted",
+ "in": "query",
+ "description": "Filter by blacklisted status",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "true",
+ "false",
+ "0",
+ "1"
+ ],
+ "example": "1"
+ }
+ },
+ {
+ "name": "find_column",
+ "in": "query",
+ "description": "Column to search in (requires find_value)",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "email",
+ "foreignKey",
+ "uniqueId"
+ ],
+ "example": "email"
+ }
+ },
+ {
+ "name": "find_value",
+ "in": "query",
+ "description": "Value to search for (requires find_column)",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "example": "email@example.com"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Subscriber"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Create a subscriber",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Creates a new subscriber (if there is no subscriber with the given email address yet).",
+ "operationId": "d3087676ec410e79550544985ec75409",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass session credentials",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateSubscriberRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Subscriber"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AlreadyExistsResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribers/{subscriberId}": {
+ "get": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Get a subscriber",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Get subscriber data by id.",
+ "operationId": "130382f8a765154049824c4bb4b7136f",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subscriberId",
+ "in": "path",
+ "description": "Subscriber ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Subscriber"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Update subscriber",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Update subscriber data by id.",
+ "operationId": "c7fd02049f53535110b7329281aefa6e",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subscriberId",
+ "in": "path",
+ "description": "Subscriber ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass session credentials",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateSubscriberRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Subscriber"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Delete subscriber",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete subscriber by id.",
+ "operationId": "719f3e26178ac8c7d65bcf2ff9d1d35f",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subscriberId",
+ "in": "path",
+ "description": "Subscriber ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribers/{subscriberId}/history": {
+ "get": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Get subscriber event history",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. ",
+ "operationId": "15830d2425a969a7482eefb114234d47",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subscriberId",
+ "in": "path",
+ "description": "Subscriber ID",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Page number (pagination)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Max items per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25
+ }
+ },
+ {
+ "name": "ip",
+ "in": "query",
+ "description": "Filter by IP address",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "date_from",
+ "in": "query",
+ "description": "Filter by date (format: Y-m-d)",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "summery",
+ "in": "query",
+ "description": "Filter by summary text",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Paginated list of subscriber events",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubscriberHistory"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribers/{subscriberId}/reset-bounce-count": {
+ "post": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Reset bounce count for a subscriber.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "14393ca0927d35d1ede3b8eebd9e0421",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subscriberId",
+ "in": "path",
+ "description": "Subscriber ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Subscriber"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribers/confirm": {
+ "get": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Confirm a subscriber by uniqueId.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
+ "operationId": "1e4d7709f3d02f54a4fe6a183b253140",
+ "parameters": [
+ {
+ "name": "uniqueId",
+ "in": "query",
+ "description": "Unique identifier for the subscriber confirmation",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "e9d8c9b2e6"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Subscriber confirmed",
+ "content": {
+ "text/html": {}
+ }
+ },
+ "400": {
+ "description": "Missing or invalid uniqueId"
+ },
+ "404": {
+ "description": "Subscriber not found"
+ }
+ }
+ }
+ },
+ "/api/v2/subscribers/export": {
+ "post": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Export subscribers",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Export subscribers to CSV file.",
+ "operationId": "d8ec2cc2a42ae9cb888e38d504a1cab6",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Filter parameters for subscribers to export. ",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExportSubscriberRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/csv": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/subscribers/import": {
+ "post": {
+ "tags": [
+ "subscribers"
+ ],
+ "summary": "Import subscribers",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Import subscribers from CSV file.",
+ "operationId": "7cd5d687b3cbe0fd9825996e1d105bcc",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "properties": {
+ "file": {
+ "description": "CSV file with subscribers data",
+ "type": "string",
+ "format": "binary"
+ },
+ "list_id": {
+ "description": "List id to add imported subscribers to",
+ "type": "string",
+ "default": null,
+ "pattern": "^\\d+$"
+ },
+ "update_existing": {
+ "description": "Weather to update existing subscribers or not",
+ "type": "string",
+ "default": "0",
+ "enum": [
+ "0",
+ "1"
+ ]
+ },
+ "skip_invalid_emails": {
+ "description": "Weather to skip invalid email or add with invalid_ prefix"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "imported": {
+ "type": "integer"
+ },
+ "skipped": {
+ "type": "integer"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BadRequestResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/lists": {
+ "get": {
+ "tags": [
+ "lists"
+ ],
+ "summary": "Gets a list of all subscriber lists.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscriber lists.",
+ "operationId": "ed0ed404ef48002705009cd8777e6b71",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "after_id",
+ "in": "query",
+ "description": "Last id (starting from 0)",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 1
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "Number of results per page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 25,
+ "maximum": 100,
+ "minimum": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubscriberList"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/CursorPagination"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "lists"
+ ],
+ "summary": "Create a subscriber list.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created list.",
+ "operationId": "24609c8dc07b9c58de81b290481884de",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass parameters to create a new subscriber list.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateSubscriberListRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriberList"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/lists/{listId}": {
+ "get": {
+ "tags": [
+ "lists"
+ ],
+ "summary": "Gets a subscriber list.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single subscriber list with specified ID.",
+ "operationId": "6e5f5ac3587ae710a87000c0537b0da4",
+ "parameters": [
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "List ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriberList"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "There is no list with that ID."
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "lists"
+ ],
+ "summary": "Update a subscriber list.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns updated list.",
+ "operationId": "0f8340a7d0a9f2c1f1bdffc728942d99",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "List ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Pass parameters to create a new subscriber list.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateSubscriberListRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriberList"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ValidationErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "lists"
+ ],
+ "summary": "Deletes a list.",
+ "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single subscriber list.",
+ "operationId": "0d1c8c4721c26084c53b90e365a57a27",
+ "parameters": [
+ {
+ "name": "php-auth-pw",
+ "in": "header",
+ "description": "Session key obtained from login",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "listId",
+ "in": "path",
+ "description": "List ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "403": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotFoundErrorResponse"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Failure",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnauthorizedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "ErrorDetails": {
+ "type": "object",
+ "example": {
+ "format.formatOptions[0]": [
+ "The value you selected is not a valid choice."
+ ],
+ "schedule.repeatUntil": [
+ "This value is not a valid datetime."
+ ],
+ "schedule.requeueUntil": [
+ "This value is not a valid datetime."
+ ]
+ },
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "UnauthorizedResponse": {
+ "required": [
+ "message"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "No valid session key was provided as basic auth password."
+ }
+ },
+ "type": "object"
+ },
+ "ValidationErrorResponse": {
+ "required": [
+ "message",
+ "errors"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "Validation failed"
+ },
+ "errors": {
+ "$ref": "#/components/schemas/ErrorDetails"
+ }
+ },
+ "type": "object"
+ },
+ "BadRequestResponse": {
+ "required": [
+ "message"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "Invalid json format"
+ }
+ },
+ "type": "object"
+ },
+ "AlreadyExistsResponse": {
+ "required": [
+ "message"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "This resource already exists."
+ }
+ },
+ "type": "object"
+ },
+ "NotFoundErrorResponse": {
+ "required": [
+ "message"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "There is no entity with that ID."
+ }
+ },
+ "type": "object"
+ },
+ "GenericErrorResponse": {
+ "required": [
+ "message"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "An unexpected error occurred."
+ }
+ },
+ "type": "object"
+ },
+ "CursorPagination": {
+ "properties": {
+ "total": {
+ "type": "integer",
+ "example": 100
+ },
+ "limit": {
+ "type": "integer",
+ "example": 25
+ },
+ "has_more": {
+ "type": "boolean",
+ "example": true
+ },
+ "next_cursor": {
+ "type": "integer",
+ "example": 129
+ }
+ },
+ "type": "object"
+ },
+ "AdminAttributeDefinitionRequest": {
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "format": "string",
+ "example": "Country"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "textline",
+ "hidden"
+ ],
+ "example": "hidden",
+ "nullable": true
+ },
+ "order": {
+ "type": "number",
+ "example": 12
+ },
+ "default_value": {
+ "type": "string",
+ "example": "United States"
+ },
+ "required": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "type": "object"
+ },
+ "CreateAdministratorRequest": {
+ "required": [
+ "login_name",
+ "password",
+ "email",
+ "super_user"
+ ],
+ "properties": {
+ "login_name": {
+ "type": "string",
+ "maxLength": 255,
+ "minLength": 3,
+ "example": "admin"
+ },
+ "password": {
+ "type": "string",
+ "format": "password",
+ "maxLength": 255,
+ "minLength": 6,
+ "example": "StrongP@ssw0rd"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "admin@example.com"
+ },
+ "super_user": {
+ "type": "boolean",
+ "example": false
+ },
+ "privileges": {
+ "description": "Array of privileges where keys are privilege names and values are booleans",
+ "properties": {
+ "subscribers": {
+ "type": "boolean",
+ "example": true
+ },
+ "campaigns": {
+ "type": "boolean",
+ "example": false
+ },
+ "statistics": {
+ "type": "boolean",
+ "example": true
+ },
+ "settings": {
+ "type": "boolean",
+ "example": false
+ }
+ },
+ "type": "object",
+ "example": {
+ "subscribers": true,
+ "campaigns": false,
+ "statistics": true,
+ "settings": false
+ }
+ }
+ },
+ "type": "object"
+ },
+ "UpdateAdministratorRequest": {
+ "properties": {
+ "login_name": {
+ "type": "string",
+ "maxLength": 255,
+ "minLength": 3,
+ "example": "admin"
+ },
+ "password": {
+ "type": "string",
+ "format": "password",
+ "maxLength": 255,
+ "minLength": 6,
+ "example": "StrongP@ssw0rd"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "admin@example.com"
+ },
+ "super_user": {
+ "type": "boolean",
+ "example": false
+ },
+ "privileges": {
+ "description": "Array of privileges where keys are privilege names and values are booleans",
+ "properties": {
+ "subscribers": {
+ "type": "boolean",
+ "example": true
+ },
+ "campaigns": {
+ "type": "boolean",
+ "example": false
+ },
+ "statistics": {
+ "type": "boolean",
+ "example": true
+ },
+ "settings": {
+ "type": "boolean",
+ "example": false
+ }
+ },
+ "type": "object",
+ "example": {
+ "subscribers": true,
+ "campaigns": false,
+ "statistics": true,
+ "settings": false
+ }
+ }
+ },
+ "type": "object"
+ },
+ "AdminAttributeDefinition": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "name": {
+ "type": "string",
+ "example": "Country"
+ },
+ "type": {
+ "type": "string",
+ "example": "hidden"
+ },
+ "list_order": {
+ "type": "integer",
+ "example": 12
+ },
+ "default_value": {
+ "type": "string",
+ "example": "United States"
+ },
+ "required": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "type": "object"
+ },
+ "AdminAttributeValue": {
+ "properties": {
+ "administrator": {
+ "$ref": "#/components/schemas/Administrator"
+ },
+ "definition": {
+ "$ref": "#/components/schemas/AdminAttributeDefinition"
+ },
+ "value": {
+ "type": "string",
+ "example": "United States"
+ }
+ },
+ "type": "object"
+ },
+ "Administrator": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "login_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "admin@example.com"
+ },
+ "super_user": {
+ "type": "boolean",
+ "example": true
+ },
+ "privileges": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2025-04-29T12:34:56+00:00"
+ }
+ },
+ "type": "object"
+ },
+ "CreateTemplateRequest": {
+ "required": [
+ "title"
+ ],
+ "properties": {
+ "title": {
+ "type": "string",
+ "example": "Newsletter Template"
+ },
+ "content": {
+ "type": "string",
+ "example": "[CONTENT]",
+ "nullable": true
+ },
+ "text": {
+ "type": "string",
+ "example": "[CONTENT]"
+ },
+ "file": {
+ "description": "Optional file upload for HTML content",
+ "type": "string",
+ "format": "binary"
+ },
+ "check_links": {
+ "description": "Check that all links have full URLs",
+ "type": "boolean",
+ "example": true
+ },
+ "check_images": {
+ "description": "Check that all images have full URLs",
+ "type": "boolean",
+ "example": false
+ },
+ "check_external_images": {
+ "description": "Check that all external images exist",
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "type": "object"
+ },
+ "ForwardMessageRequest": {
+ "required": [
+ "recipients"
+ ],
+ "properties": {
+ "recipients": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "email"
+ },
+ "example": [
+ "friend1@example.com",
+ "friend2@example.com"
+ ]
+ },
+ "uid": {
+ "type": "string",
+ "example": "fwd-123e4567-e89b-12d3-a456-426614174000",
+ "nullable": false
+ },
+ "note": {
+ "type": "string",
+ "example": "Thought you might like this.",
+ "nullable": true
+ },
+ "from_name": {
+ "type": "string",
+ "example": "Alice",
+ "nullable": false
+ },
+ "from_email": {
+ "type": "string",
+ "format": "email",
+ "example": "alice@example.com",
+ "nullable": false
+ }
+ },
+ "type": "object"
+ },
+ "MessageContentRequest": {
+ "required": [
+ "subject",
+ "text",
+ "footer"
+ ],
+ "properties": {
+ "subject": {
+ "type": "string",
+ "example": "Campaign Subject"
+ },
+ "text": {
+ "type": "string",
+ "example": "Full text content"
+ },
+ "footer": {
+ "type": "string",
+ "example": "Unsubscribe link here"
+ }
+ },
+ "type": "object"
+ },
+ "MessageFormatRequest": {
+ "required": [
+ "send_format"
+ ],
+ "properties": {
+ "send_format": {
+ "type": "string",
+ "enum": [
+ "html",
+ "text",
+ "invite"
+ ],
+ "example": "html"
+ }
+ },
+ "type": "object"
+ },
+ "MessageMetadataRequest": {
+ "required": [
+ "status"
+ ],
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "draft",
+ "sent",
+ "prepared",
+ "submitted",
+ "suspended",
+ "requeued"
+ ],
+ "example": "draft"
+ }
+ },
+ "type": "object"
+ },
+ "MessageOptionsRequest": {
+ "required": [
+ "from_field"
+ ],
+ "properties": {
+ "from_field": {
+ "type": "string",
+ "example": "info@example.com"
+ },
+ "to_field": {
+ "type": "string",
+ "example": "subscriber@example.com"
+ },
+ "reply_to": {
+ "type": "string",
+ "example": "reply@example.com"
+ },
+ "user_selection": {
+ "type": "string",
+ "example": "all-active-users"
+ }
+ },
+ "type": "object"
+ },
+ "MessageScheduleRequest": {
+ "required": [
+ "embargo"
+ ],
+ "properties": {
+ "embargo": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2025-04-17 09:00:00"
+ },
+ "repeat_interval": {
+ "type": "integer",
+ "example": "24 hours"
+ },
+ "repeat_until": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2025-04-30T00:00:00+04:00"
+ },
+ "requeue_interval": {
+ "type": "integer",
+ "example": "12 hours"
+ },
+ "requeue_until": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2025-04-20T00:00:00+04:00"
+ }
+ },
+ "type": "object"
+ },
+ "ResendMessageToListsRequest": {
+ "required": [
+ "list_ids"
+ ],
+ "properties": {
+ "list_ids": {
+ "description": "Target mailing list IDs.",
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "minimum": 1
+ },
+ "example": [
+ 1,
+ 2,
+ 3
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "TestSendMessageToSubscribersRequest": {
+ "required": [
+ "emails"
+ ],
+ "properties": {
+ "emails": {
+ "description": "Target subscribers emails.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "email"
+ },
+ "example": [
+ "user1@example.com",
+ "user2@example.com"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "BounceRegex": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 10
+ },
+ "regex": {
+ "type": "string",
+ "example": "/mailbox is full/i"
+ },
+ "regex_hash": {
+ "type": "string",
+ "example": "d41d8cd98f00b204e9800998ecf8427e"
+ },
+ "action": {
+ "type": "string",
+ "example": "delete",
+ "nullable": true
+ },
+ "list_order": {
+ "type": "integer",
+ "example": 0,
+ "nullable": true
+ },
+ "admin_id": {
+ "type": "integer",
+ "example": 1,
+ "nullable": true
+ },
+ "comment": {
+ "type": "string",
+ "example": "Auto-generated rule",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "example": "active",
+ "nullable": true
+ },
+ "count": {
+ "type": "integer",
+ "example": 5,
+ "nullable": true
+ }
+ },
+ "type": "object"
+ },
+ "ForwardRecipientResult": {
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "friend@example.com"
+ },
+ "status": {
+ "type": "string",
+ "example": "sent"
+ },
+ "reason": {
+ "type": "string",
+ "example": "precache_failed",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ },
+ "ForwardResult": {
+ "properties": {
+ "total_requested": {
+ "type": "integer",
+ "example": 3
+ },
+ "total_sent": {
+ "type": "integer",
+ "example": 2
+ },
+ "total_failed": {
+ "type": "integer",
+ "example": 1
+ },
+ "total_already_sent": {
+ "type": "integer",
+ "example": 0
+ },
+ "recipients": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ForwardRecipientResult"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "ListMessage": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "message": {
+ "$ref": "#/components/schemas/Message"
+ },
+ "subscriber_list": {
+ "$ref": "#/components/schemas/SubscriberList"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-12-01T10:00:00Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-12-01T10:00:00Z"
+ }
+ },
+ "type": "object"
+ },
+ "Message": {
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "unique_id": {
+ "type": "string",
+ "example": "2df6b147-8470-45ed-8e4e-86aa01af400d"
+ },
+ "template": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/Template"
+ }
+ ],
+ "nullable": true
+ },
+ "message_content": {
+ "properties": {
+ "subject": {
+ "type": "string",
+ "example": "Newsletter"
+ },
+ "text": {
+ "type": "string",
+ "example": "Hello World!"
+ },
+ "text_message": {
+ "type": "string"
+ },
+ "footer": {
+ "type": "string",
+ "example": "This is a footer"
+ }
+ },
+ "type": "object"
+ },
+ "message_format": {
+ "properties": {
+ "html_formated": {
+ "type": "boolean"
+ },
+ "send_format": {
+ "type": "string",
+ "example": "text",
+ "nullable": true
+ },
+ "as_text": {
+ "type": "integer",
+ "example": 12
+ },
+ "as_html": {
+ "type": "integer",
+ "example": 12
+ },
+ "as_text_and_html": {
+ "type": "integer",
+ "example": 12
+ },
+ "as_pdf": {
+ "type": "integer",
+ "example": 12
+ },
+ "as_text_and_pdf": {
+ "type": "integer",
+ "example": 12
+ }
+ },
+ "type": "object"
+ },
+ "message_metadata": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "example": "sent"
+ },
+ "processed": {
+ "type": "integer",
+ "example": 12
+ },
+ "views": {
+ "type": "integer",
+ "example": 12
+ },
+ "bounce_count": {
+ "type": "integer"
+ },
+ "entered": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "sent": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "send_start": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ },
+ "message_schedule": {
+ "properties": {
+ "repeat_interval": {
+ "type": "string",
+ "nullable": true
+ },
+ "repeat_until": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "requeue_interval": {
+ "type": "string",
+ "nullable": true
+ },
+ "requeue_until": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "embargo": {
+ "type": "string",
+ "example": "2023-01-01T12:00:00Z",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ },
+ "message_options": {
+ "properties": {
+ "from_field": {
+ "type": "string",
+ "example": " My Name ",
+ "nullable": true
+ },
+ "to_field": {
+ "type": "string",
+ "example": "",
+ "nullable": true
+ },
+ "reply_to": {
+ "type": "string",
+ "nullable": true
+ },
+ "user_selection": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "TemplateImage": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 12
+ },
+ "template_id": {
+ "type": "integer",
+ "example": 1
+ },
+ "mimetype": {
+ "type": "string",
+ "example": "image/png",
+ "nullable": true
+ },
+ "filename": {
+ "type": "string",
+ "example": "header.png",
+ "nullable": true
+ },
+ "data": {
+ "description": "Base64-encoded image data",
+ "type": "string",
+ "format": "byte",
+ "example": "iVBORw0KGgoAAAANSUhEUgAAA...",
+ "nullable": true
+ },
+ "width": {
+ "type": "integer",
+ "example": 600,
+ "nullable": true
+ },
+ "height": {
+ "type": "integer",
+ "example": 200,
+ "nullable": true
+ }
+ },
+ "type": "object",
+ "nullable": true
+ },
+ "Template": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "title": {
+ "type": "string",
+ "example": "Newsletter"
+ },
+ "content": {
+ "type": "string",
+ "example": "Hello World!",
+ "nullable": true
+ },
+ "text": {
+ "type": "string",
+ "nullable": true
+ },
+ "order": {
+ "type": "integer",
+ "nullable": true
+ },
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TemplateImage"
+ },
+ "nullable": true
+ }
+ },
+ "type": "object",
+ "nullable": true
+ },
+ "DetailedDomainStats": {
+ "properties": {
+ "domains": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "domain": {
+ "description": "This bundle provides the REST API for phpList.",
+ "type": "string"
+ },
+ "confirmed": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ },
+ "percentage": {
+ "type": "number",
+ "format": "float"
+ }
+ },
+ "type": "object"
+ },
+ "unconfirmed": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ },
+ "percentage": {
+ "type": "number",
+ "format": "float"
+ }
+ },
+ "type": "object"
+ },
+ "blacklisted": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ },
+ "percentage": {
+ "type": "number",
+ "format": "float"
+ }
+ },
+ "type": "object"
+ },
+ "total": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ },
+ "percentage": {
+ "type": "number",
+ "format": "float"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "total": {
+ "type": "integer"
+ }
+ },
+ "type": "object",
+ "nullable": true
+ },
+ "CampaignStatistics": {
+ "properties": {
+ "campaign_id": {
+ "type": "integer"
+ },
+ "subject": {
+ "type": "string"
+ },
+ "date_sent": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "sent": {
+ "type": "integer"
+ },
+ "bounces": {
+ "type": "integer"
+ },
+ "forwards": {
+ "type": "integer"
+ },
+ "unique_views": {
+ "type": "integer"
+ },
+ "total_clicks": {
+ "type": "integer"
+ },
+ "unique_clicks": {
+ "type": "integer"
+ }
+ },
+ "type": "object",
+ "nullable": true
+ },
+ "TopDomainStats": {
+ "properties": {
+ "domains": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "domain": {
+ "type": "string"
+ },
+ "subscribers": {
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "total": {
+ "type": "integer"
+ }
+ },
+ "type": "object",
+ "nullable": true
+ },
+ "LocalPartsStats": {
+ "properties": {
+ "local_parts": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "local_part": {
+ "type": "string"
+ },
+ "count": {
+ "type": "integer"
+ },
+ "percentage": {
+ "type": "number",
+ "format": "float"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "total": {
+ "type": "integer"
+ }
+ },
+ "type": "object",
+ "nullable": true
+ },
+ "ViewOpensStatistics": {
+ "properties": {
+ "campaign_id": {
+ "type": "integer"
+ },
+ "subject": {
+ "type": "string"
+ },
+ "sent": {
+ "type": "integer"
+ },
+ "unique_views": {
+ "type": "integer"
+ },
+ "rate": {
+ "type": "number",
+ "format": "float"
+ }
+ },
+ "type": "object",
+ "nullable": true
+ },
+ "CreateSubscriberListRequest": {
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "format": "string",
+ "example": "News"
+ },
+ "description": {
+ "type": "string",
+ "example": "News (and some fun stuff)"
+ },
+ "list_position": {
+ "type": "number",
+ "example": 12
+ },
+ "public": {
+ "type": "boolean",
+ "example": true
+ },
+ "category": {
+ "type": "string",
+ "example": "Marketing"
+ },
+ "subject_prefix": {
+ "type": "string",
+ "example": "[News]"
+ },
+ "rss_feed": {
+ "type": "string",
+ "example": "https://example.com/blog/rss"
+ }
+ },
+ "type": "object"
+ },
+ "CreateSubscriberRequest": {
+ "required": [
+ "email"
+ ],
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "string",
+ "example": "admin@example.com"
+ },
+ "request_confirmation": {
+ "type": "boolean",
+ "example": false
+ },
+ "html_email": {
+ "type": "boolean",
+ "example": false
+ }
+ },
+ "type": "object"
+ },
+ "SubscriberAttributeDefinitionRequest": {
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "example": "Country"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "textline",
+ "hidden",
+ "creditcardno",
+ "select",
+ "date",
+ "checkbox",
+ "textarea",
+ "radio",
+ "checkboxgroup"
+ ],
+ "example": "checkbox",
+ "nullable": true
+ },
+ "order": {
+ "type": "integer",
+ "example": 12,
+ "nullable": true
+ },
+ "default_value": {
+ "type": "string",
+ "example": "United States",
+ "nullable": true
+ },
+ "required": {
+ "type": "boolean",
+ "example": true
+ },
+ "options": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DynamicListAttr"
+ },
+ "nullable": true
+ }
+ },
+ "type": "object"
+ },
+ "DynamicListAttr": {
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1,
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "example": "United States"
+ },
+ "list_order": {
+ "type": "integer",
+ "example": 10,
+ "nullable": true
+ }
+ },
+ "type": "object"
+ },
+ "ExportSubscriberRequest": {
+ "properties": {
+ "date_type": {
+ "description": "What date needs to be used for filtering (any, signup, changed, changelog, subscribed)",
+ "default": "any",
+ "enum": [
+ "any",
+ "signup",
+ "changed",
+ "changelog",
+ "subscribed"
+ ]
+ },
+ "list_id": {
+ "description": "List ID from where to export",
+ "type": "integer"
+ },
+ "date_from": {
+ "description": "Start date for filtering (format: Y-m-d)",
+ "type": "string",
+ "format": "date"
+ },
+ "date_to": {
+ "description": "End date for filtering (format: Y-m-d)",
+ "type": "string",
+ "format": "date"
+ },
+ "is_confirmed": {
+ "description": "Whether subscriber is confirmed (true, false, 1, 0)",
+ "type": "boolean",
+ "enum": [
+ "true",
+ "false",
+ "1",
+ "0",
+ true,
+ false,
+ 1,
+ 0
+ ]
+ },
+ "is_blacklisted": {
+ "description": "Whether subscriber is blacklisted (true, false, 1, 0)",
+ "type": "boolean",
+ "enum": [
+ "true",
+ "false",
+ "1",
+ "0",
+ true,
+ false,
+ 1,
+ 0
+ ]
+ },
+ "columns": {
+ "description": "Columns to include in the export",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": [
+ "id",
+ "email",
+ "confirmed",
+ "blacklisted",
+ "bounceCount",
+ "createdAt",
+ "updatedAt",
+ "uniqueId",
+ "htmlEmail",
+ "rssFrequency",
+ "disabled",
+ "extraData",
+ "foreignKey"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "SubscriptionRequest": {
+ "required": [
+ "emails"
+ ],
+ "properties": {
+ "emails": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "email"
+ },
+ "example": [
+ "test1@example.com",
+ "test2@example.com"
+ ]
+ },
+ "autoConfirm": {
+ "description": "Whether to automatically confirm subscriptions",
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "type": "object"
+ },
+ "UpdateSubscriberRequest": {
+ "required": [
+ "email"
+ ],
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "string",
+ "example": "admin@example.com"
+ },
+ "confirmed": {
+ "type": "boolean",
+ "example": false
+ },
+ "blacklisted": {
+ "type": "boolean",
+ "example": false
+ },
+ "html_email": {
+ "type": "boolean",
+ "example": false
+ },
+ "disabled": {
+ "type": "boolean",
+ "example": false
+ }
+ },
+ "type": "object"
+ },
+ "AttributeDefinition": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "name": {
+ "type": "string",
+ "example": "Country"
+ },
+ "type": {
+ "type": "string",
+ "example": "checkbox",
+ "nullable": true
+ },
+ "list_order": {
+ "type": "integer",
+ "example": 12
+ },
+ "default_value": {
+ "type": "string",
+ "example": "United States"
+ },
+ "required": {
+ "type": "boolean",
+ "example": true
+ },
+ "options": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DynamicListAttrOption"
+ },
+ "nullable": true
+ }
+ },
+ "type": "object"
+ },
+ "DynamicListAttrOption": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1,
+ "nullable": false
+ },
+ "name": {
+ "type": "string",
+ "example": "United States"
+ },
+ "list_order": {
+ "type": "integer",
+ "example": 1,
+ "nullable": false
+ }
+ },
+ "type": "object"
+ },
+ "SubscribePage": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "title": {
+ "type": "string",
+ "example": "Subscribe to our newsletter"
+ },
+ "active": {
+ "type": "boolean",
+ "example": true
+ },
+ "owner": {
+ "$ref": "#/components/schemas/Administrator"
+ }
+ },
+ "type": "object"
+ },
+ "SubscriberAttributeValue": {
+ "properties": {
+ "subscriber": {
+ "$ref": "#/components/schemas/Subscriber"
+ },
+ "definition": {
+ "$ref": "#/components/schemas/AttributeDefinition"
+ },
+ "value": {
+ "type": "string",
+ "example": "United States"
+ }
+ },
+ "type": "object"
+ },
+ "SubscriberHistory": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "ip": {
+ "type": "string",
+ "example": "127.0.0.1"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-12-01T10:00:00Z"
+ },
+ "summary": {
+ "type": "string",
+ "example": "Added by admin"
+ },
+ "detail": {
+ "type": "string",
+ "example": "Added with add-email on test"
+ },
+ "system_info": {
+ "type": "string",
+ "example": "HTTP_USER_AGENT = Mozilla/5.0"
+ }
+ },
+ "type": "object"
+ },
+ "SubscriberList": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 2
+ },
+ "name": {
+ "type": "string",
+ "example": "Newsletter"
+ },
+ "description": {
+ "type": "string",
+ "example": "Monthly updates"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-12-01T10:00:00Z"
+ },
+ "list_position": {
+ "type": "integer",
+ "example": 1
+ },
+ "subject_prefix": {
+ "type": "string",
+ "example": "[News]"
+ },
+ "public": {
+ "type": "boolean",
+ "example": true
+ },
+ "category": {
+ "type": "string",
+ "example": "Marketing"
+ },
+ "rss_feed": {
+ "type": "string",
+ "example": "https://example.com/blog/rss"
+ }
+ },
+ "type": "object"
+ },
+ "Subscriber": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "email": {
+ "type": "string",
+ "example": "subscriber@example.com"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2023-01-01T12:00:00Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2026-01-01T12:00:00Z"
+ },
+ "confirmed": {
+ "type": "boolean",
+ "example": true
+ },
+ "blacklisted": {
+ "type": "boolean",
+ "example": false
+ },
+ "bounce_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "unique_id": {
+ "type": "string",
+ "example": "69f4e92cf50eafca9627f35704f030f4"
+ },
+ "uuid": {
+ "type": "string",
+ "example": "69f4e92-cf50eaf-ca9627f-35704f-030f4"
+ },
+ "html_email": {
+ "type": "boolean",
+ "example": true
+ },
+ "disabled": {
+ "type": "boolean",
+ "example": false
+ },
+ "subscribed_lists": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubscriberList"
+ }
+ },
+ "history": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubscriberHistory"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "SubscriberOnly": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "email": {
+ "type": "string",
+ "example": "subscriber@example.com"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2023-01-01T12:00:00Z"
+ },
+ "confirmed": {
+ "type": "boolean",
+ "example": true
+ },
+ "blacklisted": {
+ "type": "boolean",
+ "example": false
+ },
+ "bounce_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "unique_id": {
+ "type": "string",
+ "example": "69f4e92cf50eafca9627f35704f030f4"
+ },
+ "html_email": {
+ "type": "boolean",
+ "example": true
+ },
+ "disabled": {
+ "type": "boolean",
+ "example": false
+ }
+ },
+ "type": "object"
+ },
+ "Subscription": {
+ "properties": {
+ "subscriber": {
+ "$ref": "#/components/schemas/SubscriberOnly"
+ },
+ "subscriber_list": {
+ "$ref": "#/components/schemas/SubscriberList"
+ },
+ "subscription_date": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2023-01-01T12:00:00Z"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "admin-attributes",
+ "description": "admin-attributes"
+ },
+ {
+ "name": "administrators",
+ "description": "administrators"
+ },
+ {
+ "name": "password-reset",
+ "description": "password-reset"
+ },
+ {
+ "name": "sessions",
+ "description": "sessions"
+ },
+ {
+ "name": "attachments",
+ "description": "attachments"
+ },
+ {
+ "name": "bounces",
+ "description": "bounces"
+ },
+ {
+ "name": "campaigns",
+ "description": "campaigns"
+ },
+ {
+ "name": "list-messages",
+ "description": "list-messages"
+ },
+ {
+ "name": "templates",
+ "description": "templates"
+ },
+ {
+ "name": "analytics",
+ "description": "analytics"
+ },
+ {
+ "name": "tracking",
+ "description": "tracking"
+ },
+ {
+ "name": "blacklist",
+ "description": "blacklist"
+ },
+ {
+ "name": "subscriptions",
+ "description": "subscriptions"
+ },
+ {
+ "name": "subscriber-attributes",
+ "description": "subscriber-attributes"
+ },
+ {
+ "name": "subscribers",
+ "description": "subscribers"
+ },
+ {
+ "name": "lists",
+ "description": "lists"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/package.json b/package.json
index 32b4577..43f74e5 100644
--- a/package.json
+++ b/package.json
@@ -2,19 +2,39 @@
"devDependencies": {
"@babel/core": "^7.27.4",
"@babel/preset-env": "^7.27.2",
+ "@vitejs/plugin-vue": "^5.2.4",
"@symfony/webpack-encore": "^5.1.0",
+ "@tailwindcss/postcss": "^4.2.1",
+ "@vue/compiler-sfc": "^3.5.16",
+ "@vue/test-utils": "^2.4.6",
+ "autoprefixer": "^10.4.27",
"babel-loader": "^10.0.0",
+ "copy-webpack-plugin": "^12.0.2",
+ "file-loader": "^6.0.0",
"husky": "^9.1.7",
+ "jsdom": "^26.1.0",
+ "postcss": "^8.5.6",
+ "postcss-loader": "^8.1.0",
+ "tailwindcss": "^4.2.1",
+ "vite": "^5.4.19",
+ "vitest": "^2.1.8",
"vue-loader": "^17.3.1",
- "vue-template-compiler": "^2.7.14",
- "webpack": "^5.99.9",
- "webpack-cli": "^6.0.1",
+ "webpack": "5.104.1",
+ "webpack-cli": "^5.1.4",
"webpack-notifier": "^1.15.0"
},
"dependencies": {
- "vue": "^3.5.16"
+ "@ckeditor/ckeditor5-vue": "^7.4.0",
+ "@tatevikgr/rest-api-client": "^2.1.0",
+ "apexcharts": "^5.10.4",
+ "ckeditor5": "^48.0.0",
+ "vue": "^3.5.16",
+ "vue-router": "4",
+ "vue3-apexcharts": "^1.11.1"
},
"scripts": {
- "prepare": "husky install"
+ "prepare": "husky install",
+ "test:vue": "vitest run",
+ "test:vue:watch": "vitest"
}
}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
index 78ea4f9..4e0d445 100644
--- a/phpunit.xml.dist
+++ b/phpunit.xml.dist
@@ -8,6 +8,7 @@
bootstrap="vendor/autoload.php"
>
+
diff --git a/postcss.config.js b/postcss.config.js
new file mode 100644
index 0000000..b77fda6
--- /dev/null
+++ b/postcss.config.js
@@ -0,0 +1,6 @@
+module.exports = {
+ plugins: [
+ require("@tailwindcss/postcss"),
+ require('autoprefixer'),
+ ],
+};
diff --git a/src/Controller/AuthController.php b/src/Controller/AuthController.php
index 4564f15..1a1408d 100755
--- a/src/Controller/AuthController.php
+++ b/src/Controller/AuthController.php
@@ -7,25 +7,26 @@
use Exception;
use GuzzleHttp\Exception\GuzzleException;
use PhpList\RestApiClient\Endpoint\AuthClient;
+use Psr\Log\LoggerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;
class AuthController extends AbstractController
{
- private AuthClient $apiClient;
-
- public function __construct(AuthClient $apiClient)
- {
- $this->apiClient = $apiClient;
+ public function __construct(
+ private readonly AuthClient $authClient,
+ private readonly LoggerInterface $logger
+ ) {
}
#[Route('/login', name: 'login', methods: ['GET', 'POST'])]
public function login(Request $request): Response
{
if ($request->getSession()->has('auth_token')) {
- return $this->redirectToRoute('empty_start_page');
+ return $this->redirectToRoute('home');
}
$error = null;
@@ -36,23 +37,31 @@ public function login(Request $request): Response
}
if ($request->isMethod('POST')) {
- $username = $request->request->get('username');
- $password = $request->request->get('password');
+ $username = trim((string) $request->request->get('username', ''));
+ $password = (string) $request->request->get('password', '');
+
+ if ($username === '' || $password === '') {
+ return $this->render('@PhpListFrontend/auth/login.html.twig', [
+ 'error' => 'Username and password are required.',
+ ]);
+ }
try {
- $authData = $this->apiClient->login($username, $password);
+ $authData = $this->authClient->login($username, $password);
$request->getSession()->set('auth_token', $authData['key']);
- $request->getSession()->set('auth_expiry_date', $authData['key']);
+ $request->getSession()->set('auth_expiry_date', $authData['expiry_date']);
+ $request->getSession()->set('auth_id', (int) $authData['id']);
+ $request->getSession()->save();
- return $this->redirectToRoute('empty_start_page');
+ return $this->redirectToRoute('home');
} catch (Exception $e) {
- $error = 'Invalid credentials or server error: ' . $e->getMessage();
+ $error = $e->getCode() === 401 ? 'Invalid credentials: ' . $e->getMessage() : $e->getMessage();
} catch (GuzzleException $e) {
$error = 'Invalid credentials or server error: ' . $e->getMessage();
}
}
- return $this->render('auth/login.html.twig', [
+ return $this->render('@PhpListFrontend/auth/login.html.twig', [
'error' => $error,
]);
}
@@ -61,7 +70,26 @@ public function login(Request $request): Response
public function logout(Request $request): Response
{
$request->getSession()->remove('auth_token');
+ $request->getSession()->remove('auth_id');
+ $this->authClient->logout();
return $this->redirectToRoute('login');
}
+
+ #[Route('/admin-about', name: 'admin_about')]
+ public function about(): JsonResponse
+ {
+ try {
+ $user = $this->authClient->getSessionUser();
+ } catch (Exception | GuzzleException $e) {
+ $this->logger->error('Unable to load current user: ' . $e->getMessage());
+
+ return new JsonResponse(
+ ['error' => 'Unable to load current user.'],
+ Response::HTTP_SERVICE_UNAVAILABLE
+ );
+ }
+
+ return new JsonResponse($user->toArray());
+ }
}
diff --git a/src/Controller/CampaignsController.php b/src/Controller/CampaignsController.php
new file mode 100644
index 0000000..dbf9d6a
--- /dev/null
+++ b/src/Controller/CampaignsController.php
@@ -0,0 +1,44 @@
+render('@PhpListFrontend/spa.html.twig', [
+ 'page' => 'Campaigns',
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ ]);
+ }
+
+ #[Route('/create', name: 'create', methods: ['GET'])]
+ public function create(Request $request): Response
+ {
+ return $this->render('@PhpListFrontend/spa.html.twig', [
+ 'page' => 'Create Campaign',
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ ]);
+ }
+
+ #[Route('/{campaignId}/edit', name: 'edit', methods: ['GET'])]
+ public function edit(Request $request, int $campaignId): Response
+ {
+ return $this->render('@PhpListFrontend/spa.html.twig', [
+ 'page' => sprintf('Edit Campaign #%d', $campaignId),
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ ]);
+ }
+}
diff --git a/src/Controller/DashboardController.php b/src/Controller/DashboardController.php
new file mode 100755
index 0000000..ac9ee6e
--- /dev/null
+++ b/src/Controller/DashboardController.php
@@ -0,0 +1,75 @@
+statisticsClient->getDashboardStats();
+ $recentCampaigns = [];
+ foreach ($stats->recentCampaigns as $campaign) {
+ $recentCampaigns[] = [
+ 'name' => $campaign->name,
+ 'status' => $campaign->status,
+ 'date' => $campaign->date?->format('Y-m-d') ?? '',
+ 'openRate' => $campaign->openRate,
+ 'clickRate' => $campaign->clickRate,
+ ];
+ }
+
+ $chartLabels = [];
+ $chartOpens = [];
+ $chartClicks = [];
+ foreach ($stats->campaignPerformance as $point) {
+ $chartLabels[] = $point->date?->format('M d') ?? '';
+ $chartOpens[] = $point->opens;
+ $chartClicks[] = $point->clicks;
+ }
+
+ return $this->render('@PhpListFrontend/spa.html.twig', [
+ 'page' => 'Dashboard',
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ 'dashboard_stats' => [
+ 'total_subscribers' => [
+ 'value' => $stats->totalSubscribers->value,
+ 'change_vs_last_month' => $stats->totalSubscribers->changeVsLastMonth,
+ ],
+ 'active_campaigns' => [
+ 'value' => $stats->activeCampaigns->value,
+ 'change_vs_last_month' => $stats->activeCampaigns->changeVsLastMonth,
+ ],
+ 'open_rate' => [
+ 'value' => $stats->openRate->value,
+ 'change_vs_last_month' => $stats->openRate->changeVsLastMonth,
+ ],
+ 'bounce_rate' => [
+ 'value' => $stats->bounceRate->value,
+ 'change_vs_last_month' => $stats->bounceRate->changeVsLastMonth,
+ ],
+ 'recent_campaigns' => $recentCampaigns,
+ 'chart' => [
+ 'labels' => $chartLabels,
+ 'series' => [
+ ['name' => 'Opens', 'data' => $chartOpens],
+ ['name' => 'Clicks', 'data' => $chartClicks],
+ ],
+ ],
+ ],
+ ]);
+ }
+}
diff --git a/src/Controller/ListsController.php b/src/Controller/ListsController.php
new file mode 100644
index 0000000..94e63f7
--- /dev/null
+++ b/src/Controller/ListsController.php
@@ -0,0 +1,47 @@
+headers->get('Accept', '');
+ $wantsJson = $request->isXmlHttpRequest() || str_contains($accept, 'application/json');
+ if (! $wantsJson) {
+ return $this->render('@PhpListFrontend/spa.html.twig', [
+ 'page' => 'Lists',
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ ]);
+ }
+ $initialData = $this->listClient->getLists();
+
+ return $this->json($initialData);
+ }
+
+ #[Route('/{listId}/subscribers', name: 'list_subscribers', methods: ['GET'])]
+ public function view(Request $request, int $listId): JsonResponse|Response
+ {
+ return $this->render('@PhpListFrontend/spa.html.twig', [
+ 'page' => 'List Subscribers',
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ ]);
+ }
+}
diff --git a/src/Controller/SubscribersController.php b/src/Controller/SubscribersController.php
new file mode 100644
index 0000000..8d542ed
--- /dev/null
+++ b/src/Controller/SubscribersController.php
@@ -0,0 +1,122 @@
+headers->get('Accept', '');
+ $wantsJson = $request->isXmlHttpRequest() || str_contains($accept, 'application/json');
+ if (! $wantsJson) {
+ return $this->render('@PhpListFrontend/spa.html.twig', [
+ 'page' => 'Subscribers',
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ ]);
+ }
+
+ $afterId = $request->query->has('after_id') ? $request->query->getInt('after_id') : null;
+
+ $filter = new SubscribersFilterRequest(
+ isConfirmed: $request->query->has('confirmed') ? true :
+ ($request->query->has('unconfirmed') ? false : null),
+ isBlacklisted: $request->query->has('blacklisted') ? true :
+ ($request->query->has('non-blacklisted') ? false : null),
+ findColumn: $request->query->get('findColumn'),
+ findValue: $request->query->get('findValue'),
+ );
+
+ $collection = $this->subscribersClient->getSubscribers($filter, $afterId, 10);
+
+ $history = $request->getSession()->get('subscribers_history', []);
+ if (!in_array($afterId, $history, true)) {
+ $history[] = $afterId;
+ $request->getSession()->set('subscribers_history', $history);
+ }
+
+ $prevId = null;
+ $index = array_search($afterId, $history, true);
+ if ($index === 0) {
+ $prevId = 0;
+ } elseif ($index > 0) {
+ $prevId = $history[$index - 1];
+ }
+
+ return $this->json($this->subscriberCollectionNormalizer->normalize($collection, $prevId, $afterId));
+ }
+
+ /**
+ * @SuppressWarnings("CyclomaticComplexity")
+ */
+ #[Route('/export', name: 'export', methods: ['GET'])]
+ public function export(Request $request): Response
+ {
+ $exportRequest = $this->subscriberExportRequestFactory->fromQuery($request->query);
+
+ $upstreamResponse = $this->subscribersClient->exportSubscribers($exportRequest);
+ $statusCode = $upstreamResponse->getStatusCode();
+ $isSuccessfulExport = $statusCode >= 200 && $statusCode < 300;
+
+ $contentType = $upstreamResponse->getHeaderLine('Content-Type');
+ if ($isSuccessfulExport && $contentType === '') {
+ $contentType = 'text/csv; charset=UTF-8';
+ }
+
+ $contentDisposition = $upstreamResponse->getHeaderLine('Content-Disposition');
+ if ($isSuccessfulExport && $contentDisposition === '') {
+ $contentDisposition = sprintf(
+ 'attachment; filename="subscribers_export_%s.csv"',
+ date('Y-m-d_H-i-s')
+ );
+ }
+
+ $body = $upstreamResponse->getBody();
+ $response = new StreamedResponse(
+ static function () use ($body): void {
+ if ($body->isSeekable()) {
+ $body->rewind();
+ }
+ while (! $body->eof()) {
+ echo $body->read(8192);
+ }
+ },
+ $statusCode
+ );
+ if ($contentType !== '') {
+ $response->headers->set('Content-Type', $contentType);
+ }
+
+ if ($contentDisposition !== '') {
+ $response->headers->set('Content-Disposition', $contentDisposition);
+ }
+
+ return $response;
+ }
+}
diff --git a/src/Controller/TemplatesController.php b/src/Controller/TemplatesController.php
new file mode 100644
index 0000000..5d0cb29
--- /dev/null
+++ b/src/Controller/TemplatesController.php
@@ -0,0 +1,44 @@
+render('@PhpListFrontend/spa.html.twig', [
+ 'page' => 'Templates',
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ ]);
+ }
+
+ #[Route('/create', name: 'create', methods: ['GET'])]
+ public function create(Request $request): Response
+ {
+ return $this->render('@PhpListFrontend/spa.html.twig', [
+ 'page' => 'Create Template',
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ ]);
+ }
+
+ #[Route('/{templateId}/edit', name: 'edit', methods: ['GET'])]
+ public function edit(Request $request, int $templateId): Response
+ {
+ return $this->render('@PhpListFrontend/spa.html.twig', [
+ 'page' => sprintf('Edit Template #%d', $templateId),
+ 'api_token' => $request->getSession()->get('auth_token'),
+ 'api_base_url' => $this->getParameter('api_base_url'),
+ ]);
+ }
+}
diff --git a/src/DependencyInjection/Compiler/RegisterEndpointsPass.php b/src/DependencyInjection/Compiler/RegisterEndpointsPass.php
new file mode 100644
index 0000000..0ca910c
--- /dev/null
+++ b/src/DependencyInjection/Compiler/RegisterEndpointsPass.php
@@ -0,0 +1,62 @@
+hasParameter('kernel.application_dir')
+ ? $container->getParameter('kernel.application_dir')
+ : $container->getParameter('kernel.project_dir');
+
+ if (! is_string($projectDir)) {
+ return;
+ }
+
+ $endpointDirectory = rtrim($projectDir, '/') . '/vendor/tatevikgr/rest-api-client/src/Endpoint';
+ if (! is_dir($endpointDirectory)) {
+ return;
+ }
+
+ $endpointFiles = glob($endpointDirectory . '/*.php') ?: [];
+
+ foreach ($endpointFiles as $endpointFile) {
+ $className = 'PhpList\\RestApiClient\\Endpoint\\' . basename($endpointFile, '.php');
+
+ if ($container->hasDefinition($className) || $container->hasAlias($className)) {
+ continue;
+ }
+
+ try {
+ if (! class_exists($className)) {
+ continue;
+ }
+
+ $reflection = new ReflectionClass($className);
+ if (! $reflection->isInstantiable()) {
+ continue;
+ }
+ } catch (ReflectionException) {
+ continue;
+ }
+
+ $container
+ ->autowire($className, $className)
+ ->setAutowired(true)
+ ->setAutoconfigured(true)
+ ->setPublic(false);
+ }
+ }
+}
diff --git a/src/DependencyInjection/PhpListFrontendExtension.php b/src/DependencyInjection/PhpListFrontendExtension.php
index 46f66e5..120eca2 100755
--- a/src/DependencyInjection/PhpListFrontendExtension.php
+++ b/src/DependencyInjection/PhpListFrontendExtension.php
@@ -8,11 +8,15 @@
use InvalidArgumentException;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-class PhpListFrontendExtension extends Extension
+class PhpListFrontendExtension extends Extension implements PrependExtensionInterface
{
+ private const TWIG_NAMESPACE = 'PhpListFrontend';
+ private const ASSET_PACKAGE_NAME = 'phplist_web_frontend';
+
/**
* Loads a specific configuration.
*
@@ -27,7 +31,59 @@ public function load(array $configs, ContainerBuilder $container): void
{
// @phpstan-ignore-next-line
$configs;
- $loader = new YamlFileLoader($container, new FileLocator(__DIR__ . '/../../config'));
+ $loader = new YamlFileLoader($container, new FileLocator($this->getBundlePath() . '/config'));
$loader->load('services.yml');
}
+
+ public function prepend(ContainerBuilder $container): void
+ {
+ $bundlePath = $this->getBundlePath();
+
+ $container->prependExtensionConfig('twig', [
+ 'paths' => [
+ $bundlePath . '/templates' => self::TWIG_NAMESPACE,
+ ],
+ ]);
+
+ $container->prependExtensionConfig('framework', [
+ 'assets' => [
+ 'packages' => [
+ self::ASSET_PACKAGE_NAME => [
+ 'base_path' => '/',
+ ],
+ ],
+ ],
+ ]);
+
+// $container->prependExtensionConfig('security', [
+// 'providers' => [
+// 'in_memory' => ['memory' => null],
+// ],
+// 'firewalls' => [
+// 'api' => [
+// 'pattern' => '^/api/v2',
+// 'security' => false,
+// ],
+// 'main' => [
+// 'lazy' => true,
+// 'provider' => 'in_memory',
+// 'pattern' => '^/',
+// 'custom_authenticators' => [
+// 'PhpList\\WebFrontend\\Security\\SessionAuthenticator',
+// ],
+// 'entry_point' => 'PhpList\\WebFrontend\\Security\\SessionAuthenticator',
+// ],
+// ],
+// 'access_control' => [
+// ['path' => '^/login', 'roles' => 'PUBLIC_ACCESS'],
+// ['path' => '^/api/v2', 'roles' => 'PUBLIC_ACCESS'],
+// ['path' => '^/', 'roles' => 'ROLE_ADMIN'],
+// ],
+// ]);
+ }
+
+ private function getBundlePath(): string
+ {
+ return dirname(__DIR__, 2);
+ }
}
diff --git a/src/EventListener/ApiSessionListener.php b/src/EventListener/ApiSessionListener.php
new file mode 100644
index 0000000..7cf7160
--- /dev/null
+++ b/src/EventListener/ApiSessionListener.php
@@ -0,0 +1,48 @@
+ ['onKernelRequest', 10],
+ ];
+ }
+
+ public function onKernelRequest(RequestEvent $event): void
+ {
+ if (!$event->isMainRequest()) {
+ return;
+ }
+
+ $request = $event->getRequest();
+ if (!$request->hasSession()) {
+ return;
+ }
+
+ $session = $request->getSession();
+ $authToken = $session->get('auth_token');
+
+ if ($authToken) {
+ $this->apiClient->setSessionId((string) $authToken);
+ }
+
+ $authId = $session->get('auth_id');
+ if ($authId) {
+ $this->apiClient->setId((int) $authId);
+ }
+ }
+}
diff --git a/src/EventSubscriber/AuthGateSubscriber.php b/src/EventSubscriber/AuthGateSubscriber.php
new file mode 100644
index 0000000..5fa61fd
--- /dev/null
+++ b/src/EventSubscriber/AuthGateSubscriber.php
@@ -0,0 +1,91 @@
+ ['onKernelRequest', 8],
+ ];
+ }
+
+ public function onKernelRequest(RequestEvent $event): void
+ {
+ if (!$event->isMainRequest()) {
+ return;
+ }
+
+ $request = $event->getRequest();
+ if ($this->isPublicPath($request)) {
+ return;
+ }
+
+ $session = $request->getSession();
+ if (!$session->has('auth_token')) {
+ $loginUrl = $this->urlGenerator->generate('login');
+ $event->setResponse(new RedirectResponse($loginUrl));
+ }
+ }
+
+ private function isPublicPath(Request $request): bool
+ {
+ $path = $this->normalizePath($request->getPathInfo());
+
+ // Public login route
+ if ($path === '/login' || str_starts_with($path, '/login')) {
+ return true;
+ }
+
+ // Allow Symfony debug/profiler and WDT if present
+ if (str_starts_with($path, '/_profiler') || str_starts_with($path, '/_wdt')) {
+ return true;
+ }
+
+ // Allow static assets commonly served under these prefixes
+ foreach (self::ALLOW_LIST as $prefix) {
+ if (str_starts_with($path, $prefix)) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ private function normalizePath(string $path): string
+ {
+ return (string) preg_replace('#^/(?:app|app_test)\.php#', '', $path, 1);
+ }
+}
diff --git a/src/EventSubscriber/UnauthorizedSubscriber.php b/src/EventSubscriber/UnauthorizedSubscriber.php
index ea45c1a..017843f 100755
--- a/src/EventSubscriber/UnauthorizedSubscriber.php
+++ b/src/EventSubscriber/UnauthorizedSubscriber.php
@@ -5,19 +5,18 @@
namespace PhpList\WebFrontend\EventSubscriber;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
-use GuzzleHttp\Exception\ClientException;
+use PhpList\RestApiClient\Exception\AuthenticationException;
class UnauthorizedSubscriber implements EventSubscriberInterface
{
- private UrlGeneratorInterface $urlGenerator;
-
- public function __construct(UrlGeneratorInterface $urlGenerator)
- {
- $this->urlGenerator = $urlGenerator;
+ public function __construct(
+ private readonly UrlGeneratorInterface $urlGenerator,
+ ) {
}
public static function getSubscribedEvents(): array
@@ -31,20 +30,35 @@ public function onKernelException(ExceptionEvent $event): void
{
$exception = $event->getThrowable();
- if ($exception instanceof ClientException && $exception->getCode() === 401) {
+ if ($exception instanceof AuthenticationException) {
$request = $event->getRequest();
- $session = $request->getSession();
- if ($session->has('auth_token')) {
- $session->remove('auth_token');
+ if ($request->hasSession()) {
+ $session = $request->getSession();
+ $session->invalidate();
}
- $session->set('login_error', 'Your session has expired. Please log in again.');
-
$loginUrl = $this->urlGenerator->generate('login');
- $response = new RedirectResponse($loginUrl);
- $event->setResponse($response);
+ if ($request->isXmlHttpRequest()) {
+ $event->setResponse(new JsonResponse([
+ 'error' => 'session_expired',
+ 'message' => 'Your session has expired. Please log in again.',
+ 'redirect' => $loginUrl,
+ ], 401));
+
+ return;
+ }
+
+ if ($request->hasSession()) {
+ $session = $request->getSession();
+
+ if (method_exists($session, 'getFlashBag')) {
+ $session->getFlashBag()->add('error', 'Your session has expired. Please log in again.');
+ }
+ }
+
+ $event->setResponse(new RedirectResponse($loginUrl));
}
}
}
diff --git a/src/PhpListFrontendBundle.php b/src/PhpListFrontendBundle.php
index ec5e5f8..c9f965b 100755
--- a/src/PhpListFrontendBundle.php
+++ b/src/PhpListFrontendBundle.php
@@ -4,8 +4,16 @@
namespace PhpList\WebFrontend;
+use PhpList\WebFrontend\DependencyInjection\Compiler\RegisterEndpointsPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Bundle\Bundle;
class PhpListFrontendBundle extends Bundle
{
+ public function build(ContainerBuilder $container): void
+ {
+ parent::build($container);
+
+ $container->addCompilerPass(new RegisterEndpointsPass());
+ }
}
diff --git a/src/Security/SessionAuthenticator.php b/src/Security/SessionAuthenticator.php
new file mode 100644
index 0000000..36a5865
--- /dev/null
+++ b/src/Security/SessionAuthenticator.php
@@ -0,0 +1,75 @@
+normalizePath($request->getPathInfo());
+ if ($path === '/login' || str_starts_with($path, '/login/')) {
+ return false;
+ }
+
+ return true;
+ }
+
+ private function normalizePath(string $path): string
+ {
+ return (string) preg_replace('#^/(?:app|app_test)\.php#', '', $path, 1);
+ }
+
+ public function authenticate(Request $request): Passport
+ {
+ if (!$request->hasSession()) {
+ throw new AuthenticationException('Session is not available');
+ }
+ $session = $request->getSession();
+
+ if ($session->has('auth_token')) {
+ // Build a simple user granted ROLE_ADMIN when a session token exists
+ $userBadge = new UserBadge('session-user', function (): InMemoryUser {
+ return new InMemoryUser('session-user', '', ['ROLE_ADMIN']);
+ });
+
+ return new SelfValidatingPassport($userBadge);
+ }
+
+ throw new AuthenticationException('No auth token in session');
+ }
+
+ public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
+ {
+ return null;
+ }
+
+ public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
+ {
+ return $this->start($request, $exception);
+ }
+
+ public function start(Request $request, AuthenticationException $authException = null): Response
+ {
+ $loginUrl = $this->urlGenerator->generate('login');
+ return new RedirectResponse($loginUrl);
+ }
+}
diff --git a/src/Service/ApiClient.php b/src/Service/ApiClient.php
deleted file mode 100755
index b0b89ab..0000000
--- a/src/Service/ApiClient.php
+++ /dev/null
@@ -1,85 +0,0 @@
-client = new Client([
- 'base_uri' => $baseUrl,
- 'headers' => [
- 'Authorization' => 'Bearer ' . $this->authToken,
- 'Accept' => 'application/json',
- ]
- ]);
- }
-
- /**
- * @throws GuzzleException
- * @throws RuntimeException
- */
- public function authenticate(string $username, string $password): array
- {
- try {
- $response = $this->request('POST', '/api/v2/sessions', [
- 'json' => [
- 'loginName' => $username,
- 'password' => $password,
- ]
- ]);
-
- if (!isset($response['key'])) {
- throw new RuntimeException('Authentication failed: No token received');
- }
-
- return $response;
- } catch (GuzzleException $e) {
- if ($e->getCode() === 401) {
- throw new RuntimeException('Invalid credentials', 401, $e);
- }
- throw $e;
- }
- }
-
- public function setAuthToken(string $token): void
- {
- $this->authToken = $token;
- }
-
- /**
- * @throws GuzzleException
- * @throws JsonException
- */
- private function request(string $method, string $endpoint, array $options = []): array
- {
- if ($this->authToken) {
- $options['headers'] = [
- 'Authorization' => 'Bearer ' . $this->authToken,
- ...$options['headers'] ?? [],
- ];
- }
-
- $response = $this->client->request($method, $endpoint, $options);
-
- return json_decode(
- $response->getBody()->getContents(),
- true,
- 512,
- JSON_THROW_ON_ERROR
- );
- }
-}
diff --git a/src/Service/SubscriberCollectionNormalizer.php b/src/Service/SubscriberCollectionNormalizer.php
new file mode 100644
index 0000000..9be312e
--- /dev/null
+++ b/src/Service/SubscriberCollectionNormalizer.php
@@ -0,0 +1,37 @@
+ array_map(static function (Subscriber $subscriber) {
+ return [
+ 'id' => $subscriber->id,
+ 'email' => $subscriber->email,
+ 'confirmed' => $subscriber->confirmed,
+ 'blacklisted' => $subscriber->blacklisted,
+ 'createdAt' => (new DateTimeImmutable($subscriber->createdAt))->format('Y-m-d H:i:s'),
+ 'uniqueId' => $subscriber->uniqueId,
+ 'listCount' => count($subscriber->subscribedLists),
+ ];
+ }, $collection->items ?? []),
+ 'pagination' => [
+ 'limit' => $collection->pagination->limit,
+ 'afterId' => $collection->pagination->nextCursor,
+ 'hasMore' => $collection->pagination->hasMore,
+ 'total' => $collection->pagination->total,
+ 'prevId' => $prevId,
+ 'isFirstPage' => $afterId === null,
+ ],
+ ];
+ }
+}
diff --git a/src/Service/SubscriberExportRequestFactory.php b/src/Service/SubscriberExportRequestFactory.php
new file mode 100644
index 0000000..3a32509
--- /dev/null
+++ b/src/Service/SubscriberExportRequestFactory.php
@@ -0,0 +1,26 @@
+get('date_type', 'any'),
+ listId: $query->has('list_id') ? $query->getInt('list_id') : null,
+ dateFrom: $query->get('date_from') ?: null,
+ dateTo: $query->get('date_to') ?: null,
+ columns: array_values(array_filter($query->all('columns'))),
+ isConfirmed: $query->has('confirmed') ? true :
+ ($query->has('unconfirmed') ? false : null),
+ isBlacklisted: $query->has('blacklisted') ? true :
+ ($query->has('non-blacklisted') ? false : null),
+ );
+ }
+}
diff --git a/tailwind.config.js b/tailwind.config.js
new file mode 100644
index 0000000..65943cb
--- /dev/null
+++ b/tailwind.config.js
@@ -0,0 +1,36 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+ content: [
+ "./templates/**/*.twig",
+ "./themes/**/**/*.twig",
+ "./assets/vue/*.vue",
+ "./assets/vue/**/*.vue",
+ "./assets/vue/**/**/*.vue",
+ ],
+ theme: {
+ screens: {
+ xs: "0px",
+ sm: "576px",
+ md: "768px",
+ lg: "992px",
+ xl: "1200px",
+ },
+ extend: {
+ fontFamily: {
+ sans: ["Inter", "-apple-system", "sans-serif"],
+ body: ["Poppins", "-apple-system", "sans-serif"],
+ },
+ colors: {
+ 'ext-wf1': '#dc2626',
+ },
+ },
+ },
+ plugins: [],
+ corePlugins: {
+ preflight: false,
+ },
+ safelist: [
+ 'text-ext-wf1',
+ 'bg-ext-wf1',
+ ],
+};
diff --git a/templates/auth/login.html.twig b/templates/auth/login.html.twig
index 8ac6f04..e32f82c 100644
--- a/templates/auth/login.html.twig
+++ b/templates/auth/login.html.twig
@@ -1,29 +1,70 @@
{# templates/security/login.html.twig #}
-{% extends 'base.html.twig' %}
+{% extends '@PhpListFrontend/base.html.twig' %}
{% block title %}phpList - Login{% endblock %}
{% block body %}
-
-
Sign in to phpList
+
+
+
+
 }})
+
+ phpList 4
+
+
+
+
+
- {% if error %}
-
{{ error }}
- {% endif %}
+
+
Sign in to your account
+
+ Enter your credentials to access your dashboard.
+
-
+
+
+
+
+
+ Access is restricted to authorised administrators only.
+
+
+
+
+
+
+
Documentation
+
·
+
Support Forum
+
·
+
phpList v4.0.0-rc1
+
+
+
+
+
-
+
+{#
#}
{% endblock %}
diff --git a/templates/base.html.twig b/templates/base.html.twig
index 5223c6c..34c4376 100755
--- a/templates/base.html.twig
+++ b/templates/base.html.twig
@@ -4,22 +4,17 @@
{% block title %}phpList{% endblock %}
+
+
- {# Optionally include Bootstrap for styling #}
-
-
- {# Add your own custom CSS later if needed #}
- {{ encore_entry_link_tags('app') }}
+ {% block javascripts %}
+
+
+ {% endblock %}
-
+
{% block body %}{% endblock %}
-
-{# Optionally include Bootstrap JS if you use interactive components #}
-
-
-
-