agentmail 0.4.15 → 0.4.16

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 (136) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/agent/client/Client.d.ts +13 -1
  3. package/dist/cjs/api/resources/agent/client/Client.js +13 -1
  4. package/dist/cjs/api/resources/apiKeys/client/Client.d.ts +16 -3
  5. package/dist/cjs/api/resources/apiKeys/client/Client.js +16 -3
  6. package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyRequest.d.ts +1 -1
  7. package/dist/cjs/api/resources/domains/client/Client.d.ts +35 -0
  8. package/dist/cjs/api/resources/domains/client/Client.js +35 -0
  9. package/dist/cjs/api/resources/domains/types/DomainItem.d.ts +0 -1
  10. package/dist/cjs/api/resources/drafts/client/Client.d.ts +15 -0
  11. package/dist/cjs/api/resources/drafts/client/Client.js +15 -0
  12. package/dist/cjs/api/resources/inboxes/client/Client.d.ts +25 -0
  13. package/dist/cjs/api/resources/inboxes/client/Client.js +25 -0
  14. package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.d.ts +16 -3
  15. package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.js +16 -3
  16. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts +35 -0
  17. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +35 -0
  18. package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.d.ts +20 -0
  19. package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.js +20 -0
  20. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +45 -0
  21. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +45 -0
  22. package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.d.ts +5 -0
  23. package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.js +5 -0
  24. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +20 -0
  25. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +20 -0
  26. package/dist/cjs/api/resources/lists/client/Client.d.ts +20 -0
  27. package/dist/cjs/api/resources/lists/client/Client.js +20 -0
  28. package/dist/cjs/api/resources/messages/types/UpdateMessageLabels.d.ts +4 -0
  29. package/dist/cjs/api/resources/messages/types/UpdateMessageLabels.js +3 -0
  30. package/dist/cjs/api/resources/messages/types/UpdateMessageRequest.d.ts +5 -4
  31. package/dist/cjs/api/resources/messages/types/index.d.ts +1 -0
  32. package/dist/cjs/api/resources/messages/types/index.js +1 -0
  33. package/dist/cjs/api/resources/metrics/client/Client.d.ts +5 -0
  34. package/dist/cjs/api/resources/metrics/client/Client.js +5 -0
  35. package/dist/cjs/api/resources/pods/client/Client.d.ts +20 -0
  36. package/dist/cjs/api/resources/pods/client/Client.js +20 -0
  37. package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.d.ts +16 -3
  38. package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.js +16 -3
  39. package/dist/cjs/api/resources/pods/resources/domains/client/Client.d.ts +35 -0
  40. package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +35 -0
  41. package/dist/cjs/api/resources/pods/resources/drafts/client/Client.d.ts +15 -0
  42. package/dist/cjs/api/resources/pods/resources/drafts/client/Client.js +15 -0
  43. package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.d.ts +25 -0
  44. package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.js +25 -0
  45. package/dist/cjs/api/resources/pods/resources/lists/client/Client.d.ts +20 -0
  46. package/dist/cjs/api/resources/pods/resources/lists/client/Client.js +20 -0
  47. package/dist/cjs/api/resources/pods/resources/metrics/client/Client.d.ts +5 -0
  48. package/dist/cjs/api/resources/pods/resources/metrics/client/Client.js +5 -0
  49. package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +20 -0
  50. package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +20 -0
  51. package/dist/cjs/api/resources/threads/client/Client.d.ts +20 -0
  52. package/dist/cjs/api/resources/threads/client/Client.js +20 -0
  53. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +25 -0
  54. package/dist/cjs/api/resources/webhooks/client/Client.js +25 -0
  55. package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.ts +1 -1
  56. package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.js +1 -1
  57. package/dist/cjs/serialization/resources/domains/types/DomainItem.d.ts +0 -2
  58. package/dist/cjs/serialization/resources/domains/types/DomainItem.js +0 -2
  59. package/dist/cjs/serialization/resources/messages/types/UpdateMessageLabels.d.ts +7 -0
  60. package/dist/cjs/serialization/resources/messages/types/UpdateMessageLabels.js +42 -0
  61. package/dist/cjs/serialization/resources/messages/types/UpdateMessageRequest.d.ts +3 -2
  62. package/dist/cjs/serialization/resources/messages/types/UpdateMessageRequest.js +3 -2
  63. package/dist/cjs/serialization/resources/messages/types/index.d.ts +1 -0
  64. package/dist/cjs/serialization/resources/messages/types/index.js +1 -0
  65. package/dist/cjs/version.d.ts +1 -1
  66. package/dist/cjs/version.js +1 -1
  67. package/dist/esm/BaseClient.mjs +2 -2
  68. package/dist/esm/api/resources/agent/client/Client.d.mts +13 -1
  69. package/dist/esm/api/resources/agent/client/Client.mjs +13 -1
  70. package/dist/esm/api/resources/apiKeys/client/Client.d.mts +16 -3
  71. package/dist/esm/api/resources/apiKeys/client/Client.mjs +16 -3
  72. package/dist/esm/api/resources/apiKeys/types/CreateApiKeyRequest.d.mts +1 -1
  73. package/dist/esm/api/resources/domains/client/Client.d.mts +35 -0
  74. package/dist/esm/api/resources/domains/client/Client.mjs +35 -0
  75. package/dist/esm/api/resources/domains/types/DomainItem.d.mts +0 -1
  76. package/dist/esm/api/resources/drafts/client/Client.d.mts +15 -0
  77. package/dist/esm/api/resources/drafts/client/Client.mjs +15 -0
  78. package/dist/esm/api/resources/inboxes/client/Client.d.mts +25 -0
  79. package/dist/esm/api/resources/inboxes/client/Client.mjs +25 -0
  80. package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.d.mts +16 -3
  81. package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.mjs +16 -3
  82. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.d.mts +35 -0
  83. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +35 -0
  84. package/dist/esm/api/resources/inboxes/resources/lists/client/Client.d.mts +20 -0
  85. package/dist/esm/api/resources/inboxes/resources/lists/client/Client.mjs +20 -0
  86. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +45 -0
  87. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +45 -0
  88. package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.d.mts +5 -0
  89. package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.mjs +5 -0
  90. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +20 -0
  91. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +20 -0
  92. package/dist/esm/api/resources/lists/client/Client.d.mts +20 -0
  93. package/dist/esm/api/resources/lists/client/Client.mjs +20 -0
  94. package/dist/esm/api/resources/messages/types/UpdateMessageLabels.d.mts +4 -0
  95. package/dist/esm/api/resources/messages/types/UpdateMessageLabels.mjs +2 -0
  96. package/dist/esm/api/resources/messages/types/UpdateMessageRequest.d.mts +5 -4
  97. package/dist/esm/api/resources/messages/types/index.d.mts +1 -0
  98. package/dist/esm/api/resources/messages/types/index.mjs +1 -0
  99. package/dist/esm/api/resources/metrics/client/Client.d.mts +5 -0
  100. package/dist/esm/api/resources/metrics/client/Client.mjs +5 -0
  101. package/dist/esm/api/resources/pods/client/Client.d.mts +20 -0
  102. package/dist/esm/api/resources/pods/client/Client.mjs +20 -0
  103. package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.d.mts +16 -3
  104. package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.mjs +16 -3
  105. package/dist/esm/api/resources/pods/resources/domains/client/Client.d.mts +35 -0
  106. package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +35 -0
  107. package/dist/esm/api/resources/pods/resources/drafts/client/Client.d.mts +15 -0
  108. package/dist/esm/api/resources/pods/resources/drafts/client/Client.mjs +15 -0
  109. package/dist/esm/api/resources/pods/resources/inboxes/client/Client.d.mts +25 -0
  110. package/dist/esm/api/resources/pods/resources/inboxes/client/Client.mjs +25 -0
  111. package/dist/esm/api/resources/pods/resources/lists/client/Client.d.mts +20 -0
  112. package/dist/esm/api/resources/pods/resources/lists/client/Client.mjs +20 -0
  113. package/dist/esm/api/resources/pods/resources/metrics/client/Client.d.mts +5 -0
  114. package/dist/esm/api/resources/pods/resources/metrics/client/Client.mjs +5 -0
  115. package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +20 -0
  116. package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +20 -0
  117. package/dist/esm/api/resources/threads/client/Client.d.mts +20 -0
  118. package/dist/esm/api/resources/threads/client/Client.mjs +20 -0
  119. package/dist/esm/api/resources/webhooks/client/Client.d.mts +25 -0
  120. package/dist/esm/api/resources/webhooks/client/Client.mjs +25 -0
  121. package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.mts +1 -1
  122. package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.mjs +1 -1
  123. package/dist/esm/serialization/resources/domains/types/DomainItem.d.mts +0 -2
  124. package/dist/esm/serialization/resources/domains/types/DomainItem.mjs +0 -2
  125. package/dist/esm/serialization/resources/messages/types/UpdateMessageLabels.d.mts +7 -0
  126. package/dist/esm/serialization/resources/messages/types/UpdateMessageLabels.mjs +6 -0
  127. package/dist/esm/serialization/resources/messages/types/UpdateMessageRequest.d.mts +3 -2
  128. package/dist/esm/serialization/resources/messages/types/UpdateMessageRequest.mjs +3 -2
  129. package/dist/esm/serialization/resources/messages/types/index.d.mts +1 -0
  130. package/dist/esm/serialization/resources/messages/types/index.mjs +1 -0
  131. package/dist/esm/version.d.mts +1 -1
  132. package/dist/esm/version.mjs +1 -1
  133. package/dist/llms-full.txt +2836 -568
  134. package/dist/llms.txt +3 -0
  135. package/package.json +1 -1
  136. package/reference.md +1532 -15
