@emilgroup/notification-sdk 0.8.1-beta.28 → 0.8.1-beta.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.
- package/.openapi-generator/FILES +0 -1
- package/README.md +2 -2
- package/api/email-messages-api.ts +24 -36
- package/api/email-tracking-api.ts +24 -32
- package/api/email-verifications-api.ts +8 -16
- package/api/layouts-api.ts +36 -56
- package/api/notification-templates-api.ts +36 -56
- package/api/notifications-api.ts +4 -8
- package/api.ts +0 -2
- package/dist/api/email-messages-api.d.ts +24 -36
- package/dist/api/email-messages-api.js +22 -34
- package/dist/api/email-tracking-api.d.ts +24 -32
- package/dist/api/email-tracking-api.js +22 -30
- package/dist/api/email-verifications-api.d.ts +8 -16
- package/dist/api/email-verifications-api.js +8 -16
- package/dist/api/layouts-api.d.ts +36 -56
- package/dist/api/layouts-api.js +32 -52
- package/dist/api/notification-templates-api.d.ts +36 -56
- package/dist/api/notification-templates-api.js +32 -52
- package/dist/api/notifications-api.d.ts +4 -8
- package/dist/api/notifications-api.js +4 -8
- package/dist/api.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/models/email-message-class.d.ts +1 -47
- package/dist/models/email-message-class.js +1 -14
- package/dist/models/send-notification-request-dto.d.ts +0 -9
- package/dist/models/send-notification-request-dto.js +1 -2
- package/models/email-message-class.ts +1 -50
- package/models/send-notification-request-dto.ts +1 -8
- package/package.json +1 -1
- package/api/msgraph-webhooks-api.ts +0 -278
- package/dist/api/msgraph-webhooks-api.d.ts +0 -168
- package/dist/api/msgraph-webhooks-api.js +0 -305
package/.openapi-generator/FILES
CHANGED
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.
|
|
20
|
+
npm install @emilgroup/notification-sdk@0.8.1-beta.3 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/notification-sdk@0.8.1-beta.
|
|
24
|
+
yarn add @emilgroup/notification-sdk@0.8.1-beta.3
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -35,8 +35,7 @@ import { ListEmailMessagesResponseClass } from '../models';
|
|
|
35
35
|
export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
39
|
-
* @summary Download the email message attachment
|
|
38
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
40
39
|
* @param {string} code
|
|
41
40
|
* @param {number} attachmentId
|
|
42
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -84,8 +83,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
84
83
|
};
|
|
85
84
|
},
|
|
86
85
|
/**
|
|
87
|
-
*
|
|
88
|
-
* @summary Retrieve the email message
|
|
86
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
89
87
|
* @param {string} code
|
|
90
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
89
|
* @param {*} [options] Override http request option.
|
|
@@ -129,8 +127,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
129
127
|
};
|
|
130
128
|
},
|
|
131
129
|
/**
|
|
132
|
-
*
|
|
133
|
-
* @summary List the email message attachments
|
|
130
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
134
131
|
* @param {string} code
|
|
135
132
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
136
133
|
* @param {*} [options] Override http request option.
|
|
@@ -174,16 +171,16 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
174
171
|
};
|
|
175
172
|
},
|
|
176
173
|
/**
|
|
177
|
-
*
|
|
174
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
178
175
|
* @summary List email messages
|
|
179
176
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
177
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
181
178
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
182
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
179
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
183
180
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
184
181
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
185
182
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
186
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
183
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
187
184
|
* @param {*} [options] Override http request option.
|
|
188
185
|
* @throws {RequiredError}
|
|
189
186
|
*/
|
|
@@ -260,8 +257,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
260
257
|
const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
|
|
261
258
|
return {
|
|
262
259
|
/**
|
|
263
|
-
*
|
|
264
|
-
* @summary Download the email message attachment
|
|
260
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
265
261
|
* @param {string} code
|
|
266
262
|
* @param {number} attachmentId
|
|
267
263
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -273,8 +269,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
273
269
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
274
270
|
},
|
|
275
271
|
/**
|
|
276
|
-
*
|
|
277
|
-
* @summary Retrieve the email message
|
|
272
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
278
273
|
* @param {string} code
|
|
279
274
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
280
275
|
* @param {*} [options] Override http request option.
|
|
@@ -285,8 +280,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
285
280
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
286
281
|
},
|
|
287
282
|
/**
|
|
288
|
-
*
|
|
289
|
-
* @summary List the email message attachments
|
|
283
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
290
284
|
* @param {string} code
|
|
291
285
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
292
286
|
* @param {*} [options] Override http request option.
|
|
@@ -297,16 +291,16 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
297
291
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
298
292
|
},
|
|
299
293
|
/**
|
|
300
|
-
*
|
|
294
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
301
295
|
* @summary List email messages
|
|
302
296
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
303
297
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
304
298
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
305
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
299
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
306
300
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
307
301
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
308
302
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
309
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
303
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
310
304
|
* @param {*} [options] Override http request option.
|
|
311
305
|
* @throws {RequiredError}
|
|
312
306
|
*/
|
|
@@ -325,8 +319,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
325
319
|
const localVarFp = EmailMessagesApiFp(configuration)
|
|
326
320
|
return {
|
|
327
321
|
/**
|
|
328
|
-
*
|
|
329
|
-
* @summary Download the email message attachment
|
|
322
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
330
323
|
* @param {string} code
|
|
331
324
|
* @param {number} attachmentId
|
|
332
325
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -337,8 +330,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
337
330
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
|
|
338
331
|
},
|
|
339
332
|
/**
|
|
340
|
-
*
|
|
341
|
-
* @summary Retrieve the email message
|
|
333
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
342
334
|
* @param {string} code
|
|
343
335
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
344
336
|
* @param {*} [options] Override http request option.
|
|
@@ -348,8 +340,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
348
340
|
return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
|
|
349
341
|
},
|
|
350
342
|
/**
|
|
351
|
-
*
|
|
352
|
-
* @summary List the email message attachments
|
|
343
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
353
344
|
* @param {string} code
|
|
354
345
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
355
346
|
* @param {*} [options] Override http request option.
|
|
@@ -359,16 +350,16 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
359
350
|
return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
|
|
360
351
|
},
|
|
361
352
|
/**
|
|
362
|
-
*
|
|
353
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
363
354
|
* @summary List email messages
|
|
364
355
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
356
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
366
357
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
367
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
358
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
368
359
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
369
360
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
370
361
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
371
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
362
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
372
363
|
* @param {*} [options] Override http request option.
|
|
373
364
|
* @throws {RequiredError}
|
|
374
365
|
*/
|
|
@@ -476,7 +467,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
476
467
|
readonly pageToken?: string
|
|
477
468
|
|
|
478
469
|
/**
|
|
479
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
470
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
480
471
|
* @type {string}
|
|
481
472
|
* @memberof EmailMessagesApiListEmailMessages
|
|
482
473
|
*/
|
|
@@ -504,7 +495,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
504
495
|
readonly expand?: string
|
|
505
496
|
|
|
506
497
|
/**
|
|
507
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
498
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
508
499
|
* @type {string}
|
|
509
500
|
* @memberof EmailMessagesApiListEmailMessages
|
|
510
501
|
*/
|
|
@@ -519,8 +510,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
519
510
|
*/
|
|
520
511
|
export class EmailMessagesApi extends BaseAPI {
|
|
521
512
|
/**
|
|
522
|
-
*
|
|
523
|
-
* @summary Download the email message attachment
|
|
513
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
524
514
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
525
515
|
* @param {*} [options] Override http request option.
|
|
526
516
|
* @throws {RequiredError}
|
|
@@ -531,8 +521,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
531
521
|
}
|
|
532
522
|
|
|
533
523
|
/**
|
|
534
|
-
*
|
|
535
|
-
* @summary Retrieve the email message
|
|
524
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
536
525
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
537
526
|
* @param {*} [options] Override http request option.
|
|
538
527
|
* @throws {RequiredError}
|
|
@@ -543,8 +532,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
543
532
|
}
|
|
544
533
|
|
|
545
534
|
/**
|
|
546
|
-
*
|
|
547
|
-
* @summary List the email message attachments
|
|
535
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
548
536
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
549
537
|
* @param {*} [options] Override http request option.
|
|
550
538
|
* @throws {RequiredError}
|
|
@@ -555,7 +543,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
555
543
|
}
|
|
556
544
|
|
|
557
545
|
/**
|
|
558
|
-
*
|
|
546
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
559
547
|
* @summary List email messages
|
|
560
548
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
561
549
|
* @param {*} [options] Override http request option.
|
|
@@ -33,8 +33,7 @@ import { ListEmailThreadsResponseClass } from '../models';
|
|
|
33
33
|
export const EmailTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
37
|
-
* @summary Close the email thread
|
|
36
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
38
37
|
* @param {string} code
|
|
39
38
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
40
39
|
* @param {*} [options] Override http request option.
|
|
@@ -78,8 +77,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
78
77
|
};
|
|
79
78
|
},
|
|
80
79
|
/**
|
|
81
|
-
*
|
|
82
|
-
* @summary Retrieve the email thread
|
|
80
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
83
81
|
* @param {string} code
|
|
84
82
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
85
83
|
* @param {*} [options] Override http request option.
|
|
@@ -123,12 +121,12 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
123
121
|
};
|
|
124
122
|
},
|
|
125
123
|
/**
|
|
126
|
-
*
|
|
124
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
127
125
|
* @summary List email messages
|
|
128
126
|
* @param {string} code
|
|
129
127
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
130
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
131
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
128
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
129
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
132
130
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
133
131
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
134
132
|
* @param {*} [options] Override http request option.
|
|
@@ -188,7 +186,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
188
186
|
};
|
|
189
187
|
},
|
|
190
188
|
/**
|
|
191
|
-
*
|
|
189
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
192
190
|
* @summary List email threads
|
|
193
191
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
192
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -274,8 +272,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
274
272
|
const localVarAxiosParamCreator = EmailTrackingApiAxiosParamCreator(configuration)
|
|
275
273
|
return {
|
|
276
274
|
/**
|
|
277
|
-
*
|
|
278
|
-
* @summary Close the email thread
|
|
275
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
279
276
|
* @param {string} code
|
|
280
277
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
281
278
|
* @param {*} [options] Override http request option.
|
|
@@ -286,8 +283,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
286
283
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
287
284
|
},
|
|
288
285
|
/**
|
|
289
|
-
*
|
|
290
|
-
* @summary Retrieve the email thread
|
|
286
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
291
287
|
* @param {string} code
|
|
292
288
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
293
289
|
* @param {*} [options] Override http request option.
|
|
@@ -298,12 +294,12 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
298
294
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
299
295
|
},
|
|
300
296
|
/**
|
|
301
|
-
*
|
|
297
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
302
298
|
* @summary List email messages
|
|
303
299
|
* @param {string} code
|
|
304
300
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
305
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
306
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
301
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
302
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
307
303
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
308
304
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
309
305
|
* @param {*} [options] Override http request option.
|
|
@@ -314,7 +310,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
314
310
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
315
311
|
},
|
|
316
312
|
/**
|
|
317
|
-
*
|
|
313
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
318
314
|
* @summary List email threads
|
|
319
315
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
320
316
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -342,8 +338,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
342
338
|
const localVarFp = EmailTrackingApiFp(configuration)
|
|
343
339
|
return {
|
|
344
340
|
/**
|
|
345
|
-
*
|
|
346
|
-
* @summary Close the email thread
|
|
341
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
347
342
|
* @param {string} code
|
|
348
343
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
349
344
|
* @param {*} [options] Override http request option.
|
|
@@ -353,8 +348,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
353
348
|
return localVarFp.closeThread(code, authorization, options).then((request) => request(axios, basePath));
|
|
354
349
|
},
|
|
355
350
|
/**
|
|
356
|
-
*
|
|
357
|
-
* @summary Retrieve the email thread
|
|
351
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
358
352
|
* @param {string} code
|
|
359
353
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
360
354
|
* @param {*} [options] Override http request option.
|
|
@@ -364,12 +358,12 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
364
358
|
return localVarFp.getThread(code, authorization, options).then((request) => request(axios, basePath));
|
|
365
359
|
},
|
|
366
360
|
/**
|
|
367
|
-
*
|
|
361
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
368
362
|
* @summary List email messages
|
|
369
363
|
* @param {string} code
|
|
370
364
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
371
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
372
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
365
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
366
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
373
367
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
374
368
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
375
369
|
* @param {*} [options] Override http request option.
|
|
@@ -379,7 +373,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
379
373
|
return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
380
374
|
},
|
|
381
375
|
/**
|
|
382
|
-
*
|
|
376
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
383
377
|
* @summary List email threads
|
|
384
378
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
385
379
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -461,14 +455,14 @@ export interface EmailTrackingApiListMessagesRequest {
|
|
|
461
455
|
readonly authorization?: string
|
|
462
456
|
|
|
463
457
|
/**
|
|
464
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
458
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
465
459
|
* @type {string}
|
|
466
460
|
* @memberof EmailTrackingApiListMessages
|
|
467
461
|
*/
|
|
468
462
|
readonly filter?: string
|
|
469
463
|
|
|
470
464
|
/**
|
|
471
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
465
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
472
466
|
* @type {string}
|
|
473
467
|
* @memberof EmailTrackingApiListMessages
|
|
474
468
|
*/
|
|
@@ -560,8 +554,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
560
554
|
*/
|
|
561
555
|
export class EmailTrackingApi extends BaseAPI {
|
|
562
556
|
/**
|
|
563
|
-
*
|
|
564
|
-
* @summary Close the email thread
|
|
557
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
565
558
|
* @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
|
|
566
559
|
* @param {*} [options] Override http request option.
|
|
567
560
|
* @throws {RequiredError}
|
|
@@ -572,8 +565,7 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
572
565
|
}
|
|
573
566
|
|
|
574
567
|
/**
|
|
575
|
-
*
|
|
576
|
-
* @summary Retrieve the email thread
|
|
568
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
577
569
|
* @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
|
|
578
570
|
* @param {*} [options] Override http request option.
|
|
579
571
|
* @throws {RequiredError}
|
|
@@ -584,7 +576,7 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
584
576
|
}
|
|
585
577
|
|
|
586
578
|
/**
|
|
587
|
-
*
|
|
579
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
588
580
|
* @summary List email messages
|
|
589
581
|
* @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
|
|
590
582
|
* @param {*} [options] Override http request option.
|
|
@@ -596,7 +588,7 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
596
588
|
}
|
|
597
589
|
|
|
598
590
|
/**
|
|
599
|
-
*
|
|
591
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
600
592
|
* @summary List email threads
|
|
601
593
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
602
594
|
* @param {*} [options] Override http request option.
|
|
@@ -35,8 +35,7 @@ import { InitiateEmailVerificationResponseClass } from '../models';
|
|
|
35
35
|
export const EmailVerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
39
|
-
* @summary Complete an email verification
|
|
38
|
+
* undefined **Required Permissions** none
|
|
40
39
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
41
40
|
* @param {string} [authorization] Bearer Token
|
|
42
41
|
* @param {*} [options] Override http request option.
|
|
@@ -82,8 +81,7 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
|
|
|
82
81
|
};
|
|
83
82
|
},
|
|
84
83
|
/**
|
|
85
|
-
*
|
|
86
|
-
* @summary Initiate an email verification
|
|
84
|
+
* undefined **Required Permissions** none
|
|
87
85
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
88
86
|
* @param {string} [authorization] Bearer Token
|
|
89
87
|
* @param {*} [options] Override http request option.
|
|
@@ -139,8 +137,7 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
|
|
|
139
137
|
const localVarAxiosParamCreator = EmailVerificationsApiAxiosParamCreator(configuration)
|
|
140
138
|
return {
|
|
141
139
|
/**
|
|
142
|
-
*
|
|
143
|
-
* @summary Complete an email verification
|
|
140
|
+
* undefined **Required Permissions** none
|
|
144
141
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
145
142
|
* @param {string} [authorization] Bearer Token
|
|
146
143
|
* @param {*} [options] Override http request option.
|
|
@@ -151,8 +148,7 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
|
|
|
151
148
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
152
149
|
},
|
|
153
150
|
/**
|
|
154
|
-
*
|
|
155
|
-
* @summary Initiate an email verification
|
|
151
|
+
* undefined **Required Permissions** none
|
|
156
152
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
157
153
|
* @param {string} [authorization] Bearer Token
|
|
158
154
|
* @param {*} [options] Override http request option.
|
|
@@ -173,8 +169,7 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
|
|
|
173
169
|
const localVarFp = EmailVerificationsApiFp(configuration)
|
|
174
170
|
return {
|
|
175
171
|
/**
|
|
176
|
-
*
|
|
177
|
-
* @summary Complete an email verification
|
|
172
|
+
* undefined **Required Permissions** none
|
|
178
173
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
179
174
|
* @param {string} [authorization] Bearer Token
|
|
180
175
|
* @param {*} [options] Override http request option.
|
|
@@ -184,8 +179,7 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
|
|
|
184
179
|
return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then((request) => request(axios, basePath));
|
|
185
180
|
},
|
|
186
181
|
/**
|
|
187
|
-
*
|
|
188
|
-
* @summary Initiate an email verification
|
|
182
|
+
* undefined **Required Permissions** none
|
|
189
183
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
190
184
|
* @param {string} [authorization] Bearer Token
|
|
191
185
|
* @param {*} [options] Override http request option.
|
|
@@ -247,8 +241,7 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
|
|
|
247
241
|
*/
|
|
248
242
|
export class EmailVerificationsApi extends BaseAPI {
|
|
249
243
|
/**
|
|
250
|
-
*
|
|
251
|
-
* @summary Complete an email verification
|
|
244
|
+
* undefined **Required Permissions** none
|
|
252
245
|
* @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
|
|
253
246
|
* @param {*} [options] Override http request option.
|
|
254
247
|
* @throws {RequiredError}
|
|
@@ -259,8 +252,7 @@ export class EmailVerificationsApi extends BaseAPI {
|
|
|
259
252
|
}
|
|
260
253
|
|
|
261
254
|
/**
|
|
262
|
-
*
|
|
263
|
-
* @summary Initiate an email verification
|
|
255
|
+
* undefined **Required Permissions** none
|
|
264
256
|
* @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
|
|
265
257
|
* @param {*} [options] Override http request option.
|
|
266
258
|
* @throws {RequiredError}
|