@emilgroup/notification-sdk 0.8.1-beta.75 → 0.8.1-beta.76
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/email-messages-api.ts +4 -4
- package/dist/api/email-messages-api.d.ts +4 -4
- package/dist/api/email-messages-api.js +4 -4
- package/dist/models/address-correction-dto.d.ts +1 -1
- package/dist/models/resend-email-message-body-dto.d.ts +1 -19
- package/models/address-correction-dto.ts +1 -1
- package/models/resend-email-message-body-dto.ts +1 -19
- package/package.json +1 -1
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.76 --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.76
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -274,7 +274,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
274
274
|
};
|
|
275
275
|
},
|
|
276
276
|
/**
|
|
277
|
-
* 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
|
|
277
|
+
* 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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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\"
|
|
278
278
|
* @summary Resend the email message
|
|
279
279
|
* @param {string} code
|
|
280
280
|
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
@@ -395,7 +395,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
395
395
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
396
396
|
},
|
|
397
397
|
/**
|
|
398
|
-
* 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
|
|
398
|
+
* 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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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\"
|
|
399
399
|
* @summary Resend the email message
|
|
400
400
|
* @param {string} code
|
|
401
401
|
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
@@ -469,7 +469,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
469
469
|
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
470
470
|
},
|
|
471
471
|
/**
|
|
472
|
-
* 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
|
|
472
|
+
* 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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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\"
|
|
473
473
|
* @summary Resend the email message
|
|
474
474
|
* @param {string} code
|
|
475
475
|
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
@@ -700,7 +700,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
700
700
|
}
|
|
701
701
|
|
|
702
702
|
/**
|
|
703
|
-
* 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
|
|
703
|
+
* 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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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\"
|
|
704
704
|
* @summary Resend the email message
|
|
705
705
|
* @param {EmailMessagesApiResendMessageRequest} requestParameters Request parameters.
|
|
706
706
|
* @param {*} [options] Override http request option.
|
|
@@ -67,7 +67,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
67
67
|
*/
|
|
68
68
|
listEmailMessages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
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
|
|
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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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
71
|
* @summary Resend the email message
|
|
72
72
|
* @param {string} code
|
|
73
73
|
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
@@ -126,7 +126,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
126
126
|
*/
|
|
127
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
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
|
|
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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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
130
|
* @summary Resend the email message
|
|
131
131
|
* @param {string} code
|
|
132
132
|
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
@@ -185,7 +185,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
185
185
|
*/
|
|
186
186
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
187
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
|
|
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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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
189
|
* @summary Resend the email message
|
|
190
190
|
* @param {string} code
|
|
191
191
|
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
@@ -382,7 +382,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
382
382
|
*/
|
|
383
383
|
listEmailMessages(requestParameters?: EmailMessagesApiListEmailMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}, any>>;
|
|
384
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
|
|
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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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
386
|
* @summary Resend the email message
|
|
387
387
|
* @param {EmailMessagesApiResendMessageRequest} requestParameters Request parameters.
|
|
388
388
|
* @param {*} [options] Override http request option.
|
|
@@ -338,7 +338,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
338
338
|
});
|
|
339
339
|
},
|
|
340
340
|
/**
|
|
341
|
-
* 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
|
|
341
|
+
* 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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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\"
|
|
342
342
|
* @summary Resend the email message
|
|
343
343
|
* @param {string} code
|
|
344
344
|
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
@@ -499,7 +499,7 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
499
499
|
});
|
|
500
500
|
},
|
|
501
501
|
/**
|
|
502
|
-
* 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
|
|
502
|
+
* 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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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\"
|
|
503
503
|
* @summary Resend the email message
|
|
504
504
|
* @param {string} code
|
|
505
505
|
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
@@ -582,7 +582,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
582
582
|
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
583
583
|
},
|
|
584
584
|
/**
|
|
585
|
-
* 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
|
|
585
|
+
* 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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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\"
|
|
586
586
|
* @summary Resend the email message
|
|
587
587
|
* @param {string} code
|
|
588
588
|
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
@@ -657,7 +657,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
657
657
|
return (0, exports.EmailMessagesApiFp)(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
658
658
|
};
|
|
659
659
|
/**
|
|
660
|
-
* 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
|
|
660
|
+
* 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 exactly the addresses listed in corrections, which must name at least one of its bounced recipients (see bouncedAddresses); an entry whose newAddress equals its recipient resends that address unchanged, and bounced recipients that are not listed are left out. A failed email is resent to all its original recipients; corrections 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\"
|
|
661
661
|
* @summary Resend the email message
|
|
662
662
|
* @param {EmailMessagesApiResendMessageRequest} requestParameters Request parameters.
|
|
663
663
|
* @param {*} [options] Override http request option.
|
|
@@ -22,7 +22,7 @@ export interface AddressCorrectionDto {
|
|
|
22
22
|
*/
|
|
23
23
|
'recipient': string;
|
|
24
24
|
/**
|
|
25
|
-
* The address the email
|
|
25
|
+
* The address the email is resent to for `recipient`. The same address as `recipient` resends to it unchanged.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof AddressCorrectionDto
|
|
28
28
|
*/
|
|
@@ -17,27 +17,9 @@ import { AddressCorrectionDto } from './address-correction-dto';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface ResendEmailMessageBodyDto {
|
|
19
19
|
/**
|
|
20
|
-
* Bounced emails only
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof ResendEmailMessageBodyDto
|
|
23
|
-
*/
|
|
24
|
-
'recipient'?: string;
|
|
25
|
-
/**
|
|
26
|
-
* Bounced emails only: the corrected address. It replaces the bounced recipient; any other bounced recipients still receive the email. Not allowed together with corrections.
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof ResendEmailMessageBodyDto
|
|
29
|
-
*/
|
|
30
|
-
'newAddress'?: string;
|
|
31
|
-
/**
|
|
32
|
-
* Bounced emails only: corrects several bounced recipients in one resend. Each bounced recipient can be corrected once; bounced recipients that are not listed receive the email at their original address. Use instead of recipient and newAddress.
|
|
20
|
+
* Bounced emails only, and required for them: the addresses the email is resent to. Each entry names one bounced recipient once and the address to send to instead; bounced recipients that are not listed are left out of this resend and can be resent to later from the same original email. Not allowed for a failed email.
|
|
33
21
|
* @type {Array<AddressCorrectionDto>}
|
|
34
22
|
* @memberof ResendEmailMessageBodyDto
|
|
35
23
|
*/
|
|
36
24
|
'corrections'?: Array<AddressCorrectionDto>;
|
|
37
|
-
/**
|
|
38
|
-
* Bounced emails only: bounced recipients that are left out of this resend, for example while their correct address is not known yet. Each must be a bounced recipient that is not corrected in the same request, and at least one bounced recipient must remain. Skipped recipients can be resent to later from the same original email.
|
|
39
|
-
* @type {Array<string>}
|
|
40
|
-
* @memberof ResendEmailMessageBodyDto
|
|
41
|
-
*/
|
|
42
|
-
'skip'?: Array<string>;
|
|
43
25
|
}
|
|
@@ -27,7 +27,7 @@ export interface AddressCorrectionDto {
|
|
|
27
27
|
*/
|
|
28
28
|
'recipient': string;
|
|
29
29
|
/**
|
|
30
|
-
* The address the email
|
|
30
|
+
* The address the email is resent to for `recipient`. The same address as `recipient` resends to it unchanged.
|
|
31
31
|
* @type {string}
|
|
32
32
|
* @memberof AddressCorrectionDto
|
|
33
33
|
*/
|
|
@@ -22,28 +22,10 @@ import { AddressCorrectionDto } from './address-correction-dto';
|
|
|
22
22
|
*/
|
|
23
23
|
export interface ResendEmailMessageBodyDto {
|
|
24
24
|
/**
|
|
25
|
-
* Bounced emails only
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof ResendEmailMessageBodyDto
|
|
28
|
-
*/
|
|
29
|
-
'recipient'?: string;
|
|
30
|
-
/**
|
|
31
|
-
* Bounced emails only: the corrected address. It replaces the bounced recipient; any other bounced recipients still receive the email. Not allowed together with corrections.
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof ResendEmailMessageBodyDto
|
|
34
|
-
*/
|
|
35
|
-
'newAddress'?: string;
|
|
36
|
-
/**
|
|
37
|
-
* Bounced emails only: corrects several bounced recipients in one resend. Each bounced recipient can be corrected once; bounced recipients that are not listed receive the email at their original address. Use instead of recipient and newAddress.
|
|
25
|
+
* Bounced emails only, and required for them: the addresses the email is resent to. Each entry names one bounced recipient once and the address to send to instead; bounced recipients that are not listed are left out of this resend and can be resent to later from the same original email. Not allowed for a failed email.
|
|
38
26
|
* @type {Array<AddressCorrectionDto>}
|
|
39
27
|
* @memberof ResendEmailMessageBodyDto
|
|
40
28
|
*/
|
|
41
29
|
'corrections'?: Array<AddressCorrectionDto>;
|
|
42
|
-
/**
|
|
43
|
-
* Bounced emails only: bounced recipients that are left out of this resend, for example while their correct address is not known yet. Each must be a bounced recipient that is not corrected in the same request, and at least one bounced recipient must remain. Skipped recipients can be resent to later from the same original email.
|
|
44
|
-
* @type {Array<string>}
|
|
45
|
-
* @memberof ResendEmailMessageBodyDto
|
|
46
|
-
*/
|
|
47
|
-
'skip'?: Array<string>;
|
|
48
30
|
}
|
|
49
31
|
|