@@ -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.4.15",
47
- "User-Agent": "agentmail/0.4.15",
46
+ "X-Fern-SDK-Version": "0.4.16",
47
+ "User-Agent": "agentmail/0.4.16",
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);
@@ -11,12 +11,19 @@ export declare class AgentClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<AgentClient.Options>;
12
12
  constructor(options?: AgentClient.Options);
13
13
  /**
14
- * Create a new agent organization with an inbox and API key. A 6-digit OTP is sent to the human's email for verification.
14
+ * Create a new agent organization with an inbox and API key. This endpoint is for signing up for the first time. If you've already signed up, you're all set — just use your existing API key.
15
+ *
16
+ * A 6-digit OTP is sent to the human's email for verification.
15
17
  *
16
18
  * This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
17
19
  *
18
20
  * The returned API key has limited permissions until the organization is verified via the verify endpoint.
19
21
  *
22
+ * **CLI:**
23
+ * ```bash
24
+ * agentmail agent sign-up --human-email user@example.com --username my-agent
25
+ * ```
26
+ *
20
27
  * @param {AgentMail.AgentSignupRequest} request
21
28
  * @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
22
29
  *
@@ -37,6 +44,11 @@ export declare class AgentClient {
37
44
  *
38
45
  * The OTP expires after 24 hours and allows a maximum of 10 attempts.
39
46
  *
47
+ * **CLI:**
48
+ * ```bash
49
+ * agentmail agent verify --otp-code 123456
50
+ * ```
51
+ *
40
52
  * @param {AgentMail.AgentVerifyRequest} request
41
53
  * @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
42
54
  *
@@ -57,12 +57,19 @@ class AgentClient {
57
57
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
58
58
  }
59
59
  /**
60
- * Create a new agent organization with an inbox and API key. A 6-digit OTP is sent to the human's email for verification.
60
+ * Create a new agent organization with an inbox and API key. This endpoint is for signing up for the first time. If you've already signed up, you're all set — just use your existing API key.
61
+ *
62
+ * A 6-digit OTP is sent to the human's email for verification.
61
63
  *
62
64
  * This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
63
65
  *
64
66
  * The returned API key has limited permissions until the organization is verified via the verify endpoint.
65
67
  *
68
+ * **CLI:**
69
+ * ```bash
70
+ * agentmail agent sign-up --human-email user@example.com --username my-agent
71
+ * ```
72
+ *
66
73
  * @param {AgentMail.AgentSignupRequest} request
67
74
  * @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
68
75
  *
@@ -139,6 +146,11 @@ class AgentClient {
139
146
  *
140
147
  * The OTP expires after 24 hours and allows a maximum of 10 attempts.
141
148
  *
149
+ * **CLI:**
150
+ * ```bash
151
+ * agentmail agent verify --otp-code 123456
152
+ * ```
153
+ *
142
154
  * @param {AgentMail.AgentVerifyRequest} request
143
155
  * @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
144
156
  *
@@ -11,6 +11,11 @@ export declare class ApiKeysClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
12
12
  constructor(options?: ApiKeysClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail api-keys list
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.ListApiKeysRequest} request
15
20
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
16
21
  *
@@ -20,19 +25,27 @@ export declare class ApiKeysClient {
20
25
  list(request?: AgentMail.ListApiKeysRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListApiKeysResponse>;
21
26
  private __list;
22
27
  /**
28
+ * **CLI:**
29
+ * ```bash
30
+ * agentmail api-keys create --name "My Key"
31
+ * ```
32
+ *
23
33
  * @param {AgentMail.CreateApiKeyRequest} request
24
34
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
25
35
  *
26
36
  * @throws {@link AgentMail.ValidationError}
27
37
  *
28
38
  * @example
29
- * await client.apiKeys.create({
30
- * name: "name"
31
- * })
39
+ * await client.apiKeys.create({})
32
40
  */
