@emilgroup/notification-sdk-node 1.4.1-beta.29 → 1.4.1-beta.31
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 +36 -32
- package/api/email-tracking-api.ts +102 -38
- package/dist/api/email-messages-api.d.ts +36 -32
- package/dist/api/email-messages-api.js +32 -28
- package/dist/api/email-tracking-api.d.ts +79 -35
- package/dist/api/email-tracking-api.js +66 -34
- 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-node@1.4.1-beta.
|
|
20
|
+
npm install @emilgroup/notification-sdk-node@1.4.1-beta.31 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/notification-sdk-node@1.4.1-beta.
|
|
24
|
+
yarn add @emilgroup/notification-sdk-node@1.4.1-beta.31
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `LayoutApi`.
|
|
@@ -39,7 +39,7 @@ const FormData = require('form-data');
|
|
|
39
39
|
export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
* undefined **Required Permissions**
|
|
42
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
43
43
|
* @param {string} code
|
|
44
44
|
* @param {number} attachmentId
|
|
45
45
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -87,7 +87,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
87
87
|
};
|
|
88
88
|
},
|
|
89
89
|
/**
|
|
90
|
-
* undefined **Required Permissions**
|
|
90
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
91
91
|
* @param {string} code
|
|
92
92
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
93
93
|
* @param {*} [options] Override http request option.
|
|
@@ -131,7 +131,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
131
131
|
};
|
|
132
132
|
},
|
|
133
133
|
/**
|
|
134
|
-
* undefined **Required Permissions**
|
|
134
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
135
135
|
* @param {string} code
|
|
136
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
137
137
|
* @param {*} [options] Override http request option.
|
|
@@ -175,15 +175,16 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
175
175
|
};
|
|
176
176
|
},
|
|
177
177
|
/**
|
|
178
|
-
*
|
|
178
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
179
|
+
* @summary List email messages
|
|
179
180
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
181
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
181
182
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
182
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
183
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
183
184
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
184
|
-
* @param {string} [order]
|
|
185
|
-
* @param {string} [expand]
|
|
186
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
185
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
186
|
+
* @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>
|
|
187
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
187
188
|
* @param {*} [options] Override http request option.
|
|
188
189
|
* @throws {RequiredError}
|
|
189
190
|
*/
|
|
@@ -260,7 +261,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
260
261
|
const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
|
|
261
262
|
return {
|
|
262
263
|
/**
|
|
263
|
-
* undefined **Required Permissions**
|
|
264
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
264
265
|
* @param {string} code
|
|
265
266
|
* @param {number} attachmentId
|
|
266
267
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -272,7 +273,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
272
273
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
273
274
|
},
|
|
274
275
|
/**
|
|
275
|
-
* undefined **Required Permissions**
|
|
276
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
276
277
|
* @param {string} code
|
|
277
278
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
278
279
|
* @param {*} [options] Override http request option.
|
|
@@ -283,7 +284,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
283
284
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
284
285
|
},
|
|
285
286
|
/**
|
|
286
|
-
* undefined **Required Permissions**
|
|
287
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
287
288
|
* @param {string} code
|
|
288
289
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
289
290
|
* @param {*} [options] Override http request option.
|
|
@@ -294,15 +295,16 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
294
295
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
295
296
|
},
|
|
296
297
|
/**
|
|
297
|
-
*
|
|
298
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
299
|
+
* @summary List email messages
|
|
298
300
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
299
301
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
300
302
|
* @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.
|
|
301
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
303
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
302
304
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
303
|
-
* @param {string} [order]
|
|
304
|
-
* @param {string} [expand]
|
|
305
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
305
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
306
|
+
* @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>
|
|
307
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
306
308
|
* @param {*} [options] Override http request option.
|
|
307
309
|
* @throws {RequiredError}
|
|
308
310
|
*/
|
|
@@ -321,7 +323,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
321
323
|
const localVarFp = EmailMessagesApiFp(configuration)
|
|
322
324
|
return {
|
|
323
325
|
/**
|
|
324
|
-
* undefined **Required Permissions**
|
|
326
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
325
327
|
* @param {string} code
|
|
326
328
|
* @param {number} attachmentId
|
|
327
329
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -332,7 +334,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
332
334
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
|
|
333
335
|
},
|
|
334
336
|
/**
|
|
335
|
-
* undefined **Required Permissions**
|
|
337
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
336
338
|
* @param {string} code
|
|
337
339
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
338
340
|
* @param {*} [options] Override http request option.
|
|
@@ -342,7 +344,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
342
344
|
return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
|
|
343
345
|
},
|
|
344
346
|
/**
|
|
345
|
-
* undefined **Required Permissions**
|
|
347
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
346
348
|
* @param {string} code
|
|
347
349
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
348
350
|
* @param {*} [options] Override http request option.
|
|
@@ -352,15 +354,16 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
352
354
|
return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
|
|
353
355
|
},
|
|
354
356
|
/**
|
|
355
|
-
*
|
|
357
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
358
|
+
* @summary List email messages
|
|
356
359
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
357
360
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
358
361
|
* @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.
|
|
359
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
362
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
360
363
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
361
|
-
* @param {string} [order]
|
|
362
|
-
* @param {string} [expand]
|
|
363
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
364
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
365
|
+
* @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>
|
|
366
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
364
367
|
* @param {*} [options] Override http request option.
|
|
365
368
|
* @throws {RequiredError}
|
|
366
369
|
*/
|
|
@@ -468,7 +471,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
468
471
|
readonly pageToken?: string
|
|
469
472
|
|
|
470
473
|
/**
|
|
471
|
-
* Filter the response by one or multiple fields.
|
|
474
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
472
475
|
* @type {string}
|
|
473
476
|
* @memberof EmailMessagesApiListEmailMessages
|
|
474
477
|
*/
|
|
@@ -482,21 +485,21 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
482
485
|
readonly search?: string
|
|
483
486
|
|
|
484
487
|
/**
|
|
485
|
-
*
|
|
488
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
486
489
|
* @type {string}
|
|
487
490
|
* @memberof EmailMessagesApiListEmailMessages
|
|
488
491
|
*/
|
|
489
492
|
readonly order?: string
|
|
490
493
|
|
|
491
494
|
/**
|
|
492
|
-
*
|
|
495
|
+
* 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>
|
|
493
496
|
* @type {string}
|
|
494
497
|
* @memberof EmailMessagesApiListEmailMessages
|
|
495
498
|
*/
|
|
496
499
|
readonly expand?: string
|
|
497
500
|
|
|
498
501
|
/**
|
|
499
|
-
* Filters the response by one or multiple fields.
|
|
502
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
500
503
|
* @type {string}
|
|
501
504
|
* @memberof EmailMessagesApiListEmailMessages
|
|
502
505
|
*/
|
|
@@ -511,7 +514,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
511
514
|
*/
|
|
512
515
|
export class EmailMessagesApi extends BaseAPI {
|
|
513
516
|
/**
|
|
514
|
-
* undefined **Required Permissions**
|
|
517
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
515
518
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
516
519
|
* @param {*} [options] Override http request option.
|
|
517
520
|
* @throws {RequiredError}
|
|
@@ -522,7 +525,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
522
525
|
}
|
|
523
526
|
|
|
524
527
|
/**
|
|
525
|
-
* undefined **Required Permissions**
|
|
528
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
526
529
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
527
530
|
* @param {*} [options] Override http request option.
|
|
528
531
|
* @throws {RequiredError}
|
|
@@ -533,7 +536,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
533
536
|
}
|
|
534
537
|
|
|
535
538
|
/**
|
|
536
|
-
* undefined **Required Permissions**
|
|
539
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
537
540
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
538
541
|
* @param {*} [options] Override http request option.
|
|
539
542
|
* @throws {RequiredError}
|
|
@@ -544,7 +547,8 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
544
547
|
}
|
|
545
548
|
|
|
546
549
|
/**
|
|
547
|
-
*
|
|
550
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
551
|
+
* @summary List email messages
|
|
548
552
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
549
553
|
* @param {*} [options] Override http request option.
|
|
550
554
|
* @throws {RequiredError}
|
|
@@ -37,7 +37,7 @@ const FormData = require('form-data');
|
|
|
37
37
|
export const EmailTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
38
38
|
return {
|
|
39
39
|
/**
|
|
40
|
-
* undefined **Required Permissions**
|
|
40
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
41
41
|
* @param {string} code
|
|
42
42
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
43
43
|
* @param {*} [options] Override http request option.
|
|
@@ -81,7 +81,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
81
81
|
};
|
|
82
82
|
},
|
|
83
83
|
/**
|
|
84
|
-
* undefined **Required Permissions**
|
|
84
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
85
85
|
* @param {string} code
|
|
86
86
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
87
|
* @param {*} [options] Override http request option.
|
|
@@ -125,13 +125,18 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
125
125
|
};
|
|
126
126
|
},
|
|
127
127
|
/**
|
|
128
|
-
*
|
|
128
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
129
|
+
* @summary List email messages
|
|
129
130
|
* @param {string} code
|
|
130
131
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
132
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
133
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
134
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
135
|
+
* @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>
|
|
131
136
|
* @param {*} [options] Override http request option.
|
|
132
137
|
* @throws {RequiredError}
|
|
133
138
|
*/
|
|
134
|
-
listMessages: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
139
|
+
listMessages: async (code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
135
140
|
// verify required parameter 'code' is not null or undefined
|
|
136
141
|
assertParamExists('listMessages', 'code', code)
|
|
137
142
|
const localVarPath = `/notificationservice/v1/email-threads/{code}/messages`
|
|
@@ -153,6 +158,22 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
153
158
|
// http bearer authentication required
|
|
154
159
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
155
160
|
|
|
161
|
+
if (filter !== undefined) {
|
|
162
|
+
localVarQueryParameter['filter'] = filter;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
if (filters !== undefined) {
|
|
166
|
+
localVarQueryParameter['filters'] = filters;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
if (order !== undefined) {
|
|
170
|
+
localVarQueryParameter['order'] = order;
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
if (expand !== undefined) {
|
|
174
|
+
localVarQueryParameter['expand'] = expand;
|
|
175
|
+
}
|
|
176
|
+
|
|
156
177
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
157
178
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
158
179
|
}
|
|
@@ -169,15 +190,16 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
169
190
|
};
|
|
170
191
|
},
|
|
171
192
|
/**
|
|
172
|
-
*
|
|
193
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
194
|
+
* @summary List email threads
|
|
173
195
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
174
196
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
175
197
|
* @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.
|
|
176
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
198
|
+
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
177
199
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
178
|
-
* @param {string} [order]
|
|
179
|
-
* @param {string} [expand]
|
|
180
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
200
|
+
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
201
|
+
* @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: messages<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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
181
203
|
* @param {*} [options] Override http request option.
|
|
182
204
|
* @throws {RequiredError}
|
|
183
205
|
*/
|
|
@@ -254,7 +276,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
254
276
|
const localVarAxiosParamCreator = EmailTrackingApiAxiosParamCreator(configuration)
|
|
255
277
|
return {
|
|
256
278
|
/**
|
|
257
|
-
* undefined **Required Permissions**
|
|
279
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
258
280
|
* @param {string} code
|
|
259
281
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
260
282
|
* @param {*} [options] Override http request option.
|
|
@@ -265,7 +287,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
265
287
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
266
288
|
},
|
|
267
289
|
/**
|
|
268
|
-
* undefined **Required Permissions**
|
|
290
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
269
291
|
* @param {string} code
|
|
270
292
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
271
293
|
* @param {*} [options] Override http request option.
|
|
@@ -276,26 +298,32 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
276
298
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
277
299
|
},
|
|
278
300
|
/**
|
|
279
|
-
*
|
|
301
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
302
|
+
* @summary List email messages
|
|
280
303
|
* @param {string} code
|
|
281
304
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
305
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
306
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
307
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
308
|
+
* @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>
|
|
282
309
|
* @param {*} [options] Override http request option.
|
|
283
310
|
* @throws {RequiredError}
|
|
284
311
|
*/
|
|
285
|
-
async listMessages(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>> {
|
|
286
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(code, authorization, options);
|
|
312
|
+
async listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>> {
|
|
313
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(code, authorization, filter, filters, order, expand, options);
|
|
287
314
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
288
315
|
},
|
|
289
316
|
/**
|
|
290
|
-
*
|
|
317
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
318
|
+
* @summary List email threads
|
|
291
319
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
292
320
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
293
321
|
* @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.
|
|
294
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
322
|
+
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
295
323
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
296
|
-
* @param {string} [order]
|
|
297
|
-
* @param {string} [expand]
|
|
298
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
324
|
+
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
325
|
+
* @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: messages<i>
|
|
326
|
+
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
299
327
|
* @param {*} [options] Override http request option.
|
|
300
328
|
* @throws {RequiredError}
|
|
301
329
|
*/
|
|
@@ -314,7 +342,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
314
342
|
const localVarFp = EmailTrackingApiFp(configuration)
|
|
315
343
|
return {
|
|
316
344
|
/**
|
|
317
|
-
* undefined **Required Permissions**
|
|
345
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
318
346
|
* @param {string} code
|
|
319
347
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
320
348
|
* @param {*} [options] Override http request option.
|
|
@@ -324,7 +352,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
324
352
|
return localVarFp.closeThread(code, authorization, options).then((request) => request(axios, basePath));
|
|
325
353
|
},
|
|
326
354
|
/**
|
|
327
|
-
* undefined **Required Permissions**
|
|
355
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
328
356
|
* @param {string} code
|
|
329
357
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
330
358
|
* @param {*} [options] Override http request option.
|
|
@@ -334,25 +362,31 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
334
362
|
return localVarFp.getThread(code, authorization, options).then((request) => request(axios, basePath));
|
|
335
363
|
},
|
|
336
364
|
/**
|
|
337
|
-
*
|
|
365
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
366
|
+
* @summary List email messages
|
|
338
367
|
* @param {string} code
|
|
339
368
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
369
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
370
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
371
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
372
|
+
* @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>
|
|
340
373
|
* @param {*} [options] Override http request option.
|
|
341
374
|
* @throws {RequiredError}
|
|
342
375
|
*/
|
|
343
|
-
listMessages(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
|
|
344
|
-
return localVarFp.listMessages(code, authorization, options).then((request) => request(axios, basePath));
|
|
376
|
+
listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
|
|
377
|
+
return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
345
378
|
},
|
|
346
379
|
/**
|
|
347
|
-
*
|
|
380
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
381
|
+
* @summary List email threads
|
|
348
382
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
349
383
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
350
384
|
* @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.
|
|
351
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
385
|
+
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
352
386
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
353
|
-
* @param {string} [order]
|
|
354
|
-
* @param {string} [expand]
|
|
355
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
387
|
+
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
388
|
+
* @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: messages<i>
|
|
389
|
+
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
356
390
|
* @param {*} [options] Override http request option.
|
|
357
391
|
* @throws {RequiredError}
|
|
358
392
|
*/
|
|
@@ -423,6 +457,34 @@ export interface EmailTrackingApiListMessagesRequest {
|
|
|
423
457
|
* @memberof EmailTrackingApiListMessages
|
|
424
458
|
*/
|
|
425
459
|
readonly authorization?: string
|
|
460
|
+
|
|
461
|
+
/**
|
|
462
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
463
|
+
* @type {string}
|
|
464
|
+
* @memberof EmailTrackingApiListMessages
|
|
465
|
+
*/
|
|
466
|
+
readonly filter?: string
|
|
467
|
+
|
|
468
|
+
/**
|
|
469
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
470
|
+
* @type {string}
|
|
471
|
+
* @memberof EmailTrackingApiListMessages
|
|
472
|
+
*/
|
|
473
|
+
readonly filters?: string
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
477
|
+
* @type {string}
|
|
478
|
+
* @memberof EmailTrackingApiListMessages
|
|
479
|
+
*/
|
|
480
|
+
readonly order?: string
|
|
481
|
+
|
|
482
|
+
/**
|
|
483
|
+
* 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>
|
|
484
|
+
* @type {string}
|
|
485
|
+
* @memberof EmailTrackingApiListMessages
|
|
486
|
+
*/
|
|
487
|
+
readonly expand?: string
|
|
426
488
|
}
|
|
427
489
|
|
|
428
490
|
/**
|
|
@@ -453,7 +515,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
453
515
|
readonly pageToken?: string
|
|
454
516
|
|
|
455
517
|
/**
|
|
456
|
-
* Filter the response by one or multiple fields.
|
|
518
|
+
* 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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
457
519
|
* @type {string}
|
|
458
520
|
* @memberof EmailTrackingApiListThreads
|
|
459
521
|
*/
|
|
@@ -467,21 +529,21 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
467
529
|
readonly search?: string
|
|
468
530
|
|
|
469
531
|
/**
|
|
470
|
-
*
|
|
532
|
+
* 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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
471
533
|
* @type {string}
|
|
472
534
|
* @memberof EmailTrackingApiListThreads
|
|
473
535
|
*/
|
|
474
536
|
readonly order?: string
|
|
475
537
|
|
|
476
538
|
/**
|
|
477
|
-
*
|
|
539
|
+
* 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: messages<i>
|
|
478
540
|
* @type {string}
|
|
479
541
|
* @memberof EmailTrackingApiListThreads
|
|
480
542
|
*/
|
|
481
543
|
readonly expand?: string
|
|
482
544
|
|
|
483
545
|
/**
|
|
484
|
-
* Filters the response by one or multiple fields.
|
|
546
|
+
* 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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
485
547
|
* @type {string}
|
|
486
548
|
* @memberof EmailTrackingApiListThreads
|
|
487
549
|
*/
|
|
@@ -496,7 +558,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
496
558
|
*/
|
|
497
559
|
export class EmailTrackingApi extends BaseAPI {
|
|
498
560
|
/**
|
|
499
|
-
* undefined **Required Permissions**
|
|
561
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
500
562
|
* @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
|
|
501
563
|
* @param {*} [options] Override http request option.
|
|
502
564
|
* @throws {RequiredError}
|
|
@@ -507,7 +569,7 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
507
569
|
}
|
|
508
570
|
|
|
509
571
|
/**
|
|
510
|
-
* undefined **Required Permissions**
|
|
572
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
511
573
|
* @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
|
|
512
574
|
* @param {*} [options] Override http request option.
|
|
513
575
|
* @throws {RequiredError}
|
|
@@ -518,18 +580,20 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
518
580
|
}
|
|
519
581
|
|
|
520
582
|
/**
|
|
521
|
-
*
|
|
583
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
584
|
+
* @summary List email messages
|
|
522
585
|
* @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
|
|
523
586
|
* @param {*} [options] Override http request option.
|
|
524
587
|
* @throws {RequiredError}
|
|
525
588
|
* @memberof EmailTrackingApi
|
|
526
589
|
*/
|
|
527
590
|
public listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig) {
|
|
528
|
-
return EmailTrackingApiFp(this.configuration).listMessages(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
591
|
+
return EmailTrackingApiFp(this.configuration).listMessages(requestParameters.code, requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
529
592
|
}
|
|
530
593
|
|
|
531
594
|
/**
|
|
532
|
-
*
|
|
595
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
596
|
+
* @summary List email threads
|
|
533
597
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
534
598
|
* @param {*} [options] Override http request option.
|
|
535
599
|
* @throws {RequiredError}
|