simplelogin-client 0.1.7 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/README.md +16 -13
  2. package/docs/development.md +1 -1
  3. package/docs/faq.md +10 -11
  4. package/package.json +17 -20
  5. package/tscBuild/config.d.ts +26 -0
  6. package/tscBuild/config.js +22 -0
  7. package/tscBuild/config.js.map +1 -0
  8. package/tscBuild/index.d.ts +2 -1
  9. package/tscBuild/index.js +4 -13
  10. package/tscBuild/index.js.map +1 -1
  11. package/tscBuild/sdk/apis/AccountApi.d.ts +177 -0
  12. package/tscBuild/sdk/apis/AccountApi.js +409 -0
  13. package/tscBuild/sdk/apis/AccountApi.js.map +1 -0
  14. package/tscBuild/sdk/apis/AliasApi.d.ts +181 -0
  15. package/tscBuild/sdk/apis/AliasApi.js +421 -0
  16. package/tscBuild/sdk/apis/AliasApi.js.map +1 -0
  17. package/tscBuild/sdk/apis/CustomDomainApi.d.ts +33 -0
  18. package/tscBuild/sdk/apis/CustomDomainApi.js +77 -0
  19. package/tscBuild/sdk/apis/CustomDomainApi.js.map +1 -0
  20. package/tscBuild/sdk/apis/MailboxApi.d.ts +70 -0
  21. package/tscBuild/sdk/apis/MailboxApi.js +166 -0
  22. package/tscBuild/sdk/apis/MailboxApi.js.map +1 -0
  23. package/tscBuild/sdk/apis/index.d.ts +4 -0
  24. package/tscBuild/sdk/apis/index.js +23 -0
  25. package/tscBuild/sdk/apis/index.js.map +1 -0
  26. package/tscBuild/sdk/index.d.ts +3 -13
  27. package/tscBuild/sdk/index.js +5 -13
  28. package/tscBuild/sdk/index.js.map +1 -1
  29. package/tscBuild/sdk/models/Alias.d.ts +112 -0
  30. package/tscBuild/sdk/models/Alias.js +85 -0
  31. package/tscBuild/sdk/models/Alias.js.map +1 -0
  32. package/tscBuild/sdk/models/AliasAliasIdActivities.d.ts +50 -0
  33. package/tscBuild/sdk/models/AliasAliasIdActivities.js +53 -0
  34. package/tscBuild/sdk/models/AliasAliasIdActivities.js.map +1 -0
  35. package/tscBuild/sdk/models/AliasAliasIdActivitiesModelArray.d.ts +21 -0
  36. package/tscBuild/sdk/models/AliasAliasIdActivitiesModelArray.js +52 -0
  37. package/tscBuild/sdk/models/AliasAliasIdActivitiesModelArray.js.map +1 -0
  38. package/tscBuild/sdk/models/AliasAliasIdContacts.d.ts +68 -0
  39. package/tscBuild/sdk/models/AliasAliasIdContacts.js +72 -0
  40. package/tscBuild/sdk/models/AliasAliasIdContacts.js.map +1 -0
  41. package/tscBuild/sdk/models/AliasAliasIdContactsModelArray.d.ts +21 -0
  42. package/tscBuild/sdk/models/AliasAliasIdContactsModelArray.js +52 -0
  43. package/tscBuild/sdk/models/AliasAliasIdContactsModelArray.js.map +1 -0
  44. package/tscBuild/sdk/models/AliasAliasIdContactsPost.d.ts +20 -0
  45. package/tscBuild/sdk/models/AliasAliasIdContactsPost.js +38 -0
  46. package/tscBuild/sdk/models/AliasAliasIdContactsPost.js.map +1 -0
  47. package/tscBuild/sdk/models/AliasAliasIdDelete.d.ts +20 -0
  48. package/tscBuild/sdk/models/AliasAliasIdDelete.js +51 -0
  49. package/tscBuild/sdk/models/AliasAliasIdDelete.js.map +1 -0
  50. package/tscBuild/sdk/models/AliasAliasIdPatch.d.ts +50 -0
  51. package/tscBuild/sdk/models/AliasAliasIdPatch.js +61 -0
  52. package/tscBuild/sdk/models/AliasAliasIdPatch.js.map +1 -0
  53. package/tscBuild/sdk/models/AliasAliasIdTogglePost.d.ts +20 -0
  54. package/tscBuild/sdk/models/AliasAliasIdTogglePost.js +51 -0
  55. package/tscBuild/sdk/models/AliasAliasIdTogglePost.js.map +1 -0
  56. package/tscBuild/sdk/models/AliasCustomNewPost.d.ts +44 -0
  57. package/tscBuild/sdk/models/AliasCustomNewPost.js +62 -0
  58. package/tscBuild/sdk/models/AliasCustomNewPost.js.map +1 -0
  59. package/tscBuild/sdk/models/AliasLatestActivity.d.ts +33 -0
  60. package/tscBuild/sdk/models/AliasLatestActivity.js +45 -0
  61. package/tscBuild/sdk/models/AliasLatestActivity.js.map +1 -0
  62. package/tscBuild/sdk/models/AliasLatestActivityContact.d.ts +32 -0
  63. package/tscBuild/sdk/models/AliasLatestActivityContact.js +44 -0
  64. package/tscBuild/sdk/models/AliasLatestActivityContact.js.map +1 -0
  65. package/tscBuild/sdk/models/AliasModelArray.d.ts +21 -0
  66. package/tscBuild/sdk/models/AliasModelArray.js +52 -0
  67. package/tscBuild/sdk/models/AliasModelArray.js.map +1 -0
  68. package/tscBuild/sdk/models/AliasOptions.d.ts +40 -0
  69. package/tscBuild/sdk/models/AliasOptions.js +62 -0
  70. package/tscBuild/sdk/models/AliasOptions.js.map +1 -0
  71. package/tscBuild/sdk/models/AliasOptionsRecommendation.d.ts +26 -0
  72. package/tscBuild/sdk/models/AliasOptionsRecommendation.js +41 -0
  73. package/tscBuild/sdk/models/AliasOptionsRecommendation.js.map +1 -0
  74. package/tscBuild/sdk/models/AliasOptionsSuffixesInner.d.ts +38 -0
  75. package/tscBuild/sdk/models/AliasOptionsSuffixesInner.js +47 -0
  76. package/tscBuild/sdk/models/AliasOptionsSuffixesInner.js.map +1 -0
  77. package/tscBuild/sdk/models/AliasRandomNewPost.d.ts +20 -0
  78. package/tscBuild/sdk/models/AliasRandomNewPost.js +51 -0
  79. package/tscBuild/sdk/models/AliasRandomNewPost.js.map +1 -0
  80. package/tscBuild/sdk/models/AuthActivatePost.d.ts +26 -0
  81. package/tscBuild/sdk/models/AuthActivatePost.js +41 -0
  82. package/tscBuild/sdk/models/AuthActivatePost.js.map +1 -0
  83. package/tscBuild/sdk/models/AuthForgotPasswordPost.d.ts +20 -0
  84. package/tscBuild/sdk/models/AuthForgotPasswordPost.js +38 -0
  85. package/tscBuild/sdk/models/AuthForgotPasswordPost.js.map +1 -0
  86. package/tscBuild/sdk/models/AuthLogin.d.ts +44 -0
  87. package/tscBuild/sdk/models/AuthLogin.js +50 -0
  88. package/tscBuild/sdk/models/AuthLogin.js.map +1 -0
  89. package/tscBuild/sdk/models/AuthLoginPost.d.ts +32 -0
  90. package/tscBuild/sdk/models/AuthLoginPost.js +44 -0
  91. package/tscBuild/sdk/models/AuthLoginPost.js.map +1 -0
  92. package/tscBuild/sdk/models/AuthMfa.d.ts +32 -0
  93. package/tscBuild/sdk/models/AuthMfa.js +44 -0
  94. package/tscBuild/sdk/models/AuthMfa.js.map +1 -0
  95. package/tscBuild/sdk/models/AuthMfaPost.d.ts +32 -0
  96. package/tscBuild/sdk/models/AuthMfaPost.js +44 -0
  97. package/tscBuild/sdk/models/AuthMfaPost.js.map +1 -0
  98. package/tscBuild/sdk/models/AuthReactivatePost.d.ts +20 -0
  99. package/tscBuild/sdk/models/AuthReactivatePost.js +38 -0
  100. package/tscBuild/sdk/models/AuthReactivatePost.js.map +1 -0
  101. package/tscBuild/sdk/models/AuthRegisterPost.d.ts +26 -0
  102. package/tscBuild/sdk/models/AuthRegisterPost.js +41 -0
  103. package/tscBuild/sdk/models/AuthRegisterPost.js.map +1 -0
  104. package/tscBuild/sdk/models/CustomDomain.d.ts +75 -0
  105. package/tscBuild/sdk/models/CustomDomain.js +66 -0
  106. package/tscBuild/sdk/models/CustomDomain.js.map +1 -0
  107. package/tscBuild/sdk/models/Mailbox.d.ts +50 -0
  108. package/tscBuild/sdk/models/Mailbox.js +53 -0
  109. package/tscBuild/sdk/models/Mailbox.js.map +1 -0
  110. package/tscBuild/sdk/models/MailboxMailboxIdPut.d.ts +32 -0
  111. package/tscBuild/sdk/models/MailboxMailboxIdPut.js +55 -0
  112. package/tscBuild/sdk/models/MailboxMailboxIdPut.js.map +1 -0
  113. package/tscBuild/sdk/models/MailboxModelArray.d.ts +21 -0
  114. package/tscBuild/sdk/models/MailboxModelArray.js +52 -0
  115. package/tscBuild/sdk/models/MailboxModelArray.js.map +1 -0
  116. package/tscBuild/sdk/models/MailboxModelRef.d.ts +26 -0
  117. package/tscBuild/sdk/models/MailboxModelRef.js +41 -0
  118. package/tscBuild/sdk/models/MailboxModelRef.js.map +1 -0
  119. package/tscBuild/sdk/models/MailboxPost.d.ts +20 -0
  120. package/tscBuild/sdk/models/MailboxPost.js +51 -0
  121. package/tscBuild/sdk/models/MailboxPost.js.map +1 -0
  122. package/tscBuild/sdk/models/ModelError.d.ts +20 -0
  123. package/tscBuild/sdk/models/ModelError.js +51 -0
  124. package/tscBuild/sdk/models/ModelError.js.map +1 -0
  125. package/tscBuild/sdk/models/Success.d.ts +20 -0
  126. package/tscBuild/sdk/models/Success.js +38 -0
  127. package/tscBuild/sdk/models/Success.js.map +1 -0
  128. package/tscBuild/sdk/models/SudoPatch.d.ts +20 -0
  129. package/tscBuild/sdk/models/SudoPatch.js +51 -0
  130. package/tscBuild/sdk/models/SudoPatch.js.map +1 -0
  131. package/tscBuild/sdk/models/UserApiKey.d.ts +20 -0
  132. package/tscBuild/sdk/models/UserApiKey.js +38 -0
  133. package/tscBuild/sdk/models/UserApiKey.js.map +1 -0
  134. package/tscBuild/sdk/models/UserApiKeyPost.d.ts +20 -0
  135. package/tscBuild/sdk/models/UserApiKeyPost.js +38 -0
  136. package/tscBuild/sdk/models/UserApiKeyPost.js.map +1 -0
  137. package/tscBuild/sdk/models/UserCookieToken.d.ts +20 -0
  138. package/tscBuild/sdk/models/UserCookieToken.js +38 -0
  139. package/tscBuild/sdk/models/UserCookieToken.js.map +1 -0
  140. package/tscBuild/sdk/models/UserInfo.d.ts +50 -0
  141. package/tscBuild/sdk/models/UserInfo.js +53 -0
  142. package/tscBuild/sdk/models/UserInfo.js.map +1 -0
  143. package/tscBuild/sdk/models/UserInfoPatch.d.ts +26 -0
  144. package/tscBuild/sdk/models/UserInfoPatch.js +53 -0
  145. package/tscBuild/sdk/models/UserInfoPatch.js.map +1 -0
  146. package/tscBuild/sdk/models/index.d.ts +39 -0
  147. package/tscBuild/sdk/models/index.js +58 -0
  148. package/tscBuild/sdk/models/index.js.map +1 -0
  149. package/tscBuild/sdk/runtime.d.ts +190 -0
  150. package/tscBuild/sdk/runtime.js +338 -0
  151. package/tscBuild/sdk/runtime.js.map +1 -0
  152. package/tscBuild/tsconfig.build.tsbuildinfo +1 -1
  153. package/tscBuild/sdk/api.d.ts +0 -2173
  154. package/tscBuild/sdk/api.js +0 -2441
  155. package/tscBuild/sdk/api.js.map +0 -1
  156. package/tscBuild/sdk/configuration.d.ts +0 -55
  157. package/tscBuild/sdk/configuration.js +0 -59
  158. package/tscBuild/sdk/configuration.js.map +0 -1
