agentmail 0.5.27 → 0.5.29

package/reference.md

@@ -1243,7 +1243,9 @@ await client.webhooks.delete("webhook_id");
 <dl>
 <dd>
 
-Lists accounts across all providers.
+Lists accounts across all providers, scoped to the API key: an
+organization key sees every account, a pod key its pod's, an inbox key
+its inbox's. Requires `inbox_read`.
 </dd>
 </dl>
 </dd>
@@ -1298,6 +1300,21 @@ await client.accounts.list();
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns one account by ID. An account outside the key's scope is a 404.
+Requires `inbox_read`.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1339,6 +1356,93 @@ await client.accounts.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">update</a>(account_id, { ...params }) -> AgentMail.Account</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates one account. Set `status` to `disabled` to stop the inbox from
+signing in at the provider again, or to `enabled` to re-enable it.
+Idempotent: disabling an already disabled account keeps its original
+`disabled_at`, and enabling an enabled account is a no-op.
+
+Find the `account_id` with List Accounts. An account exists only after an
+inbox's first sign-in at a provider, so it cannot be disabled in advance.
+A disable applies to that inbox at that provider whichever sign-in key is
+used: the provider's next authorization ends in `access_denied`, and a code
+issued earlier is refused with `invalid_grant`. Access tokens already
+issued stay valid until they expire, and the provider's own session is
+unaffected.
+
+Requires `account_update`, which sign-in keys (`type: public_key`) cannot
+hold, so call this with a bearer API key. An account outside the key's
+scope is a 404. A 409 means the account changed during the write; read it
+again and retry.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.accounts.update("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", {});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**account_id:** `AgentMail.AccountId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `AgentMail.UpdateAccountRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2641,6 +2745,150 @@ await client.drafts.getAttachment("draft_id", "attachment_id");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Inboxes Accounts
+<details><summary><code>client.inboxes.accounts.<a href="/src/api/resources/inboxes/resources/accounts/client/Client.ts">list</a>(inbox_id, { ...params }) -> AgentMail.ListAccountsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists accounts held by the inbox, across all providers. Requires `inbox_read`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.inboxes.accounts.list("inbox_id");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**inbox_id:** `AgentMail.InboxId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `AgentMail.inboxes.ListAccountsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.inboxes.accounts.<a href="/src/api/resources/inboxes/resources/accounts/client/Client.ts">get</a>(inbox_id, account_id) -> AgentMail.Account</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns one account held by the inbox. An account elsewhere is a 404. Requires
+`inbox_read`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.inboxes.accounts.get("inbox_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**inbox_id:** `AgentMail.InboxId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**account_id:** `AgentMail.AccountId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -6668,6 +6916,150 @@ await client.organizations.get();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Pods Accounts
+<details><summary><code>client.pods.accounts.<a href="/src/api/resources/pods/resources/accounts/client/Client.ts">list</a>(pod_id, { ...params }) -> AgentMail.ListAccountsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists accounts held by inboxes in the pod, across all providers. Requires `inbox_read`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.pods.accounts.list("pod_id");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**pod_id:** `AgentMail.PodId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `AgentMail.pods.ListAccountsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.pods.accounts.<a href="/src/api/resources/pods/resources/accounts/client/Client.ts">get</a>(pod_id, account_id) -> AgentMail.Account</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns one account held by inboxes in the pod. An account elsewhere is a 404. Requires
+`inbox_read`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.pods.accounts.get("pod_id", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**pod_id:** `AgentMail.PodId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**account_id:** `AgentMail.AccountId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>