33
41
  create(request: AgentMail.CreateApiKeyRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<AgentMail.CreateApiKeyResponse>;
34
42
  private __create;
35
43
  /**
44
+ * **CLI:**
45
+ * ```bash
46
+ * agentmail api-keys delete --api-key-id <api_key_id>
47
+ * ```
48
+ *
36
49
  * @param {AgentMail.ApiKeyId} api_key_id
37
50
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
38
51
  *
@@ -57,6 +57,11 @@ class ApiKeysClient {
57
57
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
58
58
  }
59
59
  /**
60
+ * **CLI:**
61
+ * ```bash
62
+ * agentmail api-keys list
63
+ * ```
64
+ *
60
65
  * @param {AgentMail.ListApiKeysRequest} request
61
66
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
62
67
  *
@@ -112,15 +117,18 @@ class ApiKeysClient {
112
117
  });
113
118
  }
114
119
  /**
120
+ * **CLI:**
121
+ * ```bash
122
+ * agentmail api-keys create --name "My Key"
123
+ * ```
124
+ *
115
125
  * @param {AgentMail.CreateApiKeyRequest} request
116
126
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
117
127
  *
118
128
  * @throws {@link AgentMail.ValidationError}
119
129
  *
120
130
  * @example
121
- * await client.apiKeys.create({
122
- * name: "name"
123
- * })
131
+ * await client.apiKeys.create({})
124
132
  */
125
133
  create(request, requestOptions) {
126
134
  return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
@@ -182,6 +190,11 @@ class ApiKeysClient {
182
190
  });
183
191
  }
