|
1646 | 1646 | "tags": [ |
1647 | 1647 | "bounces" |
1648 | 1648 | ], |
1649 | | - "summary": "Create or update a bounce regex", |
1650 | | - "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).", |
1651 | | - "operationId": "91f09d8583ea3629b39c328464961dd8", |
| 1649 | + "summary": "Create a bounce regex", |
| 1650 | + "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Creates a new bounce regex.", |
| 1651 | + "operationId": "97db4cfc72576a22e0bcd6215fd35e51", |
1652 | 1652 | "parameters": [ |
1653 | 1653 | { |
1654 | 1654 | "name": "php-auth-pw", |
|
1661 | 1661 | } |
1662 | 1662 | ], |
1663 | 1663 | "requestBody": { |
1664 | | - "description": "Create or update a bounce regex rule.", |
| 1664 | + "description": "Create bounce regex rule", |
1665 | 1665 | "required": true, |
1666 | 1666 | "content": { |
1667 | 1667 | "application/json": { |
1668 | 1668 | "schema": { |
1669 | | - "required": [ |
1670 | | - "regex" |
1671 | | - ], |
1672 | | - "properties": { |
1673 | | - "regex": { |
1674 | | - "type": "string", |
1675 | | - "example": "/mailbox is full/i" |
1676 | | - }, |
1677 | | - "action": { |
1678 | | - "type": "string", |
1679 | | - "example": "delete", |
1680 | | - "nullable": true |
1681 | | - }, |
1682 | | - "list_order": { |
1683 | | - "type": "integer", |
1684 | | - "example": 0, |
1685 | | - "nullable": true |
1686 | | - }, |
1687 | | - "admin": { |
1688 | | - "type": "integer", |
1689 | | - "example": 1, |
1690 | | - "nullable": true |
1691 | | - }, |
1692 | | - "comment": { |
1693 | | - "type": "string", |
1694 | | - "example": "Auto-generated", |
1695 | | - "nullable": true |
1696 | | - }, |
1697 | | - "status": { |
1698 | | - "type": "string", |
1699 | | - "example": "active", |
1700 | | - "nullable": true |
1701 | | - } |
1702 | | - }, |
1703 | | - "type": "object" |
| 1669 | + "$ref": "#/components/schemas/BounceRegexRequest" |
1704 | 1670 | } |
1705 | 1671 | } |
1706 | 1672 | } |
|
1799 | 1765 | } |
1800 | 1766 | } |
1801 | 1767 | } |
| 1768 | + } |
| 1769 | + }, |
| 1770 | + "/api/v2/bounces/regex/{ruleId}": { |
| 1771 | + "put": { |
| 1772 | + "tags": [ |
| 1773 | + "bounces" |
| 1774 | + ], |
| 1775 | + "summary": "Update a bounce regex", |
| 1776 | + "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Updates an existing one.", |
| 1777 | + "operationId": "fefed1a3824116daedc42d65b0117230", |
| 1778 | + "parameters": [ |
| 1779 | + { |
| 1780 | + "name": "php-auth-pw", |
| 1781 | + "in": "header", |
| 1782 | + "description": "Session key obtained from login", |
| 1783 | + "required": true, |
| 1784 | + "schema": { |
| 1785 | + "type": "string" |
| 1786 | + } |
| 1787 | + }, |
| 1788 | + { |
| 1789 | + "name": "ruleId", |
| 1790 | + "in": "path", |
| 1791 | + "description": "regex rule ID", |
| 1792 | + "required": true, |
| 1793 | + "schema": { |
| 1794 | + "type": "integer" |
| 1795 | + } |
| 1796 | + } |
| 1797 | + ], |
| 1798 | + "requestBody": { |
| 1799 | + "description": "Update a bounce regex rule.", |
| 1800 | + "required": true, |
| 1801 | + "content": { |
| 1802 | + "application/json": { |
| 1803 | + "schema": { |
| 1804 | + "$ref": "#/components/schemas/BounceRegexRequest" |
| 1805 | + } |
| 1806 | + } |
| 1807 | + } |
| 1808 | + }, |
| 1809 | + "responses": { |
| 1810 | + "201": { |
| 1811 | + "description": "Success", |
| 1812 | + "content": { |
| 1813 | + "application/json": { |
| 1814 | + "schema": { |
| 1815 | + "$ref": "#/components/schemas/BounceRegex" |
| 1816 | + } |
| 1817 | + } |
| 1818 | + } |
| 1819 | + }, |
| 1820 | + "403": { |
| 1821 | + "description": "Failure", |
| 1822 | + "content": { |
| 1823 | + "application/json": { |
| 1824 | + "schema": { |
| 1825 | + "$ref": "#/components/schemas/UnauthorizedResponse" |
| 1826 | + } |
| 1827 | + } |
| 1828 | + } |
| 1829 | + }, |
| 1830 | + "404": { |
| 1831 | + "description": "Failure", |
| 1832 | + "content": { |
| 1833 | + "application/json": { |
| 1834 | + "schema": { |
| 1835 | + "$ref": "#/components/schemas/NotFoundErrorResponse" |
| 1836 | + } |
| 1837 | + } |
| 1838 | + } |
| 1839 | + }, |
| 1840 | + "422": { |
| 1841 | + "description": "Failure", |
| 1842 | + "content": { |
| 1843 | + "application/json": { |
| 1844 | + "schema": { |
| 1845 | + "$ref": "#/components/schemas/ValidationErrorResponse" |
| 1846 | + } |
| 1847 | + } |
| 1848 | + } |
| 1849 | + } |
| 1850 | + } |
1802 | 1851 | }, |
1803 | 1852 | "delete": { |
1804 | 1853 | "tags": [ |
1805 | 1854 | "bounces" |
1806 | 1855 | ], |
1807 | | - "summary": "Delete a bounce regex by its hash", |
1808 | | - "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete a bounce regex by its hash.", |
1809 | | - "operationId": "47b3de553732c5de46647709a42d2ced", |
| 1856 | + "summary": "Delete a bounce regex by its id", |
| 1857 | + "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete a bounce regex by its id.", |
| 1858 | + "operationId": "afe7121aa9c6652066ba8ca4e2c07fba", |
1810 | 1859 | "parameters": [ |
1811 | 1860 | { |
1812 | 1861 | "name": "php-auth-pw", |
|
7251 | 7300 | }, |
7252 | 7301 | "type": "object" |
7253 | 7302 | }, |
| 7303 | + "BounceRegexRequest": { |
| 7304 | + "required": [ |
| 7305 | + "regex", |
| 7306 | + "action", |
| 7307 | + "status" |
| 7308 | + ], |
| 7309 | + "properties": { |
| 7310 | + "regex": { |
| 7311 | + "type": "string", |
| 7312 | + "example": "/mailbox is full/i" |
| 7313 | + }, |
| 7314 | + "action": { |
| 7315 | + "type": "string", |
| 7316 | + "example": "delete", |
| 7317 | + "nullable": false |
| 7318 | + }, |
| 7319 | + "list_order": { |
| 7320 | + "type": "integer", |
| 7321 | + "example": 0, |
| 7322 | + "nullable": true |
| 7323 | + }, |
| 7324 | + "comment": { |
| 7325 | + "type": "string", |
| 7326 | + "example": "Auto-generated", |
| 7327 | + "nullable": true |
| 7328 | + }, |
| 7329 | + "status": { |
| 7330 | + "type": "string", |
| 7331 | + "example": "active", |
| 7332 | + "nullable": false |
| 7333 | + } |
| 7334 | + }, |
| 7335 | + "type": "object" |
| 7336 | + }, |
7254 | 7337 | "CreateTemplateRequest": { |
7255 | 7338 | "required": [ |
7256 | 7339 | "title" |
|
0 commit comments