agentmail 0.1.14 → 0.1.16

package/dist/llms-full.txt

@@ -5,7 +5,7 @@
 <Tip title="Welcome to AgentMail!" icon="fa-solid fa-star" />
 
 <Frame caption="We're excited to have you onboard!">
-  <img src="file:7e31e22e-f85c-4c5a-b25b-b83579d445d7" alt="We're excited to have you onboard!" />
+  <img src="file:2bbde1f0-3ffb-42e2-983f-dbde7883b260" alt="We're excited to have you onboard!" />
 </Frame>
 
 AgentMail is an API platform for giving AI agents their own inboxes to send, receive, and act upon emails. This allows agents to assume their own identity and communicate via the universal protocol of email with services, people, and other agents.
@@ -171,7 +171,7 @@ This guide will walk you through installing the AgentMail SDK, authenticating wi
   <Step title="Create an API Key">
     Now that you're in the console, you'll need to create an API key to
     authenticate your requests. Navigate to the API Keys section in your console
-    dashboard. ![API Key Creation Screenshot](file:7ec4475a-6fe5-4cfc-8e16-e8aa1dc51a8d) Click
+    dashboard. ![API Key Creation Screenshot](file:533b527b-b89e-4535-bc11-b04eda210805) Click
     "Create New API Key" and give it a descriptive name. Once created, copy the
     API key and store it securely. Create a `.env` file in your project's root
     directory and add your key to it. We recommend using environment variables to
@@ -322,7 +322,7 @@ Unlike traditional email providers that are designed for human scale, AgentMail
 
 As the diagram below illustrates, your `organization` is the top-level container that holds all your resources. You can provision many `Inboxes` within your `organization`, each with its own `Threads`, `Messages`, and `Attachments`, allowing you to manage a large fleet of agents seamlessly.
 
-<img src="file:c85a1de1-ac59-4d3c-bf3d-be58c1e545fe" alt="AgentMail Organizational Hierarchy" />
+<img src="file:2f70a86c-fb83-4804-90dd-4f3b666cccf5" alt="AgentMail Organizational Hierarchy" />
 
 <Steps>
   <Step title="Organization">
@@ -742,7 +742,7 @@ Here is an example of a well-structured and styled HTML header:
 </CodeBlocks>
 
 <Frame caption="Look how pretty this message looks!">
-  <img src="file:d544decc-f10a-4531-a0ed-c5d90ad5c4bd" alt="rendered css" />
+  <img src="file:d664e355-f144-4b64-85d2-0e39cbba8ac7" alt="rendered css" />
 </Frame>
 
 ## Receiving `Messages`
@@ -1981,7 +1981,7 @@ Configuring your domain is a three-step process: add the domain via API, copy th
     After creating your domain in the AgentMail Console, click the "Download BIND Zone File" button to get the complete zone file.
 
     <Frame caption="Downloading BIND zone file from AgentMail Console">
-      <img src="file:d4a4f23e-5b69-4258-9516-a9b5bce15090" alt="Download BIND Zone File from Console" />
+      <img src="file:b15a4c8d-594a-4014-a5fe-03b02c2921d4" alt="Download BIND Zone File from Console" />
     </Frame>
 
     <Tabs>
@@ -1992,13 +1992,13 @@ Configuring your domain is a three-step process: add the domain via API, copy th
         2. Navigate to **DNS > Records**
 
         <Frame caption="This is what the page looks like">
-          <img src="file:dc3c97c7-14ba-4e76-8043-9f4db1d4ee15" alt="Cloudflare BIND Import" />
+          <img src="file:b833b8bb-2437-44a2-85d8-e269f59dd24b" alt="Cloudflare BIND Import" />
         </Frame>
 
         3. Click **"Import and Export"**
 
         <Frame caption="You should be able to just drop the file in">
-          <img src="file:2c1ab1ff-9580-4873-bd7c-71bef79ba387" alt="Cloudflare BIND Import" />
+          <img src="file:8d2d26bc-c4f3-48c1-aabc-16cf3ee90047" alt="Cloudflare BIND Import" />
         </Frame>
 
         4. Upload the downloaded BIND zone file as is
@@ -2011,13 +2011,13 @@ Configuring your domain is a three-step process: add the domain via API, copy th
         2. Click **"Import zone file"** in the top right corner
 
         <Frame caption="Importing BIND zone file in AWS Route 53">