184
192
  /**
193
+ * **CLI:**
194
+ * ```bash
195
+ * agentmail api-keys delete --api-key-id <api_key_id>
196
+ * ```
197
+ *
185
198
  * @param {AgentMail.ApiKeyId} api_key_id
186
199
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
187
200
  *
@@ -1,5 +1,5 @@
1
1
  import type * as AgentMail from "../../../index.js";
2
2
  export interface CreateApiKeyRequest {
3
- name: AgentMail.Name;
3
+ name?: AgentMail.Name;
4
4
  permissions?: AgentMail.ApiKeyPermissions;
5
5
  }
@@ -11,6 +11,11 @@ export declare class DomainsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<DomainsClient.Options>;
12
12
  constructor(options?: DomainsClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail domains list
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.ListDomainsRequest} request
15
20
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
16
21
  *
@@ -20,6 +25,11 @@ export declare class DomainsClient {
20
25
  list(request?: AgentMail.ListDomainsRequest, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListDomainsResponse>;
21
26
  private __list;
22
27
  /**
28
+ * **CLI:**
29
+ * ```bash
30
+ * agentmail domains retrieve --domain-id <domain_id>
31
+ * ```
32
+ *
23
33
  * @param {AgentMail.DomainId} domain_id
24
34
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
25
35
  *
@@ -31,11 +41,21 @@ export declare class DomainsClient {
31
41
  get(domain_id: AgentMail.DomainId, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Domain>;
32
42
  private __get;
33
43
  /**
44
+ * **CLI:**
45
+ * ```bash
46
+ * agentmail domains get-zone-file --domain-id <domain_id>
47
+ * ```
48
+ *
34
49
  * @throws {@link AgentMail.NotFoundError}
35
50
  */
