@epilot/cli 0.1.203 → 0.1.205

package/definitions/email-settings.json

@@ -436,7 +436,7 @@
       "get": {
         "operationId": "listSharedInboxes",
         "summary": "listSharedInboxes",
-        "description": "Retrieves all shared inboxes configured for the organization.\n\n**Note**: The default inbox (with ID `default`) is not included in this list but is\nalways available for all organizations. You do not need to create it explicitly.\n",
+        "description": "Retrieves all shared inboxes configured for the organization.\n\n**Note**: The list always includes the default inbox (ID `default`, `bucket_id` `default`).\nIt is provisioned for the organization on first access, so you never need to create it.\n",
         "tags": [
           "Shared inboxes"
         ],
@@ -523,7 +523,7 @@
       "post": {
         "operationId": "connectOutlook",
         "summary": "connectOutlook",
-        "description": "Returns the Microsoft authorization URL for Outlook OAuth.\n\nThe request body selects which features to request scopes for. Feature\nflags are additive; Microsoft OAuth scopes are cumulative. Calling this\nendpoint again with a superset of features (e.g. `mail` already connected,\nand `calendar` added) triggers Microsoft's incremental-consent flow —\nthe user only sees a consent prompt for the new scopes.\n",
+        "description": "Returns the Microsoft authorization URL for Outlook OAuth.\n\nThe request body selects which features to request scopes for. Feature\nflags are additive; Microsoft OAuth scopes are cumulative. Calling this\nendpoint again with a superset of features (e.g. `mail` already connected,\nand `calendar` added) triggers Microsoft's incremental-consent flow —\nthe user only sees a consent prompt for the new scopes.\n\nRequires the Professional pricing tier or higher, except when reconnecting an\nexisting connection (the org's connection, or the user's own calendar) for\nfeatures it already has.\n",
         "tags": [
           "O365 Outlook Connection"
         ],
@@ -759,7 +759,7 @@
       "post": {
         "operationId": "connectMsTeams",
         "summary": "connectMsTeams",
-        "description": "Connects Microsoft Teams channel (click-to-call deep links, meetings) for the organization.\nRequires an active Microsoft 365 / Outlook connection.\n",
+        "description": "Connects Microsoft Teams channel (click-to-call deep links, meetings) for the organization.\nIndependent of the Microsoft 365 / Outlook connection.\n\nRequires the Professional pricing tier or higher.\n",
         "tags": [
           "Channels"
         ],
@@ -783,23 +783,8 @@
               }
             }
           },
-          "400": {
-            "description": "No active Outlook connection found",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "error": {
-                      "type": "string"
-                    },
-                    "message": {
-                      "type": "string"
-                    }
-                  }
-                }
-              }
-            }
+          "403": {
+            "$ref": "#/components/responses/PricingTierRequired"
           }
         }
       }
@@ -929,7 +914,7 @@
                       "6m",
                       "1y"
                     ],
-                    "description": "Optional timeframe for initial mailbox sync. When provided, triggers an automatic\nmailbox sync after connecting the mailbox, syncing emails from the specified period.\n"
+                    "description": "Optional timeframe for initial mailbox sync. When provided, triggers an automatic\nmailbox sync after connecting the mailbox, syncing emails from the specified period.\n`3m`, `6m` and `1y` require the `outlook-mailbox-sync-long-timeframes` feature for the\norganization; the request is rejected with 403 before anything is connected otherwise.\n"
                   }
                 }
               }
@@ -981,7 +966,7 @@
             "description": "Not connected to Microsoft 365"
           },
           "403": {
-            "description": "Access denied - user does not have access to the mailbox"
+            "description": "Access denied - user does not have access to the mailbox, the organization's\npricing tier does not include Microsoft 365 integrations (Professional or higher),\nor `mailboxSyncTimeframe` is a long timeframe (`3m`, `6m`, `1y`) not enabled for the organization\n"
           },
           "409": {
             "description": "A mailbox email already connected to an Outlook connection"
@@ -1120,6 +1105,9 @@
           "400": {
             "description": "Invalid input provided"
           },
+          "403": {
+            "$ref": "#/components/responses/PricingTierRequired"
+          },
           "404": {
             "description": "Mailbox not connected for the provided email address"
           },
@@ -1250,6 +1238,9 @@
               }
             }
           },
