agentmail 0.5.2 → 0.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/agent/types/AgentSignupRequest.d.ts +12 -0
  3. package/dist/cjs/api/resources/lists/types/ListEntryBase.d.ts +2 -0
  4. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +3 -0
  5. package/dist/cjs/api/resources/webhooks/client/Client.js +3 -0
  6. package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequest.d.ts +5 -0
  7. package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequest.d.ts +9 -0
  8. package/dist/cjs/serialization/resources/agent/types/AgentSignupRequest.d.ts +2 -0
  9. package/dist/cjs/serialization/resources/agent/types/AgentSignupRequest.js +2 -0
  10. package/dist/cjs/serialization/resources/lists/types/ListEntryBase.d.ts +1 -0
  11. package/dist/cjs/serialization/resources/lists/types/ListEntryBase.js +1 -0
  12. package/dist/cjs/serialization/resources/webhooks/types/UpdateWebhookRequest.d.ts +2 -0
  13. package/dist/cjs/serialization/resources/webhooks/types/UpdateWebhookRequest.js +2 -0
  14. package/dist/cjs/version.d.ts +1 -1
  15. package/dist/cjs/version.js +1 -1
  16. package/dist/esm/BaseClient.mjs +2 -2
  17. package/dist/esm/api/resources/agent/types/AgentSignupRequest.d.mts +12 -0
  18. package/dist/esm/api/resources/lists/types/ListEntryBase.d.mts +2 -0
  19. package/dist/esm/api/resources/webhooks/client/Client.d.mts +3 -0
  20. package/dist/esm/api/resources/webhooks/client/Client.mjs +3 -0
  21. package/dist/esm/api/resources/webhooks/types/CreateWebhookRequest.d.mts +5 -0
  22. package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequest.d.mts +9 -0
  23. package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.d.mts +2 -0
  24. package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.mjs +2 -0
  25. package/dist/esm/serialization/resources/lists/types/ListEntryBase.d.mts +1 -0
  26. package/dist/esm/serialization/resources/lists/types/ListEntryBase.mjs +1 -0
  27. package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookRequest.d.mts +2 -0
  28. package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookRequest.mjs +2 -0
  29. package/dist/esm/version.d.mts +1 -1
  30. package/dist/esm/version.mjs +1 -1
  31. package/dist/llms-full.txt +6816 -7026
  32. package/dist/llms.txt +10 -1
  33. package/package.json +1 -1
  34. package/reference.md +3 -0
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "agentmail",
46
- "X-Fern-SDK-Version": "0.5.2",
47
- "User-Agent": "agentmail/0.5.2",
46
+ "X-Fern-SDK-Version": "0.5.3",
47
+ "User-Agent": "agentmail/0.5.3",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -6,4 +6,16 @@ export interface AgentSignupRequest {
6
6
  humanEmail: string;
7
7
  /** Username for the auto-created inbox (e.g. "my-agent" creates my-agent@agentmail.to). */
8
8
  username: string;
9
+ /**
10
+ * The SDK, framework, or platform issuing this sign-up (e.g. `agentmail-python`, `agentmail-cli`, `agentmail-mcp`).
11
+ * Identifies the caller — answers "who is signing up".
12
+ * Max 2048 characters.
13
+ */
14
+ source?: string;
15
+ /**
16
+ * The channel that drove this sign-up — where the agent or its developer discovered AgentMail
17
+ * (e.g. `agent.email`, a partner URL, a campaign tag). Answers "where did this sign-up come from".
18
+ * Max 2048 characters.
19
+ */
20
+ referrer?: string;
9
21
  }
@@ -10,4 +10,6 @@ export interface ListEntryBase {
10
10
  entryType: AgentMail.EntryType;
11
11
  /** Time at which entry was created. */
12
12
  createdAt: Date;
13
+ /** Whether the entry is read-only and cannot be deleted via the API. */
14
+ readOnly?: boolean;
13
15
  }