36
51
  getZoneFile(domain_id: AgentMail.DomainId, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
37
52
  private __getZoneFile;
38
53
  /**
54
+ * **CLI:**
55
+ * ```bash
56
+ * agentmail domains create --domain example.com
57
+ * ```
58
+ *
39
59
  * @param {AgentMail.CreateDomainRequest} request
40
60
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
41
61
  *
@@ -50,6 +70,11 @@ export declare class DomainsClient {
50
70
  create(request: AgentMail.CreateDomainRequest, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Domain>;
51
71
  private __create;
52
72
  /**
73
+ * **CLI:**
74
+ * ```bash
75
+ * agentmail domains update --domain-id <domain_id>
76
+ * ```
77
+ *
53
78
  * @param {AgentMail.DomainId} domain_id
54
79
  * @param {AgentMail.UpdateDomainRequest} request
55
80
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -62,6 +87,11 @@ export declare class DomainsClient {
62
87
  update(domain_id: AgentMail.DomainId, request: AgentMail.UpdateDomainRequest, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Domain>;
63
88
  private __update;
64
89
  /**
90
+ * **CLI:**
91
+ * ```bash
92
+ * agentmail domains delete --domain-id <domain_id>
93
+ * ```
94
+ *
65
95
  * @param {AgentMail.DomainId} domain_id
66
96
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
67
97
  *
@@ -73,6 +103,11 @@ export declare class DomainsClient {
73
103
  delete(domain_id: AgentMail.DomainId, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<void>;
74
104
  private __delete;
75
105
  /**
106
+ * **CLI:**
107
+ * ```bash
108
+ * agentmail domains verify --domain-id <domain_id>
109
+ * ```
110
+ *
76
111
  * @param {AgentMail.DomainId} domain_id
77
112
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
78
113
  *
@@ -57,6 +57,11 @@ class DomainsClient {
57
57
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
58
58
  }
59
59
  /**
60
+ * **CLI:**
61
+ * ```bash
62
+ * agentmail domains list
63
+ * ```
64
+ *
60
65
  * @param {AgentMail.ListDomainsRequest} request
61
66
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
62
67
  *
@@ -112,6 +117,11 @@ class DomainsClient {
112
117
  });
113
118
  }
114
119
  /**
120
+ * **CLI:**
121
+ * ```bash
122
+ * agentmail domains retrieve --domain-id <domain_id>
123
+ * ```
124
+ *
115
125
  * @param {AgentMail.DomainId} domain_id
116
126
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
117
127
  *
@@ -174,6 +184,11 @@ class DomainsClient {
174
184
  });
175
185
  }
176
186
  /**
187
+ * **CLI:**
188
+ * ```bash
189
+ * agentmail domains get-zone-file --domain-id <domain_id>
190
+ * ```
191
+ *
177
192
  * @throws {@link AgentMail.NotFoundError}
178
193
  */
179
194
  getZoneFile(domain_id, requestOptions) {
@@ -222,6 +237,11 @@ class DomainsClient {
222
237
  });
223
238
  }