+          "403": {
+            "$ref": "#/components/responses/PricingTierRequired"
+          },
           "404": {
             "description": "No sync found or no retryable messages"
           },
@@ -1262,6 +1253,59 @@
         }
       }
     },
+    "/v2/outlook/mailbox/{email}/sync/cancel": {
+      "post": {
+        "operationId": "cancelMailboxSync",
+        "summary": "Stop Mailbox Sync",
+        "description": "Stops the running sync of an Outlook mailbox and marks it CANCELLED.\nEmails imported before the stop are kept; a new sync can be started afterwards.\n",
+        "tags": [
+          "O365 Outlook Connection"
+        ],
+        "parameters": [
+          {
+            "name": "email",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "email"
+            },
+            "description": "Email address of the Outlook mailbox"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Sync stopped",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "execution_id",
+                    "status"
+                  ],
+                  "properties": {
+                    "execution_id": {
+                      "type": "string",
+                      "description": "Execution ID of the stopped sync"
+                    },
+                    "status": {
+                      "$ref": "#/components/schemas/MailboxSyncStatuses"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "No running sync for this mailbox"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      }
+    },
     "/v2/outlook/mailbox/mappings": {
       "get": {
         "operationId": "getConnectedOutlookEmails",
@@ -1847,7 +1891,7 @@
       "get": {
         "operationId": "getSettings",
         "summary": "getSettings",
-        "description": "Retrieves settings of a specific type for the organization.\n\nIf an `id` is provided, returns only that specific setting.\nOtherwise, returns all settings of the specified type.\n\n## Setting Types\n\n| Type | Description |\n|------|-------------|\n| `signature` | HTML email signatures |\n| `email_domain` | Custom email domains |\n| `email_address` | Sender email addresses |\n| `whitelist_email_address` | Addresses exempt from duplicate detection |\n| `restrict_duplicates_within` | Time window for duplicate email detection |\n",
+        "description": "Retrieves settings of a specific type for the organization.\n\nIf an `id` is provided, returns only that specific setting.\nOtherwise, returns all settings of the specified type.\n\n## Setting Types\n\n| Type | Description |\n|------|-------------|\n| `signature` | HTML email signatures |\n| `email_domain` | Custom email domains |\n| `email_address` | Sender email addresses |\n| `whitelist_email_address` | Addresses exempt from duplicate detection |\n| `restrict_duplicates_within` | Time window for duplicate email detection |\n| `allowed_recipient_domains` | Extra recipient domains allowed for sandbox org sends |\n",
         "tags": [
           "Settings"
         ],
@@ -1920,7 +1964,7 @@
       "post": {
         "operationId": "addSetting",
         "summary": "addSetting",
-        "description": "Creates a new setting of the specified type.\n\nThe setting type determines which fields are applicable:\n- **signature**: Requires `name`, `value` (plain text), and `html` (HTML content)\n- **email_domain**: Requires `value` (domain name)\n- **whitelist_email_address**: Requires `value` (email address)\n- **restrict_duplicates_within**: Requires `value` (time duration like \"5m\", \"1d\")\n",
+        "description": "Creates a new setting of the specified type.\n\nThe setting type determines which fields are applicable:\n- **signature**: Requires `name`, `value` (plain text), and `html` (HTML content)\n- **email_domain**: Requires `value` (domain name)\n- **whitelist_email_address**: Requires `value` (email address)\n- **restrict_duplicates_within**: Requires `value` (time duration like \"5m\", \"1d\")\n- **allowed_recipient_domains**: Requires `value` (recipient domain, e.g. \"partner-company.de\")\n",
         "tags": [
           "Settings"
         ],
@@ -2016,15 +2060,8 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "Setting deleted successfully. Returns the deleted setting.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Setting"
-                }
-              }
-            }
+          "204": {
+            "description": "Setting deleted successfully. Also returned when no setting matches the given `id` and `type`."
           },
           "403": {
             "$ref": "#/components/responses/Forbidden"
@@ -2039,7 +2076,7 @@
       "post": {
         "operationId": "updateSetting",
         "summary": "updateSetting",
-        "description": "Updates an existing setting identified by its ID.\n\nInclude the `type` field in the request body to specify which setting type\nis being updated. Only the fields provided will be updated.\n",
+        "description": "Updates an existing setting identified by its ID.\n\nInclude the `type` field in the request body to specify which setting type\nis being updated. Only the fields provided will be updated.\n\nReturns 404 if no setting of that type exists with the given ID.\n",
         "tags": [
           "Settings"
         ],
@@ -2516,6 +2553,20 @@
           }
         }
       },
+      "PricingTierRequired": {
+        "description": "The organization's pricing tier does not include Microsoft 365 integrations\n(Outlook, MS Teams). Requires the Professional pricing tier or higher; sandbox\norganizations are exempt.\n",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/ErrorResponse"
+            },
+            "example": {
+              "error": "Microsoft 365 integrations (Outlook, MS Teams) require the Professional pricing tier or higher",
+              "status": 403
+            }
+          }
+        }
+      },
       "OutlookErrorResponse": {
         "description": "An error response from the Outlook OAuth flow.\nMay include an admin consent URL if admin permissions are required.\n",
         "content": {
@@ -2707,7 +2758,8 @@
           "3m",
           "6m",
           "1y"
-        ]
+        ],
+        "description": "Mailbox sync period. The long timeframes `3m`, `6m` and `1y` are only available to organizations\nwith the `outlook-mailbox-sync-long-timeframes` feature enabled; connecting a mailbox, starting a sync,\nor retrying one of these syncs returns 403 otherwise.\n"
       },
       "InboxBucketResponse": {
         "type": "object",
@@ -3644,6 +3696,13 @@
           "restrict_duplicates_within"
         ]
       },
