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,6 +11,11 @@ export declare class ListsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ListsClient.Options>;
12
12
  constructor(options?: ListsClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail lists list --direction <direction> --type <type>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.Direction} direction
15
20
  * @param {AgentMail.ListType} type
16
21
  * @param {AgentMail.ListListEntriesRequest} request
@@ -22,6 +27,11 @@ export declare class ListsClient {
22
27
  list(direction: AgentMail.Direction, type: AgentMail.ListType, request?: AgentMail.ListListEntriesRequest, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListListEntriesResponse>;
23
28
  private __list;
24
29
  /**
30
+ * **CLI:**
31
+ * ```bash
32
+ * agentmail lists retrieve --direction <direction> --type <type> --entry <entry>
33
+ * ```
34
+ *
25
35
  * @param {AgentMail.Direction} direction
26
36
  * @param {AgentMail.ListType} type
27
37
  * @param {string} entry - Email address or domain.
@@ -35,6 +45,11 @@ export declare class ListsClient {
35
45
  get(direction: AgentMail.Direction, type: AgentMail.ListType, entry: string, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListEntry>;
36
46
  private __get;
37
47
  /**
48
+ * **CLI:**
49
+ * ```bash
50
+ * agentmail lists create --direction <direction> --type <type> --entry user@example.com
51
+ * ```
52
+ *
38
53
  * @param {AgentMail.Direction} direction
39
54
  * @param {AgentMail.ListType} type
40
55
  * @param {AgentMail.CreateListEntryRequest} request
@@ -50,6 +65,11 @@ export declare class ListsClient {
50
65
  create(direction: AgentMail.Direction, type: AgentMail.ListType, request: AgentMail.CreateListEntryRequest, requestOptions?: ListsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListEntry>;
51
66
  private __create;
52
67
  /**
68
+ * **CLI:**
69
+ * ```bash
70
+ * agentmail lists delete --direction <direction> --type <type> --entry <entry>
71
+ * ```
72
+ *
53
73
  * @param {AgentMail.Direction} direction
54
74
  * @param {AgentMail.ListType} type
55
75
  * @param {string} entry - Email address or domain.
@@ -21,6 +21,11 @@ export class ListsClient {
21
21
  this._options = normalizeClientOptionsWithAuth(options);
22
22
  }
23
23
  /**
24
+ * **CLI:**
25
+ * ```bash
26
+ * agentmail lists list --direction <direction> --type <type>
27
+ * ```
28
+ *
24
29
  * @param {AgentMail.Direction} direction
25
30
  * @param {AgentMail.ListType} type
26
31
  * @param {AgentMail.ListListEntriesRequest} request
@@ -77,6 +82,11 @@ export class ListsClient {
77
82
  });
78
83
  }
79
84
  /**
85
+ * **CLI:**
86
+ * ```bash
87
+ * agentmail lists retrieve --direction <direction> --type <type> --entry <entry>
88
+ * ```
89
+ *
80
90
  * @param {AgentMail.Direction} direction
81
91
  * @param {AgentMail.ListType} type
82
92
  * @param {string} entry - Email address or domain.
@@ -141,6 +151,11 @@ export class ListsClient {
141
151
  });
142
152
  }
143
153
  /**
154
+ * **CLI:**
155
+ * ```bash
156
+ * agentmail lists create --direction <direction> --type <type> --entry user@example.com
157
+ * ```
158
+ *
144
159
  * @param {AgentMail.Direction} direction
145
160
  * @param {AgentMail.ListType} type
146
161
  * @param {AgentMail.CreateListEntryRequest} request
@@ -213,6 +228,11 @@ export class ListsClient {
213
228
  });
214
229
  }
215
230
  /**
231
+ * **CLI:**
232
+ * ```bash
233
+ * agentmail lists delete --direction <direction> --type <type> --entry <entry>
234
+ * ```
235
+ *
216
236
  * @param {AgentMail.Direction} direction
217
237
  * @param {AgentMail.ListType} type
218
238
  * @param {string} entry - Email address or domain.
@@ -0,0 +1,4 @@
1
+ /**
2
+ * Label or list of labels.
3
+ */
4
+ export type UpdateMessageLabels = string | string[];
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,6 +1,7 @@
1
+ import type * as AgentMail from "../../../index.mjs";
1
2
  export interface UpdateMessageRequest {
2
- /** Labels to add to message. */
3
- addLabels?: string[];
4
- /** Labels to remove from message. */
5
- removeLabels?: string[];
3
+ /** Label or labels to add to message. */
4
+ addLabels?: AgentMail.UpdateMessageLabels;
5
+ /** Label or labels to remove from message. */
6
+ removeLabels?: AgentMail.UpdateMessageLabels;
6
7
  }
@@ -33,5 +33,6 @@ export * from "./SendMessageReplyTo.mjs";
33
33
  export * from "./SendMessageRequest.mjs";
34
34
  export * from "./SendMessageResponse.mjs";
35
35
  export * from "./SendMessageTo.mjs";
36
+ export * from "./UpdateMessageLabels.mjs";
36
37
  export * from "./UpdateMessageRequest.mjs";
37
38
  export * from "./UpdateMessageResponse.mjs";
@@ -33,5 +33,6 @@ export * from "./SendMessageReplyTo.mjs";
33
33
  export * from "./SendMessageRequest.mjs";
34
34
  export * from "./SendMessageResponse.mjs";
35
35
  export * from "./SendMessageTo.mjs";
36
+ export * from "./UpdateMessageLabels.mjs";
36
37
  export * from "./UpdateMessageRequest.mjs";
37
38
  export * from "./UpdateMessageResponse.mjs";
@@ -11,6 +11,11 @@ export declare class MetricsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<MetricsClient.Options>;
12
12
  constructor(options?: MetricsClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail metrics list
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.QueryMetricsRequest} request
15
20
  * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
16
21
  *
@@ -22,6 +22,11 @@ export class MetricsClient {
22
22
  this._options = normalizeClientOptionsWithAuth(options);
23
23
  }
24
24
  /**
25
+ * **CLI:**
26
+ * ```bash
27
+ * agentmail metrics list
28
+ * ```
29
+ *
25
30
  * @param {AgentMail.QueryMetricsRequest} request
26
31
  * @param {MetricsClient.RequestOptions} requestOptions - Request-specific configuration.
27
32
  *
@@ -32,6 +32,11 @@ export declare class PodsClient {
32
32
  get metrics(): MetricsClient;
33
33
  get apiKeys(): ApiKeysClient;
34
34
  /**
35
+ * **CLI:**
36
+ * ```bash
37
+ * agentmail pods list
38
+ * ```
39
+ *
35
40
  * @param {AgentMail.pods.ListPodsRequest} request
36
41
  * @param {PodsClient.RequestOptions} requestOptions - Request-specific configuration.
37
42
  *
@@ -41,6 +46,11 @@ export declare class PodsClient {
41
46
  list(request?: AgentMail.pods.ListPodsRequest, requestOptions?: PodsClient.RequestOptions): core.HttpResponsePromise<AgentMail.pods.ListPodsResponse>;
42
47
  private __list;
43
48
  /**
49
+ * **CLI:**
50
+ * ```bash
51
+ * agentmail pods retrieve --pod-id <pod_id>
52
+ * ```
53
+ *
44
54
  * @param {AgentMail.pods.PodId} pod_id
45
55
  * @param {PodsClient.RequestOptions} requestOptions - Request-specific configuration.
46
56
  *
@@ -52,6 +62,11 @@ export declare class PodsClient {
52
62
  get(pod_id: AgentMail.pods.PodId, requestOptions?: PodsClient.RequestOptions): core.HttpResponsePromise<AgentMail.pods.Pod>;
53
63
  private __get;
54
64
  /**
65
+ * **CLI:**
66
+ * ```bash
67
+ * agentmail pods create --client-id my-pod
68
+ * ```
69
+ *
55
70
  * @param {AgentMail.pods.CreatePodRequest} request
56
71
  * @param {PodsClient.RequestOptions} requestOptions - Request-specific configuration.
57
72
  *
@@ -63,6 +78,11 @@ export declare class PodsClient {
63
78
  create(request: AgentMail.pods.CreatePodRequest, requestOptions?: PodsClient.RequestOptions): core.HttpResponsePromise<AgentMail.pods.Pod>;
64
79
  private __create;
65
80
  /**
81
+ * **CLI:**
82
+ * ```bash
83
+ * agentmail pods delete --pod-id <pod_id>
84
+ * ```
85
+ *
66
86
  * @param {AgentMail.pods.PodId} pod_id
67
87
  * @param {PodsClient.RequestOptions} requestOptions - Request-specific configuration.
68
88
  *
@@ -56,6 +56,11 @@ export class PodsClient {
56
56
  return ((_a = this._apiKeys) !== null && _a !== void 0 ? _a : (this._apiKeys = new ApiKeysClient(this._options)));
57
57
  }
58
58
  /**
59
+ * **CLI:**
60
+ * ```bash
61
+ * agentmail pods list
62
+ * ```
63
+ *
59
64
  * @param {AgentMail.pods.ListPodsRequest} request
60
65
  * @param {PodsClient.RequestOptions} requestOptions - Request-specific configuration.
61
66
  *
@@ -111,6 +116,11 @@ export class PodsClient {
111
116
  });
112
117
  }
113
118
  /**
119
+ * **CLI:**
120
+ * ```bash
121
+ * agentmail pods retrieve --pod-id <pod_id>
122
+ * ```
123
+ *
114
124
  * @param {AgentMail.pods.PodId} pod_id
115
125
  * @param {PodsClient.RequestOptions} requestOptions - Request-specific configuration.
116
126
  *
@@ -173,6 +183,11 @@ export class PodsClient {
173
183
  });
174
184
  }
175
185
  /**
186
+ * **CLI:**
187
+ * ```bash
188
+ * agentmail pods create --client-id my-pod
189
+ * ```
190
+ *
176
191
  * @param {AgentMail.pods.CreatePodRequest} request
177
192
  * @param {PodsClient.RequestOptions} requestOptions - Request-specific configuration.
178
193
  *
@@ -241,6 +256,11 @@ export class PodsClient {
241
256
  });
242
257
  }
243
258
  /**
259
+ * **CLI:**
260
+ * ```bash
261
+ * agentmail pods delete --pod-id <pod_id>
262
+ * ```
263
+ *
244
264
  * @param {AgentMail.pods.PodId} pod_id
245
265
  * @param {PodsClient.RequestOptions} requestOptions - Request-specific configuration.
246
266
  *
@@ -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 pods:api-keys list --pod-id <pod_id>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.pods.PodId} pod_id
15
20
  * @param {AgentMail.pods.ListApiKeysRequest} request
16
21
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class ApiKeysClient {
23
28
  list(pod_id: AgentMail.pods.PodId, request?: AgentMail.pods.ListApiKeysRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListApiKeysResponse>;
24
29
  private __list;
25
30
  /**
31
+ * **CLI:**
32
+ * ```bash
33
+ * agentmail pods:api-keys create --pod-id <pod_id> --name "My Key"
34
+ * ```
35
+ *
26
36
  * @param {AgentMail.pods.PodId} pod_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.pods.apiKeys.create("pod_id", {
35
- * name: "name"
36
- * })
44
+ * await client.pods.apiKeys.create("pod_id", {})
37
45
  */
38
46
  create(pod_id: AgentMail.pods.PodId, request: AgentMail.CreateApiKeyRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<AgentMail.CreateApiKeyResponse>;
39
47
  private __create;
40
48
  /**
49
+ * **CLI:**
50
+ * ```bash
51
+ * agentmail pods:api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
52
+ * ```
53
+ *
41
54
  * @param {AgentMail.pods.PodId} pod_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 pods:api-keys list --pod-id <pod_id>
27
+ * ```
28
+ *
24
29
  * @param {AgentMail.pods.PodId} pod_id
25
30
  * @param {AgentMail.pods.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 pods:api-keys create --pod-id <pod_id> --name "My Key"
100
+ * ```
101
+ *
92
102
  * @param {AgentMail.pods.PodId} pod_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.pods.apiKeys.create("pod_id", {
101
- * name: "name"
102
- * })
110
+ * await client.pods.apiKeys.create("pod_id", {})
103
111
  */
104
112
  create(pod_id, request, requestOptions) {
105
113
  return core.HttpResponsePromise.fromPromise(this.__create(pod_id, request, requestOptions));
@@ -169,6 +177,11 @@ export class ApiKeysClient {
169
177
  });
170
178
  }
171
179
  /**
180
+ * **CLI:**
181
+ * ```bash
182
+ * agentmail pods:api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
183
+ * ```
184
+ *
172
185
  * @param {AgentMail.pods.PodId} pod_id
173
186
  * @param {AgentMail.ApiKeyId} api_key_id
174
187
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -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 pods:domains list --pod-id <pod_id>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.pods.PodId} pod_id
15
20
  * @param {AgentMail.pods.ListDomainsRequest} request
16
21
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class DomainsClient {
23
28
  list(pod_id: AgentMail.pods.PodId, request?: AgentMail.pods.ListDomainsRequest, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListDomainsResponse>;
24
29
  private __list;
25
30
  /**
31
+ * **CLI:**
32
+ * ```bash
33
+ * agentmail pods:domains retrieve --pod-id <pod_id> --domain-id <domain_id>
34
+ * ```
35
+ *
26
36
  * @param {AgentMail.pods.PodId} pod_id
27
37
  * @param {AgentMail.DomainId} domain_id
28
38
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,11 +45,21 @@ export declare class DomainsClient {
35
45
  get(pod_id: AgentMail.pods.PodId, domain_id: AgentMail.DomainId, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Domain>;
36
46
  private __get;
37
47
  /**
48
+ * **CLI:**
49
+ * ```bash
50
+ * agentmail pods:domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
51
+ * ```
52
+ *
38
53
  * @throws {@link AgentMail.NotFoundError}
39
54
  */
40
55
  getZoneFile(pod_id: AgentMail.pods.PodId, domain_id: AgentMail.DomainId, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
41
56
  private __getZoneFile;
42
57
  /**
58
+ * **CLI:**
59
+ * ```bash
60
+ * agentmail pods:domains create --pod-id <pod_id> --domain example.com
61
+ * ```
62
+ *
43
63
  * @param {AgentMail.pods.PodId} pod_id
44
64
  * @param {AgentMail.CreateDomainRequest} request
45
65
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -55,6 +75,11 @@ export declare class DomainsClient {
55
75
  create(pod_id: AgentMail.pods.PodId, request: AgentMail.CreateDomainRequest, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Domain>;
56
76
  private __create;
57
77
  /**
78
+ * **CLI:**
79
+ * ```bash
80
+ * agentmail pods:domains update --pod-id <pod_id> --domain-id <domain_id>
81
+ * ```
82
+ *
58
83
  * @param {AgentMail.pods.PodId} pod_id
59
84
  * @param {AgentMail.DomainId} domain_id
60
85
  * @param {AgentMail.UpdateDomainRequest} request
@@ -68,6 +93,11 @@ export declare class DomainsClient {
68
93
  update(pod_id: AgentMail.pods.PodId, domain_id: AgentMail.DomainId, request: AgentMail.UpdateDomainRequest, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Domain>;
69
94
  private __update;
70
95
  /**
96
+ * **CLI:**
97
+ * ```bash
98
+ * agentmail pods:domains delete --pod-id <pod_id> --domain-id <domain_id>
99
+ * ```
100
+ *
71
101
  * @param {AgentMail.pods.PodId} pod_id
72
102
  * @param {AgentMail.DomainId} domain_id
73
103
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -80,6 +110,11 @@ export declare class DomainsClient {
80
110
  delete(pod_id: AgentMail.pods.PodId, domain_id: AgentMail.DomainId, requestOptions?: DomainsClient.RequestOptions): core.HttpResponsePromise<void>;
81
111
  private __delete;
82
112
  /**
113
+ * **CLI:**
114
+ * ```bash
115
+ * agentmail pods:domains verify --pod-id <pod_id> --domain-id <domain_id>
116
+ * ```
117
+ *
83
118
  * @param {AgentMail.pods.PodId} pod_id
84
119
  * @param {AgentMail.DomainId} domain_id
85
120
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -21,6 +21,11 @@ export class DomainsClient {
21
21
  this._options = normalizeClientOptionsWithAuth(options);
22
22
  }
23
23
  /**
24
+ * **CLI:**
25
+ * ```bash
26
+ * agentmail pods:domains list --pod-id <pod_id>
27
+ * ```
28
+ *
24
29
  * @param {AgentMail.pods.PodId} pod_id
25
30
  * @param {AgentMail.pods.ListDomainsRequest} request
26
31
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -90,6 +95,11 @@ export class DomainsClient {
90
95
  });
91
96
  }
92
97
  /**
98
+ * **CLI:**
99
+ * ```bash
100
+ * agentmail pods:domains retrieve --pod-id <pod_id> --domain-id <domain_id>
101
+ * ```
102
+ *
93
103
  * @param {AgentMail.pods.PodId} pod_id
94
104
  * @param {AgentMail.DomainId} domain_id
95
105
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -153,6 +163,11 @@ export class DomainsClient {
153
163
  });
154
164
  }
155
165
  /**
166
+ * **CLI:**
167
+ * ```bash
168
+ * agentmail pods:domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
169
+ * ```
170
+ *
156
171
  * @throws {@link AgentMail.NotFoundError}
157
172
  */
158
173
  getZoneFile(pod_id, domain_id, requestOptions) {
@@ -201,6 +216,11 @@ export class DomainsClient {
201
216
  });
202
217
  }
203
218
  /**
219
+ * **CLI:**
220
+ * ```bash
221
+ * agentmail pods:domains create --pod-id <pod_id> --domain example.com
222
+ * ```
223
+ *
204
224
  * @param {AgentMail.pods.PodId} pod_id
205
225
  * @param {AgentMail.CreateDomainRequest} request
206
226
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -273,6 +293,11 @@ export class DomainsClient {
273
293
  });
274
294
  }
275
295
  /**
296
+ * **CLI:**
297
+ * ```bash
298
+ * agentmail pods:domains update --pod-id <pod_id> --domain-id <domain_id>
299
+ * ```
300
+ *
276
301
  * @param {AgentMail.pods.PodId} pod_id
277
302
  * @param {AgentMail.DomainId} domain_id
278
303
  * @param {AgentMail.UpdateDomainRequest} request
@@ -343,6 +368,11 @@ export class DomainsClient {
343
368
  });
344
369
  }
345
370
  /**
371
+ * **CLI:**
372
+ * ```bash
373
+ * agentmail pods:domains delete --pod-id <pod_id> --domain-id <domain_id>
374
+ * ```
375
+ *
346
376
  * @param {AgentMail.pods.PodId} pod_id
347
377
  * @param {AgentMail.DomainId} domain_id
348
378
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -397,6 +427,11 @@ export class DomainsClient {
397
427
  });
398
428
  }
399
429
  /**
430
+ * **CLI:**
431
+ * ```bash
432
+ * agentmail pods:domains verify --pod-id <pod_id> --domain-id <domain_id>
433
+ * ```
434
+ *
400
435
  * @param {AgentMail.pods.PodId} pod_id
401
436
  * @param {AgentMail.DomainId} domain_id
402
437
  * @param {DomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -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 pods:drafts list --pod-id <pod_id>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.pods.PodId} pod_id
15
20
  * @param {AgentMail.pods.ListDraftsRequest} request
16
21
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class DraftsClient {
23
28
  list(pod_id: AgentMail.pods.PodId, request?: AgentMail.pods.ListDraftsRequest, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.ListDraftsResponse>;
24
29
  private __list;
25
30
  /**
31
+ * **CLI:**
32
+ * ```bash
33
+ * agentmail pods:drafts retrieve --pod-id <pod_id> --draft-id <draft_id>
34
+ * ```
35
+ *
26
36
  * @param {AgentMail.pods.PodId} pod_id
27
37
  * @param {AgentMail.DraftId} draft_id
28
38
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,6 +45,11 @@ export declare class DraftsClient {
35
45
  get(pod_id: AgentMail.pods.PodId, draft_id: AgentMail.DraftId, requestOptions?: DraftsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Draft>;
36
46
  private __get;
37
47
  /**
48
+ * **CLI:**
49
+ * ```bash
50
+ * agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>
51
+ * ```
52
+ *
38
53
  * @param {AgentMail.pods.PodId} pod_id
39
54
  * @param {AgentMail.DraftId} draft_id
40
55
  * @param {AgentMail.AttachmentId} attachment_id
@@ -22,6 +22,11 @@ export class DraftsClient {
22
22
  this._options = normalizeClientOptionsWithAuth(options);
23
23
  }
24
24
  /**
25
+ * **CLI:**
26
+ * ```bash
27
+ * agentmail pods:drafts list --pod-id <pod_id>
28
+ * ```
29
+ *
25
30
  * @param {AgentMail.pods.PodId} pod_id
26
31
  * @param {AgentMail.pods.ListDraftsRequest} request
27
32
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -103,6 +108,11 @@ export class DraftsClient {
103
108
  });
104
109
  }
105
110
  /**
111
+ * **CLI:**
112
+ * ```bash
113
+ * agentmail pods:drafts retrieve --pod-id <pod_id> --draft-id <draft_id>
114
+ * ```
115
+ *
106
116
  * @param {AgentMail.pods.PodId} pod_id
107
117
  * @param {AgentMail.DraftId} draft_id
108
118
  * @param {DraftsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -166,6 +176,11 @@ export class DraftsClient {
166
176
  });
167
177
  }
168
178
  /**
179
+ * **CLI:**
180
+ * ```bash
181
+ * agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>
182
+ * ```
183
+ *
169
184
  * @param {AgentMail.pods.PodId} pod_id
170
185
  * @param {AgentMail.DraftId} draft_id
171
186
  * @param {AgentMail.AttachmentId} attachment_id
@@ -11,6 +11,11 @@ export declare class InboxesClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<InboxesClient.Options>;
12
12
  constructor(options?: InboxesClient.Options);
13
13
  /**
14
+ * **CLI:**
15
+ * ```bash
16
+ * agentmail pods:inboxes list --pod-id <pod_id>
17
+ * ```
18
+ *
14
19
  * @param {AgentMail.pods.PodId} pod_id
15
20
  * @param {AgentMail.pods.ListInboxesRequest} request
16
21
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -23,6 +28,11 @@ export declare class InboxesClient {
23
28
  list(pod_id: AgentMail.pods.PodId, request?: AgentMail.pods.ListInboxesRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.ListInboxesResponse>;
24
29
  private __list;
25
30
  /**
31
+ * **CLI:**
32
+ * ```bash
33
+ * agentmail pods:inboxes retrieve --pod-id <pod_id> --inbox-id <inbox_id>
34
+ * ```
35
+ *
26
36
  * @param {AgentMail.pods.PodId} pod_id
27
37
  * @param {AgentMail.inboxes.InboxId} inbox_id
28
38
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,6 +45,11 @@ export declare class InboxesClient {
35
45
  get(pod_id: AgentMail.pods.PodId, inbox_id: AgentMail.inboxes.InboxId, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
36
46
  private __get;
37
47
  /**
48
+ * **CLI:**
49
+ * ```bash
50
+ * agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com
51
+ * ```
52
+ *
38
53
  * @param {AgentMail.pods.PodId} pod_id
39
54
  * @param {AgentMail.inboxes.CreateInboxRequest} request
40
55
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -47,6 +62,11 @@ export declare class InboxesClient {
47
62
  create(pod_id: AgentMail.pods.PodId, request: AgentMail.inboxes.CreateInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
48
63
  private __create;
49
64
  /**
65
+ * **CLI:**
66
+ * ```bash
67
+ * agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
68
+ * ```
69
+ *
50
70
  * @param {AgentMail.pods.PodId} pod_id
51
71
  * @param {AgentMail.inboxes.InboxId} inbox_id
52
72
  * @param {AgentMail.inboxes.UpdateInboxRequest} request
@@ -62,6 +82,11 @@ export declare class InboxesClient {
62
82
  update(pod_id: AgentMail.pods.PodId, inbox_id: AgentMail.inboxes.InboxId, request: AgentMail.inboxes.UpdateInboxRequest, requestOptions?: InboxesClient.RequestOptions): core.HttpResponsePromise<AgentMail.inboxes.Inbox>;
63
83
  private __update;
64
84
  /**
85
+ * **CLI:**
86
+ * ```bash
87
+ * agentmail pods:inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
88
+ * ```
89
+ *
65
90
  * @param {AgentMail.pods.PodId} pod_id
66
91
  * @param {AgentMail.inboxes.InboxId} inbox_id
67
92
  * @param {InboxesClient.RequestOptions} requestOptions - Request-specific configuration.