224
239
  /**
240
+ * **CLI:**
241
+ * ```bash
242
+ * agentmail domains create --domain example.com
243
+ * ```
244
+ *
225
245
  * @param {AgentMail.CreateDomainRequest} request
226
246
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
227
247
  *
@@ -293,6 +313,11 @@ class DomainsClient {
293
313
  });
294
314
  }
295
315
  /**
316
+ * **CLI:**
317
+ * ```bash
318
+ * agentmail domains update --domain-id <domain_id>
319
+ * ```
320
+ *
296
321
  * @param {AgentMail.DomainId} domain_id
297
322
  * @param {AgentMail.UpdateDomainRequest} request
298
323
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -362,6 +387,11 @@ class DomainsClient {
362
387
  });
363
388
  }
364
389
  /**
390
+ * **CLI:**
391
+ * ```bash
392
+ * agentmail domains delete --domain-id <domain_id>
393
+ * ```
394
+ *
365
395
  * @param {AgentMail.DomainId} domain_id
366
396
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
367
397
  *
@@ -415,6 +445,11 @@ class DomainsClient {
415
445
  });
416
446
  }
417
447
  /**
448
+ * **CLI:**
449
+ * ```bash
450
+ * agentmail domains verify --domain-id <domain_id>
451
+ * ```
452
+ *
418
453
  * @param {AgentMail.DomainId} domain_id
419
454
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
420
455
  *
@@ -3,7 +3,6 @@ export interface DomainItem {
3
3
  podId?: AgentMail.pods.PodId;
4
4
  domainId: AgentMail.DomainId;
5
5
  domain: AgentMail.DomainName;
6
- status: AgentMail.Status;
7
6
  feedbackEnabled: AgentMail.FeedbackEnabled;
8
7
  clientId?: AgentMail.ClientId;
9
8
  /** Time at which the domain was last updated. */
@@ -11,6 +11,11 @@ export declare class DraftsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<DraftsClient.Options>;
12
12
  constructor(options?: DraftsClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail drafts list
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.ListDraftsRequest} request
15
20
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
16
21
  *