@@ -1,2173 +0,0 @@
1
- /**
2
- * SimpleLogin (unofficial)
3
- * The unofficial SimpleLogin API docs as OpenAPI 3.0.0 spec. This is based on the official markdown based docs, but written in OpenAPI to allow for easier integration with other tools and generation of client SDKs. Please do not contact the SimpleLogin team for support or issues with this API documentation.
4
- *
5
- * OpenAPI spec version: 4.22.0
6
- * Contact: contact@ketrwu.de
7
- *
8
- * NOTE: This file is auto generated by the swagger code generator program.
9
- * https://github.com/swagger-api/swagger-codegen.git
10
- * Do not edit the file manually.
11
- */
12
- export type Response = any;
13
- import { Configuration } from "./configuration";
14
- export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
- export declare const COLLECTION_FORMATS: {
20
- csv: string;
21
- ssv: string;
22
- tsv: string;
23
- pipes: string;
24
- };
25
- /**
26
- *
27
- * @export
28
- * @interface FetchAPI
29
- */
30
- export interface FetchAPI {
31
- (url: string, init?: any): Promise<Response>;
32
- }
33
- /**
34
- *
35
- * @export
36
- * @interface FetchArgs
37
- */
38
- export interface FetchArgs {
39
- url: string;
40
- options: any;
41
- }
42
- /**
43
- *
44
- * @export
45
- * @class BaseAPI
46
- */
47
- export declare class BaseAPI {
48
- protected basePath: string;
49
- protected fetch: FetchAPI;
50
- protected configuration: Configuration;
51
- constructor(configuration?: Configuration, basePath?: string, fetch?: FetchAPI);
52
- }
53
- /**
54
- *
55
- * @export
56
- * @class RequiredError
57
- * @extends {Error}
58
- */
59
- export declare class RequiredError extends Error {
60
- field: string;
61
- name: "RequiredError";
62
- constructor(field: string, msg?: string);
63
- }
64
- /**
65
- *
66
- * @export
67
- * @interface Alias
68
- */
69
- export interface Alias {
70
- /**
71
- *
72
- * @type {Date}
73
- * @memberof Alias
74
- */
75
- creationDate: Date;
76
- /**
77
- *
78
- * @type {number}
79
- * @memberof Alias
80
- */
81
- creationTimestamp: number;
82
- /**
83
- *
84
- * @type {Email}
85
- * @memberof Alias
86
- */
87
- email: Email;
88
- /**
89
- *
90
- * @type {string}
91
- * @memberof Alias
92
- */
93
- name: string;
94
- /**
95
- *
96
- * @type {boolean}
97
- * @memberof Alias
98
- */
99
- enabled: boolean;
100
- /**
101
- *
102
- * @type {number}
103
- * @memberof Alias
104
- */
105
- id: number;
106
- /**
107
- *
108
- * @type {MailboxModelRef}
109
- * @memberof Alias
110
- */
111
- mailbox: MailboxModelRef;
112
- /**
113
- *
114
- * @type {Array<MailboxModelRef>}
115
- * @memberof Alias
116
- */
117
- mailboxes: Array<MailboxModelRef>;
118
- /**
119
- *
120
- * @type {AliasLatestActivity}
121
- * @memberof Alias
122
- */
123
- latestActivity: AliasLatestActivity;
124
- /**
125
- *
126
- * @type {number}
127
- * @memberof Alias
128
- */
129
- nbBlock: number;
130
- /**
131
- *
132
- * @type {number}
133
- * @memberof Alias
134
- */
135
- nbForward: number;
136
- /**
137
- *
138
- * @type {number}
139
- * @memberof Alias
140
- */
141
- nbReply: number;
142
- /**
143
- *
144
- * @type {string}
145
- * @memberof Alias
146
- */
147
- note: string;
148
- /**
149
- *
150
- * @type {boolean}
151
- * @memberof Alias
152
- */
153
- pinned: boolean;
154
- /**
155
- *
156
- * @type {boolean}
157
- * @memberof Alias
158
- */
159
- disablePgp: boolean;
160
- /**
161
- *
162
- * @type {boolean}
163
- * @memberof Alias
164
- */
165
- supportPgp: boolean;
166
- }
167
- /**
168
- *
169
- * @export
170
- * @interface AliasAliasIdActivities
171
- */
172
- export interface AliasAliasIdActivities {
173
- /**
174
- *
175
- * @type {string}
176
- * @memberof AliasAliasIdActivities
177
- */
178
- action: string;
179
- /**
180
- *
181
- * @type {string}
182
- * @memberof AliasAliasIdActivities
183
- */
184
- from: string;
185
- /**
186
- *
187
- * @type {UnixTimestamp}
188
- * @memberof AliasAliasIdActivities
189
- */
190
- timestamp: UnixTimestamp;
191
- /**
192
- *
193
- * @type {string}
194
- * @memberof AliasAliasIdActivities
195
- */
196
- to: string;
197
- /**
198
- *
199
- * @type {string}
200
- * @memberof AliasAliasIdActivities
201
- */
202
- reverseAlias: string;
203
- /**
204
- *
205
- * @type {string}
206
- * @memberof AliasAliasIdActivities
207
- */
208
- reverseAliasAddress: string;
209
- }
210
- /**
211
- *
212
- * @export
213
- * @interface AliasAliasIdActivitiesModelArray
214
- */
215
- export interface AliasAliasIdActivitiesModelArray {
216
- /**
217
- *
218
- * @type {Array<AliasAliasIdActivities>}
219
- * @memberof AliasAliasIdActivitiesModelArray
220
- */
221
- activities?: Array<AliasAliasIdActivities>;
222
- }
223
- /**
224
- *
225
- * @export
226
- * @interface AliasAliasIdContacts
227
- */
228
- export interface AliasAliasIdContacts {
229
- /**
230
- * Unique identifier for the email address.
231
- * @type {number}
232
- * @memberof AliasAliasIdContacts
233
- */
234
- id: number;
235
- /**
236
- * Email address for the contact.
237
- * @type {string}
238
- * @memberof AliasAliasIdContacts
239
- */
240
- contact: string;
241
- /**
242
- *
243
- * @type {Date}
244
- * @memberof AliasAliasIdContacts
245
- */
246
- creationDate: Date;
247
- /**
248
- *
249
- * @type {UnixTimestamp}
250
- * @memberof AliasAliasIdContacts
251
- */
252
- creationTimestamp: UnixTimestamp;
253
- /**
254
- *
255
- * @type {Date}
256
- * @memberof AliasAliasIdContacts
257
- */
258
- lastEmailSentDate?: Date;
259
- /**
260
- * Unix timestamp when the last email was sent.
261
- * @type {number}
262
- * @memberof AliasAliasIdContacts
263
- */
264
- lastEmailSentTimestamp?: number;
265
- /**
266
- * Reverse alias for the email address.
267
- * @type {string}
268
- * @memberof AliasAliasIdContacts
269
- */
270
- reverseAlias: string;
271
- /**
272
- * Whether the email address is blocked for forwarding.
273
- * @type {boolean}
274
- * @memberof AliasAliasIdContacts
275
- */
276
- blockForward?: boolean;
277
- /**
278
- * Whether the contact already existed.
279
- * @type {boolean}
280
- * @memberof AliasAliasIdContacts
281
- */
282
- existed?: boolean;
283
- }
284
- /**
285
- *
286
- * @export
287
- * @interface AliasAliasIdContactsModelArray
288
- */
289
- export interface AliasAliasIdContactsModelArray {
290
- /**
291
- *
292
- * @type {Array<AliasAliasIdContacts>}
293
- * @memberof AliasAliasIdContactsModelArray
294
- */
295
- contacts?: Array<AliasAliasIdContacts>;
296
- }
297
- /**
298
- *
299
- * @export
300
- * @interface AliasAliasIdContactsPost
301
- */
302
- export interface AliasAliasIdContactsPost {
303
- /**
304
- *
305
- * @type {Email}
306
- * @memberof AliasAliasIdContactsPost
307
- */
308
- contact: Email;
309
- }
310
- /**
311
- *
312
- * @export
313
- * @interface AliasAliasIdDelete
314
- */
315
- export interface AliasAliasIdDelete {
316
- /**
317
- *
318
- * @type {boolean}
319
- * @memberof AliasAliasIdDelete
320
- */
321
- deleted?: boolean;
322
- }
323
- /**
324
- *
325
- * @export
326
- * @interface AliasAliasIdPatch
327
- */
328
- export interface AliasAliasIdPatch {
329
- /**
330
- *
331
- * @type {string}
332
- * @memberof AliasAliasIdPatch
333
- */
334
- note?: string;
335
- /**
336
- *
337
- * @type {number}
338
- * @memberof AliasAliasIdPatch
339
- */
340
- mailboxId?: number;
341
- /**
342
- *
343
- * @type {string}
344
- * @memberof AliasAliasIdPatch
345
- */
346
- name?: string;
347
- /**
348
- *
349
- * @type {Array<number>}
350
- * @memberof AliasAliasIdPatch
351
- */
352
- mailboxIds?: Array<number>;
353
- /**
354
- *
355
- * @type {boolean}
356
- * @memberof AliasAliasIdPatch
357
- */
358
- disablePgp?: boolean;
359
- /**
360
- *
361
- * @type {boolean}
362
- * @memberof AliasAliasIdPatch
363
- */
364
- pinned?: boolean;
365
- }
366
- /**
367
- *
368
- * @export
369
- * @interface AliasAliasIdTogglePost
370
- */
371
- export interface AliasAliasIdTogglePost {
372
- /**
373
- *
374
- * @type {boolean}
375
- * @memberof AliasAliasIdTogglePost
376
- */
377
- enabled?: boolean;
378
- }
379
- /**
380
- *
381
- * @export
382
- * @interface AliasCustomNewPost
383
- */
384
- export interface AliasCustomNewPost {
385
- /**
386
- * The first part of the alias that user can choose.
387
- * @type {string}
388
- * @memberof AliasCustomNewPost
389
- */
390
- aliasPrefix: string;
391
- /**
392
- * One of the suffixes returned in the options endpoint.
393
- * @type {string}
394
- * @memberof AliasCustomNewPost
395
- */
396
- signedSuffix: string;
397
- /**
398
- *
399
- * @type {Array<number>}
400
- * @memberof AliasCustomNewPost
401
- */
402
- mailboxIds: Array<number>;
403
- /**
404
- * Note of this alias
405
- * @type {string}
406
- * @memberof AliasCustomNewPost
407
- */
408
- note?: string;
409
- /**
410
- * Name of this alias
411
- * @type {string}
412
- * @memberof AliasCustomNewPost
413
- */
414
- name?: string;
415
- }
416
- /**
417
- *
418
- * @export
419
- * @interface AliasLatestActivity
420
- */
421
- export interface AliasLatestActivity {
422
- /**
423
- *
424
- * @type {string}
425
- * @memberof AliasLatestActivity
426
- */
427
- action: string;
428
- /**
429
- *
430
- * @type {AliasLatestActivityContact}
431
- * @memberof AliasLatestActivity
432
- */
433
- contact: AliasLatestActivityContact;
434
- /**
435
- *
436
- * @type {number}
437
- * @memberof AliasLatestActivity
438
- */
439
- timestamp: number;
440
- }
441
- /**
442
- *
443
- * @export
444
- * @interface AliasLatestActivityContact
445
- */
446
- export interface AliasLatestActivityContact {
447
- /**
448
- *
449
- * @type {Email}
450
- * @memberof AliasLatestActivityContact
451
- */
452
- email: Email;
453
- /**
454
- *
455
- * @type {string}
456
- * @memberof AliasLatestActivityContact
457
- */
458
- name: string;
459
- /**
460
- *
461
- * @type {string}
462
- * @memberof AliasLatestActivityContact
463
- */
464
- reverseAlias: string;
465
- }
466
- /**
467
- *
468
- * @export
469
- * @interface AliasModelArray
470
- */
471
- export interface AliasModelArray {
472
- /**
473
- *
474
- * @type {Array<Alias>}
475
- * @memberof AliasModelArray
476
- */
477
- aliases?: Array<Alias>;
478
- }
479
- /**
480
- *
481
- * @export
482
- * @interface AliasOptions
483
- */
484
- export interface AliasOptions {
485
- /**
486
- * Whether the user can create an alias or not
487
- * @type {boolean}
488
- * @memberof AliasOptions
489
- */
490
- canCreate: boolean;
491
- /**
492
- *
493
- * @type {string}
494
- * @memberof AliasOptions
495
- */
496
- prefixSuggestion: string;
497
- /**
498
- *
499
- * @type {Array<AliasOptionsSuffixes>}
500
- * @memberof AliasOptions
501
- */
502
- suffixes: Array<AliasOptionsSuffixes>;
503
- /**
504
- *
505
- * @type {Array<AliasOptionsRecommendation>}
506
- * @memberof AliasOptions
507
- */
508
- recommendation?: Array<AliasOptionsRecommendation>;
509
- }
510
- /**
511
- *
512
- * @export
513
- * @interface AliasOptionsRecommendation
514
- */
515
- export interface AliasOptionsRecommendation {
516
- /**
517
- *
518
- * @type {string}
519
- * @memberof AliasOptionsRecommendation
520
- */
521
- alias: string;
522
- /**
523
- *
524
- * @type {string}
525
- * @memberof AliasOptionsRecommendation
526
- */
527
- hostname: string;
528
- }
529
- /**
530
- *
531
- * @export
532
- * @interface AliasOptionsSuffixes
533
- */
534
- export interface AliasOptionsSuffixes {
535
- /**
536
- *
537
- * @type {string}
538
- * @memberof AliasOptionsSuffixes
539
- */
540
- suffix: string;
541
- /**
542
- *
543
- * @type {string}
544
- * @memberof AliasOptionsSuffixes
545
- */
546
- signedSuffix: string;
547
- /**
548
- *
549
- * @type {boolean}
550
- * @memberof AliasOptionsSuffixes
551
- */
552
- isCustom: boolean;
553
- /**
554
- *
555
- * @type {boolean}
556
- * @memberof AliasOptionsSuffixes
557
- */
558
- isPremium: boolean;
559
- }
560
- /**
561
- *
562
- * @export
563
- * @interface AliasRandomNewPost
564
- */
565
- export interface AliasRandomNewPost {
566
- /**
567
- * Note of this alias
568
- * @type {string}
569
- * @memberof AliasRandomNewPost
570
- */
571
- note?: string;
572
- }
573
- /**
574
- *
575
- * @export
576
- * @interface AuthActivatePost
577
- */
578
- export interface AuthActivatePost {
579
- /**
580
- *
581
- * @type {Email}
582
- * @memberof AuthActivatePost
583
- */
584
- email: Email;
585
- /**
586
- * Activation code sent to email
587
- * @type {string}
588
- * @memberof AuthActivatePost
589
- */
590
- code: string;
591
- }
592
- /**
593
- *
594
- * @export
595
- * @interface AuthForgotPasswordPost
596
- */
597
- export interface AuthForgotPasswordPost {
598
- /**
599
- *
600
- * @type {Email}
601
- * @memberof AuthForgotPasswordPost
602
- */
603
- email: Email;
604
- }
605
- /**
606
- *
607
- * @export
608
- * @interface AuthLogin
609
- */
610
- export interface AuthLogin {
611
- /**
612
- * User's name, could be an empty string.
613
- * @type {string}
614
- * @memberof AuthLogin
615
- */
616
- name: string;
617
- /**
618
- *
619
- * @type {Email}
620
- * @memberof AuthLogin
621
- */
622
- email: Email;
623
- /**
624
- *
625
- * @type {boolean}
626
- * @memberof AuthLogin
627
- */
628
- mfaEnabled: boolean;
629
- /**
630
- * Only useful when user enables MFA. In this case, user needs to enter their OTP token in order to login.
631
- * @type {string}
632
- * @memberof AuthLogin
633
- */
634
- mfaKey: string;
635
- /**
636
- * If MFA is not enabled, the api key is returned right away.
637
- * @type {string}
638
- * @memberof AuthLogin
639
- */
640
- apiKey: string;
641
- }
642
- /**
643
- *
644
- * @export
645
- * @interface AuthLoginPost
646
- */
647
- export interface AuthLoginPost {
648
- /**
649
- *
650
- * @type {Email}
651
- * @memberof AuthLoginPost
652
- */
653
- email: Email;
654
- /**
655
- *
656
- * @type {string}
657
- * @memberof AuthLoginPost
658
- */
659
- password: string;
660
- /**
661
- *
662
- * @type {string}
663
- * @memberof AuthLoginPost
664
- */
665
- device: string;
666
- }
667
- /**
668
- *
669
- * @export
670
- * @interface AuthMfa
671
- */
672
- export interface AuthMfa {
673
- /**
674
- * User's name, could be an empty string
675
- * @type {string}
676
- * @memberof AuthMfa
677
- */
678
- name: string;
679
- /**
680
- * If MFA is not enabled, the api key is returned right away.
681
- * @type {string}
682
- * @memberof AuthMfa
683
- */
684
- apiKey: string;
685
- /**
686
- *
687
- * @type {Email}
688
- * @memberof AuthMfa
689
- */
690
- email: Email;
691
- }
692
- /**
693
- *
694
- * @export
695
- * @interface AuthMfaPost
696
- */
697
- export interface AuthMfaPost {
698
- /**
699
- * OTP token that user enters
700
- * @type {string}
701
- * @memberof AuthMfaPost
702
- */
703
- mfaToken: string;
704
- /**
705
- * MFA key obtained in previous auth request
706
- * @type {string}
707
- * @memberof AuthMfaPost
708
- */
709
- mfaKey: string;
710
- /**
711
- * The device name, used to create an ApiKey associated with this device
712
- * @type {string}
713
- * @memberof AuthMfaPost
714
- */
715
- device: string;
716
- }
717
- /**
718
- *
719
- * @export
720
- * @interface AuthReactivatePost
721
- */
722
- export interface AuthReactivatePost {
723
- /**
724
- *
725
- * @type {Email}
726
- * @memberof AuthReactivatePost
727
- */
728
- email: Email;
729
- }
730
- /**
731
- *
732
- * @export
733
- * @interface AuthRegisterPost
734
- */
735
- export interface AuthRegisterPost {
736
- /**
737
- *
738
- * @type {string}
739
- * @memberof AuthRegisterPost
740
- */
741
- email: string;
742
- /**
743
- *
744
- * @type {string}
745
- * @memberof AuthRegisterPost
746
- */
747
- password: string;
748
- }
749
- /**
750
- *
751
- * @export
752
- * @interface CustomDomain
753
- */
754
- export interface CustomDomain {
755
- /**
756
- *
757
- * @type {boolean}
758
- * @memberof CustomDomain
759
- */
760
- catchAll: boolean;
761
- /**
762
- *
763
- * @type {Date}
764
- * @memberof CustomDomain
765
- */
766
- creationDate: Date;
767
- /**
768
- *
769
- * @type {UnixTimestamp}
770
- * @memberof CustomDomain
771
- */
772
- creationTimestamp: UnixTimestamp;
773
- /**
774
- *
775
- * @type {string}
776
- * @memberof CustomDomain
777
- */
778
- domainName: string;
779
- /**
780
- *
781
- * @type {number}
782
- * @memberof CustomDomain
783
- */
784
- id: number;
785
- /**
786
- *
787
- * @type {boolean}
788
- * @memberof CustomDomain
789
- */
790
- isVerified: boolean;
791
- /**
792
- *
793
- * @type {Array<MailboxModelRef>}
794
- * @memberof CustomDomain
795
- */
796
- mailboxes: Array<MailboxModelRef>;
797
- /**
798
- *
799
- * @type {string}
800
- * @memberof CustomDomain
801
- */
802
- name: string;
803
- /**
804
- *
805
- * @type {number}
806
- * @memberof CustomDomain
807
- */
808
- nbAlias: number;
809
- /**
810
- *
811
- * @type {boolean}
812
- * @memberof CustomDomain
813
- */
814
- randomPrefixGeneration: boolean;
815
- }
816
- /**
817
- *
818
- * @export
819
- */
820
- export type CustomDomainModelArray = Array<CustomDomain>;
821
- /**
822
- *
823
- * @export
824
- */
825
- export type DateTime = Date;
826
- /**
827
- * Email address
828
- * @export
829
- */
830
- export type Email = string;
831
- /**
832
- *
833
- * @export
834
- * @interface Mailbox
835
- */
836
- export interface Mailbox {
837
- /**
838
- *
839
- * @type {Email}
840
- * @memberof Mailbox
841
- */
842
- email: Email;
843
- /**
844
- *
845
- * @type {number}
846
- * @memberof Mailbox
847
- */
848
- id: number;
849
- /**
850
- *
851
- * @type {boolean}
852
- * @memberof Mailbox
853
- */
854
- _default: boolean;
855
- /**
856
- *
857
- * @type {UnixTimestamp}
858
- * @memberof Mailbox
859
- */
860
- creationTimestamp: UnixTimestamp;
861
- /**
862
- *
863
- * @type {number}
864
- * @memberof Mailbox
865
- */
866
- nbAlias: number;
867
- /**
868
- *
869
- * @type {boolean}
870
- * @memberof Mailbox
871
- */
872
- verified: boolean;
873
- }
874
- /**
875
- *
876
- * @export
877
- * @interface MailboxMailboxIdPut
878
- */
879
- export interface MailboxMailboxIdPut {
880
- /**
881
- * If true, set the mailbox as the default mailbox.
882
- * @type {boolean}
883
- * @memberof MailboxMailboxIdPut
884
- */
885
- _default?: boolean;
886
- /**
887
- *
888
- * @type {Email}
889
- * @memberof MailboxMailboxIdPut
890
- */
891
- email?: Email;
892
- /**
893
- * If true, cancel the email change of the mailbox.
894
- * @type {boolean}
895
- * @memberof MailboxMailboxIdPut
896
- */
897
- cancelEmailChange?: boolean;
898
- }
899
- /**
900
- *
901
- * @export
902
- * @interface MailboxModelArray
903
- */
904
- export interface MailboxModelArray {
905
- /**
906
- *
907
- * @type {Array<Mailbox>}
908
- * @memberof MailboxModelArray
909
- */
910
- mailboxes?: Array<Mailbox>;
911
- }
912
- /**
913
- *
914
- * @export
915
- * @interface MailboxModelRef
916
- */
917
- export interface MailboxModelRef {
918
- /**
919
- *
920
- * @type {Email}
921
- * @memberof MailboxModelRef
922
- */
923
- email: Email;
924
- /**
925
- *
926
- * @type {number}
927
- * @memberof MailboxModelRef
928
- */
929
- id: number;
930
- }
931
- /**
932
- *
933
- * @export
934
- * @interface MailboxPost
935
- */
936
- export interface MailboxPost {
937
- /**
938
- *
939
- * @type {Email}
940
- * @memberof MailboxPost
941
- */
942
- email?: Email;
943
- }
944
- /**
945
- *
946
- * @export
947
- * @interface ModelError
948
- */
949
- export interface ModelError {
950
- /**
951
- * Error message
952
- * @type {string}
953
- * @memberof ModelError
954
- */
955
- error?: string;
956
- }
957
- /**
958
- *
959
- * @export
960
- * @interface Success
961
- */
962
- export interface Success {
963
- /**
964
- *
965
- * @type {boolean}
966
- * @memberof Success
967
- */
968
- ok: boolean;
969
- }
970
- /**
971
- *
972
- * @export
973
- * @interface SudoPatch
974
- */
975
- export interface SudoPatch {
976
- /**
977
- *
978
- * @type {string}
979
- * @memberof SudoPatch
980
- */
981
- password?: string;
982
- }
983
- /**
984
- * Unix timestamp
985
- * @export
986
- */
987
- export type UnixTimestamp = number;
988
- /**
989
- *
990
- * @export
991
- * @interface UserApiKey
992
- */
993
- export interface UserApiKey {
994
- /**
995
- *
996
- * @type {string}
997
- * @memberof UserApiKey
998
- */
999
- apiKey: string;
1000
- }
1001
- /**
1002
- *
1003
- * @export
1004
- * @interface UserApiKeyPost
1005
- */
1006
- export interface UserApiKeyPost {
1007
- /**
1008
- * Device name
1009
- * @type {string}
1010
- * @memberof UserApiKeyPost
1011
- */
1012
- device: string;
1013
- }
1014
- /**
1015
- *
1016
- * @export
1017
- * @interface UserCookieToken
1018
- */
1019
- export interface UserCookieToken {
1020
- /**
1021
- *
1022
- * @type {string}
1023
- * @memberof UserCookieToken
1024
- */
1025
- token: string;
1026
- }
1027
- /**
1028
- *
1029
- * @export
1030
- * @interface UserInfo
1031
- */
1032
- export interface UserInfo {
1033
- /**
1034
- * User's full name
1035
- * @type {string}
1036
- * @memberof UserInfo
1037
- */
1038
- name: string;
1039
- /**
1040
- *
1041
- * @type {Email}
1042
- * @memberof UserInfo
1043
- */
1044
- email: Email;
1045
- /**
1046
- * Whether the user is a premium user or not
1047
- * @type {boolean}
1048
- * @memberof UserInfo
1049
- */
1050
- isPremium: boolean;
1051
- /**
1052
- * Whether the user is in trial period or not
1053
- * @type {boolean}
1054
- * @memberof UserInfo
1055
- */
1056
- inTrial: boolean;
1057
- /**
1058
- * URL of the user's profile picture
1059
- * @type {string}
1060
- * @memberof UserInfo
1061
- */
1062
- profilePicture: string;
1063
- /**
1064
- *
1065
- * @type {number}
1066
- * @memberof UserInfo
1067
- */
1068
- maxAliasFreePlan: number;
1069
- }
1070
- /**
1071
- *
1072
- * @export
1073
- * @interface UserInfoPatch
1074
- */
1075
- export interface UserInfoPatch {
1076
- /**
1077
- * Image of the new profile picture encoded in base64. Set to null to remove current profile picture.
1078
- * @type {string}
1079
- * @memberof UserInfoPatch
1080
- */
1081
- profilePicture?: string;
1082
- /**
1083
- * New name of the user
1084
- * @type {string}
1085
- * @memberof UserInfoPatch
1086
- */
1087
- name?: string;
1088
- }
1089
- /**
1090
- * AccountApi - fetch parameter creator
1091
- * @export
1092
- */
1093
- export declare const AccountApiFetchParamCreator: (configuration?: Configuration) => {
1094
- /**
1095
- * Activate a new account with the activation code that was sent to the user's email.
1096
- * @summary Activate account
1097
- * @param {AuthActivatePost} body
1098
- * @param {*} [options] Override http request option.
1099
- * @throws {RequiredError}
1100
- */
1101
- activateAccount(body: AuthActivatePost, options?: any): FetchArgs;
1102
- /**
1103
- * Create a new API key
1104
- * @summary Create API key
1105
- * @param {UserApiKeyPost} body
1106
- * @param {*} [options] Override http request option.
1107
- * @throws {RequiredError}
1108
- */
1109
- createApiKey(body: UserApiKeyPost, options?: any): FetchArgs;
1110
- /**
1111
- * Delete user (requires sudo mode)
1112
- * @summary Delete user
1113
- * @param {*} [options] Override http request option.
1114
- * @throws {RequiredError}
1115
- */
1116
- deleteUser(options?: any): FetchArgs;
1117
- /**
1118
- * Enable sudo mode
1119
- * @summary Enable sudo mode
1120
- * @param {SudoPatch} body
1121
- * @param {*} [options] Override http request option.
1122
- * @throws {RequiredError}
1123
- */
1124
- enableSudoMode(body: SudoPatch, options?: any): FetchArgs;
1125
- /**
1126
- * Request a link to reset the password for a registered account.
1127
- * @summary Forgot password
1128
- * @param {AuthForgotPasswordPost} body
1129
- * @param {*} [options] Override http request option.
1130
- * @throws {RequiredError}
1131
- */
1132
- forgotPassword(body: AuthForgotPasswordPost, options?: any): FetchArgs;
1133
- /**
1134
- * Get a one time use cookie to exchange it for a valid cookie in the web app
1135
- * @summary Get cookie token
1136
- * @param {*} [options] Override http request option.
1137
- * @throws {RequiredError}
1138
- */
1139
- getCookieToken(options?: any): FetchArgs;
1140
- /**
1141
- * Get user info
1142
- * @summary Get user info
1143
- * @param {*} [options] Override http request option.
1144
- * @throws {RequiredError}
1145
- */
1146
- getUserInfo(options?: any): FetchArgs;
1147
- /**
1148
- * Login using email and password to get an access token.
1149
- * @summary Login
1150
- * @param {AuthLoginPost} body
1151
- * @param {*} [options] Override http request option.
1152
- * @throws {RequiredError}
1153
- */
1154
- login(body: AuthLoginPost, options?: any): FetchArgs;
1155
- /**
1156
- * Log out user
1157
- * @summary Logout
1158
- * @param {*} [options] Override http request option.
1159
- * @throws {RequiredError}
1160
- */
1161
- logout(options?: any): FetchArgs;
1162
- /**
1163
- * Authenticate using MFA
1164
- * @summary MFA authentication
1165
- * @param {AuthMfaPost} body The api_key is used in all subsequent requests. It&#x27;s empty if MFA is enabled. If user hasn&#x27;t enabled MFA, mfa_key is empty.
1166
- * @param {*} [options] Override http request option.
1167
- * @throws {RequiredError}
1168
- */
1169
- mfa(body: AuthMfaPost, options?: any): FetchArgs;
1170
- /**
1171
- * Request a new activation code for an account that was already registered, but not activated yet.
1172
- * @summary Reactivate account
1173
- * @param {AuthReactivatePost} body
1174
- * @param {*} [options] Override http request option.
1175
- * @throws {RequiredError}
1176
- */
1177
- reactivateAccount(body: AuthReactivatePost, options?: any): FetchArgs;
1178
- /**
1179
- * Register a new account
1180
- * @summary Register account
1181
- * @param {AuthRegisterPost} body
1182
- * @param {*} [options] Override http request option.
1183
- * @throws {RequiredError}
1184
- */
1185
- registerAccount(body: AuthRegisterPost, options?: any): FetchArgs;
1186
- /**
1187
- * Update user info
1188
- * @summary Update user info
1189
- * @param {UserInfoPatch} body
1190
- * @param {*} [options] Override http request option.
1191
- * @throws {RequiredError}
1192
- */
1193
- updateUserInfo(body: UserInfoPatch, options?: any): FetchArgs;
1194
- };
1195
- /**
1196
- * AccountApi - functional programming interface
1197
- * @export
1198
- */
1199
- export declare const AccountApiFp: (configuration?: Configuration) => {
1200
- /**
1201
- * Activate a new account with the activation code that was sent to the user's email.
1202
- * @summary Activate account
1203
- * @param {AuthActivatePost} body
1204
- * @param {*} [options] Override http request option.
1205
- * @throws {RequiredError}
1206
- */
1207
- activateAccount(body: AuthActivatePost, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
1208
- /**
1209
- * Create a new API key
1210
- * @summary Create API key
1211
- * @param {UserApiKeyPost} body
1212
- * @param {*} [options] Override http request option.
1213
- * @throws {RequiredError}
1214
- */
1215
- createApiKey(body: UserApiKeyPost, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserApiKey>;
1216
- /**
1217
- * Delete user (requires sudo mode)
1218
- * @summary Delete user
1219
- * @param {*} [options] Override http request option.
1220
- * @throws {RequiredError}
1221
- */
1222
- deleteUser(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Success>;
1223
- /**
1224
- * Enable sudo mode
1225
- * @summary Enable sudo mode
1226
- * @param {SudoPatch} body
1227
- * @param {*} [options] Override http request option.
1228
- * @throws {RequiredError}
1229
- */
1230
- enableSudoMode(body: SudoPatch, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Success>;
1231
- /**
1232
- * Request a link to reset the password for a registered account.
1233
- * @summary Forgot password
1234
- * @param {AuthForgotPasswordPost} body
1235
- * @param {*} [options] Override http request option.
1236
- * @throws {RequiredError}
1237
- */
1238
- forgotPassword(body: AuthForgotPasswordPost, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
1239
- /**
1240
- * Get a one time use cookie to exchange it for a valid cookie in the web app
1241
- * @summary Get cookie token
1242
- * @param {*} [options] Override http request option.
1243
- * @throws {RequiredError}
1244
- */
1245
- getCookieToken(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserCookieToken>;
1246
- /**
1247
- * Get user info
1248
- * @summary Get user info
1249
- * @param {*} [options] Override http request option.
1250
- * @throws {RequiredError}
1251
- */
1252
- getUserInfo(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserInfo>;
1253
- /**
1254
- * Login using email and password to get an access token.
1255
- * @summary Login
1256
- * @param {AuthLoginPost} body
1257
- * @param {*} [options] Override http request option.
1258
- * @throws {RequiredError}
1259
- */
1260
- login(body: AuthLoginPost, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AuthLogin>;
1261
- /**
1262
- * Log out user
1263
- * @summary Logout
1264
- * @param {*} [options] Override http request option.
1265
- * @throws {RequiredError}
1266
- */
1267
- logout(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserInfo>;
1268
- /**
1269
- * Authenticate using MFA
1270
- * @summary MFA authentication
1271
- * @param {AuthMfaPost} body The api_key is used in all subsequent requests. It&#x27;s empty if MFA is enabled. If user hasn&#x27;t enabled MFA, mfa_key is empty.
1272
- * @param {*} [options] Override http request option.
1273
- * @throws {RequiredError}
1274
- */
1275
- mfa(body: AuthMfaPost, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AuthMfa>;
1276
- /**
1277
- * Request a new activation code for an account that was already registered, but not activated yet.
1278
- * @summary Reactivate account
1279
- * @param {AuthReactivatePost} body
1280
- * @param {*} [options] Override http request option.
1281
- * @throws {RequiredError}
1282
- */
1283
- reactivateAccount(body: AuthReactivatePost, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
1284
- /**
1285
- * Register a new account
1286
- * @summary Register account
1287
- * @param {AuthRegisterPost} body
1288
- * @param {*} [options] Override http request option.
1289
- * @throws {RequiredError}
1290
- */
1291
- registerAccount(body: AuthRegisterPost, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
1292
- /**
1293
- * Update user info
1294
- * @summary Update user info
1295
- * @param {UserInfoPatch} body
1296
- * @param {*} [options] Override http request option.
1297
- * @throws {RequiredError}
1298
- */
1299
- updateUserInfo(body: UserInfoPatch, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<UserInfo>;
1300
- };
1301
- /**
1302
- * AccountApi - factory interface
1303
- * @export
1304
- */
1305
- export declare const AccountApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
1306
- /**
1307
- * Activate a new account with the activation code that was sent to the user's email.
1308
- * @summary Activate account
1309
- * @param {AuthActivatePost} body
1310
- * @param {*} [options] Override http request option.
1311
- * @throws {RequiredError}
1312
- */
1313
- activateAccount(body: AuthActivatePost, options?: any): Promise<any>;
1314
- /**
1315
- * Create a new API key
1316
- * @summary Create API key
1317
- * @param {UserApiKeyPost} body
1318
- * @param {*} [options] Override http request option.
1319
- * @throws {RequiredError}
1320
- */
1321
- createApiKey(body: UserApiKeyPost, options?: any): Promise<UserApiKey>;
1322
- /**
1323
- * Delete user (requires sudo mode)
1324
- * @summary Delete user
1325
- * @param {*} [options] Override http request option.
1326
- * @throws {RequiredError}
1327
- */
1328
- deleteUser(options?: any): Promise<Success>;
1329
- /**
1330
- * Enable sudo mode
1331
- * @summary Enable sudo mode
1332
- * @param {SudoPatch} body
1333
- * @param {*} [options] Override http request option.
1334
- * @throws {RequiredError}
1335
- */
1336
- enableSudoMode(body: SudoPatch, options?: any): Promise<Success>;
1337
- /**
1338
- * Request a link to reset the password for a registered account.
1339
- * @summary Forgot password
1340
- * @param {AuthForgotPasswordPost} body
1341
- * @param {*} [options] Override http request option.
1342
- * @throws {RequiredError}
1343
- */
1344
- forgotPassword(body: AuthForgotPasswordPost, options?: any): Promise<any>;
1345
- /**
1346
- * Get a one time use cookie to exchange it for a valid cookie in the web app
1347
- * @summary Get cookie token
1348
- * @param {*} [options] Override http request option.
1349
- * @throws {RequiredError}
1350
- */
1351
- getCookieToken(options?: any): Promise<UserCookieToken>;
1352
- /**
1353
- * Get user info
1354
- * @summary Get user info
1355
- * @param {*} [options] Override http request option.
1356
- * @throws {RequiredError}
1357
- */
1358
- getUserInfo(options?: any): Promise<UserInfo>;
1359
- /**
1360
- * Login using email and password to get an access token.
1361
- * @summary Login
1362
- * @param {AuthLoginPost} body
1363
- * @param {*} [options] Override http request option.
1364
- * @throws {RequiredError}
1365
- */
1366
- login(body: AuthLoginPost, options?: any): Promise<AuthLogin>;
1367
- /**
1368
- * Log out user
1369
- * @summary Logout
1370
- * @param {*} [options] Override http request option.
1371
- * @throws {RequiredError}
1372
- */
1373
- logout(options?: any): Promise<UserInfo>;
1374
- /**
1375
- * Authenticate using MFA
1376
- * @summary MFA authentication
1377
- * @param {AuthMfaPost} body The api_key is used in all subsequent requests. It&#x27;s empty if MFA is enabled. If user hasn&#x27;t enabled MFA, mfa_key is empty.
1378
- * @param {*} [options] Override http request option.
1379
- * @throws {RequiredError}
1380
- */
1381
- mfa(body: AuthMfaPost, options?: any): Promise<AuthMfa>;
1382
- /**
1383
- * Request a new activation code for an account that was already registered, but not activated yet.
1384
- * @summary Reactivate account
1385
- * @param {AuthReactivatePost} body
1386
- * @param {*} [options] Override http request option.
1387
- * @throws {RequiredError}
1388
- */
1389
- reactivateAccount(body: AuthReactivatePost, options?: any): Promise<any>;
1390
- /**
1391
- * Register a new account
1392
- * @summary Register account
1393
- * @param {AuthRegisterPost} body
1394
- * @param {*} [options] Override http request option.
1395
- * @throws {RequiredError}
1396
- */
1397
- registerAccount(body: AuthRegisterPost, options?: any): Promise<any>;
1398
- /**
1399
- * Update user info
1400
- * @summary Update user info
1401
- * @param {UserInfoPatch} body
1402
- * @param {*} [options] Override http request option.
1403
- * @throws {RequiredError}
1404
- */
1405
- updateUserInfo(body: UserInfoPatch, options?: any): Promise<UserInfo>;
1406
- };
1407
- /**
1408
- * AccountApi - object-oriented interface
1409
- * @export
1410
- * @class AccountApi
1411
- * @extends {BaseAPI}
1412
- */
1413
- export declare class AccountApi extends BaseAPI {
1414
- /**
1415
- * Activate a new account with the activation code that was sent to the user's email.
1416
- * @summary Activate account
1417
- * @param {AuthActivatePost} body
1418
- * @param {*} [options] Override http request option.
1419
- * @throws {RequiredError}
1420
- * @memberof AccountApi
1421
- */
1422
- activateAccount(body: AuthActivatePost, options?: any): Promise<any>;
1423
- /**
1424
- * Create a new API key
1425
- * @summary Create API key
1426
- * @param {UserApiKeyPost} body
1427
- * @param {*} [options] Override http request option.
1428
- * @throws {RequiredError}
1429
- * @memberof AccountApi
1430
- */
1431
- createApiKey(body: UserApiKeyPost, options?: any): Promise<UserApiKey>;
1432
- /**
1433
- * Delete user (requires sudo mode)
1434
- * @summary Delete user
1435
- * @param {*} [options] Override http request option.
1436
- * @throws {RequiredError}
1437
- * @memberof AccountApi
1438
- */
1439
- deleteUser(options?: any): Promise<Success>;
1440
- /**
1441
- * Enable sudo mode
1442
- * @summary Enable sudo mode
1443
- * @param {SudoPatch} body
1444
- * @param {*} [options] Override http request option.
1445
- * @throws {RequiredError}
1446
- * @memberof AccountApi
1447
- */
1448
- enableSudoMode(body: SudoPatch, options?: any): Promise<Success>;
1449
- /**
1450
- * Request a link to reset the password for a registered account.
1451
- * @summary Forgot password
1452
- * @param {AuthForgotPasswordPost} body
1453
- * @param {*} [options] Override http request option.
1454
- * @throws {RequiredError}
1455
- * @memberof AccountApi
1456
- */
1457
- forgotPassword(body: AuthForgotPasswordPost, options?: any): Promise<any>;
1458
- /**
1459
- * Get a one time use cookie to exchange it for a valid cookie in the web app
1460
- * @summary Get cookie token
1461
- * @param {*} [options] Override http request option.
1462
- * @throws {RequiredError}
1463
- * @memberof AccountApi
1464
- */
1465
- getCookieToken(options?: any): Promise<UserCookieToken>;
1466
- /**
1467
- * Get user info
1468
- * @summary Get user info
1469
- * @param {*} [options] Override http request option.
1470
- * @throws {RequiredError}
1471
- * @memberof AccountApi
1472
- */
1473
- getUserInfo(options?: any): Promise<UserInfo>;
1474
- /**
1475
- * Login using email and password to get an access token.
1476
- * @summary Login
1477
- * @param {AuthLoginPost} body
1478
- * @param {*} [options] Override http request option.
1479
- * @throws {RequiredError}
1480
- * @memberof AccountApi
1481
- */
1482
- login(body: AuthLoginPost, options?: any): Promise<AuthLogin>;
1483
- /**
1484
- * Log out user
1485
- * @summary Logout
1486
- * @param {*} [options] Override http request option.
1487
- * @throws {RequiredError}
1488
- * @memberof AccountApi
1489
- */
1490
- logout(options?: any): Promise<UserInfo>;
1491
- /**
1492
- * Authenticate using MFA
1493
- * @summary MFA authentication
1494
- * @param {AuthMfaPost} body The api_key is used in all subsequent requests. It&#x27;s empty if MFA is enabled. If user hasn&#x27;t enabled MFA, mfa_key is empty.
1495
- * @param {*} [options] Override http request option.
1496
- * @throws {RequiredError}
1497
- * @memberof AccountApi
1498
- */
1499
- mfa(body: AuthMfaPost, options?: any): Promise<AuthMfa>;
1500
- /**
1501
- * Request a new activation code for an account that was already registered, but not activated yet.
1502
- * @summary Reactivate account
1503
- * @param {AuthReactivatePost} body
1504
- * @param {*} [options] Override http request option.
1505
- * @throws {RequiredError}
1506
- * @memberof AccountApi
1507
- */
1508
- reactivateAccount(body: AuthReactivatePost, options?: any): Promise<any>;
1509
- /**
1510
- * Register a new account
1511
- * @summary Register account
1512
- * @param {AuthRegisterPost} body
1513
- * @param {*} [options] Override http request option.
1514
- * @throws {RequiredError}
1515
- * @memberof AccountApi
1516
- */
1517
- registerAccount(body: AuthRegisterPost, options?: any): Promise<any>;
1518
- /**
1519
- * Update user info
1520
- * @summary Update user info
1521
- * @param {UserInfoPatch} body
1522
- * @param {*} [options] Override http request option.
1523
- * @throws {RequiredError}
1524
- * @memberof AccountApi
1525
- */
1526
- updateUserInfo(body: UserInfoPatch, options?: any): Promise<UserInfo>;
1527
- }
1528
- /**
1529
- * AliasApi - fetch parameter creator
1530
- * @export
1531
- */
1532
- export declare const AliasApiFetchParamCreator: (configuration?: Configuration) => {
1533
- /**
1534
- * Create a new contact for an alias by id.
1535
- * @summary Create contact
1536
- * @param {AliasAliasIdContactsPost} body Updated settings for the given alias.
1537
- * @param {number} aliasId ID of an alias
1538
- * @param {*} [options] Override http request option.
1539
- * @throws {RequiredError}
1540
- */
1541
- createContact(body: AliasAliasIdContactsPost, aliasId: number, options?: any): FetchArgs;
1542
- /**
1543
- * Create a new custom alias
1544
- * @summary Create custom alias
1545
- * @param {AliasCustomNewPost} body
1546
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1547
- * @param {*} [options] Override http request option.
1548
- * @throws {RequiredError}
1549
- */
1550
- createCustomAlias(body: AliasCustomNewPost, hostname?: string, options?: any): FetchArgs;
1551
- /**
1552
- * Create a new random alias
1553
- * @summary Create random alias
1554
- * @param {AliasRandomNewPost} body
1555
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1556
- * @param {string} [mode] Either &#x60;uuid&#x60; or &#x60;word&#x60;. By default, use the user setting when creating new random alias.
1557
- * @param {*} [options] Override http request option.
1558
- * @throws {RequiredError}
1559
- */
1560
- createRandomAlias(body: AliasRandomNewPost, hostname?: string, mode?: string, options?: any): FetchArgs;
1561
- /**
1562
- * Delete specific alias by id.
1563
- * @summary Delete alias
1564
- * @param {number} aliasId ID of an alias
1565
- * @param {*} [options] Override http request option.
1566
- * @throws {RequiredError}
1567
- */
1568
- deleteAlias(aliasId: number, options?: any): FetchArgs;
1569
- /**
1570
- * Get activities for specific alias by id.
1571
- * @summary Get activities
1572
- * @param {number} aliasId ID of an alias
1573
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1574
- * @param {*} [options] Override http request option.
1575
- * @throws {RequiredError}
1576
- */
1577
- getActivities(aliasId: number, pageId: number, options?: any): FetchArgs;
1578
- /**
1579
- * Get specific alias by id.
1580
- * @summary Get alias
1581
- * @param {number} aliasId ID of an alias
1582
- * @param {*} [options] Override http request option.
1583
- * @throws {RequiredError}
1584
- */
1585
- getAlias(aliasId: number, options?: any): FetchArgs;
1586
- /**
1587
- * User alias info and suggestion. Used by the first extension screen when user opens the extension.
1588
- * @summary Get alias options
1589
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1590
- * @param {*} [options] Override http request option.
1591
- * @throws {RequiredError}
1592
- */
1593
- getAliasOptions(hostname?: string, options?: any): FetchArgs;
1594
- /**
1595
- * Get user aliases. Please note `pinned`, `disabled`, `enabled` are exclusive, i.e. only one can be present. They can only be set to `true`.
1596
- * @summary Get aliases
1597
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1598
- * @param {boolean} [pinned] If set, only pinned aliases are returned.
1599
- * @param {boolean} [disabled] If set, only disabled aliases are returned.
1600
- * @param {boolean} [enabled] If set, only enabled aliases are returned.
1601
- * @param {*} [options] Override http request option.
1602
- * @throws {RequiredError}
1603
- */
1604
- getAliases(pageId: number, pinned?: boolean, disabled?: boolean, enabled?: boolean, options?: any): FetchArgs;
1605
- /**
1606
- * Get contacts for specific alias by id.
1607
- * @summary Get contacts
1608
- * @param {number} aliasId ID of an alias
1609
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1610
- * @param {*} [options] Override http request option.
1611
- * @throws {RequiredError}
1612
- */
1613
- getContacts(aliasId: number, pageId: number, options?: any): FetchArgs;
1614
- /**
1615
- * Enable or disable specific alias by id.
1616
- * @summary Toggle alias
1617
- * @param {number} aliasId ID of an alias
1618
- * @param {*} [options] Override http request option.
1619
- * @throws {RequiredError}
1620
- */
1621
- toggleAlias(aliasId: number, options?: any): FetchArgs;
1622
- /**
1623
- * Update specific alias by id.
1624
- * @summary Update alias
1625
- * @param {AliasAliasIdPatch} body Updated settings for the given alias.
1626
- * @param {number} aliasId ID of an alias
1627
- * @param {*} [options] Override http request option.
1628
- * @throws {RequiredError}
1629
- */
1630
- updateAlias(body: AliasAliasIdPatch, aliasId: number, options?: any): FetchArgs;
1631
- };
1632
- /**
1633
- * AliasApi - functional programming interface
1634
- * @export
1635
- */
1636
- export declare const AliasApiFp: (configuration?: Configuration) => {
1637
- /**
1638
- * Create a new contact for an alias by id.
1639
- * @summary Create contact
1640
- * @param {AliasAliasIdContactsPost} body Updated settings for the given alias.
1641
- * @param {number} aliasId ID of an alias
1642
- * @param {*} [options] Override http request option.
1643
- * @throws {RequiredError}
1644
- */
1645
- createContact(body: AliasAliasIdContactsPost, aliasId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AliasAliasIdContacts>;
1646
- /**
1647
- * Create a new custom alias
1648
- * @summary Create custom alias
1649
- * @param {AliasCustomNewPost} body
1650
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1651
- * @param {*} [options] Override http request option.
1652
- * @throws {RequiredError}
1653
- */
1654
- createCustomAlias(body: AliasCustomNewPost, hostname?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Alias>;
1655
- /**
1656
- * Create a new random alias
1657
- * @summary Create random alias
1658
- * @param {AliasRandomNewPost} body
1659
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1660
- * @param {string} [mode] Either &#x60;uuid&#x60; or &#x60;word&#x60;. By default, use the user setting when creating new random alias.
1661
- * @param {*} [options] Override http request option.
1662
- * @throws {RequiredError}
1663
- */
1664
- createRandomAlias(body: AliasRandomNewPost, hostname?: string, mode?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Alias>;
1665
- /**
1666
- * Delete specific alias by id.
1667
- * @summary Delete alias
1668
- * @param {number} aliasId ID of an alias
1669
- * @param {*} [options] Override http request option.
1670
- * @throws {RequiredError}
1671
- */
1672
- deleteAlias(aliasId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AliasAliasIdDelete>;
1673
- /**
1674
- * Get activities for specific alias by id.
1675
- * @summary Get activities
1676
- * @param {number} aliasId ID of an alias
1677
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1678
- * @param {*} [options] Override http request option.
1679
- * @throws {RequiredError}
1680
- */
1681
- getActivities(aliasId: number, pageId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AliasAliasIdActivitiesModelArray>;
1682
- /**
1683
- * Get specific alias by id.
1684
- * @summary Get alias
1685
- * @param {number} aliasId ID of an alias
1686
- * @param {*} [options] Override http request option.
1687
- * @throws {RequiredError}
1688
- */
1689
- getAlias(aliasId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Alias>;
1690
- /**
1691
- * User alias info and suggestion. Used by the first extension screen when user opens the extension.
1692
- * @summary Get alias options
1693
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1694
- * @param {*} [options] Override http request option.
1695
- * @throws {RequiredError}
1696
- */
1697
- getAliasOptions(hostname?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AliasOptions>;
1698
- /**
1699
- * Get user aliases. Please note `pinned`, `disabled`, `enabled` are exclusive, i.e. only one can be present. They can only be set to `true`.
1700
- * @summary Get aliases
1701
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1702
- * @param {boolean} [pinned] If set, only pinned aliases are returned.
1703
- * @param {boolean} [disabled] If set, only disabled aliases are returned.
1704
- * @param {boolean} [enabled] If set, only enabled aliases are returned.
1705
- * @param {*} [options] Override http request option.
1706
- * @throws {RequiredError}
1707
- */
1708
- getAliases(pageId: number, pinned?: boolean, disabled?: boolean, enabled?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AliasModelArray>;
1709
- /**
1710
- * Get contacts for specific alias by id.
1711
- * @summary Get contacts
1712
- * @param {number} aliasId ID of an alias
1713
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1714
- * @param {*} [options] Override http request option.
1715
- * @throws {RequiredError}
1716
- */
1717
- getContacts(aliasId: number, pageId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AliasAliasIdContactsModelArray>;
1718
- /**
1719
- * Enable or disable specific alias by id.
1720
- * @summary Toggle alias
1721
- * @param {number} aliasId ID of an alias
1722
- * @param {*} [options] Override http request option.
1723
- * @throws {RequiredError}
1724
- */
1725
- toggleAlias(aliasId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AliasAliasIdTogglePost>;
1726
- /**
1727
- * Update specific alias by id.
1728
- * @summary Update alias
1729
- * @param {AliasAliasIdPatch} body Updated settings for the given alias.
1730
- * @param {number} aliasId ID of an alias
1731
- * @param {*} [options] Override http request option.
1732
- * @throws {RequiredError}
1733
- */
1734
- updateAlias(body: AliasAliasIdPatch, aliasId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Success>;
1735
- };
1736
- /**
1737
- * AliasApi - factory interface
1738
- * @export
1739
- */
1740
- export declare const AliasApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
1741
- /**
1742
- * Create a new contact for an alias by id.
1743
- * @summary Create contact
1744
- * @param {AliasAliasIdContactsPost} body Updated settings for the given alias.
1745
- * @param {number} aliasId ID of an alias
1746
- * @param {*} [options] Override http request option.
1747
- * @throws {RequiredError}
1748
- */
1749
- createContact(body: AliasAliasIdContactsPost, aliasId: number, options?: any): Promise<AliasAliasIdContacts>;
1750
- /**
1751
- * Create a new custom alias
1752
- * @summary Create custom alias
1753
- * @param {AliasCustomNewPost} body
1754
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1755
- * @param {*} [options] Override http request option.
1756
- * @throws {RequiredError}
1757
- */
1758
- createCustomAlias(body: AliasCustomNewPost, hostname?: string, options?: any): Promise<Alias>;
1759
- /**
1760
- * Create a new random alias
1761
- * @summary Create random alias
1762
- * @param {AliasRandomNewPost} body
1763
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1764
- * @param {string} [mode] Either &#x60;uuid&#x60; or &#x60;word&#x60;. By default, use the user setting when creating new random alias.
1765
- * @param {*} [options] Override http request option.
1766
- * @throws {RequiredError}
1767
- */
1768
- createRandomAlias(body: AliasRandomNewPost, hostname?: string, mode?: string, options?: any): Promise<Alias>;
1769
- /**
1770
- * Delete specific alias by id.
1771
- * @summary Delete alias
1772
- * @param {number} aliasId ID of an alias
1773
- * @param {*} [options] Override http request option.
1774
- * @throws {RequiredError}
1775
- */
1776
- deleteAlias(aliasId: number, options?: any): Promise<AliasAliasIdDelete>;
1777
- /**
1778
- * Get activities for specific alias by id.
1779
- * @summary Get activities
1780
- * @param {number} aliasId ID of an alias
1781
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1782
- * @param {*} [options] Override http request option.
1783
- * @throws {RequiredError}
1784
- */
1785
- getActivities(aliasId: number, pageId: number, options?: any): Promise<AliasAliasIdActivitiesModelArray>;
1786
- /**
1787
- * Get specific alias by id.
1788
- * @summary Get alias
1789
- * @param {number} aliasId ID of an alias
1790
- * @param {*} [options] Override http request option.
1791
- * @throws {RequiredError}
1792
- */
1793
- getAlias(aliasId: number, options?: any): Promise<Alias>;
1794
- /**
1795
- * User alias info and suggestion. Used by the first extension screen when user opens the extension.
1796
- * @summary Get alias options
1797
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1798
- * @param {*} [options] Override http request option.
1799
- * @throws {RequiredError}
1800
- */
1801
- getAliasOptions(hostname?: string, options?: any): Promise<AliasOptions>;
1802
- /**
1803
- * Get user aliases. Please note `pinned`, `disabled`, `enabled` are exclusive, i.e. only one can be present. They can only be set to `true`.
1804
- * @summary Get aliases
1805
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1806
- * @param {boolean} [pinned] If set, only pinned aliases are returned.
1807
- * @param {boolean} [disabled] If set, only disabled aliases are returned.
1808
- * @param {boolean} [enabled] If set, only enabled aliases are returned.
1809
- * @param {*} [options] Override http request option.
1810
- * @throws {RequiredError}
1811
- */
1812
- getAliases(pageId: number, pinned?: boolean, disabled?: boolean, enabled?: boolean, options?: any): Promise<AliasModelArray>;
1813
- /**
1814
- * Get contacts for specific alias by id.
1815
- * @summary Get contacts
1816
- * @param {number} aliasId ID of an alias
1817
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1818
- * @param {*} [options] Override http request option.
1819
- * @throws {RequiredError}
1820
- */
1821
- getContacts(aliasId: number, pageId: number, options?: any): Promise<AliasAliasIdContactsModelArray>;
1822
- /**
1823
- * Enable or disable specific alias by id.
1824
- * @summary Toggle alias
1825
- * @param {number} aliasId ID of an alias
1826
- * @param {*} [options] Override http request option.
1827
- * @throws {RequiredError}
1828
- */
1829
- toggleAlias(aliasId: number, options?: any): Promise<AliasAliasIdTogglePost>;
1830
- /**
1831
- * Update specific alias by id.
1832
- * @summary Update alias
1833
- * @param {AliasAliasIdPatch} body Updated settings for the given alias.
1834
- * @param {number} aliasId ID of an alias
1835
- * @param {*} [options] Override http request option.
1836
- * @throws {RequiredError}
1837
- */
1838
- updateAlias(body: AliasAliasIdPatch, aliasId: number, options?: any): Promise<Success>;
1839
- };
1840
- /**
1841
- * AliasApi - object-oriented interface
1842
- * @export
1843
- * @class AliasApi
1844
- * @extends {BaseAPI}
1845
- */
1846
- export declare class AliasApi extends BaseAPI {
1847
- /**
1848
- * Create a new contact for an alias by id.
1849
- * @summary Create contact
1850
- * @param {AliasAliasIdContactsPost} body Updated settings for the given alias.
1851
- * @param {number} aliasId ID of an alias
1852
- * @param {*} [options] Override http request option.
1853
- * @throws {RequiredError}
1854
- * @memberof AliasApi
1855
- */
1856
- createContact(body: AliasAliasIdContactsPost, aliasId: number, options?: any): Promise<AliasAliasIdContacts>;
1857
- /**
1858
- * Create a new custom alias
1859
- * @summary Create custom alias
1860
- * @param {AliasCustomNewPost} body
1861
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1862
- * @param {*} [options] Override http request option.
1863
- * @throws {RequiredError}
1864
- * @memberof AliasApi
1865
- */
1866
- createCustomAlias(body: AliasCustomNewPost, hostname?: string, options?: any): Promise<Alias>;
1867
- /**
1868
- * Create a new random alias
1869
- * @summary Create random alias
1870
- * @param {AliasRandomNewPost} body
1871
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1872
- * @param {string} [mode] Either &#x60;uuid&#x60; or &#x60;word&#x60;. By default, use the user setting when creating new random alias.
1873
- * @param {*} [options] Override http request option.
1874
- * @throws {RequiredError}
1875
- * @memberof AliasApi
1876
- */
1877
- createRandomAlias(body: AliasRandomNewPost, hostname?: string, mode?: string, options?: any): Promise<Alias>;
1878
- /**
1879
- * Delete specific alias by id.
1880
- * @summary Delete alias
1881
- * @param {number} aliasId ID of an alias
1882
- * @param {*} [options] Override http request option.
1883
- * @throws {RequiredError}
1884
- * @memberof AliasApi
1885
- */
1886
- deleteAlias(aliasId: number, options?: any): Promise<AliasAliasIdDelete>;
1887
- /**
1888
- * Get activities for specific alias by id.
1889
- * @summary Get activities
1890
- * @param {number} aliasId ID of an alias
1891
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1892
- * @param {*} [options] Override http request option.
1893
- * @throws {RequiredError}
1894
- * @memberof AliasApi
1895
- */
1896
- getActivities(aliasId: number, pageId: number, options?: any): Promise<AliasAliasIdActivitiesModelArray>;
1897
- /**
1898
- * Get specific alias by id.
1899
- * @summary Get alias
1900
- * @param {number} aliasId ID of an alias
1901
- * @param {*} [options] Override http request option.
1902
- * @throws {RequiredError}
1903
- * @memberof AliasApi
1904
- */
1905
- getAlias(aliasId: number, options?: any): Promise<Alias>;
1906
- /**
1907
- * User alias info and suggestion. Used by the first extension screen when user opens the extension.
1908
- * @summary Get alias options
1909
- * @param {string} [hostname] This information is important to know where an alias is used in order to suggest user the same alias if they want to create on alias on the same website in the future.
1910
- * @param {*} [options] Override http request option.
1911
- * @throws {RequiredError}
1912
- * @memberof AliasApi
1913
- */
1914
- getAliasOptions(hostname?: string, options?: any): Promise<AliasOptions>;
1915
- /**
1916
- * Get user aliases. Please note `pinned`, `disabled`, `enabled` are exclusive, i.e. only one can be present. They can only be set to `true`.
1917
- * @summary Get aliases
1918
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1919
- * @param {boolean} [pinned] If set, only pinned aliases are returned.
1920
- * @param {boolean} [disabled] If set, only disabled aliases are returned.
1921
- * @param {boolean} [enabled] If set, only enabled aliases are returned.
1922
- * @param {*} [options] Override http request option.
1923
- * @throws {RequiredError}
1924
- * @memberof AliasApi
1925
- */
1926
- getAliases(pageId: number, pinned?: boolean, disabled?: boolean, enabled?: boolean, options?: any): Promise<AliasModelArray>;
1927
- /**
1928
- * Get contacts for specific alias by id.
1929
- * @summary Get contacts
1930
- * @param {number} aliasId ID of an alias
1931
- * @param {number} pageId The endpoint returns maximum 20 aliases for each page.
1932
- * @param {*} [options] Override http request option.
1933
- * @throws {RequiredError}
1934
- * @memberof AliasApi
1935
- */
1936
- getContacts(aliasId: number, pageId: number, options?: any): Promise<AliasAliasIdContactsModelArray>;
1937
- /**
1938
- * Enable or disable specific alias by id.
1939
- * @summary Toggle alias
1940
- * @param {number} aliasId ID of an alias
1941
- * @param {*} [options] Override http request option.
1942
- * @throws {RequiredError}
1943
- * @memberof AliasApi
1944
- */
1945
- toggleAlias(aliasId: number, options?: any): Promise<AliasAliasIdTogglePost>;
1946
- /**
1947
- * Update specific alias by id.
1948
- * @summary Update alias
1949
- * @param {AliasAliasIdPatch} body Updated settings for the given alias.
1950
- * @param {number} aliasId ID of an alias
1951
- * @param {*} [options] Override http request option.
1952
- * @throws {RequiredError}
1953
- * @memberof AliasApi
1954
- */
1955
- updateAlias(body: AliasAliasIdPatch, aliasId: number, options?: any): Promise<Success>;
1956
- }
1957
- /**
1958
- * CustomDomainApi - fetch parameter creator
1959
- * @export
1960
- */
1961
- export declare const CustomDomainApiFetchParamCreator: (configuration?: Configuration) => {
1962
- /**
1963
- * Get users custom domains.
1964
- * @summary Get custom domains
1965
- * @param {number} aliasId ID of an alias
1966
- * @param {*} [options] Override http request option.
1967
- * @throws {RequiredError}
1968
- */
1969
- getCustomDomains(aliasId: number, options?: any): FetchArgs;
1970
- };
1971
- /**
1972
- * CustomDomainApi - functional programming interface
1973
- * @export
1974
- */
1975
- export declare const CustomDomainApiFp: (configuration?: Configuration) => {
1976
- /**
1977
- * Get users custom domains.
1978
- * @summary Get custom domains
1979
- * @param {number} aliasId ID of an alias
1980
- * @param {*} [options] Override http request option.
1981
- * @throws {RequiredError}
1982
- */
1983
- getCustomDomains(aliasId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomDomain>;
1984
- };
1985
- /**
1986
- * CustomDomainApi - factory interface
1987
- * @export
1988
- */
1989
- export declare const CustomDomainApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
1990
- /**
1991
- * Get users custom domains.
1992
- * @summary Get custom domains
1993
- * @param {number} aliasId ID of an alias
1994
- * @param {*} [options] Override http request option.
1995
- * @throws {RequiredError}
1996
- */
1997
- getCustomDomains(aliasId: number, options?: any): Promise<CustomDomain>;
1998
- };
1999
- /**
2000
- * CustomDomainApi - object-oriented interface
2001
- * @export
2002
- * @class CustomDomainApi
2003
- * @extends {BaseAPI}
2004
- */
2005
- export declare class CustomDomainApi extends BaseAPI {
2006
- /**
2007
- * Get users custom domains.
2008
- * @summary Get custom domains
2009
- * @param {number} aliasId ID of an alias
2010
- * @param {*} [options] Override http request option.
2011
- * @throws {RequiredError}
2012
- * @memberof CustomDomainApi
2013
- */
2014
- getCustomDomains(aliasId: number, options?: any): Promise<CustomDomain>;
2015
- }
2016
- /**
2017
- * MailboxApi - fetch parameter creator
2018
- * @export
2019
- */
2020
- export declare const MailboxApiFetchParamCreator: (configuration?: Configuration) => {
2021
- /**
2022
- * Create a new mailbox
2023
- * @summary Create mailbox
2024
- * @param {MailboxPost} body The new mailbox address
2025
- * @param {*} [options] Override http request option.
2026
- * @throws {RequiredError}
2027
- */
2028
- createMailbox(body: MailboxPost, options?: any): FetchArgs;
2029
- /**
2030
- * Delete specific mailbox by id.
2031
- * @summary Delete mailbox
2032
- * @param {number} mailboxId ID of a mailbox
2033
- * @param {*} [options] Override http request option.
2034
- * @throws {RequiredError}
2035
- */
2036
- deleteMailbox(mailboxId: number, options?: any): FetchArgs;
2037
- /**
2038
- * Get user mailboxes.
2039
- * @summary Get mailboxes
2040
- * @param {*} [options] Override http request option.
2041
- * @throws {RequiredError}
2042
- */
2043
- getMailboxes(options?: any): FetchArgs;
2044
- /**
2045
- * Update specific mailbox by id.
2046
- * @summary Update mailbox
2047
- * @param {MailboxMailboxIdPut} body Updated settings of mailbox
2048
- * @param {number} mailboxId ID of a mailbox
2049
- * @param {*} [options] Override http request option.
2050
- * @throws {RequiredError}
2051
- */
2052
- updateMailbox(body: MailboxMailboxIdPut, mailboxId: number, options?: any): FetchArgs;
2053
- };
2054
- /**
2055
- * MailboxApi - functional programming interface
2056
- * @export
2057
- */
2058
- export declare const MailboxApiFp: (configuration?: Configuration) => {
2059
- /**
2060
- * Create a new mailbox
2061
- * @summary Create mailbox
2062
- * @param {MailboxPost} body The new mailbox address
2063
- * @param {*} [options] Override http request option.
2064
- * @throws {RequiredError}
2065
- */
2066
- createMailbox(body: MailboxPost, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Mailbox>;
2067
- /**
2068
- * Delete specific mailbox by id.
2069
- * @summary Delete mailbox
2070
- * @param {number} mailboxId ID of a mailbox
2071
- * @param {*} [options] Override http request option.
2072
- * @throws {RequiredError}
2073
- */
2074
- deleteMailbox(mailboxId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
2075
- /**
2076
- * Get user mailboxes.
2077
- * @summary Get mailboxes
2078
- * @param {*} [options] Override http request option.
2079
- * @throws {RequiredError}
2080
- */
2081
- getMailboxes(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<MailboxModelArray>;
2082
- /**
2083
- * Update specific mailbox by id.
2084
- * @summary Update mailbox
2085
- * @param {MailboxMailboxIdPut} body Updated settings of mailbox
2086
- * @param {number} mailboxId ID of a mailbox
2087
- * @param {*} [options] Override http request option.
2088
- * @throws {RequiredError}
2089
- */
2090
- updateMailbox(body: MailboxMailboxIdPut, mailboxId: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
2091
- };
2092
- /**
2093
- * MailboxApi - factory interface
2094
- * @export
2095
- */
2096
- export declare const MailboxApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
2097
- /**
2098
- * Create a new mailbox
2099
- * @summary Create mailbox
2100
- * @param {MailboxPost} body The new mailbox address
2101
- * @param {*} [options] Override http request option.
2102
- * @throws {RequiredError}
2103
- */
2104
- createMailbox(body: MailboxPost, options?: any): Promise<Mailbox>;
2105
- /**
2106
- * Delete specific mailbox by id.
2107
- * @summary Delete mailbox
2108
- * @param {number} mailboxId ID of a mailbox
2109
- * @param {*} [options] Override http request option.
2110
- * @throws {RequiredError}
2111
- */
2112
- deleteMailbox(mailboxId: number, options?: any): Promise<any>;
2113
- /**
2114
- * Get user mailboxes.
2115
- * @summary Get mailboxes
2116
- * @param {*} [options] Override http request option.
2117
- * @throws {RequiredError}
2118
- */
2119
- getMailboxes(options?: any): Promise<MailboxModelArray>;
2120
- /**
2121
- * Update specific mailbox by id.
2122
- * @summary Update mailbox
2123
- * @param {MailboxMailboxIdPut} body Updated settings of mailbox
2124
- * @param {number} mailboxId ID of a mailbox
2125
- * @param {*} [options] Override http request option.
2126
- * @throws {RequiredError}
2127
- */
2128
- updateMailbox(body: MailboxMailboxIdPut, mailboxId: number, options?: any): Promise<any>;
2129
- };
2130
- /**
2131
- * MailboxApi - object-oriented interface
2132
- * @export
2133
- * @class MailboxApi
2134
- * @extends {BaseAPI}
2135
- */
2136
- export declare class MailboxApi extends BaseAPI {
2137
- /**
2138
- * Create a new mailbox
2139
- * @summary Create mailbox
2140
- * @param {MailboxPost} body The new mailbox address
2141
- * @param {*} [options] Override http request option.
2142
- * @throws {RequiredError}
2143
- * @memberof MailboxApi
2144
- */
2145
- createMailbox(body: MailboxPost, options?: any): Promise<Mailbox>;
2146
- /**
2147
- * Delete specific mailbox by id.
2148
- * @summary Delete mailbox
2149
- * @param {number} mailboxId ID of a mailbox
2150
- * @param {*} [options] Override http request option.
2151
- * @throws {RequiredError}
2152
- * @memberof MailboxApi
2153
- */
2154
- deleteMailbox(mailboxId: number, options?: any): Promise<any>;
2155
- /**
2156
- * Get user mailboxes.
2157
- * @summary Get mailboxes
2158
- * @param {*} [options] Override http request option.
2159
- * @throws {RequiredError}
2160
- * @memberof MailboxApi
2161
- */
2162
- getMailboxes(options?: any): Promise<MailboxModelArray>;
2163
- /**
2164
- * Update specific mailbox by id.
2165
- * @summary Update mailbox
2166
- * @param {MailboxMailboxIdPut} body Updated settings of mailbox
2167
- * @param {number} mailboxId ID of a mailbox
2168
- * @param {*} [options] Override http request option.
2169
- * @throws {RequiredError}
2170
- * @memberof MailboxApi
2171
- */
2172
- updateMailbox(body: MailboxMailboxIdPut, mailboxId: number, options?: any): Promise<any>;
2173
- }