@@ -60,6 +60,9 @@ export declare class WebhooksClient {
60
60
  create(request: AgentMail.webhooks.CreateWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.Webhook>;
61
61
  private __create;
62
62
  /**
63
+ * Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a
64
+ * non-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.
65
+ *
63
66
  * **CLI:**
64
67
  * ```bash
65
68
  * agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>
@@ -260,6 +260,9 @@ class WebhooksClient {
260
260
  });
261
261
  }
262
262
  /**
263
+ * Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a
264
+ * non-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.
265
+ *
263
266
  * **CLI:**
264
267
  * ```bash
265
268
  * agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>
@@ -1,6 +1,11 @@
1
1
  import type * as AgentMail from "../../../index.js";
2
2
  export interface CreateWebhookRequest {
3
3
  url: AgentMail.webhooks.Url;
4
+ /**
5
+ * Full list of event types this webhook should receive. At least one type is required. Send every type you
6
+ * want in this array (not incremental). See [Webhooks overview](https://docs.agentmail.to/webhooks-overview)
7
+ * for spam, blocked, and unauthenticated events and required permissions.
8
+ */
4
9
  eventTypes: AgentMail.EventTypes;
5
10
  podIds?: AgentMail.PodIds;
6
11
  inboxIds?: AgentMail.InboxIds;
@@ -8,4 +8,13 @@ export interface UpdateWebhookRequest {
8
8
  addPodIds?: AgentMail.PodIds;
9
9
  /** Pod IDs to unsubscribe from the webhook. */
10
10
  removePodIds?: AgentMail.PodIds;
11
+ /**
12
+ * When you send a non-empty list, it replaces the webhook's subscribed event types in full (the same
13
+ * "set the list" behavior as create). It is not a merge or diff: include every event type you want after
14
+ * the update. Sending a one-element array means the webhook will only receive that one type afterward.
15
+ * Omit this field or send an empty array to leave event types unchanged. Clearing all types with an empty
16
+ * list is not supported. Subscribing to `message.received.spam`, `message.received.blocked`, or
17
+ * `message.received.unauthenticated` requires the matching label permission on the API key.
18
+ */
19
+ eventTypes?: AgentMail.EventTypes;
11
20
  }
@@ -6,5 +6,7 @@ export declare namespace AgentSignupRequest {
6
6
  interface Raw {
7
7
  human_email: string;
8
8
  username: string;
9
+ source?: string | null;
10
+ referrer?: string | null;
9
11
  }
10
12
  }
@@ -39,4 +39,6 @@ const core = __importStar(require("../../../../core/index.js"));
39
39
  exports.AgentSignupRequest = core.serialization.object({
40
40
  humanEmail: core.serialization.property("human_email", core.serialization.string()),
41
41
  username: core.serialization.string(),
42
+ source: core.serialization.string().optional(),
43
+ referrer: core.serialization.string().optional(),
42
44
  });
@@ -15,5 +15,6 @@ export declare namespace ListEntryBase {
15
15
  list_type: ListType.Raw;
16
16
  entry_type: EntryType.Raw;
17
17
  created_at: string;
18
+ read_only?: boolean | null;
18
19
  }
19
20
  }
@@ -48,4 +48,5 @@ exports.ListEntryBase = core.serialization.object({
48
48
  listType: core.serialization.property("list_type", ListType_js_1.ListType),
49
49
  entryType: core.serialization.property("entry_type", EntryType_js_1.EntryType),
50
50
  createdAt: core.serialization.property("created_at", core.serialization.date()),
51
+ readOnly: core.serialization.property("read_only", core.serialization.boolean().optional()),
51
52
  });
@@ -1,6 +1,7 @@
1
1
  import type * as AgentMail from "../../../../api/index.js";
2
2
  import * as core from "../../../../core/index.js";
3
3
  import type * as serializers from "../../../index.js";
4
+ import { EventTypes } from "../../events/types/EventTypes.js";
4
5
  import { InboxIds } from "../../events/types/InboxIds.js";
5
6
  import { PodIds } from "../../events/types/PodIds.js";
6
7
  export declare const UpdateWebhookRequest: core.serialization.ObjectSchema<serializers.webhooks.UpdateWebhookRequest.Raw, AgentMail.webhooks.UpdateWebhookRequest>;
@@ -10,5 +11,6 @@ export declare namespace UpdateWebhookRequest {
10
11
  remove_inbox_ids?: InboxIds.Raw | null;
11
12
  add_pod_ids?: PodIds.Raw | null;
12
13
  remove_pod_ids?: PodIds.Raw | null;
14
+ event_types?: EventTypes.Raw | null;
13
15
  }
14
16
  }
