agentmail 0.4.15 → 0.4.17

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 +64 -0
  21. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +106 -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 +64 -0
  87. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +106 -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 +1620 -27
@@ -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
  *
@@ -21,12 +21,19 @@ export class AgentClient {
21
21
  this._options = normalizeClientOptionsWithAuth(options);
22
22
  }
23
23
  /**
24
- * Create a new agent organization with an inbox and API key. A 6-digit OTP is sent to the human's email for verification.
24
+ * 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.
25
+ *
26
+ * A 6-digit OTP is sent to the human's email for verification.
25
27
  *
26
28
  * This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
27
29
  *
28
30
  * The returned API key has limited permissions until the organization is verified via the verify endpoint.
29
31
  *
32
+ * **CLI:**
33
+ * ```bash
34
+ * agentmail agent sign-up --human-email user@example.com --username my-agent
35
+ * ```
36
+ *
30
37
  * @param {AgentMail.AgentSignupRequest} request
31
38
  * @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
32
39
  *
@@ -103,6 +110,11 @@ export class AgentClient {
103
110
  *
104
111
  * The OTP expires after 24 hours and allows a maximum of 10 attempts.
105
112
  *
113
+ * **CLI:**
114
+ * ```bash
115
+ * agentmail agent verify --otp-code 123456
116
+ * ```
117
+ *
106
118
  * @param {AgentMail.AgentVerifyRequest} request
107
119
  * @param {AgentClient.RequestOptions} requestOptions - Request-specific configuration.
108
120
  *
@@ -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
  *
@@ -21,6 +21,11 @@ export class ApiKeysClient {
21
21
  this._options = normalizeClientOptionsWithAuth(options);
22
22
  }
23
23
  /**
24
+ * **CLI:**
25
+ * ```bash
26
+ * agentmail api-keys list
27
+ * ```
28
+ *
24
29
  * @param {AgentMail.ListApiKeysRequest} request
25
30
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
26
31
  *
@@ -76,15 +81,18 @@ export class ApiKeysClient {
76
81
  });
77
82
  }
78
83
  /**
84
+ * **CLI:**
85
+ * ```bash
86
+ * agentmail api-keys create --name "My Key"
87
+ * ```
88
+ *
79
89
  * @param {AgentMail.CreateApiKeyRequest} request
80
90
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
81
91
  *
82
92
  * @throws {@link AgentMail.ValidationError}
83
93
  *
84
94
  * @example
85
- * await client.apiKeys.create({
86
- * name: "name"
87
- * })
95
+ * await client.apiKeys.create({})
88
96
  */
89
97
  create(request, requestOptions) {
90
98
  return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
@@ -146,6 +154,11 @@ export class ApiKeysClient {
146
154
  });
147
155
  }
148
156
  /**
157
+ * **CLI:**
158
+ * ```bash
159
+ * agentmail api-keys delete --api-key-id <api_key_id>
160
+ * ```
161
+ *
149
162
  * @param {AgentMail.ApiKeyId} api_key_id
150
163
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
151
164
  *
@@ -1,5 +1,5 @@
1
1
  import type * as AgentMail from "../../../index.mjs";
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
  *
@@ -21,6 +21,11 @@ export class DomainsClient {
21
21
  this._options = normalizeClientOptionsWithAuth(options);
22
22
  }
23
23
  /**
24
+ * **CLI:**
25
+ * ```bash
26
+ * agentmail domains list
27
+ * ```
28
+ *
24
29
  * @param {AgentMail.ListDomainsRequest} request
25
30
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
26
31
  *
@@ -76,6 +81,11 @@ export class DomainsClient {
76
81
  });
77
82
  }
78
83
  /**
84
+ * **CLI:**
85
+ * ```bash
86
+ * agentmail domains retrieve --domain-id <domain_id>
87
+ * ```
88
+ *
79
89
  * @param {AgentMail.DomainId} domain_id
80
90
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
81
91
  *
@@ -138,6 +148,11 @@ export class DomainsClient {
138
148
  });
139
149
  }
140
150
  /**
151
+ * **CLI:**
152
+ * ```bash
153
+ * agentmail domains get-zone-file --domain-id <domain_id>
154
+ * ```
155
+ *
141
156
  * @throws {@link AgentMail.NotFoundError}
142
157
  */
143
158
  getZoneFile(domain_id, requestOptions) {
@@ -186,6 +201,11 @@ export class DomainsClient {
186
201
  });
187
202
  }