@@ -22,6 +27,11 @@ export declare class DraftsClient {
22
27
  list(request?: AgentMail.ListDraftsRequest, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListDraftsResponse>;
23
28
  private __list;
24
29
  /**
30
+ * **CLI:**
31
+ * ```bash
32
+ * agentmail drafts retrieve --draft-id <draft_id>
33
+ * ```
34
+ *
25
35
  * @param {AgentMail.DraftId} draft_id
26
36
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
27
37
  *
@@ -33,6 +43,11 @@ export declare class DraftsClient {
33
43
  get(draft_id: AgentMail.DraftId, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Draft>;
34
44
  private __get;
35
45
  /**
46
+ * **CLI:**
47
+ * ```bash
48
+ * agentmail drafts get-attachment --draft-id <draft_id> --attachment-id <attachment_id>
49
+ * ```
50
+ *
36
51
  * @param {AgentMail.DraftId} draft_id
37
52
  * @param {AgentMail.AttachmentId} attachment_id
38
53
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -58,6 +58,11 @@ class DraftsClient {
58
58
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
59
59
  }
60
60
  /**
61
+ * **CLI:**
62
+ * ```bash
63
+ * agentmail drafts list
64
+ * ```
65
+ *
61
66
  * @param {AgentMail.ListDraftsRequest} request
62
67
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
63
68
  *
@@ -138,6 +143,11 @@ class DraftsClient {
138
143
  });
139
144
  }
140
145
  /**
146
+ * **CLI:**
147
+ * ```bash
148
+ * agentmail drafts retrieve --draft-id <draft_id>
149
+ * ```
150
+ *
141
151
  * @param {AgentMail.DraftId} draft_id
142
152
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
143
153
  *
@@ -200,6 +210,11 @@ class DraftsClient {
200
210
  });
201
211
  }
202
212
  /**
213
+ * **CLI:**
214
+ * ```bash
215
+ * agentmail drafts get-attachment --draft-id <draft_id> --attachment-id <attachment_id>
216
+ * ```
217
+ *
203
218
  * @param {AgentMail.DraftId} draft_id
204
219
  * @param {AgentMail.AttachmentId} attachment_id
205
220
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -29,6 +29,11 @@ export declare class InboxesClient {
29
29
  get metrics(): MetricsClient;
30
30
  get apiKeys(): ApiKeysClient;
31
31
  /**
32
+ * **CLI:**
33
+ * ```bash
34
+ * agentmail inboxes list
35
+ * ```
36
+ *
32
37
  * @param {AgentMail.inboxes.ListInboxesRequest} request
33
38
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
34
39
  *
@@ -38,6 +43,11 @@ export declare class InboxesClient {
38
43
  list(request?: AgentMail.inboxes.ListInboxesRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.ListInboxesResponse>;
39
44
  private __list;
40
45
  /**
46
+ * **CLI:**
47
+ * ```bash
48
+ * agentmail inboxes retrieve --inbox-id <inbox_id>
49
+ * ```
50
+ *
41
51
  * @param {AgentMail.inboxes.InboxId} inbox_id
42
52
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
43
53
  *
@@ -49,6 +59,11 @@ export declare class InboxesClient {
49
59
  get(inbox_id: AgentMail.inboxes.InboxId, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
50
60
  private __get;
51
61
  /**
62
+ * **CLI:**
63
+ * ```bash
64
+ * agentmail inboxes create --display-name "My Agent" --username myagent --domain agentmail.to
65
+ * ```
66
+ *
52
67
  * @param {AgentMail.inboxes.CreateInboxRequest} request
53
68
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
54
69
  *
@@ -60,6 +75,11 @@ export declare class InboxesClient {
60
75
  create(request?: AgentMail.inboxes.CreateInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
61
76
  private __create;
62
77
  /**
78
+ * **CLI:**
79
+ * ```bash
80
+ * agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"
81
+ * ```
82
+ *
63
83
  * @param {AgentMail.inboxes.InboxId} inbox_id
64
84
  * @param {AgentMail.inboxes.UpdateInboxRequest} request
65
85
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -74,6 +94,11 @@ export declare class InboxesClient {
74
94
  update(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.UpdateInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
75
95
  private __update;
76
96
  /**
97
+ * **CLI:**
98
+ * ```bash
99
+ * agentmail inboxes delete --inbox-id <inbox_id>
100
+ * ```
101
+ *
77
102
  * @param {AgentMail.inboxes.InboxId} inbox_id
78
103
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
79
104
  *
@@ -87,6 +87,11 @@ class InboxesClient {
87
87
  return ((_a = this._apiKeys) !== null && _a !== void 0 ? _a : (this._apiKeys = new Client_js_1.ApiKeysClient(this._options)));
88
88
  }
89
89
  /**
90
+ * **CLI:**
91
+ * ```bash
92
+ * agentmail inboxes list
93
+ * ```
94
+ *
90
95
  * @param {AgentMail.inboxes.ListInboxesRequest} request
91
96
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
92
97
  *
@@ -142,6 +147,11 @@ class InboxesClient {
142
147
  });
143
148
  }
144
149
  /**
150
+ * **CLI:**
151
+ * ```bash
152
+ * agentmail inboxes retrieve --inbox-id <inbox_id>
153
+ * ```
154
+ *
145
155
  * @param {AgentMail.inboxes.InboxId} inbox_id
146
156
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
147
157
  *
@@ -204,6 +214,11 @@ class InboxesClient {
204
214
  });
205
215
  }
206
216
  /**
217
+ * **CLI:**
218
+ * ```bash
219
+ * agentmail inboxes create --display-name "My Agent" --username myagent --domain agentmail.to
220
+ * ```
221
+ *
207
222
  * @param {AgentMail.inboxes.CreateInboxRequest} request
208
223
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
209
224
  *
@@ -272,6 +287,11 @@ class InboxesClient {
272
287
  });
273
288
  }
274
289
  /**
290
+ * **CLI:**
291
+ * ```bash
292
+ * agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"
293
+ * ```
294
+ *
275
295
  * @param {AgentMail.inboxes.InboxId} inbox_id
276
296
  * @param {AgentMail.inboxes.UpdateInboxRequest} request
277
297
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -343,6 +363,11 @@ class InboxesClient {
343
363
  });
344
364
  }
345
365
  /**
366
+ * **CLI:**
367
+ * ```bash
368
+ * agentmail inboxes delete --inbox-id <inbox_id>
369
+ * ```
370
+ *
346
371
  * @param {AgentMail.inboxes.InboxId} inbox_id
347
372
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
348
373
  *
@@ -11,6 +11,11 @@ export declare class ApiKeysClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
12
12
  constructor(options?: ApiKeysClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail inboxes:api-keys list --inbox-id <inbox_id>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.inboxes.InboxId} inbox_id
15
20
  * @param {AgentMail.inboxes.ListApiKeysRequest} request
16
21
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class ApiKeysClient {
23
28
  list(inbox_id: AgentMail.inboxes.InboxId, request?: AgentMail.inboxes.ListApiKeysRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListApiKeysResponse>;
24
29
  private __list;
25
30
  /**
31
+ * **CLI:**
32
+ * ```bash
33
+ * agentmail inboxes:api-keys create --inbox-id <inbox_id> --name "My Key"
34
+ * ```
35
+ *
26
36
  * @param {AgentMail.inboxes.InboxId} inbox_id
27
37
  * @param {AgentMail.CreateApiKeyRequest} request
28
38
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,13 +41,16 @@ export declare class ApiKeysClient {
31
41
  * @throws {@link AgentMail.ValidationError}
32
42
  *
33
43
  * @example
34
- * await client.inboxes.apiKeys.create("inbox_id", {
35
- * name: "name"
36
- * })
44
+ * await client.inboxes.apiKeys.create("inbox_id", {})
37
45
  */
38
46
  create(inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.CreateApiKeyRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<AgentMail.CreateApiKeyResponse>;
39
47
  private __create;
40
48
  /**
49
+ * **CLI:**
50
+ * ```bash
51
+ * agentmail inboxes:api-keys delete --inbox-id <inbox_id> --api-key-id <api_key_id>
52
+ * ```
53
+ *
41
54
  * @param {AgentMail.inboxes.InboxId} inbox_id
42
55
  * @param {AgentMail.ApiKeyId} api_key_id
43
56
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -57,6 +57,11 @@ class ApiKeysClient {
57
57
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
58
58
  }
59
59
  /**
60
+ * **CLI:**
61
+ * ```bash
62
+ * agentmail inboxes:api-keys list --inbox-id <inbox_id>
63
+ * ```
64
+ *
60
65
  * @param {AgentMail.inboxes.InboxId} inbox_id
61
66
  * @param {AgentMail.inboxes.ListApiKeysRequest} request
62
67
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -125,6 +130,11 @@ class ApiKeysClient {
125
130
  });
126
131
  }
127
132
  /**
133
+ * **CLI:**
134
+ * ```bash
135
+ * agentmail inboxes:api-keys create --inbox-id <inbox_id> --name "My Key"
136
+ * ```
137
+ *
128
138
  * @param {AgentMail.inboxes.InboxId} inbox_id
129
139
  * @param {AgentMail.CreateApiKeyRequest} request
130
140
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -133,9 +143,7 @@ class ApiKeysClient {
133
143
  * @throws {@link AgentMail.ValidationError}
134
144
  *
135
145
  * @example
136
- * await client.inboxes.apiKeys.create("inbox_id", {
137
- * name: "name"
138
- * })
146
+ * await client.inboxes.apiKeys.create("inbox_id", {})
139
147
  */
140
148
  create(inbox_id, request, requestOptions) {
141
149
  return core.HttpResponsePromise.fromPromise(this.__create(inbox_id, request, requestOptions));
@@ -205,6 +213,11 @@ class ApiKeysClient {
205
213
  });
206
214
  }
207
215
  /**
216
+ * **CLI:**
217
+ * ```bash
218
+ * agentmail inboxes:api-keys delete --inbox-id <inbox_id> --api-key-id <api_key_id>
219
+ * ```
220
+ *
208
221
  * @param {AgentMail.inboxes.InboxId} inbox_id
209
222
  * @param {AgentMail.ApiKeyId} api_key_id
210
223
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.