+      "AllowedRecipientDomainsSetting": {
+        "type": "string",
+        "description": "- Extra recipient domain allowed for outbound email from a sandbox organization.\n- Sandbox orgs (organization_use) with the sandbox recipient allowlist enabled may only\n  send unattended emails (workflow/automation/bulk/system) to epilot domains, the\n  verified sending domains of the org and its parent production org, plus the domains\n  listed in settings of this type.\n- One setting per domain, stored in `value` (e.g. \"partner-company.de\").\n",
+        "enum": [
+          "allowed_recipient_domains"
+        ]
+      },
       "SettingType": {
         "oneOf": [
           {
@@ -3660,12 +3719,15 @@
           },
           {
             "$ref": "#/components/schemas/RestrictDuplicatesWithinSetting"
+          },
+          {
+            "$ref": "#/components/schemas/AllowedRecipientDomainsSetting"
           }
         ]
       },
       "Setting": {
         "type": "object",
-        "description": "Generic setting object used for various email configuration types.\nThe applicable fields depend on the setting type:\n- **signature**: Uses `name`, `value` (plain text), and `html` (rich text)\n- **email_domain**: Uses `value` (domain name)\n- **whitelist_email_address**: Uses `value` (email address)\n- **restrict_duplicates_within**: Uses `value` (time duration)\n",
+        "description": "Generic setting object used for various email configuration types.\nThe applicable fields depend on the setting type:\n- **signature**: Uses `name`, `value` (plain text), and `html` (rich text)\n- **email_domain**: Uses `value` (domain name)\n- **whitelist_email_address**: Uses `value` (email address)\n- **restrict_duplicates_within**: Uses `value` (time duration)\n- **allowed_recipient_domains**: Uses `value` (recipient domain allowed for sandbox sends)\n",
         "required": [
           "type"
         ],