@emilgroup/notification-sdk 0.8.1-beta.27 → 0.8.1-beta.28

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/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/notification-sdk@0.8.1-beta.27 --save
20
+ npm install @emilgroup/notification-sdk@0.8.1-beta.28 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk@0.8.1-beta.27
24
+ yarn add @emilgroup/notification-sdk@0.8.1-beta.28
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -35,7 +35,8 @@ import { ListEmailMessagesResponseClass } from '../models';
35
35
  export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
38
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
39
+ * @summary Download the email message attachment
39
40
  * @param {string} code
40
41
  * @param {number} attachmentId
41
42
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -83,7 +84,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
83
84
  };
84
85
  },
85
86
  /**
86
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
87
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
88
+ * @summary Retrieve the email message
87
89
  * @param {string} code
88
90
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
91
  * @param {*} [options] Override http request option.
@@ -127,7 +129,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
127
129
  };
128
130
  },
129
131
  /**
130
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
132
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
133
+ * @summary List the email message attachments
131
134
  * @param {string} code
132
135
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
136
  * @param {*} [options] Override http request option.
@@ -171,7 +174,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
171
174
  };
172
175
  },
173
176
  /**
174
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
177
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
175
178
  * @summary List email messages
176
179
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
177
180
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -257,7 +260,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
257
260
  const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
258
261
  return {
259
262
  /**
260
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
263
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
264
+ * @summary Download the email message attachment
261
265
  * @param {string} code
262
266
  * @param {number} attachmentId
263
267
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -269,7 +273,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
269
273
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
270
274
  },
271
275
  /**
272
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
276
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
277
+ * @summary Retrieve the email message
273
278
  * @param {string} code
274
279
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
275
280
  * @param {*} [options] Override http request option.
@@ -280,7 +285,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
280
285
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
281
286
  },
282
287
  /**
283
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
288
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
289
+ * @summary List the email message attachments
284
290
  * @param {string} code
285
291
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
286
292
  * @param {*} [options] Override http request option.
@@ -291,7 +297,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
291
297
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
292
298
  },
293
299
  /**
294
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
300
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
295
301
  * @summary List email messages
296
302
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
303
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -319,7 +325,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
319
325
  const localVarFp = EmailMessagesApiFp(configuration)
320
326
  return {
321
327
  /**
322
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
328
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
329
+ * @summary Download the email message attachment
323
330
  * @param {string} code
324
331
  * @param {number} attachmentId
325
332
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -330,7 +337,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
330
337
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
331
338
  },
332
339
  /**
333
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
340
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
341
+ * @summary Retrieve the email message
334
342
  * @param {string} code
335
343
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
336
344
  * @param {*} [options] Override http request option.
@@ -340,7 +348,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
340
348
  return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
341
349
  },
342
350
  /**
343
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
351
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
352
+ * @summary List the email message attachments
344
353
  * @param {string} code
345
354
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
346
355
  * @param {*} [options] Override http request option.
@@ -350,7 +359,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
350
359
  return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
351
360
  },
352
361
  /**
353
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
362
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
354
363
  * @summary List email messages
355
364
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
356
365
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -510,7 +519,8 @@ export interface EmailMessagesApiListEmailMessagesRequest {
510
519
  */
