@emilgroup/notification-sdk 0.8.1-beta.60 → 0.8.1-beta.62
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 +2 -0
- package/README.md +2 -2
- package/api/email-messages-api.ts +130 -8
- package/api/email-tracking-api.ts +8 -8
- package/dist/api/email-messages-api.d.ts +74 -8
- package/dist/api/email-messages-api.js +108 -6
- package/dist/api/email-tracking-api.d.ts +8 -8
- package/dist/api/email-tracking-api.js +6 -6
- package/dist/models/email-message-class.d.ts +23 -0
- package/dist/models/email-message-class.js +5 -1
- package/dist/models/email-message-summary-class.d.ts +17 -0
- package/dist/models/email-message-summary-class.js +5 -1
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/resend-email-message-body-dto.d.ts +30 -0
- package/dist/models/resend-email-message-body-dto.js +15 -0
- package/dist/models/resend-email-message-response-class.d.ts +25 -0
- package/dist/models/resend-email-message-response-class.js +15 -0
- package/models/email-message-class.ts +24 -0
- package/models/email-message-summary-class.ts +18 -0
- package/models/index.ts +2 -0
- package/models/resend-email-message-body-dto.ts +36 -0
- package/models/resend-email-message-response-class.ts +31 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -66,6 +66,8 @@ models/notification-template-class.ts
|
|
|
66
66
|
models/reconcile-email-subscriptions-request-dto.ts
|
|
67
67
|
models/reconcile-email-subscriptions-response-class.ts
|
|
68
68
|
models/renew-email-subscription-response-class.ts
|
|
69
|
+
models/resend-email-message-body-dto.ts
|
|
70
|
+
models/resend-email-message-response-class.ts
|
|
69
71
|
models/s3-document-dto.ts
|
|
70
72
|
models/send-email-request-dto.ts
|
|
71
73
|
models/send-email-response-class.ts
|
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.62 --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.62
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -28,6 +28,10 @@ import { GetEmailMessageResponseClass } from '../models';
|
|
|
28
28
|
import { ListEmailAttachmentsResponseClass } from '../models';
|
|
29
29
|
// @ts-ignore
|
|
30
30
|
import { ListEmailMessagesResponseClass } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
import { ResendEmailMessageBodyDto } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
import { ResendEmailMessageResponseClass } from '../models';
|
|
31
35
|
/**
|
|
32
36
|
* EmailMessagesApi - axios parameter creator
|
|
33
37
|
* @export
|
|
@@ -185,11 +189,11 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
185
189
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
186
190
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
187
191
|
* @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.
|
|
188
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
192
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
189
193
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
190
194
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
191
195
|
* @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>
|
|
192
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
196
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
193
197
|
* @param {*} [options] Override http request option.
|
|
194
198
|
* @throws {RequiredError}
|
|
195
199
|
*/
|
|
@@ -252,6 +256,59 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
252
256
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
253
257
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
254
258
|
|
|
259
|
+
return {
|
|
260
|
+
url: toPathString(localVarUrlObj),
|
|
261
|
+
options: localVarRequestOptions,
|
|
262
|
+
};
|
|
263
|
+
},
|
|
264
|
+
/**
|
|
265
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
266
|
+
* @summary Resend the email message
|
|
267
|
+
* @param {string} code
|
|
268
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
269
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
|
+
* @param {*} [options] Override http request option.
|
|
271
|
+
* @throws {RequiredError}
|
|
272
|
+
*/
|
|
273
|
+
resendMessage: async (code: string, resendEmailMessageBodyDto: ResendEmailMessageBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
274
|
+
// verify required parameter 'code' is not null or undefined
|
|
275
|
+
assertParamExists('resendMessage', 'code', code)
|
|
276
|
+
// verify required parameter 'resendEmailMessageBodyDto' is not null or undefined
|
|
277
|
+
assertParamExists('resendMessage', 'resendEmailMessageBodyDto', resendEmailMessageBodyDto)
|
|
278
|
+
const localVarPath = `/notificationservice/v1/email-messages/{code}/resend`
|
|
279
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
280
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
281
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
282
|
+
let baseOptions;
|
|
283
|
+
let baseAccessToken;
|
|
284
|
+
if (configuration) {
|
|
285
|
+
baseOptions = configuration.baseOptions;
|
|
286
|
+
baseAccessToken = configuration.accessToken;
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
290
|
+
const localVarHeaderParameter = {} as any;
|
|
291
|
+
const localVarQueryParameter = {} as any;
|
|
292
|
+
|
|
293
|
+
// authentication bearer required
|
|
294
|
+
// http bearer authentication required
|
|
295
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
296
|
+
|
|
297
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
298
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
299
|
+
if (authorizationValue) {
|
|
300
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
306
|
+
|
|
307
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
308
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
309
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
310
|
+
localVarRequestOptions.data = serializeDataIfNeeded(resendEmailMessageBodyDto, localVarRequestOptions, configuration)
|
|
311
|
+
|
|
255
312
|
return {
|
|
256
313
|
url: toPathString(localVarUrlObj),
|
|
257
314
|
options: localVarRequestOptions,
|
|
@@ -310,11 +367,11 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
310
367
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
311
368
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
312
369
|
* @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.
|
|
313
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
370
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
314
371
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
315
372
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
316
373
|
* @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>
|
|
317
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
374
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
318
375
|
* @param {*} [options] Override http request option.
|
|
319
376
|
* @throws {RequiredError}
|
|
320
377
|
*/
|
|
@@ -322,6 +379,19 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
322
379
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
323
380
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
324
381
|
},
|
|
382
|
+
/**
|
|
383
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
384
|
+
* @summary Resend the email message
|
|
385
|
+
* @param {string} code
|
|
386
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
387
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
388
|
+
* @param {*} [options] Override http request option.
|
|
389
|
+
* @throws {RequiredError}
|
|
390
|
+
*/
|
|
391
|
+
async resendMessage(code: string, resendEmailMessageBodyDto: ResendEmailMessageBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResendEmailMessageResponseClass>> {
|
|
392
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.resendMessage(code, resendEmailMessageBodyDto, authorization, options);
|
|
393
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
394
|
+
},
|
|
325
395
|
}
|
|
326
396
|
};
|
|
327
397
|
|
|
@@ -372,17 +442,29 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
372
442
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
373
443
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
374
444
|
* @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.
|
|
375
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
445
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
376
446
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
377
447
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
378
448
|
* @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>
|
|
379
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
449
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
380
450
|
* @param {*} [options] Override http request option.
|
|
381
451
|
* @throws {RequiredError}
|
|
382
452
|
*/
|
|
383
453
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
|
|
384
454
|
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
385
455
|
},
|
|
456
|
+
/**
|
|
457
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
458
|
+
* @summary Resend the email message
|
|
459
|
+
* @param {string} code
|
|
460
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
461
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
462
|
+
* @param {*} [options] Override http request option.
|
|
463
|
+
* @throws {RequiredError}
|
|
464
|
+
*/
|
|
465
|
+
resendMessage(code: string, resendEmailMessageBodyDto: ResendEmailMessageBodyDto, authorization?: string, options?: any): AxiosPromise<ResendEmailMessageResponseClass> {
|
|
466
|
+
return localVarFp.resendMessage(code, resendEmailMessageBodyDto, authorization, options).then((request) => request(axios, basePath));
|
|
467
|
+
},
|
|
386
468
|
};
|
|
387
469
|
};
|
|
388
470
|
|
|
@@ -484,7 +566,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
484
566
|
readonly pageToken?: string
|
|
485
567
|
|
|
486
568
|
/**
|
|
487
|
-
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
569
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
488
570
|
* @type {string}
|
|
489
571
|
* @memberof EmailMessagesApiListEmailMessages
|
|
490
572
|
*/
|
|
@@ -512,13 +594,41 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
512
594
|
readonly expand?: string
|
|
513
595
|
|
|
514
596
|
/**
|
|
515
|
-
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
597
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
516
598
|
* @type {string}
|
|
517
599
|
* @memberof EmailMessagesApiListEmailMessages
|
|
518
600
|
*/
|
|
519
601
|
readonly filters?: string
|
|
520
602
|
}
|
|
521
603
|
|
|
604
|
+
/**
|
|
605
|
+
* Request parameters for resendMessage operation in EmailMessagesApi.
|
|
606
|
+
* @export
|
|
607
|
+
* @interface EmailMessagesApiResendMessageRequest
|
|
608
|
+
*/
|
|
609
|
+
export interface EmailMessagesApiResendMessageRequest {
|
|
610
|
+
/**
|
|
611
|
+
*
|
|
612
|
+
* @type {string}
|
|
613
|
+
* @memberof EmailMessagesApiResendMessage
|
|
614
|
+
*/
|
|
615
|
+
readonly code: string
|
|
616
|
+
|
|
617
|
+
/**
|
|
618
|
+
*
|
|
619
|
+
* @type {ResendEmailMessageBodyDto}
|
|
620
|
+
* @memberof EmailMessagesApiResendMessage
|
|
621
|
+
*/
|
|
622
|
+
readonly resendEmailMessageBodyDto: ResendEmailMessageBodyDto
|
|
623
|
+
|
|
624
|
+
/**
|
|
625
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
626
|
+
* @type {string}
|
|
627
|
+
* @memberof EmailMessagesApiResendMessage
|
|
628
|
+
*/
|
|
629
|
+
readonly authorization?: string
|
|
630
|
+
}
|
|
631
|
+
|
|
522
632
|
/**
|
|
523
633
|
* EmailMessagesApi - object-oriented interface
|
|
524
634
|
* @export
|
|
@@ -573,4 +683,16 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
573
683
|
public listEmailMessages(requestParameters: EmailMessagesApiListEmailMessagesRequest = {}, options?: AxiosRequestConfig) {
|
|
574
684
|
return EmailMessagesApiFp(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
575
685
|
}
|
|
686
|
+
|
|
687
|
+
/**
|
|
688
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
689
|
+
* @summary Resend the email message
|
|
690
|
+
* @param {EmailMessagesApiResendMessageRequest} requestParameters Request parameters.
|
|
691
|
+
* @param {*} [options] Override http request option.
|
|
692
|
+
* @throws {RequiredError}
|
|
693
|
+
* @memberof EmailMessagesApi
|
|
694
|
+
*/
|
|
695
|
+
public resendMessage(requestParameters: EmailMessagesApiResendMessageRequest, options?: AxiosRequestConfig) {
|
|
696
|
+
return EmailMessagesApiFp(this.configuration).resendMessage(requestParameters.code, requestParameters.resendEmailMessageBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
697
|
+
}
|
|
576
698
|
}
|
|
@@ -190,8 +190,8 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
190
190
|
* @summary List email messages
|
|
191
191
|
* @param {string} code
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
194
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
193
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
194
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
195
195
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
196
196
|
* @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>
|
|
197
197
|
* @param {*} [options] Override http request option.
|
|
@@ -429,8 +429,8 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
429
429
|
* @summary List email messages
|
|
430
430
|
* @param {string} code
|
|
431
431
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
432
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
433
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
432
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
433
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
434
434
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
435
435
|
* @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>
|
|
436
436
|
* @param {*} [options] Override http request option.
|
|
@@ -519,8 +519,8 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
519
519
|
* @summary List email messages
|
|
520
520
|
* @param {string} code
|
|
521
521
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
522
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
523
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
522
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
523
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
524
524
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
525
525
|
* @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>
|
|
526
526
|
* @param {*} [options] Override http request option.
|
|
@@ -651,14 +651,14 @@ export interface EmailTrackingApiListMessagesRequest {
|
|
|
651
651
|
readonly authorization?: string
|
|
652
652
|
|
|
653
653
|
/**
|
|
654
|
-
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
654
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
655
655
|
* @type {string}
|
|
656
656
|
* @memberof EmailTrackingApiListMessages
|
|
657
657
|
*/
|
|
658
658
|
readonly filter?: string
|
|
659
659
|
|
|
660
660
|
/**
|
|
661
|
-
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
661
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
662
662
|
* @type {string}
|
|
663
663
|
* @memberof EmailTrackingApiListMessages
|
|
664
664
|
*/
|
|
@@ -16,6 +16,8 @@ import { DownloadAttachmentResponseClass } from '../models';
|
|
|
16
16
|
import { GetEmailMessageResponseClass } from '../models';
|
|
17
17
|
import { ListEmailAttachmentsResponseClass } from '../models';
|
|
18
18
|
import { ListEmailMessagesResponseClass } from '../models';
|
|
19
|
+
import { ResendEmailMessageBodyDto } from '../models';
|
|
20
|
+
import { ResendEmailMessageResponseClass } from '../models';
|
|
19
21
|
/**
|
|
20
22
|
* EmailMessagesApi - axios parameter creator
|
|
21
23
|
* @export
|
|
@@ -55,15 +57,25 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
55
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
56
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
57
59
|
* @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.
|
|
58
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
60
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
59
61
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
62
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
61
63
|
* @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>
|
|
62
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
64
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
63
65
|
* @param {*} [options] Override http request option.
|
|
64
66
|
* @throws {RequiredError}
|
|
65
67
|
*/
|
|
66
68
|
listEmailMessages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
/**
|
|
70
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
71
|
+
* @summary Resend the email message
|
|
72
|
+
* @param {string} code
|
|
73
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
74
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
resendMessage: (code: string, resendEmailMessageBodyDto: ResendEmailMessageBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
79
|
};
|
|
68
80
|
/**
|
|
69
81
|
* EmailMessagesApi - functional programming interface
|
|
@@ -104,15 +116,25 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
104
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
106
118
|
* @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.
|
|
107
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
119
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
108
120
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
109
121
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
110
122
|
* @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>
|
|
111
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
123
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
112
124
|
* @param {*} [options] Override http request option.
|
|
113
125
|
* @throws {RequiredError}
|
|
114
126
|
*/
|
|
115
127
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
|
|
128
|
+
/**
|
|
129
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
130
|
+
* @summary Resend the email message
|
|
131
|
+
* @param {string} code
|
|
132
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
133
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
resendMessage(code: string, resendEmailMessageBodyDto: ResendEmailMessageBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResendEmailMessageResponseClass>>;
|
|
116
138
|
};
|
|
117
139
|
/**
|
|
118
140
|
* EmailMessagesApi - factory interface
|
|
@@ -153,15 +175,25 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
153
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
155
177
|
* @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.
|
|
156
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
178
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
157
179
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
180
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
159
181
|
* @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>
|
|
160
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
182
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
161
183
|
* @param {*} [options] Override http request option.
|
|
162
184
|
* @throws {RequiredError}
|
|
163
185
|
*/
|
|
164
186
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
187
|
+
/**
|
|
188
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
189
|
+
* @summary Resend the email message
|
|
190
|
+
* @param {string} code
|
|
191
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
192
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
resendMessage(code: string, resendEmailMessageBodyDto: ResendEmailMessageBodyDto, authorization?: string, options?: any): AxiosPromise<ResendEmailMessageResponseClass>;
|
|
165
197
|
};
|
|
166
198
|
/**
|
|
167
199
|
* Request parameters for downloadAttachment operation in EmailMessagesApi.
|
|
@@ -251,7 +283,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
251
283
|
*/
|
|
252
284
|
readonly pageToken?: string;
|
|
253
285
|
/**
|
|
254
|
-
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
286
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
255
287
|
* @type {string}
|
|
256
288
|
* @memberof EmailMessagesApiListEmailMessages
|
|
257
289
|
*/
|
|
@@ -275,12 +307,37 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
275
307
|
*/
|
|
276
308
|
readonly expand?: string;
|
|
277
309
|
/**
|
|
278
|
-
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
310
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
279
311
|
* @type {string}
|
|
280
312
|
* @memberof EmailMessagesApiListEmailMessages
|
|
281
313
|
*/
|
|
282
314
|
readonly filters?: string;
|
|
283
315
|
}
|
|
316
|
+
/**
|
|
317
|
+
* Request parameters for resendMessage operation in EmailMessagesApi.
|
|
318
|
+
* @export
|
|
319
|
+
* @interface EmailMessagesApiResendMessageRequest
|
|
320
|
+
*/
|
|
321
|
+
export interface EmailMessagesApiResendMessageRequest {
|
|
322
|
+
/**
|
|
323
|
+
*
|
|
324
|
+
* @type {string}
|
|
325
|
+
* @memberof EmailMessagesApiResendMessage
|
|
326
|
+
*/
|
|
327
|
+
readonly code: string;
|
|
328
|
+
/**
|
|
329
|
+
*
|
|
330
|
+
* @type {ResendEmailMessageBodyDto}
|
|
331
|
+
* @memberof EmailMessagesApiResendMessage
|
|
332
|
+
*/
|
|
333
|
+
readonly resendEmailMessageBodyDto: ResendEmailMessageBodyDto;
|
|
334
|
+
/**
|
|
335
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
336
|
+
* @type {string}
|
|
337
|
+
* @memberof EmailMessagesApiResendMessage
|
|
338
|
+
*/
|
|
339
|
+
readonly authorization?: string;
|
|
340
|
+
}
|
|
284
341
|
/**
|
|
285
342
|
* EmailMessagesApi - object-oriented interface
|
|
286
343
|
* @export
|
|
@@ -324,4 +381,13 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
324
381
|
* @memberof EmailMessagesApi
|
|
325
382
|
*/
|
|
326
383
|
listEmailMessages(requestParameters?: EmailMessagesApiListEmailMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}, any>>;
|
|
384
|
+
/**
|
|
385
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
386
|
+
* @summary Resend the email message
|
|
387
|
+
* @param {EmailMessagesApiResendMessageRequest} requestParameters Request parameters.
|
|
388
|
+
* @param {*} [options] Override http request option.
|
|
389
|
+
* @throws {RequiredError}
|
|
390
|
+
* @memberof EmailMessagesApi
|
|
391
|
+
*/
|
|
392
|
+
resendMessage(requestParameters: EmailMessagesApiResendMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResendEmailMessageResponseClass, any, {}, any>>;
|
|
327
393
|
}
|
|
@@ -255,11 +255,11 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
255
255
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
256
256
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
257
257
|
* @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.
|
|
258
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
258
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
259
259
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
260
260
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
261
261
|
* @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>
|
|
262
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
262
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
263
263
|
* @param {*} [options] Override http request option.
|
|
264
264
|
* @throws {RequiredError}
|
|
265
265
|
*/
|
|
@@ -322,6 +322,62 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
322
322
|
});
|
|
323
323
|
});
|
|
324
324
|
},
|
|
325
|
+
/**
|
|
326
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
327
|
+
* @summary Resend the email message
|
|
328
|
+
* @param {string} code
|
|
329
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
330
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
331
|
+
* @param {*} [options] Override http request option.
|
|
332
|
+
* @throws {RequiredError}
|
|
333
|
+
*/
|
|
334
|
+
resendMessage: function (code, resendEmailMessageBodyDto, authorization, options) {
|
|
335
|
+
if (options === void 0) { options = {}; }
|
|
336
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
337
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
338
|
+
return __generator(this, function (_a) {
|
|
339
|
+
switch (_a.label) {
|
|
340
|
+
case 0:
|
|
341
|
+
// verify required parameter 'code' is not null or undefined
|
|
342
|
+
(0, common_1.assertParamExists)('resendMessage', 'code', code);
|
|
343
|
+
// verify required parameter 'resendEmailMessageBodyDto' is not null or undefined
|
|
344
|
+
(0, common_1.assertParamExists)('resendMessage', 'resendEmailMessageBodyDto', resendEmailMessageBodyDto);
|
|
345
|
+
localVarPath = "/notificationservice/v1/email-messages/{code}/resend"
|
|
346
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
347
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
348
|
+
if (configuration) {
|
|
349
|
+
baseOptions = configuration.baseOptions;
|
|
350
|
+
baseAccessToken = configuration.accessToken;
|
|
351
|
+
}
|
|
352
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
353
|
+
localVarHeaderParameter = {};
|
|
354
|
+
localVarQueryParameter = {};
|
|
355
|
+
// authentication bearer required
|
|
356
|
+
// http bearer authentication required
|
|
357
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
358
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
359
|
+
];
|
|
360
|
+
case 1:
|
|
361
|
+
// authentication bearer required
|
|
362
|
+
// http bearer authentication required
|
|
363
|
+
_a.sent();
|
|
364
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
365
|
+
if (authorizationValue) {
|
|
366
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
367
|
+
}
|
|
368
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
369
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
370
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
371
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
372
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(resendEmailMessageBodyDto, localVarRequestOptions, configuration);
|
|
373
|
+
return [2 /*return*/, {
|
|
374
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
375
|
+
options: localVarRequestOptions,
|
|
376
|
+
}];
|
|
377
|
+
}
|
|
378
|
+
});
|
|
379
|
+
});
|
|
380
|
+
},
|
|
325
381
|
};
|
|
326
382
|
};
|
|
327
383
|
exports.EmailMessagesApiAxiosParamCreator = EmailMessagesApiAxiosParamCreator;
|
|
@@ -402,11 +458,11 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
402
458
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
403
459
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
404
460
|
* @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.
|
|
405
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
461
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
406
462
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
407
463
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
408
464
|
* @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>
|
|
409
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
465
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
410
466
|
* @param {*} [options] Override http request option.
|
|
411
467
|
* @throws {RequiredError}
|
|
412
468
|
*/
|
|
@@ -423,6 +479,28 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
423
479
|
});
|
|
424
480
|
});
|
|
425
481
|
},
|
|
482
|
+
/**
|
|
483
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
484
|
+
* @summary Resend the email message
|
|
485
|
+
* @param {string} code
|
|
486
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
487
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
488
|
+
* @param {*} [options] Override http request option.
|
|
489
|
+
* @throws {RequiredError}
|
|
490
|
+
*/
|
|
491
|
+
resendMessage: function (code, resendEmailMessageBodyDto, authorization, options) {
|
|
492
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
493
|
+
var localVarAxiosArgs;
|
|
494
|
+
return __generator(this, function (_a) {
|
|
495
|
+
switch (_a.label) {
|
|
496
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.resendMessage(code, resendEmailMessageBodyDto, authorization, options)];
|
|
497
|
+
case 1:
|
|
498
|
+
localVarAxiosArgs = _a.sent();
|
|
499
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
500
|
+
}
|
|
501
|
+
});
|
|
502
|
+
});
|
|
503
|
+
},
|
|
426
504
|
};
|
|
427
505
|
};
|
|
428
506
|
exports.EmailMessagesApiFp = EmailMessagesApiFp;
|
|
@@ -473,17 +551,29 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
473
551
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
474
552
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
475
553
|
* @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.
|
|
476
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
554
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
477
555
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
478
556
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
479
557
|
* @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>
|
|
480
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
558
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
481
559
|
* @param {*} [options] Override http request option.
|
|
482
560
|
* @throws {RequiredError}
|
|
483
561
|
*/
|
|
484
562
|
listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
485
563
|
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
486
564
|
},
|
|
565
|
+
/**
|
|
566
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
567
|
+
* @summary Resend the email message
|
|
568
|
+
* @param {string} code
|
|
569
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
570
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
571
|
+
* @param {*} [options] Override http request option.
|
|
572
|
+
* @throws {RequiredError}
|
|
573
|
+
*/
|
|
574
|
+
resendMessage: function (code, resendEmailMessageBodyDto, authorization, options) {
|
|
575
|
+
return localVarFp.resendMessage(code, resendEmailMessageBodyDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
576
|
+
},
|
|
487
577
|
};
|
|
488
578
|
};
|
|
489
579
|
exports.EmailMessagesApiFactory = EmailMessagesApiFactory;
|
|
@@ -547,6 +637,18 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
547
637
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
548
638
|
return (0, exports.EmailMessagesApiFp)(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
549
639
|
};
|
|
640
|
+
/**
|
|
641
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to the recipient that bounced, or to newAddress when the address is corrected; pass recipient when more than one recipient bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
642
|
+
* @summary Resend the email message
|
|
643
|
+
* @param {EmailMessagesApiResendMessageRequest} requestParameters Request parameters.
|
|
644
|
+
* @param {*} [options] Override http request option.
|
|
645
|
+
* @throws {RequiredError}
|
|
646
|
+
* @memberof EmailMessagesApi
|
|
647
|
+
*/
|
|
648
|
+
EmailMessagesApi.prototype.resendMessage = function (requestParameters, options) {
|
|
649
|
+
var _this = this;
|
|
650
|
+
return (0, exports.EmailMessagesApiFp)(this.configuration).resendMessage(requestParameters.code, requestParameters.resendEmailMessageBodyDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
651
|
+
};
|
|
550
652
|
return EmailMessagesApi;
|
|
551
653
|
}(base_1.BaseAPI));
|
|
552
654
|
exports.EmailMessagesApi = EmailMessagesApi;
|
|
@@ -56,8 +56,8 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56
56
|
* @summary List email messages
|
|
57
57
|
* @param {string} code
|
|
58
58
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
60
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
59
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
60
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
61
61
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
62
62
|
* @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>
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
@@ -127,8 +127,8 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
127
127
|
* @summary List email messages
|
|
128
128
|
* @param {string} code
|
|
129
129
|
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
132
132
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
133
133
|
* @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
134
|
* @param {*} [options] Override http request option.
|
|
@@ -198,8 +198,8 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
198
198
|
* @summary List email messages
|
|
199
199
|
* @param {string} code
|
|
200
200
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
201
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
202
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
201
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
202
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
203
203
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
204
204
|
* @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>
|
|
205
205
|
* @param {*} [options] Override http request option.
|
|
@@ -313,13 +313,13 @@ export interface EmailTrackingApiListMessagesRequest {
|
|
|
313
313
|
*/
|
|
314
314
|
readonly authorization?: string;
|
|
315
315
|
/**
|
|
316
|
-
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
316
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
317
317
|
* @type {string}
|
|
318
318
|
* @memberof EmailTrackingApiListMessages
|
|
319
319
|
*/
|
|
320
320
|
readonly filter?: string;
|
|
321
321
|
/**
|
|
322
|
-
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
322
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
323
323
|
* @type {string}
|
|
324
324
|
* @memberof EmailTrackingApiListMessages
|
|
325
325
|
*/
|
|
@@ -255,8 +255,8 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
|
|
|
255
255
|
* @summary List email messages
|
|
256
256
|
* @param {string} code
|
|
257
257
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
258
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
259
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
258
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
259
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
260
260
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
261
261
|
* @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>
|
|
262
262
|
* @param {*} [options] Override http request option.
|
|
@@ -518,8 +518,8 @@ var EmailTrackingApiFp = function (configuration) {
|
|
|
518
518
|
* @summary List email messages
|
|
519
519
|
* @param {string} code
|
|
520
520
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
521
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
522
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
521
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
522
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
523
523
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
524
524
|
* @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>
|
|
525
525
|
* @param {*} [options] Override http request option.
|
|
@@ -635,8 +635,8 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
|
|
|
635
635
|
* @summary List email messages
|
|
636
636
|
* @param {string} code
|
|
637
637
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
638
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
639
|
-
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
638
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
639
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
640
640
|
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
641
641
|
* @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>
|
|
642
642
|
* @param {*} [options] Override http request option.
|
|
@@ -185,6 +185,24 @@ export interface EmailMessageClass {
|
|
|
185
185
|
* @memberof EmailMessageClass
|
|
186
186
|
*/
|
|
187
187
|
'workflowStatus'?: EmailMessageClassWorkflowStatusEnum;
|
|
188
|
+
/**
|
|
189
|
+
* Set only on an email that was created by resending another one: code of the bounced or failed email it was resent from. Written once when the email is created and never changed.
|
|
190
|
+
* @type {string}
|
|
191
|
+
* @memberof EmailMessageClass
|
|
192
|
+
*/
|
|
193
|
+
'resentFromMessageCode'?: string;
|
|
194
|
+
/**
|
|
195
|
+
* Set only on a resent email: why it was resent, which is the delivery status the original had at that moment.
|
|
196
|
+
* @type {string}
|
|
197
|
+
* @memberof EmailMessageClass
|
|
198
|
+
*/
|
|
199
|
+
'resendReason'?: EmailMessageClassResendReasonEnum;
|
|
200
|
+
/**
|
|
201
|
+
* Set only on an email resent because of a bounce: the address that bounced and that this email replaces. `toAddresses` holds the address the email was resent to.
|
|
202
|
+
* @type {string}
|
|
203
|
+
* @memberof EmailMessageClass
|
|
204
|
+
*/
|
|
205
|
+
'resentOriginalRecipient'?: string;
|
|
188
206
|
}
|
|
189
207
|
export declare const EmailMessageClassMatchStatusEnum: {
|
|
190
208
|
readonly Pending: "pending";
|
|
@@ -222,3 +240,8 @@ export declare const EmailMessageClassWorkflowStatusEnum: {
|
|
|
222
240
|
readonly Cancelled: "cancelled";
|
|
223
241
|
};
|
|
224
242
|
export type EmailMessageClassWorkflowStatusEnum = typeof EmailMessageClassWorkflowStatusEnum[keyof typeof EmailMessageClassWorkflowStatusEnum];
|
|
243
|
+
export declare const EmailMessageClassResendReasonEnum: {
|
|
244
|
+
readonly Bounced: "bounced";
|
|
245
|
+
readonly Failed: "failed";
|
|
246
|
+
};
|
|
247
|
+
export type EmailMessageClassResendReasonEnum = typeof EmailMessageClassResendReasonEnum[keyof typeof EmailMessageClassResendReasonEnum];
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.EmailMessageClassWorkflowStatusEnum = exports.EmailMessageClassDeliveryStatusEnum = exports.EmailMessageClassDirectionEnum = exports.EmailMessageClassProviderEnum = exports.EmailMessageClassKindEnum = exports.EmailMessageClassMatchStatusEnum = void 0;
|
|
16
|
+
exports.EmailMessageClassResendReasonEnum = exports.EmailMessageClassWorkflowStatusEnum = exports.EmailMessageClassDeliveryStatusEnum = exports.EmailMessageClassDirectionEnum = exports.EmailMessageClassProviderEnum = exports.EmailMessageClassKindEnum = exports.EmailMessageClassMatchStatusEnum = void 0;
|
|
17
17
|
exports.EmailMessageClassMatchStatusEnum = {
|
|
18
18
|
Pending: 'pending',
|
|
19
19
|
Matched: 'matched',
|
|
@@ -44,3 +44,7 @@ exports.EmailMessageClassWorkflowStatusEnum = {
|
|
|
44
44
|
Failed: 'failed',
|
|
45
45
|
Cancelled: 'cancelled'
|
|
46
46
|
};
|
|
47
|
+
exports.EmailMessageClassResendReasonEnum = {
|
|
48
|
+
Bounced: 'bounced',
|
|
49
|
+
Failed: 'failed'
|
|
50
|
+
};
|
|
@@ -75,6 +75,18 @@ export interface EmailMessageSummaryClass {
|
|
|
75
75
|
* @memberof EmailMessageSummaryClass
|
|
76
76
|
*/
|
|
77
77
|
'workflowStatus'?: EmailMessageSummaryClassWorkflowStatusEnum;
|
|
78
|
+
/**
|
|
79
|
+
* Set only on an email that was created by resending another one: code of the bounced or failed email it was resent from.
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof EmailMessageSummaryClass
|
|
82
|
+
*/
|
|
83
|
+
'resentFromMessageCode'?: string;
|
|
84
|
+
/**
|
|
85
|
+
* Set only on a resent email: why it was resent, which is the delivery status the original had at that moment.
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof EmailMessageSummaryClass
|
|
88
|
+
*/
|
|
89
|
+
'resendReason'?: EmailMessageSummaryClassResendReasonEnum;
|
|
78
90
|
}
|
|
79
91
|
export declare const EmailMessageSummaryClassDirectionEnum: {
|
|
80
92
|
readonly Outbound: "outbound";
|
|
@@ -96,3 +108,8 @@ export declare const EmailMessageSummaryClassWorkflowStatusEnum: {
|
|
|
96
108
|
readonly Cancelled: "cancelled";
|
|
97
109
|
};
|
|
98
110
|
export type EmailMessageSummaryClassWorkflowStatusEnum = typeof EmailMessageSummaryClassWorkflowStatusEnum[keyof typeof EmailMessageSummaryClassWorkflowStatusEnum];
|
|
111
|
+
export declare const EmailMessageSummaryClassResendReasonEnum: {
|
|
112
|
+
readonly Bounced: "bounced";
|
|
113
|
+
readonly Failed: "failed";
|
|
114
|
+
};
|
|
115
|
+
export type EmailMessageSummaryClassResendReasonEnum = typeof EmailMessageSummaryClassResendReasonEnum[keyof typeof EmailMessageSummaryClassResendReasonEnum];
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.EmailMessageSummaryClassWorkflowStatusEnum = exports.EmailMessageSummaryClassDeliveryStatusEnum = exports.EmailMessageSummaryClassDirectionEnum = void 0;
|
|
16
|
+
exports.EmailMessageSummaryClassResendReasonEnum = exports.EmailMessageSummaryClassWorkflowStatusEnum = exports.EmailMessageSummaryClassDeliveryStatusEnum = exports.EmailMessageSummaryClassDirectionEnum = void 0;
|
|
17
17
|
exports.EmailMessageSummaryClassDirectionEnum = {
|
|
18
18
|
Outbound: 'outbound',
|
|
19
19
|
Inbound: 'inbound'
|
|
@@ -31,3 +31,7 @@ exports.EmailMessageSummaryClassWorkflowStatusEnum = {
|
|
|
31
31
|
Failed: 'failed',
|
|
32
32
|
Cancelled: 'cancelled'
|
|
33
33
|
};
|
|
34
|
+
exports.EmailMessageSummaryClassResendReasonEnum = {
|
|
35
|
+
Bounced: 'bounced',
|
|
36
|
+
Failed: 'failed'
|
|
37
|
+
};
|
package/dist/models/index.d.ts
CHANGED
|
@@ -45,6 +45,8 @@ export * from './notification-template-class';
|
|
|
45
45
|
export * from './reconcile-email-subscriptions-request-dto';
|
|
46
46
|
export * from './reconcile-email-subscriptions-response-class';
|
|
47
47
|
export * from './renew-email-subscription-response-class';
|
|
48
|
+
export * from './resend-email-message-body-dto';
|
|
49
|
+
export * from './resend-email-message-response-class';
|
|
48
50
|
export * from './s3-document-dto';
|
|
49
51
|
export * from './send-email-request-dto';
|
|
50
52
|
export * from './send-email-response-class';
|
package/dist/models/index.js
CHANGED
|
@@ -61,6 +61,8 @@ __exportStar(require("./notification-template-class"), exports);
|
|
|
61
61
|
__exportStar(require("./reconcile-email-subscriptions-request-dto"), exports);
|
|
62
62
|
__exportStar(require("./reconcile-email-subscriptions-response-class"), exports);
|
|
63
63
|
__exportStar(require("./renew-email-subscription-response-class"), exports);
|
|
64
|
+
__exportStar(require("./resend-email-message-body-dto"), exports);
|
|
65
|
+
__exportStar(require("./resend-email-message-response-class"), exports);
|
|
64
66
|
__exportStar(require("./s3-document-dto"), exports);
|
|
65
67
|
__exportStar(require("./send-email-request-dto"), exports);
|
|
66
68
|
__exportStar(require("./send-email-response-class"), exports);
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL NotificationService
|
|
3
|
+
* The EMIL NotificationService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ResendEmailMessageBodyDto
|
|
16
|
+
*/
|
|
17
|
+
export interface ResendEmailMessageBodyDto {
|
|
18
|
+
/**
|
|
19
|
+
* Bounced emails only: the bounced recipient to resend to. Required when more than one recipient of the email bounced.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ResendEmailMessageBodyDto
|
|
22
|
+
*/
|
|
23
|
+
'recipient'?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Bounced emails only: the corrected address. The email is sent to it instead of the bounced recipient.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ResendEmailMessageBodyDto
|
|
28
|
+
*/
|
|
29
|
+
'newAddress'?: string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL NotificationService
|
|
6
|
+
* The EMIL NotificationService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL NotificationService
|
|
3
|
+
* The EMIL NotificationService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { EmailMessageClass } from './email-message-class';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ResendEmailMessageResponseClass
|
|
17
|
+
*/
|
|
18
|
+
export interface ResendEmailMessageResponseClass {
|
|
19
|
+
/**
|
|
20
|
+
* The email message response.
|
|
21
|
+
* @type {EmailMessageClass}
|
|
22
|
+
* @memberof ResendEmailMessageResponseClass
|
|
23
|
+
*/
|
|
24
|
+
'message': EmailMessageClass;
|
|
25
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL NotificationService
|
|
6
|
+
* The EMIL NotificationService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -190,6 +190,24 @@ export interface EmailMessageClass {
|
|
|
190
190
|
* @memberof EmailMessageClass
|
|
191
191
|
*/
|
|
192
192
|
'workflowStatus'?: EmailMessageClassWorkflowStatusEnum;
|
|
193
|
+
/**
|
|
194
|
+
* Set only on an email that was created by resending another one: code of the bounced or failed email it was resent from. Written once when the email is created and never changed.
|
|
195
|
+
* @type {string}
|
|
196
|
+
* @memberof EmailMessageClass
|
|
197
|
+
*/
|
|
198
|
+
'resentFromMessageCode'?: string;
|
|
199
|
+
/**
|
|
200
|
+
* Set only on a resent email: why it was resent, which is the delivery status the original had at that moment.
|
|
201
|
+
* @type {string}
|
|
202
|
+
* @memberof EmailMessageClass
|
|
203
|
+
*/
|
|
204
|
+
'resendReason'?: EmailMessageClassResendReasonEnum;
|
|
205
|
+
/**
|
|
206
|
+
* Set only on an email resent because of a bounce: the address that bounced and that this email replaces. `toAddresses` holds the address the email was resent to.
|
|
207
|
+
* @type {string}
|
|
208
|
+
* @memberof EmailMessageClass
|
|
209
|
+
*/
|
|
210
|
+
'resentOriginalRecipient'?: string;
|
|
193
211
|
}
|
|
194
212
|
|
|
195
213
|
export const EmailMessageClassMatchStatusEnum = {
|
|
@@ -234,5 +252,11 @@ export const EmailMessageClassWorkflowStatusEnum = {
|
|
|
234
252
|
} as const;
|
|
235
253
|
|
|
236
254
|
export type EmailMessageClassWorkflowStatusEnum = typeof EmailMessageClassWorkflowStatusEnum[keyof typeof EmailMessageClassWorkflowStatusEnum];
|
|
255
|
+
export const EmailMessageClassResendReasonEnum = {
|
|
256
|
+
Bounced: 'bounced',
|
|
257
|
+
Failed: 'failed'
|
|
258
|
+
} as const;
|
|
259
|
+
|
|
260
|
+
export type EmailMessageClassResendReasonEnum = typeof EmailMessageClassResendReasonEnum[keyof typeof EmailMessageClassResendReasonEnum];
|
|
237
261
|
|
|
238
262
|
|
|
@@ -80,6 +80,18 @@ export interface EmailMessageSummaryClass {
|
|
|
80
80
|
* @memberof EmailMessageSummaryClass
|
|
81
81
|
*/
|
|
82
82
|
'workflowStatus'?: EmailMessageSummaryClassWorkflowStatusEnum;
|
|
83
|
+
/**
|
|
84
|
+
* Set only on an email that was created by resending another one: code of the bounced or failed email it was resent from.
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof EmailMessageSummaryClass
|
|
87
|
+
*/
|
|
88
|
+
'resentFromMessageCode'?: string;
|
|
89
|
+
/**
|
|
90
|
+
* Set only on a resent email: why it was resent, which is the delivery status the original had at that moment.
|
|
91
|
+
* @type {string}
|
|
92
|
+
* @memberof EmailMessageSummaryClass
|
|
93
|
+
*/
|
|
94
|
+
'resendReason'?: EmailMessageSummaryClassResendReasonEnum;
|
|
83
95
|
}
|
|
84
96
|
|
|
85
97
|
export const EmailMessageSummaryClassDirectionEnum = {
|
|
@@ -105,5 +117,11 @@ export const EmailMessageSummaryClassWorkflowStatusEnum = {
|
|
|
105
117
|
} as const;
|
|
106
118
|
|
|
107
119
|
export type EmailMessageSummaryClassWorkflowStatusEnum = typeof EmailMessageSummaryClassWorkflowStatusEnum[keyof typeof EmailMessageSummaryClassWorkflowStatusEnum];
|
|
120
|
+
export const EmailMessageSummaryClassResendReasonEnum = {
|
|
121
|
+
Bounced: 'bounced',
|
|
122
|
+
Failed: 'failed'
|
|
123
|
+
} as const;
|
|
124
|
+
|
|
125
|
+
export type EmailMessageSummaryClassResendReasonEnum = typeof EmailMessageSummaryClassResendReasonEnum[keyof typeof EmailMessageSummaryClassResendReasonEnum];
|
|
108
126
|
|
|
109
127
|
|
package/models/index.ts
CHANGED
|
@@ -45,6 +45,8 @@ export * from './notification-template-class';
|
|
|
45
45
|
export * from './reconcile-email-subscriptions-request-dto';
|
|
46
46
|
export * from './reconcile-email-subscriptions-response-class';
|
|
47
47
|
export * from './renew-email-subscription-response-class';
|
|
48
|
+
export * from './resend-email-message-body-dto';
|
|
49
|
+
export * from './resend-email-message-response-class';
|
|
48
50
|
export * from './s3-document-dto';
|
|
49
51
|
export * from './send-email-request-dto';
|
|
50
52
|
export * from './send-email-response-class';
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL NotificationService
|
|
5
|
+
* The EMIL NotificationService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface ResendEmailMessageBodyDto
|
|
21
|
+
*/
|
|
22
|
+
export interface ResendEmailMessageBodyDto {
|
|
23
|
+
/**
|
|
24
|
+
* Bounced emails only: the bounced recipient to resend to. Required when more than one recipient of the email bounced.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof ResendEmailMessageBodyDto
|
|
27
|
+
*/
|
|
28
|
+
'recipient'?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Bounced emails only: the corrected address. The email is sent to it instead of the bounced recipient.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof ResendEmailMessageBodyDto
|
|
33
|
+
*/
|
|
34
|
+
'newAddress'?: string;
|
|
35
|
+
}
|
|
36
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL NotificationService
|
|
5
|
+
* The EMIL NotificationService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import { EmailMessageClass } from './email-message-class';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @export
|
|
21
|
+
* @interface ResendEmailMessageResponseClass
|
|
22
|
+
*/
|
|
23
|
+
export interface ResendEmailMessageResponseClass {
|
|
24
|
+
/**
|
|
25
|
+
* The email message response.
|
|
26
|
+
* @type {EmailMessageClass}
|
|
27
|
+
* @memberof ResendEmailMessageResponseClass
|
|
28
|
+
*/
|
|
29
|
+
'message': EmailMessageClass;
|
|
30
|
+
}
|
|
31
|
+
|