@@ -36,6 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
36
36
  Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.UpdateWebhookRequest = void 0;
38
38
  const core = __importStar(require("../../../../core/index.js"));
39
+ const EventTypes_js_1 = require("../../events/types/EventTypes.js");
39
40
  const InboxIds_js_1 = require("../../events/types/InboxIds.js");
40
41
  const PodIds_js_1 = require("../../events/types/PodIds.js");
41
42
  exports.UpdateWebhookRequest = core.serialization.object({
@@ -43,4 +44,5 @@ exports.UpdateWebhookRequest = core.serialization.object({
43
44
  removeInboxIds: core.serialization.property("remove_inbox_ids", InboxIds_js_1.InboxIds.optional()),
44
45
  addPodIds: core.serialization.property("add_pod_ids", PodIds_js_1.PodIds.optional()),
45
46
  removePodIds: core.serialization.property("remove_pod_ids", PodIds_js_1.PodIds.optional()),
47
+ eventTypes: core.serialization.property("event_types", EventTypes_js_1.EventTypes.optional()),
46
48
  });
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.5.2";
1
+ export declare const SDK_VERSION = "0.5.3";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.5.2";
4
+ exports.SDK_VERSION = "0.5.3";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "agentmail",
9
- "X-Fern-SDK-Version": "0.5.2",
10
- "User-Agent": "agentmail/0.5.2",
9
+ "X-Fern-SDK-Version": "0.5.3",
10
+ "User-Agent": "agentmail/0.5.3",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -6,4 +6,16 @@ export interface AgentSignupRequest {
6
6
  humanEmail: string;
7
7
  /** Username for the auto-created inbox (e.g. "my-agent" creates my-agent@agentmail.to). */
8
8
  username: string;
9
+ /**
10
+ * The SDK, framework, or platform issuing this sign-up (e.g. `agentmail-python`, `agentmail-cli`, `agentmail-mcp`).
11
+ * Identifies the caller — answers "who is signing up".
12
+ * Max 2048 characters.
13
+ */
14
+ source?: string;
15
+ /**
16
+ * The channel that drove this sign-up — where the agent or its developer discovered AgentMail
17
+ * (e.g. `agent.email`, a partner URL, a campaign tag). Answers "where did this sign-up come from".
18
+ * Max 2048 characters.
19
+ */
20
+ referrer?: string;
9
21
  }
@@ -10,4 +10,6 @@ export interface ListEntryBase {
10
10
  entryType: AgentMail.EntryType;
11
11
  /** Time at which entry was created. */
12
12
  createdAt: Date;
13
+ /** Whether the entry is read-only and cannot be deleted via the API. */
14
+ readOnly?: boolean;
13
15
  }
@@ -60,6 +60,9 @@ export declare class WebhooksClient {
60
60
  create(request: AgentMail.webhooks.CreateWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<AgentMail.webhooks.Webhook>;
61
61
  private __create;
62
62
  /**
63
+ * Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a
64
+ * non-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.
65
+ *
63
66
  * **CLI:**
64
67
  * ```bash
65
68
  * agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>
@@ -224,6 +224,9 @@ export class WebhooksClient {
224
224
  });
225
225
  }
226
226
  /**
227
+ * Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a
228
+ * non-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.
229
+ *
227
230
  * **CLI:**
228
231
  * ```bash
229
232
  * agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>
@@ -1,6 +1,11 @@
1
1
  import type * as AgentMail from "../../../index.mjs";
2
2
  export interface CreateWebhookRequest {
3
3
  url: AgentMail.webhooks.Url;
4
+ /**
5
+ * Full list of event types this webhook should receive. At least one type is required. Send every type you
6
+ * want in this array (not incremental). See [Webhooks overview](https://docs.agentmail.to/webhooks-overview)
7
+ * for spam, blocked, and unauthenticated events and required permissions.
8
+ */
4
9
  eventTypes: AgentMail.EventTypes;
5
10
  podIds?: AgentMail.PodIds;
6
11
  inboxIds?: AgentMail.InboxIds;
@@ -8,4 +8,13 @@ export interface UpdateWebhookRequest {
8
8
  addPodIds?: AgentMail.PodIds;
9
9
  /** Pod IDs to unsubscribe from the webhook. */
10
10
  removePodIds?: AgentMail.PodIds;
11
+ /**
12
+ * When you send a non-empty list, it replaces the webhook's subscribed event types in full (the same
13
+ * "set the list" behavior as create). It is not a merge or diff: include every event type you want after
14
+ * the update. Sending a one-element array means the webhook will only receive that one type afterward.
15
+ * Omit this field or send an empty array to leave event types unchanged. Clearing all types with an empty
16
+ * list is not supported. Subscribing to `message.received.spam`, `message.received.blocked`, or
17
+ * `message.received.unauthenticated` requires the matching label permission on the API key.
18
+ */
19
+ eventTypes?: AgentMail.EventTypes;
11
20
  }
@@ -6,5 +6,7 @@ export declare namespace AgentSignupRequest {
6
6
  interface Raw {
7
7
  human_email: string;
8
8
  username: string;
9
+ source?: string | null;
10
+ referrer?: string | null;
9
11
  }
10
12
  }
@@ -3,4 +3,6 @@ import * as core from "../../../../core/index.mjs";
3
3
  export const AgentSignupRequest = core.serialization.object({
4
4
  humanEmail: core.serialization.property("human_email", core.serialization.string()),
5
5
  username: core.serialization.string(),
6
+ source: core.serialization.string().optional(),
7
+ referrer: core.serialization.string().optional(),
6
8
  });
@@ -15,5 +15,6 @@ export declare namespace ListEntryBase {
15
15
  list_type: ListType.Raw;
16
16
  entry_type: EntryType.Raw;
17
17
  created_at: string;
18
+ read_only?: boolean | null;
18
19
  }
19
20
  }
@@ -12,4 +12,5 @@ export const ListEntryBase = core.serialization.object({
12
12
  listType: core.serialization.property("list_type", ListType),
13
13
  entryType: core.serialization.property("entry_type", EntryType),
14
14
  createdAt: core.serialization.property("created_at", core.serialization.date()),
15
+ readOnly: core.serialization.property("read_only", core.serialization.boolean().optional()),
15
16
  });
@@ -1,6 +1,7 @@
1
1
  import type * as AgentMail from "../../../../api/index.mjs";
2
2
  import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
+ import { EventTypes } from "../../events/types/EventTypes.mjs";
4
5
  import { InboxIds } from "../../events/types/InboxIds.mjs";
5
6
  import { PodIds } from "../../events/types/PodIds.mjs";
6
7
  export declare const UpdateWebhookRequest: core.serialization.ObjectSchema<serializers.webhooks.UpdateWebhookRequest.Raw, AgentMail.webhooks.UpdateWebhookRequest>;
@@ -10,5 +11,6 @@ export declare namespace UpdateWebhookRequest {
10
11
  remove_inbox_ids?: InboxIds.Raw | null;
11
12
  add_pod_ids?: PodIds.Raw | null;
12
13
  remove_pod_ids?: PodIds.Raw | null;
14
+ event_types?: EventTypes.Raw | null;
13
15
  }
14
16
  }
@@ -1,5 +1,6 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  import * as core from "../../../../core/index.mjs";
3
+ import { EventTypes } from "../../events/types/EventTypes.mjs";
3
4
  import { InboxIds } from "../../events/types/InboxIds.mjs";
4
5
  import { PodIds } from "../../events/types/PodIds.mjs";
5
6
  export const UpdateWebhookRequest = core.serialization.object({
@@ -7,4 +8,5 @@ export const UpdateWebhookRequest = core.serialization.object({
7
8
  removeInboxIds: core.serialization.property("remove_inbox_ids", InboxIds.optional()),
8
9
  addPodIds: core.serialization.property("add_pod_ids", PodIds.optional()),
9
10
  removePodIds: core.serialization.property("remove_pod_ids", PodIds.optional()),
11
+ eventTypes: core.serialization.property("event_types", EventTypes.optional()),
10
12
  });
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.5.2";
1
+ export declare const SDK_VERSION = "0.5.3";
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.5.2";
1
+ export const SDK_VERSION = "0.5.3";