511
520
  export class EmailMessagesApi extends BaseAPI {
512
521
  /**
513
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
522
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
523
+ * @summary Download the email message attachment
514
524
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
515
525
  * @param {*} [options] Override http request option.
516
526
  * @throws {RequiredError}
@@ -521,7 +531,8 @@ export class EmailMessagesApi extends BaseAPI {
521
531
  }
522
532
 
523
533
  /**
524
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
534
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
535
+ * @summary Retrieve the email message
525
536
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
526
537
  * @param {*} [options] Override http request option.
527
538
  * @throws {RequiredError}
@@ -532,7 +543,8 @@ export class EmailMessagesApi extends BaseAPI {
532
543
  }
533
544
 
534
545
  /**
535
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
546
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
547
+ * @summary List the email message attachments
536
548
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
537
549
  * @param {*} [options] Override http request option.
538
550
  * @throws {RequiredError}
@@ -543,7 +555,7 @@ export class EmailMessagesApi extends BaseAPI {
543
555
  }
544
556
 
545
557
  /**
546
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
558
+ * Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
547
559
  * @summary List email messages
548
560
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
549
561
  * @param {*} [options] Override http request option.
@@ -33,7 +33,8 @@ import { ListEmailThreadsResponseClass } from '../models';
33
33
  export const EmailTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
34
34
  return {
35
35
  /**
36
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
36
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
37
+ * @summary Close the email thread
37
38
  * @param {string} code
38
39
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
40
  * @param {*} [options] Override http request option.
@@ -77,7 +78,8 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
77
78
  };
78
79
  },
79
80
  /**
80
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
81
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
82
+ * @summary Retrieve the email thread
81
83
  * @param {string} code
82
84
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
83
85
  * @param {*} [options] Override http request option.
@@ -121,7 +123,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
121
123
  };
122
124
  },
123
125
  /**
124
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
126
+ * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
125
127
  * @summary List email messages
126
128
  * @param {string} code
127
129
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -186,7 +188,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
186
188
  };
187
189
  },
188
190
  /**
189
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
191
+ * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
190
192
  * @summary List email threads
191
193
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
192
194
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -272,7 +274,8 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
272
274
  const localVarAxiosParamCreator = EmailTrackingApiAxiosParamCreator(configuration)
273
275
  return {
274
276
  /**
275
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
277
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
278
+ * @summary Close the email thread
276
279
  * @param {string} code
277
280
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
278
281
  * @param {*} [options] Override http request option.
@@ -283,7 +286,8 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
283
286
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
284
287
  },
285
288
  /**
286
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
289
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
290
+ * @summary Retrieve the email thread
287
291
  * @param {string} code
288
292
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
289
293
  * @param {*} [options] Override http request option.
@@ -294,7 +298,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
294
298
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
295
299
  },
296
300
  /**
297
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
301
+ * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
298
302
  * @summary List email messages
299
303
  * @param {string} code
300
304
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -310,7 +314,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
310
314
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
311
315
  },
312
316
  /**
313
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
317
+ * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
314
318
  * @summary List email threads
315
319
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
316
320
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -338,7 +342,8 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
338
342
  const localVarFp = EmailTrackingApiFp(configuration)
339
343
  return {
340
344
  /**
341
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
345
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
346
+ * @summary Close the email thread
342
347
  * @param {string} code
343
348
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
344
349
  * @param {*} [options] Override http request option.
@@ -348,7 +353,8 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
348
353
  return localVarFp.closeThread(code, authorization, options).then((request) => request(axios, basePath));
349
354
  },
350
355
  /**
351
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
356
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
357
+ * @summary Retrieve the email thread
352
358
  * @param {string} code
353
359
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
354
360
  * @param {*} [options] Override http request option.
@@ -358,7 +364,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
358
364
  return localVarFp.getThread(code, authorization, options).then((request) => request(axios, basePath));
359
365
  },
360
366
  /**
361
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
367
+ * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
362
368
  * @summary List email messages
363
369
  * @param {string} code
364
370
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -373,7 +379,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
373
379
  return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
374
380
  },
375
381
  /**
376
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
382
+ * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
377
383
  * @summary List email threads
378
384
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
379
385
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -554,7 +560,8 @@ export interface EmailTrackingApiListThreadsRequest {
554
560
  */
555
561
  export class EmailTrackingApi extends BaseAPI {
556
562
  /**
557
- * undefined **Required Permissions** \"notification-management.email-messages.update\"
563
+ * Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
564
+ * @summary Close the email thread
558
565
  * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
559
566
  * @param {*} [options] Override http request option.
560
567
  * @throws {RequiredError}
@@ -565,7 +572,8 @@ export class EmailTrackingApi extends BaseAPI {
565
572
  }
566
573
 
567
574
  /**
568
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
575
+ * Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
576
+ * @summary Retrieve the email thread
569
577
  * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
570
578
  * @param {*} [options] Override http request option.
571
579
  * @throws {RequiredError}
@@ -576,7 +584,7 @@ export class EmailTrackingApi extends BaseAPI {
576
584
  }
577
585
 
578
586
  /**
579
- * Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
587
+ * Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
580
588
  * @summary List email messages
581
589
  * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
582
590
  * @param {*} [options] Override http request option.
@@ -588,7 +596,7 @@ export class EmailTrackingApi extends BaseAPI {
588
596
  }
589
597
 
590
598
  /**
591
- * Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
599
+ * Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
592
600
  * @summary List email threads
593
601
  * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
594
602
  * @param {*} [options] Override http request option.
@@ -35,7 +35,8 @@ import { InitiateEmailVerificationResponseClass } from '../models';
35
35
  export const EmailVerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * undefined **Required Permissions** none
38
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
39
+ * @summary Complete an email verification
39
40
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
40
41
  * @param {string} [authorization] Bearer Token
41
42
  * @param {*} [options] Override http request option.
@@ -81,7 +82,8 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
81
82
  };
82
83
  },
83
84
  /**
84
- * undefined **Required Permissions** none
85
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
86
+ * @summary Initiate an email verification
85
87
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
86
88
  * @param {string} [authorization] Bearer Token
87
89
  * @param {*} [options] Override http request option.
@@ -137,7 +139,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
137
139
  const localVarAxiosParamCreator = EmailVerificationsApiAxiosParamCreator(configuration)
138
140
  return {
139
141
  /**
140
- * undefined **Required Permissions** none
142
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
143
+ * @summary Complete an email verification
141
144
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
142
145
  * @param {string} [authorization] Bearer Token
143
146
  * @param {*} [options] Override http request option.
@@ -148,7 +151,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
148
151
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
149
152
  },
150
153
  /**
151
- * undefined **Required Permissions** none
154
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
155
+ * @summary Initiate an email verification
152
156
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
153
157
  * @param {string} [authorization] Bearer Token
154
158
  * @param {*} [options] Override http request option.
@@ -169,7 +173,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
169
173
  const localVarFp = EmailVerificationsApiFp(configuration)
170
174
  return {
171
175
  /**
172
- * undefined **Required Permissions** none
176
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
177
+ * @summary Complete an email verification
173
178
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
174
179
  * @param {string} [authorization] Bearer Token
175
180
  * @param {*} [options] Override http request option.
@@ -179,7 +184,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
179
184
  return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then((request) => request(axios, basePath));
180
185
  },
181
186
  /**
182
- * undefined **Required Permissions** none
187
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
188
+ * @summary Initiate an email verification
183
189
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
184
190
  * @param {string} [authorization] Bearer Token
185
191
  * @param {*} [options] Override http request option.
@@ -241,7 +247,8 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
241
247
  */
242
248
  export class EmailVerificationsApi extends BaseAPI {
243
249
  /**
244
- * undefined **Required Permissions** none
250
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
251
+ * @summary Complete an email verification
245
252
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
246
253
  * @param {*} [options] Override http request option.
247
254
  * @throws {RequiredError}
@@ -252,7 +259,8 @@ export class EmailVerificationsApi extends BaseAPI {
252
259
  }
253
260
 
254
261
  /**
255
- * undefined **Required Permissions** none
262
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
263
+ * @summary Initiate an email verification
256
264
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
257
265
  * @param {*} [options] Override http request option.
258
266
  * @throws {RequiredError}