-          <img src="file:bc92f8b9-ca2b-42b3-80d7-7a8bad684cbb" alt="AWS Route 53 BIND Import" />
+          <img src="file:d7b1afc1-0bad-4d53-a011-5c4091a4380f" alt="AWS Route 53 BIND Import" />
         </Frame>
 
         3. Paste the CONTENTS of downloaded BIND zone file
 
         <Frame caption="Open the file with text editor and paste the contents. It should look similar to what we have in this image.">
-          <img src="file:85169b02-214a-41fe-9e04-7ef8eff1fa2c" alt="AWS Route 53 BIND Import" />
+          <img src="file:bbc90a2f-9733-4e39-890d-8068bc184c73" alt="AWS Route 53 BIND Import" />
         </Frame>
 
         4. Review the records and click **"Import"**
@@ -2046,13 +2046,13 @@ Configuring your domain is a three-step process: add the domain via API, copy th
         2. Navigate to the **DNS** subtab of the domain you want to send from
 
         <Frame caption="Click on this button!">
-          <img src="file:afc83fd7-56ca-4401-a9bb-8b2b97dc1c98" alt="Porkbun DNS Management" />
+          <img src="file:4785688a-45d5-4f45-bd33-b92d0ef11fab" alt="Porkbun DNS Management" />
         </Frame>
 
         3. Scroll down to the quick upload section
 
         <Frame caption="Upload your BIND zone file here">
-          <img src="file:1338c4d9-2241-4bb6-9004-47b443bda49d" alt="Porkbun Zone File Import" />
+          <img src="file:b8882eda-ea51-462c-a0fc-da905d4821d7" alt="Porkbun Zone File Import" />
         </Frame>
 
         4. Upload the downloaded BIND zone file as is
@@ -2485,7 +2485,7 @@ The process is straightforward:
   </Step>
 
   <Step title="2. Register the Endpoint with AgentMail">
-    You can register your URL using the AgentMail API. When you create a webhook, you'll specify your endpoint's URL. As AgentMail currently only supports the `message.received` event, there's no need to specify event types.
+    You can register your URL using the AgentMail API. When you create a webhook, you'll specify your endpoint's URL as well as event types you want to receive.
 
     <CodeBlocks>
       ```python
@@ -2870,13 +2870,13 @@ Ngrok creates a secure tunnel from a public URL to your local development server
 
 Visit [ngrok.com](https://ngrok.com/) and click "Sign up" to create a free account.
 
-<img src="file:9836b58f-369e-4dcc-9813-b0ff5613e37d" alt="Ngrok homepage" />
+<img src="file:257e9c77-745e-4f57-898d-6ad64c30184f" alt="Ngrok homepage" />
 
 ### 1.2 Choose your platform and install
 
 After logging in, ngrok will guide you through the setup process. Select your operating system and follow the installation instructions.
 
-<img src="file:8a4a7ad0-6c03-4e13-a7dc-f986ce988f19" alt="Ngrok setup instructions" />
+<img src="file:62640b7b-609b-4c81-b4c5-93673f5a0a1b" alt="Ngrok setup instructions" />
 
 For macOS, you can install ngrok via Homebrew:
 
@@ -2922,7 +2922,7 @@ ngrok http 3000
 
 You should see output similar to this:
 
-<img src="file:dbd52d4e-2186-4925-85a8-40f7e08dd062" alt="Ngrok terminal output" />
+<img src="file:0fe5c03c-37be-413a-8ae6-ffb22f356221" alt="Ngrok terminal output" />
 
 Copy the **Forwarding URL** (e.g., `https://your-subdomain.ngrok-free.app`). This is the public URL that AgentMail will use to send webhooks.
 
@@ -3019,7 +3019,7 @@ python webhook_receiver.py
 
 Open your browser and visit `http://127.0.0.1:3000` to see the status page confirming your webhook receiver is running:
 
-<img src="file:bea7ba98-6cd7-4dba-a73f-92b14c538c61" alt="Webhook receiver status page" />
+<img src="file:445e6cfc-8d24-4d5b-9ade-cbf9e21c5f4e" alt="Webhook receiver status page" />
 
 ## Testing Your Setup
 
