@epilot/email-settings-client 1.1.0-rc1 → 1.3.0

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.
package/dist/openapi.d.ts CHANGED
@@ -18,24 +18,25 @@ declare namespace Components {
18
18
  SharedInboxId?: Parameters.SharedInboxId;
19
19
  }
20
20
  namespace Responses {
21
- export type BadRequest = Schemas.ErrorResponse;
22
- export type Conflict = Schemas.ErrorResponse;
23
- export type CreateEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
24
- export type CreateSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
25
- export type Forbidden = Schemas.ErrorResponse;
26
- export type GetEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
27
- export type GetSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
28
- export type InternalServerError = Schemas.ErrorResponse;
29
- export type ListEmailAddressesSuccessResponse = Schemas.EmailAddressResponse[];
30
- export type ListInboxBucketsSuccessResponse = Schemas.InboxBucketResponse[];
31
- export type ListSharedInboxesSuccessResponse = Schemas.SharedInboxResponse[];
21
+ export type BadRequest = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
22
+ export type Conflict = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
23
+ export type CreateEmailAddressSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
24
+ export type CreateSharedInboxSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse;
25
+ export type Forbidden = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
26
+ export type GetEmailAddressSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
27
+ export type GetSharedInboxSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse;
28
+ export type InternalServerError = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
29
+ export type ListEmailAddressesSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse[];
30
+ export type ListInboxBucketsSuccessResponse = /* Inbox bucket representing the storage container for a shared inbox. */ Schemas.InboxBucketResponse[];
31
+ export type ListSharedInboxesSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse[];
32
32
  export interface NoContent {
33
33
  }
34
- export type NotFound = Schemas.ErrorResponse;
35
- export type ProvisionEpilotEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
36
- export type SetEmailAddressPrimarySuccessResponse = Schemas.EmailAddressResponse;
37
- export type UpdateEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
38
- export type UpdateSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
34
+ export type NotFound = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
35
+ export type OutlookErrorResponse = Schemas.OutlookConnectionError;
36
+ export type ProvisionEpilotEmailAddressSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
37
+ export type SetEmailAddressPrimarySuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
38
+ export type UpdateEmailAddressSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
39
+ export type UpdateSharedInboxSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse;
39
40
  }
40
41
  namespace Schemas {
41
42
  /**
@@ -65,42 +66,194 @@ declare namespace Components {
65
66
  */
66
67
  connected_by_user_id?: string;
67
68
  }
69
+ /**
70
+ * Request payload for creating a new email address.
71
+ */
68
72
  export interface CreateEmailAddressPayload {
73
+ /**
74
+ * The email address to add (e.g., from a custom domain or external provider)
75
+ * example:
76
+ * support@yourcompany.com
77
+ */
69
78
  address: string;
79
+ /**
80
+ * Display name shown as the sender name in emails
81
+ * example:
82
+ * Customer Support
83
+ */
70
84
  name?: string;
85
+ /**
86
+ * List of user IDs who can send from this address
87
+ * example:
88
+ * [
89
+ * "user-123"
90
+ * ]
91
+ */
71
92
  user_ids?: string[];
93
+ /**
94
+ * List of group IDs whose members can send from this address
95
+ * example:
96
+ * [
97
+ * "group-456"
98
+ * ]
99
+ */
72
100
  group_ids?: string[];
101
+ /**
102
+ * ID of the signature to use by default when sending from this address
103
+ * example:
104
+ * sig-789
105
+ */
73
106
  default_signature_id?: string;
107
+ /**
108
+ * ID of the shared inbox to associate with this address
109
+ * example:
110
+ * inbox-abc
111
+ */
74
112
  shared_inbox_id?: string;
75
113
  }
114
+ /**
115
+ * Request payload for creating a new shared inbox.
116
+ */
76
117
  export interface CreateSharedInboxPayload {
118
+ /**
119
+ * Optional custom ID for the inbox (auto-generated if not provided)
120
+ * example:
121
+ * support-inbox
122
+ */
77
123
  id?: string;
124
+ /**
125
+ * Hex color code for visual identification in the UI (required)
126
+ * example:
127
+ * #2196F3
128
+ */
78
129
  color: string;
130
+ /**
131
+ * Display name of the shared inbox (required)
132
+ * example:
133
+ * Sales Inquiries
134
+ */
79
135
  name: string;
136
+ /**
137
+ * List of user IDs to assign to this inbox
138
+ * example:
139
+ * [
140
+ * "user-123",
141
+ * "user-456"
142
+ * ]
143
+ */
80
144
  assignees?: string[];
145
+ /**
146
+ * Optional description of the inbox purpose
147
+ * example:
148
+ * Inbound sales and pricing requests
149
+ */
81
150
  description?: string;
82
151
  }
152
+ /**
153
+ * Custom email domain configuration.
154
+ */
83
155
  export interface Domain {
84
156
  /**
157
+ * The domain name to add or verify. Can be a root domain or subdomain.
158
+ * Examples: "yourcompany.com", "mail.yourcompany.com"
159
+ *
85
160
  * example:
86
- * subdomain.epilot.cloud
161
+ * mail.yourcompany.com
87
162
  */
88
163
  domain?: string;
89
164
  }
165
+ /**
166
+ * Email address configuration with all associated metadata.
167
+ */
90
168
  export interface EmailAddressResponse {
169
+ /**
170
+ * Unique identifier (UUID) for the resource
171
+ * example:
172
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
173
+ */
91
174
  id: string;
175
+ /**
176
+ * Timestamp when the resource was created
177
+ * example:
178
+ * 2024-01-15T10:30:00Z
179
+ */
92
180
  created_at: string; // date-time
181
+ /**
182
+ * Timestamp when the resource was last updated
183
+ * example:
184
+ * 2024-01-20T14:45:00Z
185
+ */
93
186
  updated_at?: string; // date-time
187
+ /**
188
+ * User ID of the user who created the resource
189
+ * example:
190
+ * user-123
191
+ */
94
192
  created_by?: string;
193
+ /**
194
+ * User ID of the user who last updated the resource
195
+ * example:
196
+ * user-456
197
+ */
95
198
  updated_by?: string;
199
+ /**
200
+ * The email address string
201
+ * example:
202
+ * sales@yourcompany.com
203
+ */
96
204
  address: string;
205
+ /**
206
+ * Display name shown as the sender name
207
+ * example:
208
+ * Sales Team
209
+ */
97
210
  name?: string;
211
+ /**
212
+ * IDs of users who can send from this address
213
+ * example:
214
+ * [
215
+ * "user-123",
216
+ * "user-456"
217
+ * ]
218
+ */
98
219
  user_ids?: string[];
220
+ /**
221
+ * IDs of groups whose members can send from this address
222
+ * example:
223
+ * [
224
+ * "group-789"
225
+ * ]
226
+ */
99
227
  group_ids?: string[];
228
+ /**
229
+ * ID of the default signature for this address
230
+ * example:
231
+ * sig-abc
232
+ */
100
233
  default_signature_id?: string;
234
+ /**
235
+ * ID of the associated shared inbox
236
+ * example:
237
+ * inbox-xyz
238
+ */
101
239
  shared_inbox_id?: string;
240
+ /**
241
+ * Whether the address is currently active for sending
242
+ * example:
243
+ * true
244
+ */
102
245
  is_active?: boolean;
246
+ /**
247
+ * Whether this is the organization's primary email address
248
+ * example:
249
+ * false
250
+ */
103
251
  is_primary?: boolean;
252
+ /**
253
+ * Whether this is an epilot-managed address (@epilot.cloud)
254
+ * example:
255
+ * false
256
+ */
104
257
  is_epilot_email_address?: boolean;
105
258
  }
106
259
  /**
@@ -111,34 +264,121 @@ declare namespace Components {
111
264
  * Setting that allows to add a custom domain. For e.g; doe.com
112
265
  */
113
266
  export type EmailDomainSetting = "email_domain";
267
+ /**
268
+ * Standard error response format for all API errors.
269
+ */
114
270
  export interface ErrorResponse {
271
+ /**
272
+ * Human-readable error message describing what went wrong
273
+ * example:
274
+ * Resource not found
275
+ */
115
276
  error: string;
277
+ /**
278
+ * HTTP status code of the error
279
+ * example:
280
+ * 404
281
+ */
116
282
  status: number;
117
283
  }
284
+ /**
285
+ * Inbox bucket representing the storage container for a shared inbox.
286
+ */
118
287
  export interface InboxBucketResponse {
288
+ /**
289
+ * Unique identifier of the bucket
290
+ * example:
291
+ * bucket-abc
292
+ */
119
293
  id: string;
294
+ /**
295
+ * ID of the shared inbox associated with this bucket
296
+ * example:
297
+ * inbox-xyz
298
+ */
120
299
  inbox_id: string;
121
300
  }
