@epilot/email-settings-client 0.6.1 → 0.8.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/definition.js +1 -1
- package/dist/openapi.d.ts +504 -0
- package/package.json +17 -16
- package/LICENSE +0 -21
- package/src/openapi.d.ts +0 -380
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={390:function(e,t
|
|
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
|
@@ -9,7 +9,49 @@ import type {
|
|
|
9
9
|
} from 'openapi-client-axios';
|
|
10
10
|
|
|
11
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
|
+
}
|
|
12
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
|
+
}
|
|
13
55
|
export interface Domain {
|
|
14
56
|
/**
|
|
15
57
|
* example:
|
|
@@ -17,6 +59,22 @@ declare namespace Components {
|
|
|
17
59
|
*/
|
|
18
60
|
domain?: string;
|
|
19
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
|
+
}
|
|
20
78
|
/**
|
|
21
79
|
* Setting that allows to add an email address on the custom domain. For e.g; john@doe.com
|
|
22
80
|
*/
|
|
@@ -25,6 +83,13 @@ declare namespace Components {
|
|
|
25
83
|
* Setting that allows to add a custom domain. For e.g; doe.com
|
|
26
84
|
*/
|
|
27
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
|
+
}
|
|
28
93
|
/**
|
|
29
94
|
* - Restrict duplicates within:
|
|
30
95
|
* * 10s
|
|
@@ -39,6 +104,9 @@ declare namespace Components {
|
|
|
39
104
|
*
|
|
40
105
|
*/
|
|
41
106
|
export type RestrictDuplicatesWithinSetting = "restrict_duplicates_within";
|
|
107
|
+
export interface SetEmailAddressPrimaryPayload {
|
|
108
|
+
address: string;
|
|
109
|
+
}
|
|
42
110
|
export interface Setting {
|
|
43
111
|
[name: string]: any;
|
|
44
112
|
id?: string;
|
|
@@ -52,6 +120,13 @@ declare namespace Components {
|
|
|
52
120
|
created_by?: string;
|
|
53
121
|
updated_by?: string;
|
|
54
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
|
+
}
|
|
55
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 | /**
|
|
56
131
|
* - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
|
|
57
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.
|
|
@@ -72,10 +147,35 @@ declare namespace Components {
|
|
|
72
147
|
*/
|
|
73
148
|
RestrictDuplicatesWithinSetting;
|
|
74
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
|
+
}
|
|
75
161
|
/**
|
|
76
162
|
* Setting that allows to add a signature.
|
|
77
163
|
*/
|
|
78
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
|
+
}
|
|
79
179
|
/**
|
|
80
180
|
* - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
|
|
81
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.
|
|
@@ -95,6 +195,16 @@ declare namespace Paths {
|
|
|
95
195
|
}
|
|
96
196
|
}
|
|
97
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
|
+
}
|
|
98
208
|
namespace AddSetting {
|
|
99
209
|
export type RequestBody = Components.Schemas.Setting;
|
|
100
210
|
namespace Responses {
|
|
@@ -105,6 +215,16 @@ declare namespace Paths {
|
|
|
105
215
|
}
|
|
106
216
|
}
|
|
107
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
|
+
}
|
|
108
228
|
namespace DeleteDomain {
|
|
109
229
|
export type RequestBody = Components.Schemas.Domain;
|
|
110
230
|
namespace Responses {
|
|
@@ -116,6 +236,20 @@ declare namespace Paths {
|
|
|
116
236
|
}
|
|
117
237
|
}
|
|
118
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
|
+
}
|
|
119
253
|
namespace DeleteSetting {
|
|
120
254
|
export interface RequestBody {
|
|
121
255
|
type: Components.Schemas.SettingType;
|
|
@@ -134,6 +268,33 @@ declare namespace Paths {
|
|
|
134
268
|
}
|
|
135
269
|
}
|
|
136
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
|
+
}
|
|
137
298
|
namespace GetSettings {
|
|
138
299
|
namespace Parameters {
|
|
139
300
|
export type Id = string;
|
|
@@ -151,6 +312,70 @@ declare namespace Paths {
|
|
|
151
312
|
}
|
|
152
313
|
}
|
|
153
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
|
+
}
|
|
154
379
|
namespace UpdateSetting {
|
|
155
380
|
namespace Parameters {
|
|
156
381
|
export type Id = string;
|
|
@@ -167,6 +392,23 @@ declare namespace Paths {
|
|
|
167
392
|
}
|
|
168
393
|
}
|
|
169
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
|
+
}
|
|
170
412
|
namespace VerifyDomain {
|
|
171
413
|
export type RequestBody = Components.Schemas.Domain;
|
|
172
414
|
namespace Responses {
|
|
@@ -191,6 +433,126 @@ declare namespace Paths {
|
|
|
191
433
|
|
|
192
434
|
|
|
193
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>
|
|
194
556
|
/**
|
|
195
557
|
* getSettings - getSettings
|
|
196
558
|
*
|
|
@@ -274,6 +636,138 @@ export interface OperationMethods {
|
|
|
274
636
|
}
|
|
275
637
|
|
|
276
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
|
+
}
|
|
277
771
|
['/v1/email-settings']: {
|
|
278
772
|
/**
|
|
279
773
|
* getSettings - getSettings
|
|
@@ -369,12 +863,22 @@ export interface PathsDictionary {
|
|
|
369
863
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
370
864
|
|
|
371
865
|
|
|
866
|
+
export type CreateEmailAddressPayload = Components.Schemas.CreateEmailAddressPayload;
|
|
867
|
+
export type CreateSharedInboxPayload = Components.Schemas.CreateSharedInboxPayload;
|
|
372
868
|
export type Domain = Components.Schemas.Domain;
|
|
869
|
+
export type EmailAddressResponse = Components.Schemas.EmailAddressResponse;
|
|
373
870
|
export type EmailAddressSetting = Components.Schemas.EmailAddressSetting;
|
|
374
871
|
export type EmailDomainSetting = Components.Schemas.EmailDomainSetting;
|
|
872
|
+
export type ErrorResponse = Components.Schemas.ErrorResponse;
|
|
873
|
+
export type ProvisionEpilotEmailAddressPayload = Components.Schemas.ProvisionEpilotEmailAddressPayload;
|
|
375
874
|
export type RestrictDuplicatesWithinSetting = Components.Schemas.RestrictDuplicatesWithinSetting;
|
|
875
|
+
export type SetEmailAddressPrimaryPayload = Components.Schemas.SetEmailAddressPrimaryPayload;
|
|
376
876
|
export type Setting = Components.Schemas.Setting;
|
|
877
|
+
export type SettingMeta = Components.Schemas.SettingMeta;
|
|
377
878
|
export type SettingType = Components.Schemas.SettingType;
|
|
378
879
|
export type SettingsResponse = Components.Schemas.SettingsResponse;
|
|
880
|
+
export type SharedInboxResponse = Components.Schemas.SharedInboxResponse;
|
|
379
881
|
export type SignatureSetting = Components.Schemas.SignatureSetting;
|
|
882
|
+
export type UpdateEmailAddressPayload = Components.Schemas.UpdateEmailAddressPayload;
|
|
883
|
+
export type UpdateSharedInboxPayload = Components.Schemas.UpdateSharedInboxPayload;
|
|
380
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.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "API Client for epilot Email Settings API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -18,6 +18,18 @@
|
|
|
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
|
+
},
|
|
21
33
|
"files": [
|
|
22
34
|
"*.js",
|
|
23
35
|
"*.d.ts",
|
|
@@ -48,26 +60,15 @@
|
|
|
48
60
|
"@types/jest": "^26.0.20",
|
|
49
61
|
"axios": "^1.11.0",
|
|
50
62
|
"copy-webpack-plugin": "^7.0.0",
|
|
51
|
-
"jest": "^
|
|
63
|
+
"jest": "^29.6.2",
|
|
52
64
|
"json-loader": "^0.5.7",
|
|
53
65
|
"openapicmd": "^2.7.0",
|
|
54
|
-
"ts-jest": "^
|
|
66
|
+
"ts-jest": "^29.4.1",
|
|
55
67
|
"ts-loader": "^8.0.14",
|
|
56
68
|
"ts-node": "^10.9.1",
|
|
57
69
|
"typescript": "^4.1.3",
|
|
58
70
|
"webpack": "^5.18.0",
|
|
59
71
|
"webpack-cli": "^4.4.0"
|
|
60
72
|
},
|
|
61
|
-
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
62
|
-
|
|
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
|
-
}
|
|
73
|
+
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
74
|
+
}
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
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.
|
package/src/openapi.d.ts
DELETED
|
@@ -1,380 +0,0 @@
|
|
|
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 Schemas {
|
|
13
|
-
export interface Domain {
|
|
14
|
-
/**
|
|
15
|
-
* example:
|
|
16
|
-
* subdomain.epilot.cloud
|
|
17
|
-
*/
|
|
18
|
-
domain?: string;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Setting that allows to add an email address on the custom domain. For e.g; john@doe.com
|
|
22
|
-
*/
|
|
23
|
-
export type EmailAddressSetting = "email_address";
|
|
24
|
-
/**
|
|
25
|
-
* Setting that allows to add a custom domain. For e.g; doe.com
|
|
26
|
-
*/
|
|
27
|
-
export type EmailDomainSetting = "email_domain";
|
|
28
|
-
/**
|
|
29
|
-
* - Restrict duplicates within:
|
|
30
|
-
* * 10s
|
|
31
|
-
* * 5m
|
|
32
|
-
* * 1d
|
|
33
|
-
* * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.
|
|
34
|
-
* - Defaults to 3 minutes
|
|
35
|
-
* - Negative values will be treated same as positive values
|
|
36
|
-
* - If not set, defaults to 3 min
|
|
37
|
-
* - If set as 0, then the no email will be treated as a duplicate
|
|
38
|
-
* - Cannot have multiple values
|
|
39
|
-
*
|
|
40
|
-
*/
|
|
41
|
-
export type RestrictDuplicatesWithinSetting = "restrict_duplicates_within";
|
|
42
|
-
export interface Setting {
|
|
43
|
-
[name: string]: any;
|
|
44
|
-
id?: string;
|
|
45
|
-
name?: string;
|
|
46
|
-
org_id?: string;
|
|
47
|
-
type: SettingType;
|
|
48
|
-
value?: string;
|
|
49
|
-
html?: string;
|
|
50
|
-
created_at?: string;
|
|
51
|
-
updated_at?: string;
|
|
52
|
-
created_by?: string;
|
|
53
|
-
updated_by?: string;
|
|
54
|
-
}
|
|
55
|
-
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 | /**
|
|
56
|
-
* - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
|
|
57
|
-
* - 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.
|
|
58
|
-
*
|
|
59
|
-
*/
|
|
60
|
-
WhitelistEmailAddressSetting | /**
|
|
61
|
-
* - Restrict duplicates within:
|
|
62
|
-
* * 10s
|
|
63
|
-
* * 5m
|
|
64
|
-
* * 1d
|
|
65
|
-
* * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.
|
|
66
|
-
* - Defaults to 3 minutes
|
|
67
|
-
* - Negative values will be treated same as positive values
|
|
68
|
-
* - If not set, defaults to 3 min
|
|
69
|
-
* - If set as 0, then the no email will be treated as a duplicate
|
|
70
|
-
* - Cannot have multiple values
|
|
71
|
-
*
|
|
72
|
-
*/
|
|
73
|
-
RestrictDuplicatesWithinSetting;
|
|
74
|
-
export type SettingsResponse = Setting[] | Setting;
|
|
75
|
-
/**
|
|
76
|
-
* Setting that allows to add a signature.
|
|
77
|
-
*/
|
|
78
|
-
export type SignatureSetting = "signature";
|
|
79
|
-
/**
|
|
80
|
-
* - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
|
|
81
|
-
* - 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.
|
|
82
|
-
*
|
|
83
|
-
*/
|
|
84
|
-
export type WhitelistEmailAddressSetting = "whitelist_email_address";
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
declare namespace Paths {
|
|
88
|
-
namespace AddDomain {
|
|
89
|
-
export type RequestBody = Components.Schemas.Domain;
|
|
90
|
-
namespace Responses {
|
|
91
|
-
export type $200 = Components.Schemas.SettingsResponse;
|
|
92
|
-
export interface $403 {
|
|
93
|
-
}
|
|
94
|
-
export interface $404 {
|
|
95
|
-
}
|
|
96
|
-
}
|
|
97
|
-
}
|
|
98
|
-
namespace AddSetting {
|
|
99
|
-
export type RequestBody = Components.Schemas.Setting;
|
|
100
|
-
namespace Responses {
|
|
101
|
-
export type $200 = Components.Schemas.SettingsResponse;
|
|
102
|
-
export interface $403 {
|
|
103
|
-
}
|
|
104
|
-
export interface $404 {
|
|
105
|
-
}
|
|
106
|
-
}
|
|
107
|
-
}
|
|
108
|
-
namespace DeleteDomain {
|
|
109
|
-
export type RequestBody = Components.Schemas.Domain;
|
|
110
|
-
namespace Responses {
|
|
111
|
-
export interface $204 {
|
|
112
|
-
}
|
|
113
|
-
export interface $403 {
|
|
114
|
-
}
|
|
115
|
-
export interface $404 {
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
namespace DeleteSetting {
|
|
120
|
-
export interface RequestBody {
|
|
121
|
-
type: Components.Schemas.SettingType;
|
|
122
|
-
/**
|
|
123
|
-
* ID of setting
|
|
124
|
-
* example:
|
|
125
|
-
* a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
|
|
126
|
-
*/
|
|
127
|
-
id: string;
|
|
128
|
-
}
|
|
129
|
-
namespace Responses {
|
|
130
|
-
export type $200 = Components.Schemas.Setting;
|
|
131
|
-
export interface $403 {
|
|
132
|
-
}
|
|
133
|
-
export interface $404 {
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
}
|
|
137
|
-
namespace GetSettings {
|
|
138
|
-
namespace Parameters {
|
|
139
|
-
export type Id = string;
|
|
140
|
-
export type Type = Components.Schemas.SettingType;
|
|
141
|
-
}
|
|
142
|
-
export interface QueryParameters {
|
|
143
|
-
type: Parameters.Type;
|
|
144
|
-
id?: Parameters.Id;
|
|
145
|
-
}
|
|
146
|
-
namespace Responses {
|
|
147
|
-
export type $200 = Components.Schemas.SettingsResponse;
|
|
148
|
-
export interface $403 {
|
|
149
|
-
}
|
|
150
|
-
export interface $404 {
|
|
151
|
-
}
|
|
152
|
-
}
|
|
153
|
-
}
|
|
154
|
-
namespace UpdateSetting {
|
|
155
|
-
namespace Parameters {
|
|
156
|
-
export type Id = string;
|
|
157
|
-
}
|
|
158
|
-
export interface PathParameters {
|
|
159
|
-
id: Parameters.Id;
|
|
160
|
-
}
|
|
161
|
-
export type RequestBody = Components.Schemas.Setting;
|
|
162
|
-
namespace Responses {
|
|
163
|
-
export type $200 = Components.Schemas.Setting;
|
|
164
|
-
export interface $403 {
|
|
165
|
-
}
|
|
166
|
-
export interface $404 {
|
|
167
|
-
}
|
|
168
|
-
}
|
|
169
|
-
}
|
|
170
|
-
namespace VerifyDomain {
|
|
171
|
-
export type RequestBody = Components.Schemas.Domain;
|
|
172
|
-
namespace Responses {
|
|
173
|
-
export type $200 = Components.Schemas.SettingsResponse;
|
|
174
|
-
export interface $403 {
|
|
175
|
-
}
|
|
176
|
-
export interface $404 {
|
|
177
|
-
}
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
namespace VerifyNameServers {
|
|
181
|
-
export type RequestBody = Components.Schemas.Domain;
|
|
182
|
-
namespace Responses {
|
|
183
|
-
export type $200 = Components.Schemas.SettingsResponse;
|
|
184
|
-
export interface $403 {
|
|
185
|
-
}
|
|
186
|
-
export interface $404 {
|
|
187
|
-
}
|
|
188
|
-
}
|
|
189
|
-
}
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
export interface OperationMethods {
|
|
194
|
-
/**
|
|
195
|
-
* getSettings - getSettings
|
|
196
|
-
*
|
|
197
|
-
* Get all settings by type
|
|
198
|
-
*/
|
|
199
|
-
'getSettings'(
|
|
200
|
-
parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
|
|
201
|
-
data?: any,
|
|
202
|
-
config?: AxiosRequestConfig
|
|
203
|
-
): OperationResponse<Paths.GetSettings.Responses.$200>
|
|
204
|
-
/**
|
|
205
|
-
* addSetting - addSetting
|
|
206
|
-
*
|
|
207
|
-
* Add setting
|
|
208
|
-
*/
|
|
209
|
-
'addSetting'(
|
|
210
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
211
|
-
data?: Paths.AddSetting.RequestBody,
|
|
212
|
-
config?: AxiosRequestConfig
|
|
213
|
-
): OperationResponse<Paths.AddSetting.Responses.$200>
|
|
214
|
-
/**
|
|
215
|
-
* deleteSetting - deleteSetting
|
|
216
|
-
*
|
|
217
|
-
* delete setting by ID and type
|
|
218
|
-
*/
|
|
219
|
-
'deleteSetting'(
|
|
220
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
221
|
-
data?: Paths.DeleteSetting.RequestBody,
|
|
222
|
-
config?: AxiosRequestConfig
|
|
223
|
-
): OperationResponse<Paths.DeleteSetting.Responses.$200>
|
|
224
|
-
/**
|
|
225
|
-
* updateSetting - updateSetting
|
|
226
|
-
*
|
|
227
|
-
* Update setting by ID
|
|
228
|
-
*/
|
|
229
|
-
'updateSetting'(
|
|
230
|
-
parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
|
|
231
|
-
data?: Paths.UpdateSetting.RequestBody,
|
|
232
|
-
config?: AxiosRequestConfig
|
|
233
|
-
): OperationResponse<Paths.UpdateSetting.Responses.$200>
|
|
234
|
-
/**
|
|
235
|
-
* addDomain - addDomain
|
|
236
|
-
*
|
|
237
|
-
* Add domain
|
|
238
|
-
*/
|
|
239
|
-
'addDomain'(
|
|
240
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
241
|
-
data?: Paths.AddDomain.RequestBody,
|
|
242
|
-
config?: AxiosRequestConfig
|
|
243
|
-
): OperationResponse<Paths.AddDomain.Responses.$200>
|
|
244
|
-
/**
|
|
245
|
-
* deleteDomain - deleteDomain
|
|
246
|
-
*
|
|
247
|
-
* Delete domain
|
|
248
|
-
*/
|
|
249
|
-
'deleteDomain'(
|
|
250
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
251
|
-
data?: Paths.DeleteDomain.RequestBody,
|
|
252
|
-
config?: AxiosRequestConfig
|
|
253
|
-
): OperationResponse<Paths.DeleteDomain.Responses.$204>
|
|
254
|
-
/**
|
|
255
|
-
* verifyNameServers - verifyNameServers
|
|
256
|
-
*
|
|
257
|
-
* Verify name servers
|
|
258
|
-
*/
|
|
259
|
-
'verifyNameServers'(
|
|
260
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
261
|
-
data?: Paths.VerifyNameServers.RequestBody,
|
|
262
|
-
config?: AxiosRequestConfig
|
|
263
|
-
): OperationResponse<Paths.VerifyNameServers.Responses.$200>
|
|
264
|
-
/**
|
|
265
|
-
* verifyDomain - verifyDomain
|
|
266
|
-
*
|
|
267
|
-
* Verify domain
|
|
268
|
-
*/
|
|
269
|
-
'verifyDomain'(
|
|
270
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
271
|
-
data?: Paths.VerifyDomain.RequestBody,
|
|
272
|
-
config?: AxiosRequestConfig
|
|
273
|
-
): OperationResponse<Paths.VerifyDomain.Responses.$200>
|
|
274
|
-
}
|
|
275
|
-
|
|
276
|
-
export interface PathsDictionary {
|
|
277
|
-
['/v1/email-settings']: {
|
|
278
|
-
/**
|
|
279
|
-
* getSettings - getSettings
|
|
280
|
-
*
|
|
281
|
-
* Get all settings by type
|
|
282
|
-
*/
|
|
283
|
-
'get'(
|
|
284
|
-
parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
|
|
285
|
-
data?: any,
|
|
286
|
-
config?: AxiosRequestConfig
|
|
287
|
-
): OperationResponse<Paths.GetSettings.Responses.$200>
|
|
288
|
-
/**
|
|
289
|
-
* addSetting - addSetting
|
|
290
|
-
*
|
|
291
|
-
* Add setting
|
|
292
|
-
*/
|
|
293
|
-
'post'(
|
|
294
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
295
|
-
data?: Paths.AddSetting.RequestBody,
|
|
296
|
-
config?: AxiosRequestConfig
|
|
297
|
-
): OperationResponse<Paths.AddSetting.Responses.$200>
|
|
298
|
-
/**
|
|
299
|
-
* deleteSetting - deleteSetting
|
|
300
|
-
*
|
|
301
|
-
* delete setting by ID and type
|
|
302
|
-
*/
|
|
303
|
-
'delete'(
|
|
304
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
305
|
-
data?: Paths.DeleteSetting.RequestBody,
|
|
306
|
-
config?: AxiosRequestConfig
|
|
307
|
-
): OperationResponse<Paths.DeleteSetting.Responses.$200>
|
|
308
|
-
}
|
|
309
|
-
['/v1/email-settings/{id}']: {
|
|
310
|
-
/**
|
|
311
|
-
* updateSetting - updateSetting
|
|
312
|
-
*
|
|
313
|
-
* Update setting by ID
|
|
314
|
-
*/
|
|
315
|
-
'post'(
|
|
316
|
-
parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
|
|
317
|
-
data?: Paths.UpdateSetting.RequestBody,
|
|
318
|
-
config?: AxiosRequestConfig
|
|
319
|
-
): OperationResponse<Paths.UpdateSetting.Responses.$200>
|
|
320
|
-
}
|
|
321
|
-
['/v1/email-settings/domain']: {
|
|
322
|
-
/**
|
|
323
|
-
* addDomain - addDomain
|
|
324
|
-
*
|
|
325
|
-
* Add domain
|
|
326
|
-
*/
|
|
327
|
-
'post'(
|
|
328
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
329
|
-
data?: Paths.AddDomain.RequestBody,
|
|
330
|
-
config?: AxiosRequestConfig
|
|
331
|
-
): OperationResponse<Paths.AddDomain.Responses.$200>
|
|
332
|
-
/**
|
|
333
|
-
* deleteDomain - deleteDomain
|
|
334
|
-
*
|
|
335
|
-
* Delete domain
|
|
336
|
-
*/
|
|
337
|
-
'delete'(
|
|
338
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
339
|
-
data?: Paths.DeleteDomain.RequestBody,
|
|
340
|
-
config?: AxiosRequestConfig
|
|
341
|
-
): OperationResponse<Paths.DeleteDomain.Responses.$204>
|
|
342
|
-
}
|
|
343
|
-
['/v1/email-settings/domain/name-servers:verify']: {
|
|
344
|
-
/**
|
|
345
|
-
* verifyNameServers - verifyNameServers
|
|
346
|
-
*
|
|
347
|
-
* Verify name servers
|
|
348
|
-
*/
|
|
349
|
-
'post'(
|
|
350
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
351
|
-
data?: Paths.VerifyNameServers.RequestBody,
|
|
352
|
-
config?: AxiosRequestConfig
|
|
353
|
-
): OperationResponse<Paths.VerifyNameServers.Responses.$200>
|
|
354
|
-
}
|
|
355
|
-
['/v1/email-settings/domain:verify']: {
|
|
356
|
-
/**
|
|
357
|
-
* verifyDomain - verifyDomain
|
|
358
|
-
*
|
|
359
|
-
* Verify domain
|
|
360
|
-
*/
|
|
361
|
-
'post'(
|
|
362
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
363
|
-
data?: Paths.VerifyDomain.RequestBody,
|
|
364
|
-
config?: AxiosRequestConfig
|
|
365
|
-
): OperationResponse<Paths.VerifyDomain.Responses.$200>
|
|
366
|
-
}
|
|
367
|
-
}
|
|
368
|
-
|
|
369
|
-
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
export type Domain = Components.Schemas.Domain;
|
|
373
|
-
export type EmailAddressSetting = Components.Schemas.EmailAddressSetting;
|
|
374
|
-
export type EmailDomainSetting = Components.Schemas.EmailDomainSetting;
|
|
375
|
-
export type RestrictDuplicatesWithinSetting = Components.Schemas.RestrictDuplicatesWithinSetting;
|
|
376
|
-
export type Setting = Components.Schemas.Setting;
|
|
377
|
-
export type SettingType = Components.Schemas.SettingType;
|
|
378
|
-
export type SettingsResponse = Components.Schemas.SettingsResponse;
|
|
379
|
-
export type SignatureSetting = Components.Schemas.SignatureSetting;
|
|
380
|
-
export type WhitelistEmailAddressSetting = Components.Schemas.WhitelistEmailAddressSetting;
|