@@ -3516,7 +3516,7 @@ How you send your emails is just as important as what you send. If you're sendin
     more natural to email providers. AgentMail's ability to create inboxes at
     scale makes this strategy easy to implement.
 
-    <img src="file:809afcab-40b2-4798-93ca-5b7cc0b19b7a" alt="Diagram comparing one inbox sending 1000 emails vs. five inboxes sending 200 each." />
+    <img src="file:98c9cc4a-14cd-4306-b9af-5add27313bfe" alt="Diagram comparing one inbox sending 1000 emails vs. five inboxes sending 200 each." />
   </Step>
 
   <Step title="Protect Your Reputation with Multiple Domains">
@@ -5535,7 +5535,7 @@ Done
 
 Go to your AgentMail inbox and filter by labels to organize your emails:
 
-<img src="file:4332462e-7efd-4695-a8e1-daa0da6699f4" alt="Test image" />
+<img src="file:aabdc3e3-f51c-4b2d-93e9-0aeaff841bf8" alt="Test image" />
 
 **Filter by sentiment:**
 
@@ -15081,9 +15081,12 @@ components:
     type_domains:VerificationStatus:
       type: string
       enum:
+        - value: NOT_STARTED
         - value: PENDING
+        - value: INVALID
+        - value: FAILED
         - value: VERIFYING
-        - value: READY
+        - value: VERIFIED
     type_domains:FeedbackEnabled:
       type: boolean
     type_domains:RecordType:
@@ -15096,7 +15099,8 @@ components:
       type: string
       enum:
         - value: MISSING
-        - value: VERIFIED
+        - value: INVALID
+        - value: VALID
     type_domains:VerificationRecord:
       type: object
       properties:
@@ -15529,9 +15533,12 @@ components:
     type_domains:VerificationStatus:
       type: string
       enum:
+        - value: NOT_STARTED
         - value: PENDING
+        - value: INVALID
+        - value: FAILED
         - value: VERIFYING
-        - value: READY
+        - value: VERIFIED
     type_domains:RecordType:
       type: string
       enum:
@@ -15542,7 +15549,8 @@ components:
       type: string
       enum:
         - value: MISSING
-        - value: VERIFIED
+        - value: INVALID
+        - value: VALID
     type_domains:VerificationRecord:
       type: object
       properties:
@@ -16175,7 +16183,11 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/type_events:EventType'
-    type_webhooks:InboxIds:
+    type_events:PodIds:
+      type: array
+      items:
+        type: string
+    type_events:InboxIds:
       type: array
       items:
         type: string
@@ -16190,8 +16202,10 @@ components:
           $ref: '#/components/schemas/type_webhooks:Url'
         event_types:
           $ref: '#/components/schemas/type_events:EventTypes'
+        pod_ids:
+          $ref: '#/components/schemas/type_events:PodIds'
         inbox_ids:
-          $ref: '#/components/schemas/type_webhooks:InboxIds'
+          $ref: '#/components/schemas/type_events:InboxIds'
         secret:
           type: string
           description: Secret for webhook signature verification.
@@ -16422,7 +16436,11 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/type_events:EventType'
-    type_webhooks:InboxIds:
+    type_events:PodIds:
+      type: array
+      items:
+        type: string
+    type_events:InboxIds:
       type: array
       items:
         type: string
@@ -16437,8 +16455,10 @@ components:
           $ref: '#/components/schemas/type_webhooks:Url'
         event_types:
           $ref: '#/components/schemas/type_events:EventTypes'
+        pod_ids:
+          $ref: '#/components/schemas/type_events:PodIds'
         inbox_ids:
-          $ref: '#/components/schemas/type_webhooks:InboxIds'
+          $ref: '#/components/schemas/type_events:InboxIds'
         secret:
           type: string
           description: Secret for webhook signature verification.
@@ -16653,7 +16673,11 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/type_events:EventType'
-    type_webhooks:InboxIds:
+    type_events:PodIds:
+      type: array
+      items:
+        type: string
+    type_events:InboxIds:
       type: array
       items:
         type: string
@@ -16666,8 +16690,10 @@ components:
           $ref: '#/components/schemas/type_webhooks:Url'
         event_types:
           $ref: '#/components/schemas/type_events:EventTypes'
+        pod_ids:
+          $ref: '#/components/schemas/type_events:PodIds'
         inbox_ids:
-          $ref: '#/components/schemas/type_webhooks:InboxIds'
+          $ref: '#/components/schemas/type_events:InboxIds'
         client_id:
           $ref: '#/components/schemas/type_webhooks:ClientId'
       required:
@@ -16684,8 +16710,10 @@ components:
           $ref: '#/components/schemas/type_webhooks:Url'
         event_types:
           $ref: '#/components/schemas/type_events:EventTypes'
+        pod_ids:
+          $ref: '#/components/schemas/type_events:PodIds'
         inbox_ids:
-          $ref: '#/components/schemas/type_webhooks:InboxIds'
+          $ref: '#/components/schemas/type_events:InboxIds'
         secret:
           type: string
           description: Secret for webhook signature verification.
@@ -18014,9 +18042,12 @@ components:
     type_domains:VerificationStatus:
       type: string
       enum:
+        - value: NOT_STARTED
         - value: PENDING
+        - value: INVALID
+        - value: FAILED
         - value: VERIFYING
-        - value: READY
+        - value: VERIFIED
     type_domains:FeedbackEnabled:
       type: boolean
     type_domains:RecordType:
@@ -18029,7 +18060,8 @@ components:
       type: string
       enum:
         - value: MISSING
-        - value: VERIFIED
+        - value: INVALID
+        - value: VALID
     type_domains:VerificationRecord:
       type: object
       properties:
@@ -18221,6 +18253,14 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/type_events:EventType'
+    type_events:InboxIds:
+      type: array
+      items:
+        type: string
+    type_events:PodIds:
+      type: array
+      items:
+        type: string
     type_websockets:Subscribed:
       type: object
       properties:
@@ -18232,15 +18272,9 @@ components:
         event_types:
           $ref: '#/components/schemas/type_events:EventTypes'
         inbox_ids:
-          type: array
-          items:
-            type: string
-          description: IDs of the inboxes that have been subscribed to.
+          $ref: '#/components/schemas/type_events:InboxIds'
         pod_ids:
-          type: array
-          items:
-            type: string
-          description: IDs of the pods that have been subscribed to.
+          $ref: '#/components/schemas/type_events:PodIds'
       required:
         - type
     type_events:EventId:
@@ -18767,9 +18801,12 @@ components:
     type_domains:VerificationStatus:
       type: string
       enum:
+        - value: NOT_STARTED
         - value: PENDING
+        - value: INVALID
+        - value: FAILED
         - value: VERIFYING
-        - value: READY
+        - value: VERIFIED
     type_domains:FeedbackEnabled:
       type: boolean
     type_domains:RecordType:
@@ -18782,7 +18819,8 @@ components:
       type: string
       enum:
         - value: MISSING
-        - value: VERIFIED
+        - value: INVALID
+        - value: VALID
     type_domains:VerificationRecord:
       type: object
       properties:
@@ -18875,15 +18913,9 @@ components:
         event_types:
           $ref: '#/components/schemas/type_events:EventTypes'
         inbox_ids:
-          type: array
-          items:
-            type: string
-          description: IDs of the inboxes to subscribe to.
+          $ref: '#/components/schemas/type_events:InboxIds'
         pod_ids:
-          type: array
-          items:
-            type: string
-          description: IDs of the pods to subscribe to.
+          $ref: '#/components/schemas/type_events:PodIds'
       required:
         - type
 
@@ -23455,9 +23487,12 @@ components:
     type_domains:VerificationStatus:
       type: string
       enum:
+        - value: NOT_STARTED
         - value: PENDING
+        - value: INVALID
+        - value: FAILED
         - value: VERIFYING
-        - value: READY
+        - value: VERIFIED
     type_domains:RecordType:
       type: string
       enum:
@@ -23468,7 +23503,8 @@ components:
       type: string
       enum:
         - value: MISSING
-        - value: VERIFIED
+        - value: INVALID
+        - value: VALID
     type_domains:VerificationRecord:
       type: object
       properties:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "agentmail",
-    "version": "0.1.14",
+    "version": "0.1.16",
     "private": false,
     "repository": "github:agentmail-to/agentmail-node",
     "type": "commonjs",

package/reference.md

@@ -2394,6 +2394,62 @@ await client.metrics.list({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Organizations
+<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">get</a>() -> AgentMail.Organization</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get the current organization.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizations.get();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>