122
- /**
123
- * Outlook connection config stored in DynamoDB
124
- */
125
- export interface OutlookConnectionConfig {
126
- connected_at?: string; // date-time
301
+ export interface OutlookConnectionError {
302
+ /**
303
+ * Error code or message from the OAuth flow.
304
+ */
305
+ error: string;
306
+ /**
307
+ * Human-readable description of the error.
308
+ */
309
+ error_description?: string;
310
+ /**
311
+ * URL for tenant admin to grant consent, if applicable.
312
+ */
313
+ admin_consent_url?: string; // uri
314
+ }
315
+ export interface OutlookConnectionStatus {
316
+ /**
317
+ * Current connection status:
318
+ * - pending_auth: Admin consent granted, waiting for user OAuth
319
+ * - connected: Fully connected with valid tokens
320
+ * - expired: Tokens expired, need to re-authenticate
321
+ * - not_connected: No connection, initiate OAuth
322
+ *
323
+ */
324
+ status: "connected" | "expired" | "pending_auth" | "not_connected";
325
+ /**
326
+ * Action for UI to take (all call GET /outlook/connect):
327
+ * - connect: No connection, initiate OAuth
328
+ * - authorize: Admin consent done, complete OAuth
329
+ * - reconnect: Re-authenticate expired session
330
+ * - none: Fully connected, no action needed
331
+ *
332
+ */
333
+ action: "connect" | "authorize" | "reconnect" | "none";
334
+ /**
335
+ * Display name of user who connected
336
+ */
337
+ connected_by_display_name?: string;
338
+ /**
339
+ * Email of the user who connected
340
+ */
341
+ connected_by_email?: string; // email
342
+ /**
343
+ * Azure AD Object ID of user who connected
344
+ */
127
345
  connected_by_user_id?: string;
128
- display_name?: string;
129
- email_address?: string; // email
130
- outlook_email?: string; // email
131
- provider?: string;
132
- shared_inbox_id?: string;
133
- tenant_id?: string;
346
+ /**
347
+ * When the connection was established
348
+ */
349
+ connected_at?: string; // date-time
350
+ /**
351
+ * When the connection was last updated
352
+ */
353
+ updated_at?: string; // date-time
354
+ /**
355
+ * Microsoft Azure AD tenant ID
356
+ */
357
+ tenant_id: string;
358
+ /**
359
+ * Granted permission scopes
360
+ */
361
+ scopes?: string[];
362
+ /**
363
+ * When the current access token expires
364
+ */
365
+ expires_at?: string; // date-time
366
+ /**
367
+ * Whether the current token is still valid
368
+ */
369
+ is_token_valid?: boolean;
134
370
  }
371
+ /**
372
+ * Request payload for provisioning an epilot-managed email address.
373
+ */
135
374
  export interface ProvisionEpilotEmailAddressPayload {
375
+ /**
376
+ * The epilot email address to provision (must be on @epilot.cloud domain)
377
+ * example:
378
+ * mycompany@epilot.cloud
379
+ */
136
380
  address: string;
137
381
  }
138
- export interface ResolveOutlookConnectionResponse {
139
- resolved: boolean;
140
- connection?: /* Outlook connection config stored in DynamoDB */ OutlookConnectionConfig;
141
- }
142
382
  /**
143
383
  * - Restrict duplicates within:
144
384
  * * 10s
@@ -153,27 +393,122 @@ declare namespace Components {
153
393
  *
154
394
  */
155
395
  export type RestrictDuplicatesWithinSetting = "restrict_duplicates_within";
396
+ /**
397
+ * Request payload for setting an email address as the organization's primary address.
398
+ */
156
399
  export interface SetEmailAddressPrimaryPayload {
400
+ /**
401
+ * The email address to set as primary
402
+ * example:
403
+ * sales@yourcompany.com
404
+ */
157
405
  address: string;
158
406
  }
407
+ /**
408
+ * Generic setting object used for various email configuration types.
409
+ * The applicable fields depend on the setting type:
410
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
411
+ * - **email_domain**: Uses `value` (domain name)
412
+ * - **whitelist_email_address**: Uses `value` (email address)
413
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
414
+ *
415
+ */
159
416
  export interface Setting {
160
417
  [name: string]: any;
418
+ /**
419
+ * Unique identifier of the setting
420
+ * example:
421
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
422
+ */
161
423
  id?: string;
424
+ /**
425
+ * Display name of the setting (used for signatures)
426
+ * example:
427
+ * Default Signature
428
+ */
162
429
  name?: string;
430
+ /**
431
+ * Organization ID that owns this setting
432
+ * example:
433
+ * org-123
434
+ */
163
435
  org_id?: string;
164
436
  type: SettingType;
437
+ /**
438
+ * The setting value. Interpretation depends on type:
439
+ * - signature: Plain text version of the signature
440
+ * - email_domain: Domain name (e.g., "yourcompany.com")
441
+ * - whitelist_email_address: Email address to whitelist
442
+ * - restrict_duplicates_within: Time duration (e.g., "5m", "1d")
443
+ *
444
+ * example:
445
+ * Best regards, The Team
446
+ */
165
447
  value?: string;
448
+ /**
449
+ * HTML content (only applicable for signature type)
450
+ * example:
451
+ * <p>Best regards,<br/><strong>The Team</strong></p>
452
+ */
166
453
  html?: string;
454
+ /**
455
+ * ISO 8601 timestamp when the setting was created
456
+ * example:
457
+ * 2024-01-15T10:30:00Z
458
+ */
167
459
  created_at?: string;
460
+ /**
461
+ * ISO 8601 timestamp when the setting was last updated
462
+ * example:
463
+ * 2024-01-20T14:45:00Z
464
+ */
168
465
  updated_at?: string;
466
+ /**
467
+ * User ID of the creator
468
+ * example:
469
+ * user-123
470
+ */
169
471
  created_by?: string;
472
+ /**
473
+ * User ID of the last editor
474
+ * example:
475
+ * user-456
476
+ */
170
477
  updated_by?: string;
171
478
  }
479
+ /**
480
+ * Common metadata fields for all settings and resources.
481
+ */
172
482
  export interface SettingMeta {
483
+ /**
484
+ * Unique identifier (UUID) for the resource
485
+ * example:
486
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
487
+ */
173
488
  id: string;
489
+ /**
490
+ * Timestamp when the resource was created
491
+ * example:
492
+ * 2024-01-15T10:30:00Z
493
+ */
174
494
  created_at: string; // date-time
495
+ /**
496
+ * Timestamp when the resource was last updated
497
+ * example:
498
+ * 2024-01-20T14:45:00Z
499
+ */
175
500
  updated_at?: string; // date-time
501
+ /**
502
+ * User ID of the user who created the resource
503
+ * example:
504
+ * user-123
505
+ */
176
506
  created_by?: string;
507
+ /**
508
+ * User ID of the user who last updated the resource
509
+ * example:
510
+ * user-456
511
+ */
177
512
  updated_by?: string;
178
513
  }
179
514
  export type SettingType = /* Setting that allows to add a signature. */ SignatureSetting | /* Setting that allows to add a custom domain. For e.g; doe.com */ EmailDomainSetting | /* Setting that allows to add an email address on the custom domain. For e.g; john@doe.com */ EmailAddressSetting | /**
@@ -195,35 +530,177 @@ declare namespace Components {
195
530
  *
196
531
  */
197
532
  RestrictDuplicatesWithinSetting;
198
- export type SettingsResponse = Setting[] | Setting;
533
+ export type SettingsResponse = /**
534
+ * Generic setting object used for various email configuration types.
535
+ * The applicable fields depend on the setting type:
536
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
537
+ * - **email_domain**: Uses `value` (domain name)
538
+ * - **whitelist_email_address**: Uses `value` (email address)
539
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
540
+ *
541
+ */
542
+ Setting[] | /**
543
+ * Generic setting object used for various email configuration types.
544
+ * The applicable fields depend on the setting type:
545
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
546
+ * - **email_domain**: Uses `value` (domain name)
547
+ * - **whitelist_email_address**: Uses `value` (email address)
548
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
549
+ *
550
+ */
551
+ Setting;
552
+ /**
553
+ * Shared inbox configuration with all associated metadata.
554
+ */
199
555
  export interface SharedInboxResponse {
556
+ /**
557
+ * Unique identifier of the shared inbox
558
+ * example:
559
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
560
+ */
200
561
  id: string;
562
+ /**
563
+ * Timestamp when the resource was created
564
+ * example:
565
+ * 2024-01-15T10:30:00Z
566
+ */
201
567
  created_at: string; // date-time
568
+ /**
569
+ * Timestamp when the resource was last updated
570
+ * example:
571
+ * 2024-01-20T14:45:00Z
572
+ */
202
573
  updated_at?: string; // date-time
574
+ /**
575
+ * User ID of the user who created the resource
576
+ * example:
577
+ * user-123
578
+ */
203
579
  created_by?: string;
580
+ /**
581
+ * User ID of the user who last updated the resource
582
+ * example:
583
+ * user-456
584
+ */
204
585
  updated_by?: string;
586
+ /**
587
+ * Display name of the shared inbox
588
+ * example:
589
+ * Customer Support
590
+ */
205
591
  name: string;
592
+ /**
593
+ * Hex color code for visual identification
594
+ * example:
595
+ * #4CAF50
596
+ */
206
597
  color: string;
598
+ /**
599
+ * List of user IDs assigned to this inbox
600
+ * example:
601
+ * [
602
+ * "user-123",
603
+ * "user-456"
604
+ * ]
605
+ */
207
606
  assignees: string[];
607
+ /**
608
+ * Description of the inbox purpose
609
+ * example:
610
+ * Incoming customer support requests
611
+ */
208
612
  description?: string;
613
+ /**
614
+ * ID of the associated storage bucket for messages
615
+ * example:
616
+ * bucket-xyz
617
+ */
209
618
  bucket_id: string;
210
619
  }
211
620
  /**
212
621
  * Setting that allows to add a signature.
213
622
  */
214
623
  export type SignatureSetting = "signature";
624
+ /**
625
+ * Request payload for updating an email address configuration.
626
+ * All fields are optional; only provided fields will be updated.
627
+ *
628
+ */
215
629
  export interface UpdateEmailAddressPayload {
630
+ /**
631
+ * Display name shown as the sender name in emails
632
+ * example:
633
+ * Sales Team
634
+ */
216
635
  name?: string;
636
+ /**
637
+ * List of user IDs who can send from this address
638
+ * example:
639
+ * [
640
+ * "user-123",
641
+ * "user-456"
642
+ * ]
643
+ */
217
644
  user_ids?: string[];
645
+ /**
646
+ * List of group IDs whose members can send from this address
647
+ * example:
648
+ * [
649
+ * "group-789"
650
+ * ]
651
+ */
218
652
  group_ids?: string[];
653
+ /**
654
+ * ID of the signature to use by default when sending from this address
655
+ * example:
656
+ * sig-abc
657
+ */
219
658
  default_signature_id?: string;
659
+ /**
660
+ * ID of the shared inbox to associate with this address
661
+ * example:
662
+ * inbox-xyz
663
+ */
220
664
  shared_inbox_id?: string;
665
+ /**
666
+ * Whether the email address is active and can be used for sending
667
+ * example:
668
+ * true
669
+ */
221
670
  is_active?: boolean;
222
671
  }
672
+ /**
673
+ * Request payload for updating a shared inbox configuration.
674
+ * All fields are optional; only provided fields will be updated.
675
+ *
676
+ */
223
677
  export interface UpdateSharedInboxPayload {
678
+ /**
679
+ * Hex color code for visual identification in the UI
680
+ * example:
681
+ * #4CAF50
682
+ */
224
683
  color?: string;
684
+ /**
685
+ * Display name of the shared inbox
686
+ * example:
687
+ * Customer Support
688
+ */
225
689
  name?: string;
690
+ /**
691
+ * List of user IDs assigned to this inbox
692
+ * example:
693
+ * [
694
+ * "user-123",
695
+ * "user-456"
696
+ * ]
697
+ */
226
698
  assignees?: string[];
699
+ /**
700
+ * Optional description of the inbox purpose
701
+ * example:
702
+ * Incoming customer support requests
703
+ */
227
704
  description?: string;
228
705
  }
229
706
  /**
@@ -236,17 +713,15 @@ declare namespace Components {
236
713
  }
237
714
  declare namespace Paths {
238
715
  namespace AddDomain {
239
- export type RequestBody = Components.Schemas.Domain;
716
+ export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
240
717
  namespace Responses {
241
718
  export type $200 = Components.Schemas.SettingsResponse;
242
- export interface $403 {
243
- }
244
- export interface $404 {
245
- }
719
+ export type $403 = Components.Responses.Forbidden;
720
+ export type $404 = Components.Responses.NotFound;
246
721
  }
247
722
  }
248
723
  namespace AddEmailAddress {
249
- export type RequestBody = Components.Schemas.CreateEmailAddressPayload;
724
+ export type RequestBody = /* Request payload for creating a new email address. */ Components.Schemas.CreateEmailAddressPayload;
250
725
  namespace Responses {
251
726
  export type $201 = Components.Responses.CreateEmailAddressSuccessResponse;
252
727
  export type $400 = Components.Responses.BadRequest;
@@ -256,17 +731,24 @@ declare namespace Paths {
256
731
  }
257
732
  }
258
733
  namespace AddSetting {
259
- export type RequestBody = Components.Schemas.Setting;
734
+ export type RequestBody = /**
735
+ * Generic setting object used for various email configuration types.
736
+ * The applicable fields depend on the setting type:
737
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
738
+ * - **email_domain**: Uses `value` (domain name)
739
+ * - **whitelist_email_address**: Uses `value` (email address)
740
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
741
+ *
742
+ */
743
+ Components.Schemas.Setting;
260
744
  namespace Responses {
261
745
  export type $200 = Components.Schemas.SettingsResponse;
262
- export interface $403 {
263
- }
264
- export interface $404 {
265
- }
746
+ export type $403 = Components.Responses.Forbidden;
747
+ export type $404 = Components.Responses.NotFound;
266
748
  }
267
749
  }
268
750
  namespace AddSharedInbox {
269
- export type RequestBody = Components.Schemas.CreateSharedInboxPayload;
751
+ export type RequestBody = /* Request payload for creating a new shared inbox. */ Components.Schemas.CreateSharedInboxPayload;
270
752
  namespace Responses {
271
753
  export type $201 = Components.Responses.CreateSharedInboxSuccessResponse;
272
754
  export type $400 = Components.Responses.BadRequest;
@@ -280,6 +762,7 @@ declare namespace Paths {
280
762
  export interface $200 {
281
763
  authorization_url?: string;
282
764
  }
765
+ export type $403 = Components.Responses.OutlookErrorResponse;
283
766
  }
284
767
  }
285
768
  namespace ConnectOutlookMailbox {
@@ -295,7 +778,7 @@ declare namespace Paths {
295
778
  }
296
779
  namespace Responses {
297
780
  export interface $201 {
298
- email_address: Components.Schemas.EmailAddressResponse;
781
+ email_address: /* Email address configuration with all associated metadata. */ Components.Schemas.EmailAddressResponse;
299
782
  /**
300
783
  * The email of the connected mailbox
301
784
  */
@@ -322,14 +805,12 @@ declare namespace Paths {
322
805
  }
323
806
  }
324
807
  namespace DeleteDomain {
325
- export type RequestBody = Components.Schemas.Domain;
808
+ export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
326
809
  namespace Responses {
327
810
  export interface $204 {
328
811
  }
329
- export interface $403 {
330
- }
331
- export interface $404 {
332
- }
812
+ export type $403 = Components.Responses.Forbidden;
813
+ export type $404 = Components.Responses.NotFound;
333
814
  }
334
815
  }
335
816
  namespace DeleteEmailAddress {
@@ -350,18 +831,25 @@ declare namespace Paths {
350
831
  export interface RequestBody {
351
832
  type: Components.Schemas.SettingType;
352
833
  /**
353
- * ID of setting
834
+ * The unique identifier of the setting to delete
354
835
  * example:
355
836
  * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
356
837
  */
357
838
  id: string;
358
839
  }
359
840
  namespace Responses {
360
- export type $200 = Components.Schemas.Setting;
361
- export interface $403 {
362
- }
363
- export interface $404 {
364
- }
841
+ export type $200 = /**
842
+ * Generic setting object used for various email configuration types.
843
+ * The applicable fields depend on the setting type:
844
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
845
+ * - **email_domain**: Uses `value` (domain name)
846
+ * - **whitelist_email_address**: Uses `value` (email address)
847
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
848
+ *
849
+ */
850
+ Components.Schemas.Setting;
851
+ export type $403 = Components.Responses.Forbidden;
852
+ export type $404 = Components.Responses.NotFound;
365
853
  }
366
854
  }
367
855
  namespace DeleteSharedInbox {
@@ -410,6 +898,27 @@ declare namespace Paths {
410
898
  }
411
899
  }
412
900
  }
901
+ namespace DisconnectOutlookMailbox {
902
+ namespace Parameters {
903
+ export type Email = string; // email
904
+ }
905
+ export interface PathParameters {
906
+ email: Parameters.Email /* email */;
907
+ }
908
+ namespace Responses {
909
+ export interface $200 {
910
+ success: boolean;
911
+ /**
912
+ * The email address that was disconnected
913
+ */
914
+ email: string; // email
915
+ }
916
+ export interface $404 {
917
+ }
918
+ export interface $500 {
919
+ }
920
+ }
921
+ }
413
922
  namespace GetConnectedOutlookEmails {
414
923
  namespace Responses {
415
924
  export interface $200 {
@@ -450,61 +959,7 @@ declare namespace Paths {
450
959
  /**
451
960
  * List of Outlook connections (one per tenant)
452
961
  */
453
- connections: {
454
- /**
455
- * Current connection status:
456
- * - pending_auth: Admin consent granted, waiting for user OAuth
457
- * - connected: Fully connected with valid tokens
458
- * - expired: Tokens expired, need to re-authenticate
459
- *
460
- */
461
- status: "connected" | "expired" | "pending_auth";
462
- /**
463
- * Action for UI to take (all call GET /outlook/connect):
464
- * - connect: No connection, initiate OAuth
465
- * - authorize: Admin consent done, complete OAuth
466
- * - reconnect: Re-authenticate expired session
467
- * - none: Fully connected, no action needed
468
- *
469
- */
470
- action: "connect" | "authorize" | "reconnect" | "none";
471
- /**
472
- * Display name of user who connected
473
- */
474
- connected_by_display_name?: string;
475
- /**
476
- * Email of the user who connected
477
- */
478
- connected_by_email?: string; // email
479
- /**
480
- * Azure AD Object ID of user who connected
481
- */
482
- connected_by_user_id?: string;
483
- /**
484
- * When the connection was established
485
- */
486
- connected_at?: string; // date-time
487
- /**
488
- * When the connection was last updated
489
- */
490
- updated_at?: string; // date-time
491
- /**
492
- * Microsoft Azure AD tenant ID
493
- */
494
- tenant_id: string;
495
- /**
496
- * Granted permission scopes
497
- */
498
- scopes?: string[];
499
- /**
500
- * When the current access token expires
501
- */
502
- expires_at?: string; // date-time
503
- /**
504
- * Whether the current token is still valid
505
- */
506
- is_token_valid?: boolean;
507
- }[];
962
+ connections: Components.Schemas.OutlookConnectionStatus[];
508
963
  /**
509
964
  * Whether any connections exist
510
965
  */
@@ -527,10 +982,8 @@ declare namespace Paths {
527
982
  }
528
983
  namespace Responses {
529
984
  export type $200 = Components.Schemas.SettingsResponse;
530
- export interface $403 {
531
- }
532
- export interface $404 {
533
- }
985
+ export type $403 = Components.Responses.Forbidden;
986
+ export type $404 = Components.Responses.NotFound;
534
987
  }
535
988
  }
536
989
  namespace GetSharedInbox {
@@ -602,7 +1055,7 @@ declare namespace Paths {
602
1055
  }
603
1056
  }
604
1057
  namespace ProvisionEpilotEmailAddress {
605
- export type RequestBody = Components.Schemas.ProvisionEpilotEmailAddressPayload;
1058
+ export type RequestBody = /* Request payload for provisioning an epilot-managed email address. */ Components.Schemas.ProvisionEpilotEmailAddressPayload;
606
1059
  namespace Responses {
607
1060
  export type $200 = Components.Responses.ProvisionEpilotEmailAddressSuccessResponse;
608
1061
  export type $400 = Components.Responses.BadRequest;
@@ -610,21 +1063,8 @@ declare namespace Paths {
610
1063
  export type $500 = Components.Responses.InternalServerError;
611
1064
  }
612
1065
  }
613
- namespace ResolveOutlookConnection {
614
- namespace Parameters {
615
- export type Email = string; // email
616
- }
617
- export interface QueryParameters {
618
- email: Parameters.Email /* email */;
619
- }
620
- namespace Responses {
621
- export type $200 = Components.Schemas.ResolveOutlookConnectionResponse;
622
- export type $400 = Components.Responses.BadRequest;
623
- export type $500 = Components.Responses.InternalServerError;
624
- }
625
- }
626
1066
  namespace SetEmailAddressPrimary {
627
- export type RequestBody = Components.Schemas.SetEmailAddressPrimaryPayload;
1067
+ export type RequestBody = /* Request payload for setting an email address as the organization's primary address. */ Components.Schemas.SetEmailAddressPrimaryPayload;
628
1068
  namespace Responses {
629
1069
  export type $200 = Components.Responses.SetEmailAddressPrimarySuccessResponse;
630
1070
  export type $400 = Components.Responses.BadRequest;
@@ -683,7 +1123,12 @@ declare namespace Paths {
683
1123
  export interface PathParameters {
684
1124
  id: Parameters.Id;
685
1125
  }
686
- export type RequestBody = Components.Schemas.UpdateEmailAddressPayload;
1126
+ export type RequestBody = /**
1127
+ * Request payload for updating an email address configuration.
1128
+ * All fields are optional; only provided fields will be updated.
1129
+ *
1130
+ */
1131
+ Components.Schemas.UpdateEmailAddressPayload;
687
1132
  namespace Responses {
688
1133
  export type $200 = Components.Responses.UpdateEmailAddressSuccessResponse;
689
1134
  export type $400 = Components.Responses.BadRequest;
@@ -700,13 +1145,29 @@ declare namespace Paths {
700
1145
  export interface PathParameters {
701
1146
  id: Parameters.Id;
702
1147
  }
703
- export type RequestBody = Components.Schemas.Setting;
1148
+ export type RequestBody = /**
1149
+ * Generic setting object used for various email configuration types.
1150
+ * The applicable fields depend on the setting type:
1151
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
1152
+ * - **email_domain**: Uses `value` (domain name)
1153
+ * - **whitelist_email_address**: Uses `value` (email address)
1154
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
1155
+ *
1156
+ */
1157
+ Components.Schemas.Setting;
704
1158
  namespace Responses {
705
- export type $200 = Components.Schemas.Setting;
706
- export interface $403 {
707
- }
708
- export interface $404 {
709
- }
1159
+ export type $200 = /**
1160
+ * Generic setting object used for various email configuration types.
1161
+ * The applicable fields depend on the setting type:
1162
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
1163
+ * - **email_domain**: Uses `value` (domain name)
1164
+ * - **whitelist_email_address**: Uses `value` (email address)
1165
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
1166
+ *
1167
+ */
1168
+ Components.Schemas.Setting;
1169
+ export type $403 = Components.Responses.Forbidden;
1170
+ export type $404 = Components.Responses.NotFound;
710
1171
  }
711
1172
  }
712
1173
  namespace UpdateSharedInbox {
@@ -716,7 +1177,12 @@ declare namespace Paths {
716
1177
  export interface PathParameters {
717
1178
  id: Parameters.Id;
718
1179
  }
719
- export type RequestBody = Components.Schemas.UpdateSharedInboxPayload;
1180
+ export type RequestBody = /**
1181
+ * Request payload for updating a shared inbox configuration.
1182
+ * All fields are optional; only provided fields will be updated.
1183
+ *
1184
+ */
1185
+ Components.Schemas.UpdateSharedInboxPayload;
720
1186
  namespace Responses {
721
1187
  export type $200 = Components.Responses.UpdateSharedInboxSuccessResponse;
722
1188
  export type $400 = Components.Responses.BadRequest;
@@ -727,23 +1193,19 @@ declare namespace Paths {
727
1193
  }
728
1194
  }
729
1195
  namespace VerifyDomain {
730
- export type RequestBody = Components.Schemas.Domain;
1196
+ export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
731
1197
  namespace Responses {
732
1198
  export type $200 = Components.Schemas.SettingsResponse;
733
- export interface $403 {
734
- }
735
- export interface $404 {
736
- }
1199
+ export type $403 = Components.Responses.Forbidden;
1200
+ export type $404 = Components.Responses.NotFound;
737
1201
  }
738
1202
  }
739
1203
  namespace VerifyNameServers {
740
- export type RequestBody = Components.Schemas.Domain;
1204
+ export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
741
1205
  namespace Responses {
742
1206
  export type $200 = Components.Schemas.SettingsResponse;
743
- export interface $403 {
744
- }
745
- export interface $404 {
746
- }
1207
+ export type $403 = Components.Responses.Forbidden;
1208
+ export type $404 = Components.Responses.NotFound;
747
1209
  }
748
1210
  }
749
1211
  }
@@ -753,7 +1215,13 @@ export interface OperationMethods {
753
1215
  /**
754
1216
  * provisionEpilotEmailAddress - provisionEpilotEmailAddress
755
1217
  *
756
- * Provision or reactivate epilot email address, deactivating other active epilot email addresses.
1218
+ * Provisions or reactivates an epilot-managed email address for the organization.
1219
+ *
1220
+ * When provisioning a new epilot email address, any previously active epilot email addresses
1221
+ * will be automatically deactivated. Only one epilot email address can be active at a time.
1222
+ *
1223
+ * Epilot email addresses use the `@epilot.cloud` domain and are fully managed by the platform.
1224
+ *
757
1225
  */
758
1226
  'provisionEpilotEmailAddress'(
759
1227
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -763,7 +1231,11 @@ export interface OperationMethods {
763
1231
  /**
764
1232
  * setEmailAddressPrimary - setEmailAddressPrimary
765
1233
  *
766
- * Set email address as primary
1234
+ * Sets the specified email address as the primary address for the organization.
1235
+ *
1236
+ * The primary email address is used as the default sender address when composing new emails.
1237
+ * Only one email address can be primary at a time; setting a new primary will unset the previous one.
1238
+ *
767
1239
  */
768
1240
  'setEmailAddressPrimary'(
769
1241
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -773,7 +1245,11 @@ export interface OperationMethods {
773
1245
  /**
774
1246
  * getEmailAddress - getEmailAddress
775
1247
  *
776
- * Get email address
1248
+ * Retrieves the details of a specific email address by its ID.
1249
+ *
1250
+ * Returns the full configuration including display name, assigned users/groups,
1251
+ * default signature, and shared inbox association.
1252
+ *
777
1253
  */
778
1254
  'getEmailAddress'(
779
1255
  parameters?: Parameters<Paths.GetEmailAddress.PathParameters> | null,
@@ -783,7 +1259,15 @@ export interface OperationMethods {
783
1259
  /**
784
1260
  * updateEmailAddress - updateEmailAddress
785
1261
  *
786
- * Update email address
1262
+ * Updates the configuration of an existing email address.
1263
+ *
1264
+ * You can modify:
1265
+ * - Display name
1266
+ * - Assigned users and groups
1267
+ * - Default signature
1268
+ * - Shared inbox association
1269
+ * - Active status
1270
+ *
787
1271
  */
788
1272
  'updateEmailAddress'(
789
1273
  parameters?: Parameters<Paths.UpdateEmailAddress.PathParameters> | null,
@@ -793,7 +1277,11 @@ export interface OperationMethods {
793
1277
  /**
794
1278
  * deleteEmailAddress - deleteEmailAddress
795
1279
  *
796
- * Delete email address
1280
+ * Permanently deletes an email address from the organization.
1281
+ *
1282
+ * **Warning**: This action cannot be undone. Users will no longer be able to send
1283
+ * emails from this address after deletion.
1284
+ *
797
1285
  */
798
1286
  'deleteEmailAddress'(
799
1287
  parameters?: Parameters<Paths.DeleteEmailAddress.PathParameters> | null,
@@ -803,7 +1291,11 @@ export interface OperationMethods {
803
1291
  /**
804
1292
  * listEmailAddresses - listEmailAddresses
805
1293
  *
806
- * List email addresses
1294
+ * Retrieves all email addresses configured for the organization.
1295
+ *
1296
+ * Returns an array of email address configurations including their IDs, display names,
1297
+ * assigned users/groups, signatures, and status flags.
1298
+ *
807
1299
  */
808
1300
  'listEmailAddresses'(
809
1301
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -813,7 +1305,11 @@ export interface OperationMethods {
813
1305
  /**
814
1306
  * addEmailAddress - addEmailAddress
815
1307
  *
816
- * Add email address
1308
+ * Adds a new email address to the organization.
1309
+ *
1310
+ * The email address can be from a custom domain (if configured) or any external
1311
+ * email provider. Optionally assign users, groups, and a default signature.
1312
+ *
817
1313
  */
818
1314
  'addEmailAddress'(
819
1315
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -823,7 +1319,11 @@ export interface OperationMethods {
823
1319
  /**
824
1320
  * getSharedInbox - getSharedInbox
825
1321
  *
826
- * Get shared inbox
1322
+ * Retrieves the details of a specific shared inbox by its ID.
1323
+ *
1324
+ * Returns the inbox configuration including name, color, description, assigned team members,
1325
+ * and the associated bucket ID.
1326
+ *
827
1327
  */
828
1328
  'getSharedInbox'(
829
1329
  parameters?: Parameters<Paths.GetSharedInbox.PathParameters> | null,
@@ -833,7 +1333,11 @@ export interface OperationMethods {
833
1333
  /**
834
1334
  * updateSharedInbox - updateSharedInbox
835
1335
  *
836
- * Update shared inbox
1336
+ * Updates the configuration of an existing shared inbox.
1337
+ *
1338
+ * You can modify the inbox name, color, description, and team member assignments.
1339
+ * Changes take effect immediately for all associated email addresses.
1340
+ *
837
1341
  */
838
1342
  'updateSharedInbox'(
839
1343
  parameters?: Parameters<Paths.UpdateSharedInbox.PathParameters> | null,
@@ -843,7 +1347,15 @@ export interface OperationMethods {
843
1347
  /**
844
1348
  * deleteSharedInbox - deleteSharedInbox
845
1349
  *
846
- * Delete shared inbox, rerouting emails to a successor inbox (or default inbox if no successor is provided).
1350
+ * Deletes a shared inbox and reroutes all associated emails to a successor inbox.
1351
+ *
1352
+ * When a shared inbox is deleted:
1353
+ * - All email addresses associated with this inbox will be reassigned to the successor
1354
+ * - If no successor is specified, emails are routed to the default inbox
1355
+ * - The inbox's message history is preserved in the successor inbox
1356
+ *
1357
+ * **Note**: The default inbox cannot be deleted.
1358
+ *
847
1359
  */
848
1360
  'deleteSharedInbox'(
849
1361
  parameters?: Parameters<Paths.DeleteSharedInbox.QueryParameters & Paths.DeleteSharedInbox.PathParameters> | null,
@@ -853,7 +1365,11 @@ export interface OperationMethods {
853
1365
  /**
854
1366
  * listSharedInboxes - listSharedInboxes
855
1367
  *
856
- * List shared inboxes. Default inbox (with inbox_id `default`) is not included, but is always available.
1368
+ * Retrieves all shared inboxes configured for the organization.
1369
+ *
1370
+ * **Note**: The default inbox (with ID `default`) is not included in this list but is
1371
+ * always available for all organizations. You do not need to create it explicitly.
1372
+ *
857
1373
  */
858
1374
  'listSharedInboxes'(
859
1375
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -863,7 +1379,11 @@ export interface OperationMethods {
863
1379
  /**
864
1380
  * addSharedInbox - addSharedInbox
865
1381
  *
866
- * Add shared inbox
1382
+ * Creates a new shared inbox for the organization.
1383
+ *
1384
+ * Shared inboxes help teams organize and categorize incoming emails.
1385
+ * Each inbox requires a name and color for visual identification.
1386
+ *
867
1387
  */
868
1388
  'addSharedInbox'(
869
1389
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -873,7 +1393,14 @@ export interface OperationMethods {
873
1393
  /**
874
1394
  * listInboxBuckets - listInboxBuckets
875
1395
  *
876
- * List inbox buckets for an organization. Default bucket (with bucket_id `default`) is not included, but is always available.
1396
+ * Retrieves all inbox buckets for the organization.
1397
+ *
1398
+ * Inbox buckets are internal storage containers that correspond to shared inboxes.
1399
+ * Each shared inbox has an associated bucket for storing messages.
1400
+ *
1401
+ * **Note**: The default bucket (with ID `default`) is not included in this list but
1402
+ * is always available for all organizations.
1403
+ *
877
1404
  */
878
1405
  'listInboxBuckets'(
879
1406
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -881,7 +1408,7 @@ export interface OperationMethods {
881
1408
  config?: AxiosRequestConfig
882
1409
  ): OperationResponse<Paths.ListInboxBuckets.Responses.$200>
883
1410
  /**
884
- * connectOutlook - Connect Outlook
1411
+ * connectOutlook - connectOutlook
885
1412
  *
886
1413
  * Returns Microsoft authorization URL for Outlook OAuth.
887
1414
  */
@@ -891,7 +1418,7 @@ export interface OperationMethods {
891
1418
  config?: AxiosRequestConfig
892
1419
  ): OperationResponse<Paths.ConnectOutlook.Responses.$200>
893
1420
  /**
894
- * getOutlookConnectionStatus - Get Outlook Connection Status
1421
+ * getOutlookConnectionStatus - getOutlookConnectionStatus
895
1422
  *
896
1423
  * Returns all Microsoft 365 / Outlook connections for the organization.
897
1424
  * Supports multiple connections (one per Azure AD tenant).
@@ -906,17 +1433,7 @@ export interface OperationMethods {
906
1433
  config?: AxiosRequestConfig
907
1434
  ): OperationResponse<Paths.GetOutlookConnectionStatus.Responses.$200>
908
1435
  /**
909
- * resolveOutlookConnection - Resolve Outlook Connection
910
- *
911
- * Resolves the Outlook connection for the provided filter parameters.
912
- */
913
- 'resolveOutlookConnection'(
914
- parameters?: Parameters<Paths.ResolveOutlookConnection.QueryParameters> | null,
915
- data?: any,
916
- config?: AxiosRequestConfig
917
- ): OperationResponse<Paths.ResolveOutlookConnection.Responses.$200>
918
- /**
919
- * disconnectOutlook - Disconnect Outlook
1436
+ * disconnectOutlook - disconnectOutlook
920
1437
  *
921
1438
  * Removes the Microsoft 365 / Outlook connection for a specific tenant.
922
1439
  * This deletes the stored tokens and disconnects the integration.
@@ -928,7 +1445,7 @@ export interface OperationMethods {
928
1445
  config?: AxiosRequestConfig
929
1446
  ): OperationResponse<Paths.DisconnectOutlook.Responses.$200>
930
1447
  /**
931
- * connectOutlookMailbox - Connect Outlook Mailbox
1448
+ * connectOutlookMailbox - connectOutlookMailbox
932
1449
  *
933
1450
  * Connects an Outlook mailbox:
934
1451
  * 1. Validates the user has access to the mailbox via Microsoft Graph API
@@ -942,7 +1459,20 @@ export interface OperationMethods {
942
1459
  config?: AxiosRequestConfig
943
1460
  ): OperationResponse<Paths.ConnectOutlookMailbox.Responses.$201>
944
1461
  /**
945
- * getConnectedOutlookEmails - Get Connected Outlook Emails
1462
+ * disconnectOutlookMailbox - Disconnect Outlook Mailbox
1463
+ *
1464
+ * Disconnects a single Outlook mailbox by email address.
1465
+ * Deletes the email address entity, Outlook email mapping, and Graph API subscriptions.
1466
+ * Does not affect the tenant-level Outlook connection.
1467
+ *
1468
+ */
1469
+ 'disconnectOutlookMailbox'(
1470
+ parameters?: Parameters<Paths.DisconnectOutlookMailbox.PathParameters> | null,
1471
+ data?: any,
1472
+ config?: AxiosRequestConfig
1473
+ ): OperationResponse<Paths.DisconnectOutlookMailbox.Responses.$200>
1474
+ /**
1475
+ * getConnectedOutlookEmails - getConnectedOutlookEmails
946
1476
  *
947
1477
  * Returns all Outlook email addresses connected to the organization.
948
1478
  *
@@ -953,7 +1483,7 @@ export interface OperationMethods {
953
1483
  config?: AxiosRequestConfig
954
1484
  ): OperationResponse<Paths.GetConnectedOutlookEmails.Responses.$200>
955
1485
  /**
956
- * testWebhookGet - Test Webhook (GET)
1486
+ * testWebhookGet - testWebhookGet
957
1487
  *
958
1488
  * Test endpoint for debugging Graph API webhook notifications via ngrok.
959
1489
  * Handles Microsoft Graph subscription validation requests by returning the validationToken.
@@ -966,7 +1496,7 @@ export interface OperationMethods {
966
1496
  config?: AxiosRequestConfig
967
1497
  ): OperationResponse<Paths.TestWebhookGet.Responses.$200 | Paths.TestWebhookGet.Responses.$202>
968
1498
  /**
969
- * testWebhookPost - Test Webhook (POST)
1499
+ * testWebhookPost - testWebhookPost
970
1500
  *
971
1501
  * Test endpoint for debugging Graph API webhook notifications via ngrok.
972
1502
  * Logs all incoming webhook payloads for debugging purposes.
@@ -979,7 +1509,7 @@ export interface OperationMethods {
979
1509
  config?: AxiosRequestConfig
980
1510
  ): OperationResponse<Paths.TestWebhookPost.Responses.$200 | Paths.TestWebhookPost.Responses.$202>
981
1511
  /**
982
- * outlookOAuthCallback - Outlook OAuth callback
1512
+ * outlookOAuthCallback - outlookOAuthCallback
983
1513
  *
984
1514
  * Exchanges authorization code for tokens and stores them.
985
1515
  */
@@ -991,7 +1521,21 @@ export interface OperationMethods {
991
1521
  /**
992
1522
  * getSettings - getSettings
993
1523
  *
994
- * Get all settings by type
1524
+ * Retrieves settings of a specific type for the organization.
1525
+ *
1526
+ * If an `id` is provided, returns only that specific setting.
1527
+ * Otherwise, returns all settings of the specified type.
1528
+ *
1529
+ * ## Setting Types
1530
+ *
1531
+ * | Type | Description |
1532
+ * |------|-------------|
1533
+ * | `signature` | HTML email signatures |
1534
+ * | `email_domain` | Custom email domains |
1535
+ * | `email_address` | Sender email addresses |
1536
+ * | `whitelist_email_address` | Addresses exempt from duplicate detection |
1537
+ * | `restrict_duplicates_within` | Time window for duplicate email detection |
1538
+ *
995
1539
  */
996
1540
  'getSettings'(
997
1541
  parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
@@ -1001,7 +1545,14 @@ export interface OperationMethods {
1001
1545
  /**
1002
1546
  * addSetting - addSetting
1003
1547
  *
1004
- * Add setting
1548
+ * Creates a new setting of the specified type.
1549
+ *
1550
+ * The setting type determines which fields are applicable:
1551
+ * - **signature**: Requires `name`, `value` (plain text), and `html` (HTML content)
1552
+ * - **email_domain**: Requires `value` (domain name)
1553
+ * - **whitelist_email_address**: Requires `value` (email address)
1554
+ * - **restrict_duplicates_within**: Requires `value` (time duration like "5m", "1d")
1555
+ *
1005
1556
  */
1006
1557
  'addSetting'(
1007
1558
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1011,7 +1562,12 @@ export interface OperationMethods {
1011
1562
  /**
1012
1563
  * deleteSetting - deleteSetting
1013
1564
  *
1014
- * delete setting by ID and type
1565
+ * Deletes a setting by its ID and type.
1566
+ *
1567
+ * Both the `id` and `type` are required to uniquely identify the setting to delete.
1568
+ *
1569
+ * **Warning**: This action cannot be undone.
1570
+ *
1015
1571
  */
1016
1572
  'deleteSetting'(
1017
1573
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1021,7 +1577,11 @@ export interface OperationMethods {
1021
1577
  /**
1022
1578
  * updateSetting - updateSetting
1023
1579
  *
1024
- * Update setting by ID
1580
+ * Updates an existing setting identified by its ID.
1581
+ *
1582
+ * Include the `type` field in the request body to specify which setting type
1583
+ * is being updated. Only the fields provided will be updated.
1584
+ *
1025
1585
  */
1026
1586
  'updateSetting'(
1027
1587
  parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
@@ -1031,7 +1591,14 @@ export interface OperationMethods {
1031
1591
  /**
1032
1592
  * addDomain - addDomain
1033
1593
  *
1034
- * Add domain
1594
+ * Adds a custom email domain to the organization.
1595
+ *
1596
+ * After adding the domain, you must:
1597
+ * 1. Configure the required DNS records (provided in the response)
1598
+ * 2. Verify the domain using the verification endpoint
1599
+ *
1600
+ * Until verification is complete, the domain cannot be used for sending emails.
1601
+ *
1035
1602
  */
1036
1603
  'addDomain'(
1037
1604
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1041,7 +1608,12 @@ export interface OperationMethods {
1041
1608
  /**
1042
1609
  * deleteDomain - deleteDomain
1043
1610
  *
1044
- * Delete domain
1611
+ * Removes a custom email domain from the organization.
1612
+ *
1613
+ * **Warning**: Deleting a domain will prevent sending emails from any addresses
1614
+ * using this domain. Existing email addresses on this domain should be removed
1615
+ * or reassigned before deleting the domain.
1616
+ *
1045
1617
  */
1046
1618
  'deleteDomain'(
1047
1619
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1051,7 +1623,13 @@ export interface OperationMethods {
1051
1623
  /**
1052
1624
  * verifyNameServers - verifyNameServers
1053
1625
  *
1054
- * Verify name servers
1626
+ * Verifies that the domain's name server (NS) records are correctly configured.
1627
+ *
1628
+ * This check ensures that DNS resolution is properly set up for the domain
1629
+ * before proceeding with full domain verification.
1630
+ *
1631
+ * Run this verification after configuring NS records in your DNS provider.
1632
+ *
1055
1633
  */
1056
1634
  'verifyNameServers'(
1057
1635
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1061,7 +1639,16 @@ export interface OperationMethods {
1061
1639
  /**
1062
1640
  * verifyDomain - verifyDomain
1063
1641
  *
1064
- * Verify domain
1642
+ * Verifies ownership and configuration of a custom email domain.
1643
+ *
1644
+ * Domain verification checks:
1645
+ * - DNS TXT records for domain ownership
1646
+ * - MX records for email routing
1647
+ * - SPF records for sender authentication
1648
+ * - DKIM records for email signing
1649
+ *
1650
+ * Once verified, the domain can be used to create email addresses and send emails.
1651
+ *
1065
1652
  */
1066
1653
  'verifyDomain'(
1067
1654
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1075,7 +1662,13 @@ export interface PathsDictionary {
1075
1662
  /**
1076
1663
  * provisionEpilotEmailAddress - provisionEpilotEmailAddress
1077
1664
  *
1078
- * Provision or reactivate epilot email address, deactivating other active epilot email addresses.
1665
+ * Provisions or reactivates an epilot-managed email address for the organization.
1666
+ *
1667
+ * When provisioning a new epilot email address, any previously active epilot email addresses
1668
+ * will be automatically deactivated. Only one epilot email address can be active at a time.
1669
+ *
1670
+ * Epilot email addresses use the `@epilot.cloud` domain and are fully managed by the platform.
1671
+ *
1079
1672
  */
1080
1673
  'put'(
1081
1674
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1087,7 +1680,11 @@ export interface PathsDictionary {
1087
1680
  /**
1088
1681
  * setEmailAddressPrimary - setEmailAddressPrimary
1089
1682
  *
1090
- * Set email address as primary
1683
+ * Sets the specified email address as the primary address for the organization.
1684
+ *
1685
+ * The primary email address is used as the default sender address when composing new emails.
1686
+ * Only one email address can be primary at a time; setting a new primary will unset the previous one.
1687
+ *
1091
1688
  */
1092
1689
  'post'(
1093
1690
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1099,7 +1696,11 @@ export interface PathsDictionary {
1099
1696
  /**
1100
1697
  * getEmailAddress - getEmailAddress
1101
1698
  *
1102
- * Get email address
1699
+ * Retrieves the details of a specific email address by its ID.
1700
+ *
1701
+ * Returns the full configuration including display name, assigned users/groups,
1702
+ * default signature, and shared inbox association.
1703
+ *
1103
1704
  */
1104
1705
  'get'(
1105
1706
  parameters?: Parameters<Paths.GetEmailAddress.PathParameters> | null,
@@ -1109,7 +1710,11 @@ export interface PathsDictionary {
1109
1710
  /**
1110
1711
  * deleteEmailAddress - deleteEmailAddress
1111
1712
  *
1112
- * Delete email address
1713
+ * Permanently deletes an email address from the organization.
1714
+ *
1715
+ * **Warning**: This action cannot be undone. Users will no longer be able to send
1716
+ * emails from this address after deletion.
1717
+ *
1113
1718
  */
1114
1719
  'delete'(
1115
1720
  parameters?: Parameters<Paths.DeleteEmailAddress.PathParameters> | null,
@@ -1119,7 +1724,15 @@ export interface PathsDictionary {
1119
1724
  /**
1120
1725
  * updateEmailAddress - updateEmailAddress
1121
1726
  *
1122
- * Update email address
1727
+ * Updates the configuration of an existing email address.
1728
+ *
1729
+ * You can modify:
1730
+ * - Display name
1731
+ * - Assigned users and groups
1732
+ * - Default signature
1733
+ * - Shared inbox association
1734
+ * - Active status
1735
+ *
1123
1736
  */
1124
1737
  'put'(
1125
1738
  parameters?: Parameters<Paths.UpdateEmailAddress.PathParameters> | null,
@@ -1131,7 +1744,11 @@ export interface PathsDictionary {
1131
1744
  /**
1132
1745
  * listEmailAddresses - listEmailAddresses
1133
1746
  *
1134
- * List email addresses
1747
+ * Retrieves all email addresses configured for the organization.
1748
+ *
1749
+ * Returns an array of email address configurations including their IDs, display names,
1750
+ * assigned users/groups, signatures, and status flags.
1751
+ *
1135
1752
  */
1136
1753
  'get'(
1137
1754
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1141,7 +1758,11 @@ export interface PathsDictionary {
1141
1758
  /**
1142
1759
  * addEmailAddress - addEmailAddress
1143
1760
  *
1144
- * Add email address
1761
+ * Adds a new email address to the organization.
1762
+ *
1763
+ * The email address can be from a custom domain (if configured) or any external
1764
+ * email provider. Optionally assign users, groups, and a default signature.
1765
+ *
1145
1766
  */
1146
1767
  'post'(
1147
1768
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1153,7 +1774,11 @@ export interface PathsDictionary {
1153
1774
  /**
1154
1775
  * getSharedInbox - getSharedInbox
1155
1776
  *
1156
- * Get shared inbox
1777
+ * Retrieves the details of a specific shared inbox by its ID.
1778
+ *
1779
+ * Returns the inbox configuration including name, color, description, assigned team members,
1780
+ * and the associated bucket ID.
1781
+ *
1157
1782
  */
1158
1783
  'get'(
1159
1784
  parameters?: Parameters<Paths.GetSharedInbox.PathParameters> | null,
@@ -1163,7 +1788,15 @@ export interface PathsDictionary {
1163
1788
  /**
1164
1789
  * deleteSharedInbox - deleteSharedInbox
1165
1790
  *
1166
- * Delete shared inbox, rerouting emails to a successor inbox (or default inbox if no successor is provided).
1791
+ * Deletes a shared inbox and reroutes all associated emails to a successor inbox.
1792
+ *
1793
+ * When a shared inbox is deleted:
1794
+ * - All email addresses associated with this inbox will be reassigned to the successor
1795
+ * - If no successor is specified, emails are routed to the default inbox
1796
+ * - The inbox's message history is preserved in the successor inbox
1797
+ *
1798
+ * **Note**: The default inbox cannot be deleted.
1799
+ *
1167
1800
  */
1168
1801
  'delete'(
1169
1802
  parameters?: Parameters<Paths.DeleteSharedInbox.QueryParameters & Paths.DeleteSharedInbox.PathParameters> | null,
@@ -1173,7 +1806,11 @@ export interface PathsDictionary {
1173
1806
  /**
1174
1807
  * updateSharedInbox - updateSharedInbox
1175
1808
  *
1176
- * Update shared inbox
1809
+ * Updates the configuration of an existing shared inbox.
1810
+ *
1811
+ * You can modify the inbox name, color, description, and team member assignments.
1812
+ * Changes take effect immediately for all associated email addresses.
1813
+ *
1177
1814
  */
1178
1815
  'put'(
1179
1816
  parameters?: Parameters<Paths.UpdateSharedInbox.PathParameters> | null,
@@ -1185,7 +1822,11 @@ export interface PathsDictionary {
1185
1822
  /**
1186
1823
  * listSharedInboxes - listSharedInboxes
1187
1824
  *
1188
- * List shared inboxes. Default inbox (with inbox_id `default`) is not included, but is always available.
1825
+ * Retrieves all shared inboxes configured for the organization.
1826
+ *
1827
+ * **Note**: The default inbox (with ID `default`) is not included in this list but is
1828
+ * always available for all organizations. You do not need to create it explicitly.
1829
+ *
1189
1830
  */
1190
1831
  'get'(
1191
1832
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1195,7 +1836,11 @@ export interface PathsDictionary {
1195
1836
  /**
1196
1837
  * addSharedInbox - addSharedInbox
1197
1838
  *
1198
- * Add shared inbox
1839
+ * Creates a new shared inbox for the organization.
1840
+ *
1841
+ * Shared inboxes help teams organize and categorize incoming emails.
1842
+ * Each inbox requires a name and color for visual identification.
1843
+ *
1199
1844
  */
1200
1845
  'post'(
1201
1846
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1207,7 +1852,14 @@ export interface PathsDictionary {
1207
1852
  /**
1208
1853
  * listInboxBuckets - listInboxBuckets
1209
1854
  *
1210
- * List inbox buckets for an organization. Default bucket (with bucket_id `default`) is not included, but is always available.
1855
+ * Retrieves all inbox buckets for the organization.
1856
+ *
1857
+ * Inbox buckets are internal storage containers that correspond to shared inboxes.
1858
+ * Each shared inbox has an associated bucket for storing messages.
1859
+ *
1860
+ * **Note**: The default bucket (with ID `default`) is not included in this list but
1861
+ * is always available for all organizations.
1862
+ *
1211
1863
  */
1212
1864
  'get'(
1213
1865
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1217,7 +1869,7 @@ export interface PathsDictionary {
1217
1869
  }
1218
1870
  ['/v2/outlook/connect']: {
1219
1871
  /**
1220
- * connectOutlook - Connect Outlook
1872
+ * connectOutlook - connectOutlook
1221
1873
  *
1222
1874
  * Returns Microsoft authorization URL for Outlook OAuth.
1223
1875
  */
@@ -1229,7 +1881,7 @@ export interface PathsDictionary {
1229
1881
  }
1230
1882
  ['/v2/outlook/connection/status']: {
1231
1883
  /**
1232
- * getOutlookConnectionStatus - Get Outlook Connection Status
1884
+ * getOutlookConnectionStatus - getOutlookConnectionStatus
1233
1885
  *
1234
1886
  * Returns all Microsoft 365 / Outlook connections for the organization.
1235
1887
  * Supports multiple connections (one per Azure AD tenant).
@@ -1244,21 +1896,9 @@ export interface PathsDictionary {
1244
1896
  config?: AxiosRequestConfig
1245
1897
  ): OperationResponse<Paths.GetOutlookConnectionStatus.Responses.$200>
1246
1898
  }
1247
- ['/v2/outlook/connection:resolve']: {
1248
- /**
1249
- * resolveOutlookConnection - Resolve Outlook Connection
1250
- *
1251
- * Resolves the Outlook connection for the provided filter parameters.
1252
- */
1253
- 'get'(
1254
- parameters?: Parameters<Paths.ResolveOutlookConnection.QueryParameters> | null,
1255
- data?: any,
1256
- config?: AxiosRequestConfig
1257
- ): OperationResponse<Paths.ResolveOutlookConnection.Responses.$200>
1258
- }
1259
1899
  ['/v2/outlook/connection/disconnect']: {
1260
1900
  /**
1261
- * disconnectOutlook - Disconnect Outlook
1901
+ * disconnectOutlook - disconnectOutlook
1262
1902
  *
1263
1903
  * Removes the Microsoft 365 / Outlook connection for a specific tenant.
1264
1904
  * This deletes the stored tokens and disconnects the integration.
@@ -1272,7 +1912,7 @@ export interface PathsDictionary {
1272
1912
  }
1273
1913
  ['/v2/outlook/mailbox/connect']: {
1274
1914
  /**
1275
- * connectOutlookMailbox - Connect Outlook Mailbox
1915
+ * connectOutlookMailbox - connectOutlookMailbox
1276
1916
  *
1277
1917
  * Connects an Outlook mailbox:
1278
1918
  * 1. Validates the user has access to the mailbox via Microsoft Graph API
@@ -1286,9 +1926,24 @@ export interface PathsDictionary {
1286
1926
  config?: AxiosRequestConfig
1287
1927
  ): OperationResponse<Paths.ConnectOutlookMailbox.Responses.$201>
1288
1928
  }
1929
+ ['/v2/outlook/mailbox/{email}/disconnect']: {
1930
+ /**
1931
+ * disconnectOutlookMailbox - Disconnect Outlook Mailbox
1932
+ *
1933
+ * Disconnects a single Outlook mailbox by email address.
1934
+ * Deletes the email address entity, Outlook email mapping, and Graph API subscriptions.
1935
+ * Does not affect the tenant-level Outlook connection.
1936
+ *
1937
+ */
1938
+ 'post'(
1939
+ parameters?: Parameters<Paths.DisconnectOutlookMailbox.PathParameters> | null,
1940
+ data?: any,
1941
+ config?: AxiosRequestConfig
1942
+ ): OperationResponse<Paths.DisconnectOutlookMailbox.Responses.$200>
1943
+ }
1289
1944
  ['/v2/outlook/mailbox/mappings']: {
1290
1945
  /**
1291
- * getConnectedOutlookEmails - Get Connected Outlook Emails
1946
+ * getConnectedOutlookEmails - getConnectedOutlookEmails
1292
1947
  *
1293
1948
  * Returns all Outlook email addresses connected to the organization.
1294
1949
  *
@@ -1301,7 +1956,7 @@ export interface PathsDictionary {
1301
1956
  }
1302
1957
  ['/v2/outlook/test-webhook']: {
1303
1958
  /**
1304
- * testWebhookGet - Test Webhook (GET)
1959
+ * testWebhookGet - testWebhookGet
1305
1960
  *
1306
1961
  * Test endpoint for debugging Graph API webhook notifications via ngrok.
1307
1962
  * Handles Microsoft Graph subscription validation requests by returning the validationToken.
@@ -1314,7 +1969,7 @@ export interface PathsDictionary {
1314
1969
  config?: AxiosRequestConfig
1315
1970
  ): OperationResponse<Paths.TestWebhookGet.Responses.$200 | Paths.TestWebhookGet.Responses.$202>
1316
1971
  /**
1317
- * testWebhookPost - Test Webhook (POST)
1972
+ * testWebhookPost - testWebhookPost
1318
1973
  *
1319
1974
  * Test endpoint for debugging Graph API webhook notifications via ngrok.
1320
1975
  * Logs all incoming webhook payloads for debugging purposes.
@@ -1329,7 +1984,7 @@ export interface PathsDictionary {
1329
1984
  }
1330
1985
  ['/v2/outlook/oauth/callback']: {
1331
1986
  /**
1332
- * outlookOAuthCallback - Outlook OAuth callback
1987
+ * outlookOAuthCallback - outlookOAuthCallback
1333
1988
  *
1334
1989
  * Exchanges authorization code for tokens and stores them.
1335
1990
  */
@@ -1343,7 +1998,21 @@ export interface PathsDictionary {
1343
1998
  /**
1344
1999
  * getSettings - getSettings
1345
2000
  *
1346
- * Get all settings by type
2001
+ * Retrieves settings of a specific type for the organization.
2002
+ *
2003
+ * If an `id` is provided, returns only that specific setting.
2004
+ * Otherwise, returns all settings of the specified type.
2005
+ *
2006
+ * ## Setting Types
2007
+ *
2008
+ * | Type | Description |
2009
+ * |------|-------------|
2010
+ * | `signature` | HTML email signatures |
2011
+ * | `email_domain` | Custom email domains |
2012
+ * | `email_address` | Sender email addresses |
2013
+ * | `whitelist_email_address` | Addresses exempt from duplicate detection |
2014
+ * | `restrict_duplicates_within` | Time window for duplicate email detection |
2015
+ *
1347
2016
  */
1348
2017
  'get'(
1349
2018
  parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
@@ -1353,7 +2022,14 @@ export interface PathsDictionary {
1353
2022
  /**
1354
2023
  * addSetting - addSetting
1355
2024
  *
1356
- * Add setting
2025
+ * Creates a new setting of the specified type.
2026
+ *
2027
+ * The setting type determines which fields are applicable:
2028
+ * - **signature**: Requires `name`, `value` (plain text), and `html` (HTML content)
2029
+ * - **email_domain**: Requires `value` (domain name)
2030
+ * - **whitelist_email_address**: Requires `value` (email address)
2031
+ * - **restrict_duplicates_within**: Requires `value` (time duration like "5m", "1d")
2032
+ *
1357
2033
  */
1358
2034
  'post'(
1359
2035
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1363,7 +2039,12 @@ export interface PathsDictionary {
1363
2039
  /**
1364
2040
  * deleteSetting - deleteSetting
1365
2041
  *
1366
- * delete setting by ID and type
2042
+ * Deletes a setting by its ID and type.
2043
+ *
2044
+ * Both the `id` and `type` are required to uniquely identify the setting to delete.
2045
+ *
2046
+ * **Warning**: This action cannot be undone.
2047
+ *
1367
2048
  */
1368
2049
  'delete'(
1369
2050
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1375,7 +2056,11 @@ export interface PathsDictionary {
1375
2056
  /**
1376
2057
  * updateSetting - updateSetting
1377
2058
  *
1378
- * Update setting by ID
2059
+ * Updates an existing setting identified by its ID.
2060
+ *
2061
+ * Include the `type` field in the request body to specify which setting type
2062
+ * is being updated. Only the fields provided will be updated.
2063
+ *
1379
2064
  */
1380
2065
  'post'(
1381
2066
  parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
@@ -1387,7 +2072,14 @@ export interface PathsDictionary {
1387
2072
  /**
1388
2073
  * addDomain - addDomain
1389
2074
  *
1390
- * Add domain
2075
+ * Adds a custom email domain to the organization.
2076
+ *
2077
+ * After adding the domain, you must:
2078
+ * 1. Configure the required DNS records (provided in the response)
2079
+ * 2. Verify the domain using the verification endpoint
2080
+ *
2081
+ * Until verification is complete, the domain cannot be used for sending emails.
2082
+ *
1391
2083
  */
1392
2084
  'post'(
1393
2085
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1397,7 +2089,12 @@ export interface PathsDictionary {
1397
2089
  /**
1398
2090
  * deleteDomain - deleteDomain
1399
2091
  *
1400
- * Delete domain
2092
+ * Removes a custom email domain from the organization.
2093
+ *
2094
+ * **Warning**: Deleting a domain will prevent sending emails from any addresses
2095
+ * using this domain. Existing email addresses on this domain should be removed
2096
+ * or reassigned before deleting the domain.
2097
+ *
1401
2098
  */
1402
2099
  'delete'(
1403
2100
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1409,7 +2106,13 @@ export interface PathsDictionary {
1409
2106
  /**
1410
2107
  * verifyNameServers - verifyNameServers
1411
2108
  *
1412
- * Verify name servers
2109
+ * Verifies that the domain's name server (NS) records are correctly configured.
2110
+ *
2111
+ * This check ensures that DNS resolution is properly set up for the domain
2112
+ * before proceeding with full domain verification.
2113
+ *
2114
+ * Run this verification after configuring NS records in your DNS provider.
2115
+ *
1413
2116
  */
1414
2117
  'post'(
1415
2118
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1421,7 +2124,16 @@ export interface PathsDictionary {
1421
2124
  /**
1422
2125
  * verifyDomain - verifyDomain
1423
2126
  *
1424
- * Verify domain
2127
+ * Verifies ownership and configuration of a custom email domain.
2128
+ *
2129
+ * Domain verification checks:
2130
+ * - DNS TXT records for domain ownership
2131
+ * - MX records for email routing
2132
+ * - SPF records for sender authentication
2133
+ * - DKIM records for email signing
2134
+ *
2135
+ * Once verified, the domain can be used to create email addresses and send emails.
2136
+ *
1425
2137
  */
1426
2138
  'post'(
1427
2139
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1443,9 +2155,9 @@ export type EmailAddressSetting = Components.Schemas.EmailAddressSetting;
1443
2155
  export type EmailDomainSetting = Components.Schemas.EmailDomainSetting;
1444
2156
  export type ErrorResponse = Components.Schemas.ErrorResponse;
1445
2157
  export type InboxBucketResponse = Components.Schemas.InboxBucketResponse;
1446
- export type OutlookConnectionConfig = Components.Schemas.OutlookConnectionConfig;
2158
+ export type OutlookConnectionError = Components.Schemas.OutlookConnectionError;
2159
+ export type OutlookConnectionStatus = Components.Schemas.OutlookConnectionStatus;
1447
2160
  export type ProvisionEpilotEmailAddressPayload = Components.Schemas.ProvisionEpilotEmailAddressPayload;
1448
- export type ResolveOutlookConnectionResponse = Components.Schemas.ResolveOutlookConnectionResponse;
1449
2161
  export type RestrictDuplicatesWithinSetting = Components.Schemas.RestrictDuplicatesWithinSetting;
1450
2162
  export type SetEmailAddressPrimaryPayload = Components.Schemas.SetEmailAddressPrimaryPayload;
1451
2163
  export type Setting = Components.Schemas.Setting;