188
203
  /**
204
+ * **CLI:**
205
+ * ```bash
206
+ * agentmail domains create --domain example.com
207
+ * ```
208
+ *
189
209
  * @param {AgentMail.CreateDomainRequest} request
190
210
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
191
211
  *
@@ -257,6 +277,11 @@ export class DomainsClient {
257
277
  });
258
278
  }
259
279
  /**
280
+ * **CLI:**
281
+ * ```bash
282
+ * agentmail domains update --domain-id <domain_id>
283
+ * ```
284
+ *
260
285
  * @param {AgentMail.DomainId} domain_id
261
286
  * @param {AgentMail.UpdateDomainRequest} request
262
287
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -326,6 +351,11 @@ export class DomainsClient {
326
351
  });
327
352
  }
328
353
  /**
354
+ * **CLI:**
355
+ * ```bash
356
+ * agentmail domains delete --domain-id <domain_id>
357
+ * ```
358
+ *
329
359
  * @param {AgentMail.DomainId} domain_id
330
360
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
331
361
  *
@@ -379,6 +409,11 @@ export class DomainsClient {
379
409
  });
380
410
  }
381
411
  /**
412
+ * **CLI:**
413
+ * ```bash
414
+ * agentmail domains verify --domain-id <domain_id>
415
+ * ```
416
+ *
382
417
  * @param {AgentMail.DomainId} domain_id
383
418
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
384
419
  *
@@ -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.
@@ -22,6 +22,11 @@ export class DraftsClient {
22
22
  this._options = normalizeClientOptionsWithAuth(options);
23
23
  }
24
24
  /**
25
+ * **CLI:**
26
+ * ```bash
27
+ * agentmail drafts list
28
+ * ```
29
+ *
25
30
  * @param {AgentMail.ListDraftsRequest} request
26
31
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
27
32
  *
@@ -102,6 +107,11 @@ export class DraftsClient {
102
107
  });
103
108
  }
104
109
  /**
110
+ * **CLI:**
111
+ * ```bash
112
+ * agentmail drafts retrieve --draft-id <draft_id>
113
+ * ```
114
+ *
105
115
  * @param {AgentMail.DraftId} draft_id
106
116
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
107
117
  *
@@ -164,6 +174,11 @@ export class DraftsClient {
164
174
  });
165
175
  }
166
176
  /**
177
+ * **CLI:**
178
+ * ```bash
179
+ * agentmail drafts get-attachment --draft-id <draft_id> --attachment-id <attachment_id>
180
+ * ```
181
+ *
167
182
  * @param {AgentMail.DraftId} draft_id
168
183
  * @param {AgentMail.AttachmentId} attachment_id
169
184
  * @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
  *
@@ -51,6 +51,11 @@ export class InboxesClient {
51
51
  return ((_a = this._apiKeys) !== null && _a !== void 0 ? _a : (this._apiKeys = new ApiKeysClient(this._options)));
52
52
  }
53
53
  /**
54
+ * **CLI:**
55
+ * ```bash
56
+ * agentmail inboxes list
57
+ * ```
58
+ *
54
59
  * @param {AgentMail.inboxes.ListInboxesRequest} request
55
60
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
56
61
  *
@@ -106,6 +111,11 @@ export class InboxesClient {
106
111
  });
107
112
  }
108
113
  /**
114
+ * **CLI:**
115
+ * ```bash
116
+ * agentmail inboxes retrieve --inbox-id <inbox_id>
117
+ * ```
118
+ *
109
119
  * @param {AgentMail.inboxes.InboxId} inbox_id
110
120
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
111
121
  *
@@ -168,6 +178,11 @@ export class InboxesClient {
168
178
  });
169
179
  }
170
180
  /**
181
+ * **CLI:**
182
+ * ```bash
183
+ * agentmail inboxes create --display-name "My Agent" --username myagent --domain agentmail.to
184
+ * ```
185
+ *
171
186
  * @param {AgentMail.inboxes.CreateInboxRequest} request
172
187
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
173
188
  *
@@ -236,6 +251,11 @@ export class InboxesClient {
236
251
  });
237
252
  }
238
253
  /**
254
+ * **CLI:**
255
+ * ```bash
256
+ * agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"
257
+ * ```
258
+ *
239
259
  * @param {AgentMail.inboxes.InboxId} inbox_id
240
260
  * @param {AgentMail.inboxes.UpdateInboxRequest} request
241
261
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -307,6 +327,11 @@ export class InboxesClient {
307
327
  });
308
328
  }
309
329
  /**
330
+ * **CLI:**
331
+ * ```bash
332
+ * agentmail inboxes delete --inbox-id <inbox_id>
333
+ * ```
334
+ *
310
335
  * @param {AgentMail.inboxes.InboxId} inbox_id
311
336
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
312
337
  *
@@ -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.
@@ -21,6 +21,11 @@ export class ApiKeysClient {
21
21
  this._options = normalizeClientOptionsWithAuth(options);
22
22
  }
23
23
  /**
24
+ * **CLI:**
25
+ * ```bash
26
+ * agentmail inboxes:api-keys list --inbox-id <inbox_id>
27
+ * ```
28
+ *
24
29
  * @param {AgentMail.inboxes.InboxId} inbox_id
25
30
  * @param {AgentMail.inboxes.ListApiKeysRequest} request
26
31
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -89,6 +94,11 @@ export class ApiKeysClient {
89
94
  });
90
95
  }
91
96
  /**
97
+ * **CLI:**
98
+ * ```bash
99
+ * agentmail inboxes:api-keys create --inbox-id <inbox_id> --name "My Key"
100
+ * ```
101
+ *
92
102
  * @param {AgentMail.inboxes.InboxId} inbox_id
93
103
  * @param {AgentMail.CreateApiKeyRequest} request
94
104
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -97,9 +107,7 @@ export class ApiKeysClient {
97
107
  * @throws {@link AgentMail.ValidationError}
98
108
  *
99
109
  * @example
100
- * await client.inboxes.apiKeys.create("inbox_id", {
101
- * name: "name"
102
- * })
110
+ * await client.inboxes.apiKeys.create("inbox_id", {})
103
111
  */
104
112
  create(inbox_id, request, requestOptions) {
105
113
  return core.HttpResponsePromise.fromPromise(this.__create(inbox_id, request, requestOptions));
@@ -169,6 +177,11 @@ export class ApiKeysClient {
169
177
  });
170
178
  }
171
179
  /**
180
+ * **CLI:**
181
+ * ```bash
182
+ * agentmail inboxes:api-keys delete --inbox-id <inbox_id> --api-key-id <api_key_id>
183
+ * ```
184
+ *
172
185
  * @param {AgentMail.inboxes.InboxId} inbox_id
173
186
  * @param {AgentMail.ApiKeyId} api_key_id
174
187
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.