@epilot/email-settings-client 0.7.0 → 0.8.1

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2025 epilot GmbH
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={390:function(e,t,n){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=o(n(466));t.default=s.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/email-settings/shared-inboxes/{id}":{"get":{"operationId":"getSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"responses":{}},"delete":{"operationId":"deleteSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"responses":{}},"put":{"operationId":"updateSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/shared-inboxes":{"get":{"operationId":"listSharedInboxes","responses":{}},"post":{"operationId":"addSharedInbox","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings":{"get":{"operationId":"getSettings","parameters":[{"name":"type","in":"query","required":true},{"name":"id","in":"query"}],"responses":{}},"post":{"operationId":"addSetting","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSetting","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/{id}":{"post":{"operationId":"updateSetting","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain":{"post":{"operationId":"addDomain","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteDomain","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain/name-servers:verify":{"post":{"operationId":"verifyNameServers","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain:verify":{"post":{"operationId":"verifyDomain","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"NoContent":{},"CreateSharedInboxSuccessResponse":{"content":{"application/json":{}}},"UpdateSharedInboxSuccessResponse":{"content":{"application/json":{}}},"GetSharedInboxSuccessResponse":{"content":{"application/json":{}}},"ListSharedInboxesSuccessResponse":{"content":{"application/json":{}}},"BadRequest":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}}},"parameters":{"SharedInboxId":{"name":"id","in":"path","required":true}}},"servers":[{"url":"https://email-settings.sls.epilot.io"}]}')}},t={},n=function n(o){var s=t[o];if(void 0!==s)return s.exports;var r=t[o]={exports:{}};return e[o].call(r.exports,r,r.exports,n),r.exports}(390),o=exports;for(var s in n)o[s]=n[s];n.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={390:function(e,s,t){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(s,"__esModule",{value:!0});var n=o(t(466));s.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/email-settings/email-addresses/epilot:provision":{"put":{"operationId":"provisionEpilotEmailAddress","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/email-addresses/primary":{"post":{"operationId":"setEmailAddressPrimary","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/email-addresses/{id}":{"get":{"operationId":"getEmailAddress","parameters":[{"$ref":"#/components/parameters/EmailAddressId"}],"responses":{}},"delete":{"operationId":"deleteEmailAddress","parameters":[{"$ref":"#/components/parameters/EmailAddressId"}],"responses":{}},"put":{"operationId":"updateEmailAddress","parameters":[{"$ref":"#/components/parameters/EmailAddressId"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/email-addresses":{"get":{"operationId":"listEmailAddresses","responses":{}},"post":{"operationId":"addEmailAddress","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/shared-inboxes/{id}":{"get":{"operationId":"getSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"responses":{}},"delete":{"operationId":"deleteSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"responses":{}},"put":{"operationId":"updateSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/shared-inboxes":{"get":{"operationId":"listSharedInboxes","responses":{}},"post":{"operationId":"addSharedInbox","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings":{"get":{"operationId":"getSettings","parameters":[{"name":"type","in":"query","required":true},{"name":"id","in":"query"}],"responses":{}},"post":{"operationId":"addSetting","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSetting","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/{id}":{"post":{"operationId":"updateSetting","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain":{"post":{"operationId":"addDomain","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteDomain","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain/name-servers:verify":{"post":{"operationId":"verifyNameServers","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain:verify":{"post":{"operationId":"verifyDomain","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"ProvisionEpilotEmailAddressSuccessResponse":{"content":{"application/json":{}}},"SetEmailAddressPrimarySuccessResponse":{"content":{"application/json":{}}},"CreateEmailAddressSuccessResponse":{"content":{"application/json":{}}},"UpdateEmailAddressSuccessResponse":{"content":{"application/json":{}}},"GetEmailAddressSuccessResponse":{"content":{"application/json":{}}},"ListEmailAddressesSuccessResponse":{"content":{"application/json":{}}},"NoContent":{},"CreateSharedInboxSuccessResponse":{"content":{"application/json":{}}},"UpdateSharedInboxSuccessResponse":{"content":{"application/json":{}}},"GetSharedInboxSuccessResponse":{"content":{"application/json":{}}},"ListSharedInboxesSuccessResponse":{"content":{"application/json":{}}},"BadRequest":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}}},"parameters":{"EmailAddressId":{"name":"id","in":"path","required":true},"SharedInboxId":{"name":"id","in":"path","required":true}}},"servers":[{"url":"https://email-settings.sls.epilot.io"}]}')}},s={},t=function t(o){var n=s[o];if(void 0!==n)return n.exports;var a=s[o]={exports:{}};return e[o].call(a.exports,a,a.exports,t),a.exports}(390),o=exports;for(var n in t)o[n]=t[n];t.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})();
package/dist/openapi.d.ts CHANGED
@@ -10,25 +10,41 @@ import type {
10
10
 
11
11
  declare namespace Components {
12
12
  namespace Parameters {
13
+ export type EmailAddressId = string;
13
14
  export type SharedInboxId = string;
14
15
  }
15
16
  export interface PathParameters {
17
+ EmailAddressId?: Parameters.EmailAddressId;
16
18
  SharedInboxId?: Parameters.SharedInboxId;
17
19
  }
18
20
  namespace Responses {
19
21
  export type BadRequest = Schemas.ErrorResponse;
20
22
  export type Conflict = Schemas.ErrorResponse;
23
+ export type CreateEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
21
24
  export type CreateSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
22
25
  export type Forbidden = Schemas.ErrorResponse;
26
+ export type GetEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
23
27
  export type GetSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
24
28
  export type InternalServerError = Schemas.ErrorResponse;
29
+ export type ListEmailAddressesSuccessResponse = Schemas.EmailAddressResponse[];
25
30
  export type ListSharedInboxesSuccessResponse = Schemas.SharedInboxResponse[];
26
31
  export interface NoContent {
27
32
  }
28
33
  export type NotFound = Schemas.ErrorResponse;
34
+ export type ProvisionEpilotEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
35
+ export type SetEmailAddressPrimarySuccessResponse = Schemas.EmailAddressResponse;
36
+ export type UpdateEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
29
37
  export type UpdateSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
30
38
  }
31
39
  namespace Schemas {
40
+ export interface CreateEmailAddressPayload {
41
+ address: string;
42
+ name?: string;
43
+ user_ids?: string[];
44
+ group_ids?: string[];
45
+ default_signature_id?: string;
46
+ shared_inbox_id?: string;
47
+ }
32
48
  export interface CreateSharedInboxPayload {
33
49
  id?: string;
34
50
  color: string;
@@ -43,6 +59,22 @@ declare namespace Components {
43
59
  */
44
60
  domain?: string;
45
61
  }
62
+ export interface EmailAddressResponse {
63
+ id: string;
64
+ created_at: string; // date-time
65
+ updated_at?: string; // date-time
66
+ created_by?: string;
67
+ updated_by?: string;
68
+ address: string;
69
+ name?: string;
70
+ user_ids?: string[];
71
+ group_ids?: string[];
72
+ default_signature_id?: string;
73
+ shared_inbox_id?: string;
74
+ is_active?: boolean;
75
+ is_primary?: boolean;
76
+ is_epilot_email_address?: boolean;
77
+ }
46
78
  /**
47
79
  * Setting that allows to add an email address on the custom domain. For e.g; john@doe.com
48
80
  */
@@ -55,6 +87,9 @@ declare namespace Components {
55
87
  error: string;
56
88
  status: number;
57
89
  }
90
+ export interface ProvisionEpilotEmailAddressPayload {
91
+ address: string;
92
+ }
58
93
  /**
59
94
  * - Restrict duplicates within:
60
95
  * * 10s
@@ -69,6 +104,9 @@ declare namespace Components {
69
104
  *
70
105
  */
71
106
  export type RestrictDuplicatesWithinSetting = "restrict_duplicates_within";
107
+ export interface SetEmailAddressPrimaryPayload {
108
+ address: string;
109
+ }
72
110
  export interface Setting {
73
111
  [name: string]: any;
74
112
  id?: string;
@@ -124,6 +162,14 @@ declare namespace Components {
124
162
  * Setting that allows to add a signature.
125
163
  */
126
164
  export type SignatureSetting = "signature";
165
+ export interface UpdateEmailAddressPayload {
166
+ name?: string;
167
+ user_ids?: string[];
168
+ group_ids?: string[];
169
+ default_signature_id?: string;
170
+ shared_inbox_id?: string;
171
+ is_active?: boolean;
172
+ }
127
173
  export interface UpdateSharedInboxPayload {
128
174
  color?: string;
129
175
  name?: string;
@@ -149,6 +195,16 @@ declare namespace Paths {
149
195
  }
150
196
  }
151
197
  }
198
+ namespace AddEmailAddress {
199
+ export type RequestBody = Components.Schemas.CreateEmailAddressPayload;
200
+ namespace Responses {
201
+ export type $201 = Components.Responses.CreateEmailAddressSuccessResponse;
202
+ export type $400 = Components.Responses.BadRequest;
203
+ export type $403 = Components.Responses.Forbidden;
204
+ export type $409 = Components.Responses.Conflict;
205
+ export type $500 = Components.Responses.InternalServerError;
206
+ }
207
+ }
152
208
  namespace AddSetting {
153
209
  export type RequestBody = Components.Schemas.Setting;
154
210
  namespace Responses {
@@ -180,6 +236,20 @@ declare namespace Paths {
180
236
  }
181
237
  }
182
238
  }
239
+ namespace DeleteEmailAddress {
240
+ namespace Parameters {
241
+ export type Id = string;
242
+ }
243
+ export interface PathParameters {
244
+ id: Parameters.Id;
245
+ }
246
+ namespace Responses {
247
+ export type $204 = Components.Responses.NoContent;
248
+ export type $403 = Components.Responses.Forbidden;
249
+ export type $404 = Components.Responses.NotFound;
250
+ export type $500 = Components.Responses.InternalServerError;
251
+ }
252
+ }
183
253
  namespace DeleteSetting {
184
254
  export interface RequestBody {
185
255
  type: Components.Schemas.SettingType;
@@ -211,6 +281,20 @@ declare namespace Paths {
211
281
  export type $500 = Components.Responses.InternalServerError;
212
282
  }
213
283
  }
284
+ namespace GetEmailAddress {
285
+ namespace Parameters {
286
+ export type Id = string;
287
+ }
288
+ export interface PathParameters {
289
+ id: Parameters.Id;
290
+ }
291
+ namespace Responses {
292
+ export type $200 = Components.Responses.GetEmailAddressSuccessResponse;
293
+ export type $403 = Components.Responses.Forbidden;
294
+ export type $404 = Components.Responses.NotFound;
295
+ export type $500 = Components.Responses.InternalServerError;
296
+ }
297
+ }
214
298
  namespace GetSettings {
215
299
  namespace Parameters {
216
300
  export type Id = string;
@@ -242,6 +326,13 @@ declare namespace Paths {
242
326
  export type $500 = Components.Responses.InternalServerError;
243
327
  }
244
328
  }
329
+ namespace ListEmailAddresses {
330
+ namespace Responses {
331
+ export type $200 = Components.Responses.ListEmailAddressesSuccessResponse;
332
+ export type $403 = Components.Responses.Forbidden;
333
+ export type $500 = Components.Responses.InternalServerError;
334
+ }
335
+ }
245
336
  namespace ListSharedInboxes {
246
337
  namespace Responses {
247
338
  export type $200 = Components.Responses.ListSharedInboxesSuccessResponse;
@@ -249,6 +340,42 @@ declare namespace Paths {
249
340
  export type $500 = Components.Responses.InternalServerError;
250
341
  }
251
342
  }
343
+ namespace ProvisionEpilotEmailAddress {
344
+ export type RequestBody = Components.Schemas.ProvisionEpilotEmailAddressPayload;
345
+ namespace Responses {
346
+ export type $200 = Components.Responses.ProvisionEpilotEmailAddressSuccessResponse;
347
+ export type $400 = Components.Responses.BadRequest;
348
+ export type $409 = Components.Responses.Conflict;
349
+ export type $500 = Components.Responses.InternalServerError;
350
+ }
351
+ }
352
+ namespace SetEmailAddressPrimary {
353
+ export type RequestBody = Components.Schemas.SetEmailAddressPrimaryPayload;
354
+ namespace Responses {
355
+ export type $200 = Components.Responses.SetEmailAddressPrimarySuccessResponse;
356
+ export type $400 = Components.Responses.BadRequest;
357
+ export type $403 = Components.Responses.Forbidden;
358
+ export type $409 = Components.Responses.Conflict;
359
+ export type $500 = Components.Responses.InternalServerError;
360
+ }
361
+ }
362
+ namespace UpdateEmailAddress {
363
+ namespace Parameters {
364
+ export type Id = string;
365
+ }
366
+ export interface PathParameters {
367
+ id: Parameters.Id;
368
+ }
369
+ export type RequestBody = Components.Schemas.UpdateEmailAddressPayload;
370
+ namespace Responses {
371
+ export type $200 = Components.Responses.UpdateEmailAddressSuccessResponse;
372
+ export type $400 = Components.Responses.BadRequest;
373
+ export type $403 = Components.Responses.Forbidden;
374
+ export type $404 = Components.Responses.NotFound;
375
+ export type $409 = Components.Responses.Conflict;
376
+ export type $500 = Components.Responses.InternalServerError;
377
+ }
378
+ }
252
379
  namespace UpdateSetting {
253
380
  namespace Parameters {
254
381
  export type Id = string;
@@ -306,6 +433,76 @@ declare namespace Paths {
306
433
 
307
434
 
308
435
  export interface OperationMethods {
436
+ /**
437
+ * provisionEpilotEmailAddress - provisionEpilotEmailAddress
438
+ *
439
+ * Provision or reactivate epilot email address, deactivating other active epilot email addresses.
440
+ */
441
+ 'provisionEpilotEmailAddress'(
442
+ parameters?: Parameters<UnknownParamsObject> | null,
443
+ data?: Paths.ProvisionEpilotEmailAddress.RequestBody,
444
+ config?: AxiosRequestConfig
445
+ ): OperationResponse<Paths.ProvisionEpilotEmailAddress.Responses.$200>
446
+ /**
447
+ * setEmailAddressPrimary - setEmailAddressPrimary
448
+ *
449
+ * Set email address as primary
450
+ */
451
+ 'setEmailAddressPrimary'(
452
+ parameters?: Parameters<UnknownParamsObject> | null,
453
+ data?: Paths.SetEmailAddressPrimary.RequestBody,
454
+ config?: AxiosRequestConfig
455
+ ): OperationResponse<Paths.SetEmailAddressPrimary.Responses.$200>
456
+ /**
457
+ * getEmailAddress - getEmailAddress
458
+ *
459
+ * Get email address
460
+ */
461
+ 'getEmailAddress'(
462
+ parameters?: Parameters<Paths.GetEmailAddress.PathParameters> | null,
463
+ data?: any,
464
+ config?: AxiosRequestConfig
465
+ ): OperationResponse<Paths.GetEmailAddress.Responses.$200>
466
+ /**
467
+ * updateEmailAddress - updateEmailAddress
468
+ *
469
+ * Update email address
470
+ */
471
+ 'updateEmailAddress'(
472
+ parameters?: Parameters<Paths.UpdateEmailAddress.PathParameters> | null,
473
+ data?: Paths.UpdateEmailAddress.RequestBody,
474
+ config?: AxiosRequestConfig
475
+ ): OperationResponse<Paths.UpdateEmailAddress.Responses.$200>
476
+ /**
477
+ * deleteEmailAddress - deleteEmailAddress
478
+ *
479
+ * Delete email address
480
+ */
481
+ 'deleteEmailAddress'(
482
+ parameters?: Parameters<Paths.DeleteEmailAddress.PathParameters> | null,
483
+ data?: any,
484
+ config?: AxiosRequestConfig
485
+ ): OperationResponse<Paths.DeleteEmailAddress.Responses.$204>
486
+ /**
487
+ * listEmailAddresses - listEmailAddresses
488
+ *
489
+ * List email addresses
490
+ */
491
+ 'listEmailAddresses'(
492
+ parameters?: Parameters<UnknownParamsObject> | null,
493
+ data?: any,
494
+ config?: AxiosRequestConfig
495
+ ): OperationResponse<Paths.ListEmailAddresses.Responses.$200>
496
+ /**
497
+ * addEmailAddress - addEmailAddress
498
+ *
499
+ * Add email address
500
+ */
501
+ 'addEmailAddress'(
502
+ parameters?: Parameters<UnknownParamsObject> | null,
503
+ data?: Paths.AddEmailAddress.RequestBody,
504
+ config?: AxiosRequestConfig
505
+ ): OperationResponse<Paths.AddEmailAddress.Responses.$201>
309
506
  /**
310
507
  * getSharedInbox - getSharedInbox
311
508
  *
@@ -439,6 +636,84 @@ export interface OperationMethods {
439
636
  }
440
637
 
441
638
  export interface PathsDictionary {
639
+ ['/v2/email-settings/email-addresses/epilot:provision']: {
640
+ /**
641
+ * provisionEpilotEmailAddress - provisionEpilotEmailAddress
642
+ *
643
+ * Provision or reactivate epilot email address, deactivating other active epilot email addresses.
644
+ */
645
+ 'put'(
646
+ parameters?: Parameters<UnknownParamsObject> | null,
647
+ data?: Paths.ProvisionEpilotEmailAddress.RequestBody,
648
+ config?: AxiosRequestConfig
649
+ ): OperationResponse<Paths.ProvisionEpilotEmailAddress.Responses.$200>
650
+ }
651
+ ['/v2/email-settings/email-addresses/primary']: {
652
+ /**
653
+ * setEmailAddressPrimary - setEmailAddressPrimary
654
+ *
655
+ * Set email address as primary
656
+ */
657
+ 'post'(
658
+ parameters?: Parameters<UnknownParamsObject> | null,
659
+ data?: Paths.SetEmailAddressPrimary.RequestBody,
660
+ config?: AxiosRequestConfig
661
+ ): OperationResponse<Paths.SetEmailAddressPrimary.Responses.$200>
662
+ }
663
+ ['/v2/email-settings/email-addresses/{id}']: {
664
+ /**
665
+ * getEmailAddress - getEmailAddress
666
+ *
667
+ * Get email address
668
+ */
669
+ 'get'(
670
+ parameters?: Parameters<Paths.GetEmailAddress.PathParameters> | null,
671
+ data?: any,
672
+ config?: AxiosRequestConfig
673
+ ): OperationResponse<Paths.GetEmailAddress.Responses.$200>
674
+ /**
675
+ * deleteEmailAddress - deleteEmailAddress
676
+ *
677
+ * Delete email address
678
+ */
679
+ 'delete'(
680
+ parameters?: Parameters<Paths.DeleteEmailAddress.PathParameters> | null,
681
+ data?: any,
682
+ config?: AxiosRequestConfig
683
+ ): OperationResponse<Paths.DeleteEmailAddress.Responses.$204>
684
+ /**
685
+ * updateEmailAddress - updateEmailAddress
686
+ *
687
+ * Update email address
688
+ */
689
+ 'put'(
690
+ parameters?: Parameters<Paths.UpdateEmailAddress.PathParameters> | null,
691
+ data?: Paths.UpdateEmailAddress.RequestBody,
692
+ config?: AxiosRequestConfig
693
+ ): OperationResponse<Paths.UpdateEmailAddress.Responses.$200>
694
+ }
695
+ ['/v2/email-settings/email-addresses']: {
696
+ /**
697
+ * listEmailAddresses - listEmailAddresses
698
+ *
699
+ * List email addresses
700
+ */
701
+ 'get'(
702
+ parameters?: Parameters<UnknownParamsObject> | null,
703
+ data?: any,
704
+ config?: AxiosRequestConfig
705
+ ): OperationResponse<Paths.ListEmailAddresses.Responses.$200>
706
+ /**
707
+ * addEmailAddress - addEmailAddress
708
+ *
709
+ * Add email address
710
+ */
711
+ 'post'(
712
+ parameters?: Parameters<UnknownParamsObject> | null,
713
+ data?: Paths.AddEmailAddress.RequestBody,
714
+ config?: AxiosRequestConfig
715
+ ): OperationResponse<Paths.AddEmailAddress.Responses.$201>
716
+ }
442
717
  ['/v2/email-settings/shared-inboxes/{id}']: {
443
718
  /**
444
719
  * getSharedInbox - getSharedInbox
@@ -588,17 +863,22 @@ export interface PathsDictionary {
588
863
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
589
864
 
590
865
 
866
+ export type CreateEmailAddressPayload = Components.Schemas.CreateEmailAddressPayload;
591
867
  export type CreateSharedInboxPayload = Components.Schemas.CreateSharedInboxPayload;
592
868
  export type Domain = Components.Schemas.Domain;
869
+ export type EmailAddressResponse = Components.Schemas.EmailAddressResponse;
593
870
  export type EmailAddressSetting = Components.Schemas.EmailAddressSetting;
594
871
  export type EmailDomainSetting = Components.Schemas.EmailDomainSetting;
595
872
  export type ErrorResponse = Components.Schemas.ErrorResponse;
873
+ export type ProvisionEpilotEmailAddressPayload = Components.Schemas.ProvisionEpilotEmailAddressPayload;
596
874
  export type RestrictDuplicatesWithinSetting = Components.Schemas.RestrictDuplicatesWithinSetting;
875
+ export type SetEmailAddressPrimaryPayload = Components.Schemas.SetEmailAddressPrimaryPayload;
597
876
  export type Setting = Components.Schemas.Setting;
598
877
  export type SettingMeta = Components.Schemas.SettingMeta;
599
878
  export type SettingType = Components.Schemas.SettingType;
600
879
  export type SettingsResponse = Components.Schemas.SettingsResponse;
601
880
  export type SharedInboxResponse = Components.Schemas.SharedInboxResponse;
602
881
  export type SignatureSetting = Components.Schemas.SignatureSetting;
882
+ export type UpdateEmailAddressPayload = Components.Schemas.UpdateEmailAddressPayload;
603
883
  export type UpdateSharedInboxPayload = Components.Schemas.UpdateSharedInboxPayload;
604
884
  export type WhitelistEmailAddressSetting = Components.Schemas.WhitelistEmailAddressSetting;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/email-settings-client",
3
- "version": "0.7.0",
3
+ "version": "0.8.1",
4
4
  "description": "API Client for epilot Email Settings API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -18,18 +18,6 @@
18
18
  "sdk",
19
19
  "email-settings"
20
20
  ],
21
- "scripts": {
22
- "test": "jest",
23
- "typescript": "tsc",
24
- "bundle-definition": "webpack",
25
- "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/email-settings.yaml",
26
- "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
27
- "build": "tsc && npm run build:patch && npm run bundle-definition",
28
- "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
29
- "build:watch": "npm run build && tsc -w",
30
- "prepublishOnly": "npm run typegen && npm run build",
31
- "lint": "pnpm exec eslint src"
32
- },
33
21
  "files": [
34
22
  "*.js",
35
23
  "*.d.ts",
@@ -51,7 +39,7 @@
51
39
  "@dazn/lambda-powertools-correlation-ids": "^1.28.1",
52
40
  "buffer": "^6.0.3",
53
41
  "https-browserify": "^1.0.0",
54
- "openapi-client-axios": "^7.6.0",
42
+ "openapi-client-axios": "^7.8.0",
55
43
  "stream-http": "^3.1.1",
56
44
  "url": "^0.11.0",
57
45
  "util": "^0.12.3"
@@ -70,5 +58,16 @@
70
58
  "webpack": "^5.18.0",
71
59
  "webpack-cli": "^4.4.0"
72
60
  },
73
- "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
74
- }
61
+ "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7",
62
+ "scripts": {
63
+ "test": "jest",
64
+ "typescript": "tsc",
65
+ "bundle-definition": "webpack",
66
+ "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/email-settings.yaml",
67
+ "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
68
+ "build": "tsc && npm run build:patch && npm run bundle-definition",
69
+ "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
70
+ "build:watch": "npm run build && tsc -w",
71
+ "lint": "pnpm exec eslint src"
72
+ }
73
+ }
@@ -0,0 +1,884 @@
1
+ /* eslint-disable */
2
+
3
+ import type {
4
+ OpenAPIClient,
5
+ Parameters,
6
+ UnknownParamsObject,
7
+ OperationResponse,
8
+ AxiosRequestConfig,
9
+ } from 'openapi-client-axios';
10
+
11
+ declare namespace Components {
12
+ namespace Parameters {
13
+ export type EmailAddressId = string;
14
+ export type SharedInboxId = string;
15
+ }
16
+ export interface PathParameters {
17
+ EmailAddressId?: Parameters.EmailAddressId;
18
+ SharedInboxId?: Parameters.SharedInboxId;
19
+ }
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 ListSharedInboxesSuccessResponse = Schemas.SharedInboxResponse[];
31
+ export interface NoContent {
32
+ }
33
+ export type NotFound = Schemas.ErrorResponse;
34
+ export type ProvisionEpilotEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
35
+ export type SetEmailAddressPrimarySuccessResponse = Schemas.EmailAddressResponse;
36
+ export type UpdateEmailAddressSuccessResponse = Schemas.EmailAddressResponse;
37
+ export type UpdateSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
38
+ }
39
+ namespace Schemas {
40
+ export interface CreateEmailAddressPayload {
41
+ address: string;
42
+ name?: string;
43
+ user_ids?: string[];
44
+ group_ids?: string[];
45
+ default_signature_id?: string;
46
+ shared_inbox_id?: string;
47
+ }
48
+ export interface CreateSharedInboxPayload {
49
+ id?: string;
50
+ color: string;
51
+ name: string;
52
+ assignees?: string[];
53
+ description?: string;
54
+ }
55
+ export interface Domain {
56
+ /**
57
+ * example:
58
+ * subdomain.epilot.cloud
59
+ */
60
+ domain?: string;
61
+ }
62
+ export interface EmailAddressResponse {
63
+ id: string;
64
+ created_at: string; // date-time
65
+ updated_at?: string; // date-time
66
+ created_by?: string;
67
+ updated_by?: string;
68
+ address: string;
69
+ name?: string;
70
+ user_ids?: string[];
71
+ group_ids?: string[];
72
+ default_signature_id?: string;
73
+ shared_inbox_id?: string;
74
+ is_active?: boolean;
75
+ is_primary?: boolean;
76
+ is_epilot_email_address?: boolean;
77
+ }
78
+ /**
79
+ * Setting that allows to add an email address on the custom domain. For e.g; john@doe.com
80
+ */
81
+ export type EmailAddressSetting = "email_address";
82
+ /**
83
+ * Setting that allows to add a custom domain. For e.g; doe.com
84
+ */
85
+ export type EmailDomainSetting = "email_domain";
86
+ export interface ErrorResponse {
87
+ error: string;
88
+ status: number;
89
+ }
90
+ export interface ProvisionEpilotEmailAddressPayload {
91
+ address: string;
92
+ }
93
+ /**
94
+ * - Restrict duplicates within:
95
+ * * 10s
96
+ * * 5m
97
+ * * 1d
98
+ * * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.
99
+ * - Defaults to 3 minutes
100
+ * - Negative values will be treated same as positive values
101
+ * - If not set, defaults to 3 min
102
+ * - If set as 0, then the no email will be treated as a duplicate
103
+ * - Cannot have multiple values
104
+ *
105
+ */
106
+ export type RestrictDuplicatesWithinSetting = "restrict_duplicates_within";
107
+ export interface SetEmailAddressPrimaryPayload {
108
+ address: string;
109
+ }
110
+ export interface Setting {
111
+ [name: string]: any;
112
+ id?: string;
113
+ name?: string;
114
+ org_id?: string;
115
+ type: SettingType;
116
+ value?: string;
117
+ html?: string;
118
+ created_at?: string;
119
+ updated_at?: string;
120
+ created_by?: string;
121
+ updated_by?: string;
122
+ }
123
+ export interface SettingMeta {
124
+ id: string;
125
+ created_at: string; // date-time
126
+ updated_at?: string; // date-time
127
+ created_by?: string;
128
+ updated_by?: string;
129
+ }
130
+ 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 | /**
131
+ * - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
132
+ * - An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.
133
+ *
134
+ */
135
+ WhitelistEmailAddressSetting | /**
136
+ * - Restrict duplicates within:
137
+ * * 10s
138
+ * * 5m
139
+ * * 1d
140
+ * * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.
141
+ * - Defaults to 3 minutes
142
+ * - Negative values will be treated same as positive values
143
+ * - If not set, defaults to 3 min
144
+ * - If set as 0, then the no email will be treated as a duplicate
145
+ * - Cannot have multiple values
146
+ *
147
+ */
148
+ RestrictDuplicatesWithinSetting;
149
+ export type SettingsResponse = Setting[] | Setting;
150
+ export interface SharedInboxResponse {
151
+ id: string;
152
+ created_at: string; // date-time
153
+ updated_at?: string; // date-time
154
+ created_by?: string;
155
+ updated_by?: string;
156
+ name: string;
157
+ color: string;
158
+ assignees: string[];
159
+ description?: string;
160
+ }
161
+ /**
162
+ * Setting that allows to add a signature.
163
+ */
164
+ export type SignatureSetting = "signature";
165
+ export interface UpdateEmailAddressPayload {
166
+ name?: string;
167
+ user_ids?: string[];
168
+ group_ids?: string[];
169
+ default_signature_id?: string;
170
+ shared_inbox_id?: string;
171
+ is_active?: boolean;
172
+ }
173
+ export interface UpdateSharedInboxPayload {
174
+ color?: string;
175
+ name?: string;
176
+ assignees?: string[];
177
+ description?: string;
178
+ }
179
+ /**
180
+ * - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
181
+ * - An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.
182
+ *
183
+ */
184
+ export type WhitelistEmailAddressSetting = "whitelist_email_address";
185
+ }
186
+ }
187
+ declare namespace Paths {
188
+ namespace AddDomain {
189
+ export type RequestBody = Components.Schemas.Domain;
190
+ namespace Responses {
191
+ export type $200 = Components.Schemas.SettingsResponse;
192
+ export interface $403 {
193
+ }
194
+ export interface $404 {
195
+ }
196
+ }
197
+ }
198
+ namespace AddEmailAddress {
199
+ export type RequestBody = Components.Schemas.CreateEmailAddressPayload;
200
+ namespace Responses {
201
+ export type $201 = Components.Responses.CreateEmailAddressSuccessResponse;
202
+ export type $400 = Components.Responses.BadRequest;
203
+ export type $403 = Components.Responses.Forbidden;
204
+ export type $409 = Components.Responses.Conflict;
205
+ export type $500 = Components.Responses.InternalServerError;
206
+ }
207
+ }
208
+ namespace AddSetting {
209
+ export type RequestBody = Components.Schemas.Setting;
210
+ namespace Responses {
211
+ export type $200 = Components.Schemas.SettingsResponse;
212
+ export interface $403 {
213
+ }
214
+ export interface $404 {
215
+ }
216
+ }
217
+ }
218
+ namespace AddSharedInbox {
219
+ export type RequestBody = Components.Schemas.CreateSharedInboxPayload;
220
+ namespace Responses {
221
+ export type $201 = Components.Responses.CreateSharedInboxSuccessResponse;
222
+ export type $400 = Components.Responses.BadRequest;
223
+ export type $403 = Components.Responses.Forbidden;
224
+ export type $409 = Components.Responses.Conflict;
225
+ export type $500 = Components.Responses.InternalServerError;
226
+ }
227
+ }
228
+ namespace DeleteDomain {
229
+ export type RequestBody = Components.Schemas.Domain;
230
+ namespace Responses {
231
+ export interface $204 {
232
+ }
233
+ export interface $403 {
234
+ }
235
+ export interface $404 {
236
+ }
237
+ }
238
+ }
239
+ namespace DeleteEmailAddress {
240
+ namespace Parameters {
241
+ export type Id = string;
242
+ }
243
+ export interface PathParameters {
244
+ id: Parameters.Id;
245
+ }
246
+ namespace Responses {
247
+ export type $204 = Components.Responses.NoContent;
248
+ export type $403 = Components.Responses.Forbidden;
249
+ export type $404 = Components.Responses.NotFound;
250
+ export type $500 = Components.Responses.InternalServerError;
251
+ }
252
+ }
253
+ namespace DeleteSetting {
254
+ export interface RequestBody {
255
+ type: Components.Schemas.SettingType;
256
+ /**
257
+ * ID of setting
258
+ * example:
259
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
260
+ */
261
+ id: string;
262
+ }
263
+ namespace Responses {
264
+ export type $200 = Components.Schemas.Setting;
265
+ export interface $403 {
266
+ }
267
+ export interface $404 {
268
+ }
269
+ }
270
+ }
271
+ namespace DeleteSharedInbox {
272
+ namespace Parameters {
273
+ export type Id = string;
274
+ }
275
+ export interface PathParameters {
276
+ id: Parameters.Id;
277
+ }
278
+ namespace Responses {
279
+ export type $204 = Components.Responses.NoContent;
280
+ export type $403 = Components.Responses.Forbidden;
281
+ export type $500 = Components.Responses.InternalServerError;
282
+ }
283
+ }
284
+ namespace GetEmailAddress {
285
+ namespace Parameters {
286
+ export type Id = string;
287
+ }
288
+ export interface PathParameters {
289
+ id: Parameters.Id;
290
+ }
291
+ namespace Responses {
292
+ export type $200 = Components.Responses.GetEmailAddressSuccessResponse;
293
+ export type $403 = Components.Responses.Forbidden;
294
+ export type $404 = Components.Responses.NotFound;
295
+ export type $500 = Components.Responses.InternalServerError;
296
+ }
297
+ }
298
+ namespace GetSettings {
299
+ namespace Parameters {
300
+ export type Id = string;
301
+ export type Type = Components.Schemas.SettingType;
302
+ }
303
+ export interface QueryParameters {
304
+ type: Parameters.Type;
305
+ id?: Parameters.Id;
306
+ }
307
+ namespace Responses {
308
+ export type $200 = Components.Schemas.SettingsResponse;
309
+ export interface $403 {
310
+ }
311
+ export interface $404 {
312
+ }
313
+ }
314
+ }
315
+ namespace GetSharedInbox {
316
+ namespace Parameters {
317
+ export type Id = string;
318
+ }
319
+ export interface PathParameters {
320
+ id: Parameters.Id;
321
+ }
322
+ namespace Responses {
323
+ export type $200 = Components.Responses.GetSharedInboxSuccessResponse;
324
+ export type $403 = Components.Responses.Forbidden;
325
+ export type $404 = Components.Responses.NotFound;
326
+ export type $500 = Components.Responses.InternalServerError;
327
+ }
328
+ }
329
+ namespace ListEmailAddresses {
330
+ namespace Responses {
331
+ export type $200 = Components.Responses.ListEmailAddressesSuccessResponse;
332
+ export type $403 = Components.Responses.Forbidden;
333
+ export type $500 = Components.Responses.InternalServerError;
334
+ }
335
+ }
336
+ namespace ListSharedInboxes {
337
+ namespace Responses {
338
+ export type $200 = Components.Responses.ListSharedInboxesSuccessResponse;
339
+ export type $403 = Components.Responses.Forbidden;
340
+ export type $500 = Components.Responses.InternalServerError;
341
+ }
342
+ }
343
+ namespace ProvisionEpilotEmailAddress {
344
+ export type RequestBody = Components.Schemas.ProvisionEpilotEmailAddressPayload;
345
+ namespace Responses {
346
+ export type $200 = Components.Responses.ProvisionEpilotEmailAddressSuccessResponse;
347
+ export type $400 = Components.Responses.BadRequest;
348
+ export type $409 = Components.Responses.Conflict;
349
+ export type $500 = Components.Responses.InternalServerError;
350
+ }
351
+ }
352
+ namespace SetEmailAddressPrimary {
353
+ export type RequestBody = Components.Schemas.SetEmailAddressPrimaryPayload;
354
+ namespace Responses {
355
+ export type $200 = Components.Responses.SetEmailAddressPrimarySuccessResponse;
356
+ export type $400 = Components.Responses.BadRequest;
357
+ export type $403 = Components.Responses.Forbidden;
358
+ export type $409 = Components.Responses.Conflict;
359
+ export type $500 = Components.Responses.InternalServerError;
360
+ }
361
+ }
362
+ namespace UpdateEmailAddress {
363
+ namespace Parameters {
364
+ export type Id = string;
365
+ }
366
+ export interface PathParameters {
367
+ id: Parameters.Id;
368
+ }
369
+ export type RequestBody = Components.Schemas.UpdateEmailAddressPayload;
370
+ namespace Responses {
371
+ export type $200 = Components.Responses.UpdateEmailAddressSuccessResponse;
372
+ export type $400 = Components.Responses.BadRequest;
373
+ export type $403 = Components.Responses.Forbidden;
374
+ export type $404 = Components.Responses.NotFound;
375
+ export type $409 = Components.Responses.Conflict;
376
+ export type $500 = Components.Responses.InternalServerError;
377
+ }
378
+ }
379
+ namespace UpdateSetting {
380
+ namespace Parameters {
381
+ export type Id = string;
382
+ }
383
+ export interface PathParameters {
384
+ id: Parameters.Id;
385
+ }
386
+ export type RequestBody = Components.Schemas.Setting;
387
+ namespace Responses {
388
+ export type $200 = Components.Schemas.Setting;
389
+ export interface $403 {
390
+ }
391
+ export interface $404 {
392
+ }
393
+ }
394
+ }
395
+ namespace UpdateSharedInbox {
396
+ namespace Parameters {
397
+ export type Id = string;
398
+ }
399
+ export interface PathParameters {
400
+ id: Parameters.Id;
401
+ }
402
+ export type RequestBody = Components.Schemas.UpdateSharedInboxPayload;
403
+ namespace Responses {
404
+ export type $200 = Components.Responses.UpdateSharedInboxSuccessResponse;
405
+ export type $400 = Components.Responses.BadRequest;
406
+ export type $403 = Components.Responses.Forbidden;
407
+ export type $404 = Components.Responses.NotFound;
408
+ export type $409 = Components.Responses.Conflict;
409
+ export type $500 = Components.Responses.InternalServerError;
410
+ }
411
+ }
412
+ namespace VerifyDomain {
413
+ export type RequestBody = Components.Schemas.Domain;
414
+ namespace Responses {
415
+ export type $200 = Components.Schemas.SettingsResponse;
416
+ export interface $403 {
417
+ }
418
+ export interface $404 {
419
+ }
420
+ }
421
+ }
422
+ namespace VerifyNameServers {
423
+ export type RequestBody = Components.Schemas.Domain;
424
+ namespace Responses {
425
+ export type $200 = Components.Schemas.SettingsResponse;
426
+ export interface $403 {
427
+ }
428
+ export interface $404 {
429
+ }
430
+ }
431
+ }
432
+ }
433
+
434
+
435
+ export interface OperationMethods {
436
+ /**
437
+ * provisionEpilotEmailAddress - provisionEpilotEmailAddress
438
+ *
439
+ * Provision or reactivate epilot email address, deactivating other active epilot email addresses.
440
+ */
441
+ 'provisionEpilotEmailAddress'(
442
+ parameters?: Parameters<UnknownParamsObject> | null,
443
+ data?: Paths.ProvisionEpilotEmailAddress.RequestBody,
444
+ config?: AxiosRequestConfig
445
+ ): OperationResponse<Paths.ProvisionEpilotEmailAddress.Responses.$200>
446
+ /**
447
+ * setEmailAddressPrimary - setEmailAddressPrimary
448
+ *
449
+ * Set email address as primary
450
+ */
451
+ 'setEmailAddressPrimary'(
452
+ parameters?: Parameters<UnknownParamsObject> | null,
453
+ data?: Paths.SetEmailAddressPrimary.RequestBody,
454
+ config?: AxiosRequestConfig
455
+ ): OperationResponse<Paths.SetEmailAddressPrimary.Responses.$200>
456
+ /**
457
+ * getEmailAddress - getEmailAddress
458
+ *
459
+ * Get email address
460
+ */
461
+ 'getEmailAddress'(
462
+ parameters?: Parameters<Paths.GetEmailAddress.PathParameters> | null,
463
+ data?: any,
464
+ config?: AxiosRequestConfig
465
+ ): OperationResponse<Paths.GetEmailAddress.Responses.$200>
466
+ /**
467
+ * updateEmailAddress - updateEmailAddress
468
+ *
469
+ * Update email address
470
+ */
471
+ 'updateEmailAddress'(
472
+ parameters?: Parameters<Paths.UpdateEmailAddress.PathParameters> | null,
473
+ data?: Paths.UpdateEmailAddress.RequestBody,
474
+ config?: AxiosRequestConfig
475
+ ): OperationResponse<Paths.UpdateEmailAddress.Responses.$200>
476
+ /**
477
+ * deleteEmailAddress - deleteEmailAddress
478
+ *
479
+ * Delete email address
480
+ */
481
+ 'deleteEmailAddress'(
482
+ parameters?: Parameters<Paths.DeleteEmailAddress.PathParameters> | null,
483
+ data?: any,
484
+ config?: AxiosRequestConfig
485
+ ): OperationResponse<Paths.DeleteEmailAddress.Responses.$204>
486
+ /**
487
+ * listEmailAddresses - listEmailAddresses
488
+ *
489
+ * List email addresses
490
+ */
491
+ 'listEmailAddresses'(
492
+ parameters?: Parameters<UnknownParamsObject> | null,
493
+ data?: any,
494
+ config?: AxiosRequestConfig
495
+ ): OperationResponse<Paths.ListEmailAddresses.Responses.$200>
496
+ /**
497
+ * addEmailAddress - addEmailAddress
498
+ *
499
+ * Add email address
500
+ */
501
+ 'addEmailAddress'(
502
+ parameters?: Parameters<UnknownParamsObject> | null,
503
+ data?: Paths.AddEmailAddress.RequestBody,
504
+ config?: AxiosRequestConfig
505
+ ): OperationResponse<Paths.AddEmailAddress.Responses.$201>
506
+ /**
507
+ * getSharedInbox - getSharedInbox
508
+ *
509
+ * Get shared inbox
510
+ */
511
+ 'getSharedInbox'(
512
+ parameters?: Parameters<Paths.GetSharedInbox.PathParameters> | null,
513
+ data?: any,
514
+ config?: AxiosRequestConfig
515
+ ): OperationResponse<Paths.GetSharedInbox.Responses.$200>
516
+ /**
517
+ * updateSharedInbox - updateSharedInbox
518
+ *
519
+ * Update shared inbox
520
+ */
521
+ 'updateSharedInbox'(
522
+ parameters?: Parameters<Paths.UpdateSharedInbox.PathParameters> | null,
523
+ data?: Paths.UpdateSharedInbox.RequestBody,
524
+ config?: AxiosRequestConfig
525
+ ): OperationResponse<Paths.UpdateSharedInbox.Responses.$200>
526
+ /**
527
+ * deleteSharedInbox - deleteSharedInbox
528
+ *
529
+ * Delete shared inbox
530
+ */
531
+ 'deleteSharedInbox'(
532
+ parameters?: Parameters<Paths.DeleteSharedInbox.PathParameters> | null,
533
+ data?: any,
534
+ config?: AxiosRequestConfig
535
+ ): OperationResponse<Paths.DeleteSharedInbox.Responses.$204>
536
+ /**
537
+ * listSharedInboxes - listSharedInboxes
538
+ *
539
+ * List shared inboxes
540
+ */
541
+ 'listSharedInboxes'(
542
+ parameters?: Parameters<UnknownParamsObject> | null,
543
+ data?: any,
544
+ config?: AxiosRequestConfig
545
+ ): OperationResponse<Paths.ListSharedInboxes.Responses.$200>
546
+ /**
547
+ * addSharedInbox - addSharedInbox
548
+ *
549
+ * Add shared inbox
550
+ */
551
+ 'addSharedInbox'(
552
+ parameters?: Parameters<UnknownParamsObject> | null,
553
+ data?: Paths.AddSharedInbox.RequestBody,
554
+ config?: AxiosRequestConfig
555
+ ): OperationResponse<Paths.AddSharedInbox.Responses.$201>
556
+ /**
557
+ * getSettings - getSettings
558
+ *
559
+ * Get all settings by type
560
+ */
561
+ 'getSettings'(
562
+ parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
563
+ data?: any,
564
+ config?: AxiosRequestConfig
565
+ ): OperationResponse<Paths.GetSettings.Responses.$200>
566
+ /**
567
+ * addSetting - addSetting
568
+ *
569
+ * Add setting
570
+ */
571
+ 'addSetting'(
572
+ parameters?: Parameters<UnknownParamsObject> | null,
573
+ data?: Paths.AddSetting.RequestBody,
574
+ config?: AxiosRequestConfig
575
+ ): OperationResponse<Paths.AddSetting.Responses.$200>
576
+ /**
577
+ * deleteSetting - deleteSetting
578
+ *
579
+ * delete setting by ID and type
580
+ */
581
+ 'deleteSetting'(
582
+ parameters?: Parameters<UnknownParamsObject> | null,
583
+ data?: Paths.DeleteSetting.RequestBody,
584
+ config?: AxiosRequestConfig
585
+ ): OperationResponse<Paths.DeleteSetting.Responses.$200>
586
+ /**
587
+ * updateSetting - updateSetting
588
+ *
589
+ * Update setting by ID
590
+ */
591
+ 'updateSetting'(
592
+ parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
593
+ data?: Paths.UpdateSetting.RequestBody,
594
+ config?: AxiosRequestConfig
595
+ ): OperationResponse<Paths.UpdateSetting.Responses.$200>
596
+ /**
597
+ * addDomain - addDomain
598
+ *
599
+ * Add domain
600
+ */
601
+ 'addDomain'(
602
+ parameters?: Parameters<UnknownParamsObject> | null,
603
+ data?: Paths.AddDomain.RequestBody,
604
+ config?: AxiosRequestConfig
605
+ ): OperationResponse<Paths.AddDomain.Responses.$200>
606
+ /**
607
+ * deleteDomain - deleteDomain
608
+ *
609
+ * Delete domain
610
+ */
611
+ 'deleteDomain'(
612
+ parameters?: Parameters<UnknownParamsObject> | null,
613
+ data?: Paths.DeleteDomain.RequestBody,
614
+ config?: AxiosRequestConfig
615
+ ): OperationResponse<Paths.DeleteDomain.Responses.$204>
616
+ /**
617
+ * verifyNameServers - verifyNameServers
618
+ *
619
+ * Verify name servers
620
+ */
621
+ 'verifyNameServers'(
622
+ parameters?: Parameters<UnknownParamsObject> | null,
623
+ data?: Paths.VerifyNameServers.RequestBody,
624
+ config?: AxiosRequestConfig
625
+ ): OperationResponse<Paths.VerifyNameServers.Responses.$200>
626
+ /**
627
+ * verifyDomain - verifyDomain
628
+ *
629
+ * Verify domain
630
+ */
631
+ 'verifyDomain'(
632
+ parameters?: Parameters<UnknownParamsObject> | null,
633
+ data?: Paths.VerifyDomain.RequestBody,
634
+ config?: AxiosRequestConfig
635
+ ): OperationResponse<Paths.VerifyDomain.Responses.$200>
636
+ }
637
+
638
+ export interface PathsDictionary {
639
+ ['/v2/email-settings/email-addresses/epilot:provision']: {
640
+ /**
641
+ * provisionEpilotEmailAddress - provisionEpilotEmailAddress
642
+ *
643
+ * Provision or reactivate epilot email address, deactivating other active epilot email addresses.
644
+ */
645
+ 'put'(
646
+ parameters?: Parameters<UnknownParamsObject> | null,
647
+ data?: Paths.ProvisionEpilotEmailAddress.RequestBody,
648
+ config?: AxiosRequestConfig
649
+ ): OperationResponse<Paths.ProvisionEpilotEmailAddress.Responses.$200>
650
+ }
651
+ ['/v2/email-settings/email-addresses/primary']: {
652
+ /**
653
+ * setEmailAddressPrimary - setEmailAddressPrimary
654
+ *
655
+ * Set email address as primary
656
+ */
657
+ 'post'(
658
+ parameters?: Parameters<UnknownParamsObject> | null,
659
+ data?: Paths.SetEmailAddressPrimary.RequestBody,
660
+ config?: AxiosRequestConfig
661
+ ): OperationResponse<Paths.SetEmailAddressPrimary.Responses.$200>
662
+ }
663
+ ['/v2/email-settings/email-addresses/{id}']: {
664
+ /**
665
+ * getEmailAddress - getEmailAddress
666
+ *
667
+ * Get email address
668
+ */
669
+ 'get'(
670
+ parameters?: Parameters<Paths.GetEmailAddress.PathParameters> | null,
671
+ data?: any,
672
+ config?: AxiosRequestConfig
673
+ ): OperationResponse<Paths.GetEmailAddress.Responses.$200>
674
+ /**
675
+ * deleteEmailAddress - deleteEmailAddress
676
+ *
677
+ * Delete email address
678
+ */
679
+ 'delete'(
680
+ parameters?: Parameters<Paths.DeleteEmailAddress.PathParameters> | null,
681
+ data?: any,
682
+ config?: AxiosRequestConfig
683
+ ): OperationResponse<Paths.DeleteEmailAddress.Responses.$204>
684
+ /**
685
+ * updateEmailAddress - updateEmailAddress
686
+ *
687
+ * Update email address
688
+ */
689
+ 'put'(
690
+ parameters?: Parameters<Paths.UpdateEmailAddress.PathParameters> | null,
691
+ data?: Paths.UpdateEmailAddress.RequestBody,
692
+ config?: AxiosRequestConfig
693
+ ): OperationResponse<Paths.UpdateEmailAddress.Responses.$200>
694
+ }
695
+ ['/v2/email-settings/email-addresses']: {
696
+ /**
697
+ * listEmailAddresses - listEmailAddresses
698
+ *
699
+ * List email addresses
700
+ */
701
+ 'get'(
702
+ parameters?: Parameters<UnknownParamsObject> | null,
703
+ data?: any,
704
+ config?: AxiosRequestConfig
705
+ ): OperationResponse<Paths.ListEmailAddresses.Responses.$200>
706
+ /**
707
+ * addEmailAddress - addEmailAddress
708
+ *
709
+ * Add email address
710
+ */
711
+ 'post'(
712
+ parameters?: Parameters<UnknownParamsObject> | null,
713
+ data?: Paths.AddEmailAddress.RequestBody,
714
+ config?: AxiosRequestConfig
715
+ ): OperationResponse<Paths.AddEmailAddress.Responses.$201>
716
+ }
717
+ ['/v2/email-settings/shared-inboxes/{id}']: {
718
+ /**
719
+ * getSharedInbox - getSharedInbox
720
+ *
721
+ * Get shared inbox
722
+ */
723
+ 'get'(
724
+ parameters?: Parameters<Paths.GetSharedInbox.PathParameters> | null,
725
+ data?: any,
726
+ config?: AxiosRequestConfig
727
+ ): OperationResponse<Paths.GetSharedInbox.Responses.$200>
728
+ /**
729
+ * deleteSharedInbox - deleteSharedInbox
730
+ *
731
+ * Delete shared inbox
732
+ */
733
+ 'delete'(
734
+ parameters?: Parameters<Paths.DeleteSharedInbox.PathParameters> | null,
735
+ data?: any,
736
+ config?: AxiosRequestConfig
737
+ ): OperationResponse<Paths.DeleteSharedInbox.Responses.$204>
738
+ /**
739
+ * updateSharedInbox - updateSharedInbox
740
+ *
741
+ * Update shared inbox
742
+ */
743
+ 'put'(
744
+ parameters?: Parameters<Paths.UpdateSharedInbox.PathParameters> | null,
745
+ data?: Paths.UpdateSharedInbox.RequestBody,
746
+ config?: AxiosRequestConfig
747
+ ): OperationResponse<Paths.UpdateSharedInbox.Responses.$200>
748
+ }
749
+ ['/v2/email-settings/shared-inboxes']: {
750
+ /**
751
+ * listSharedInboxes - listSharedInboxes
752
+ *
753
+ * List shared inboxes
754
+ */
755
+ 'get'(
756
+ parameters?: Parameters<UnknownParamsObject> | null,
757
+ data?: any,
758
+ config?: AxiosRequestConfig
759
+ ): OperationResponse<Paths.ListSharedInboxes.Responses.$200>
760
+ /**
761
+ * addSharedInbox - addSharedInbox
762
+ *
763
+ * Add shared inbox
764
+ */
765
+ 'post'(
766
+ parameters?: Parameters<UnknownParamsObject> | null,
767
+ data?: Paths.AddSharedInbox.RequestBody,
768
+ config?: AxiosRequestConfig
769
+ ): OperationResponse<Paths.AddSharedInbox.Responses.$201>
770
+ }
771
+ ['/v1/email-settings']: {
772
+ /**
773
+ * getSettings - getSettings
774
+ *
775
+ * Get all settings by type
776
+ */
777
+ 'get'(
778
+ parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
779
+ data?: any,
780
+ config?: AxiosRequestConfig
781
+ ): OperationResponse<Paths.GetSettings.Responses.$200>
782
+ /**
783
+ * addSetting - addSetting
784
+ *
785
+ * Add setting
786
+ */
787
+ 'post'(
788
+ parameters?: Parameters<UnknownParamsObject> | null,
789
+ data?: Paths.AddSetting.RequestBody,
790
+ config?: AxiosRequestConfig
791
+ ): OperationResponse<Paths.AddSetting.Responses.$200>
792
+ /**
793
+ * deleteSetting - deleteSetting
794
+ *
795
+ * delete setting by ID and type
796
+ */
797
+ 'delete'(
798
+ parameters?: Parameters<UnknownParamsObject> | null,
799
+ data?: Paths.DeleteSetting.RequestBody,
800
+ config?: AxiosRequestConfig
801
+ ): OperationResponse<Paths.DeleteSetting.Responses.$200>
802
+ }
803
+ ['/v1/email-settings/{id}']: {
804
+ /**
805
+ * updateSetting - updateSetting
806
+ *
807
+ * Update setting by ID
808
+ */
809
+ 'post'(
810
+ parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
811
+ data?: Paths.UpdateSetting.RequestBody,
812
+ config?: AxiosRequestConfig
813
+ ): OperationResponse<Paths.UpdateSetting.Responses.$200>
814
+ }
815
+ ['/v1/email-settings/domain']: {
816
+ /**
817
+ * addDomain - addDomain
818
+ *
819
+ * Add domain
820
+ */
821
+ 'post'(
822
+ parameters?: Parameters<UnknownParamsObject> | null,
823
+ data?: Paths.AddDomain.RequestBody,
824
+ config?: AxiosRequestConfig
825
+ ): OperationResponse<Paths.AddDomain.Responses.$200>
826
+ /**
827
+ * deleteDomain - deleteDomain
828
+ *
829
+ * Delete domain
830
+ */
831
+ 'delete'(
832
+ parameters?: Parameters<UnknownParamsObject> | null,
833
+ data?: Paths.DeleteDomain.RequestBody,
834
+ config?: AxiosRequestConfig
835
+ ): OperationResponse<Paths.DeleteDomain.Responses.$204>
836
+ }
837
+ ['/v1/email-settings/domain/name-servers:verify']: {
838
+ /**
839
+ * verifyNameServers - verifyNameServers
840
+ *
841
+ * Verify name servers
842
+ */
843
+ 'post'(
844
+ parameters?: Parameters<UnknownParamsObject> | null,
845
+ data?: Paths.VerifyNameServers.RequestBody,
846
+ config?: AxiosRequestConfig
847
+ ): OperationResponse<Paths.VerifyNameServers.Responses.$200>
848
+ }
849
+ ['/v1/email-settings/domain:verify']: {
850
+ /**
851
+ * verifyDomain - verifyDomain
852
+ *
853
+ * Verify domain
854
+ */
855
+ 'post'(
856
+ parameters?: Parameters<UnknownParamsObject> | null,
857
+ data?: Paths.VerifyDomain.RequestBody,
858
+ config?: AxiosRequestConfig
859
+ ): OperationResponse<Paths.VerifyDomain.Responses.$200>
860
+ }
861
+ }
862
+
863
+ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
864
+
865
+
866
+ export type CreateEmailAddressPayload = Components.Schemas.CreateEmailAddressPayload;
867
+ export type CreateSharedInboxPayload = Components.Schemas.CreateSharedInboxPayload;
868
+ export type Domain = Components.Schemas.Domain;
869
+ export type EmailAddressResponse = Components.Schemas.EmailAddressResponse;
870
+ export type EmailAddressSetting = Components.Schemas.EmailAddressSetting;
871
+ export type EmailDomainSetting = Components.Schemas.EmailDomainSetting;
872
+ export type ErrorResponse = Components.Schemas.ErrorResponse;
873
+ export type ProvisionEpilotEmailAddressPayload = Components.Schemas.ProvisionEpilotEmailAddressPayload;
874
+ export type RestrictDuplicatesWithinSetting = Components.Schemas.RestrictDuplicatesWithinSetting;
875
+ export type SetEmailAddressPrimaryPayload = Components.Schemas.SetEmailAddressPrimaryPayload;
876
+ export type Setting = Components.Schemas.Setting;
877
+ export type SettingMeta = Components.Schemas.SettingMeta;
878
+ export type SettingType = Components.Schemas.SettingType;
879
+ export type SettingsResponse = Components.Schemas.SettingsResponse;
880
+ export type SharedInboxResponse = Components.Schemas.SharedInboxResponse;
881
+ export type SignatureSetting = Components.Schemas.SignatureSetting;
882
+ export type UpdateEmailAddressPayload = Components.Schemas.UpdateEmailAddressPayload;
883
+ export type UpdateSharedInboxPayload = Components.Schemas.UpdateSharedInboxPayload;
884
+ export type WhitelistEmailAddressSetting = Components.Schemas.WhitelistEmailAddressSetting;