@emilgroup/notification-sdk 0.1.1-beta.8 → 0.2.1-beta.11
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 +55 -51
- package/api/email-tracking-api.ts +102 -38
- package/dist/api/email-messages-api.d.ts +52 -48
- package/dist/api/email-messages-api.js +40 -36
- package/dist/api/email-tracking-api.d.ts +79 -35
- package/dist/api/email-tracking-api.js +66 -34
- package/dist/models/email-message-class.d.ts +8 -2
- package/dist/models/email-thread-class.d.ts +2 -2
- package/models/email-message-class.ts +8 -2
- package/models/email-thread-class.ts +2 -2
- package/package.json +2 -2
|
@@ -33,7 +33,7 @@ import { ListEmailThreadsResponseClass } from '../models';
|
|
|
33
33
|
export const EmailTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
* undefined **Required Permissions**
|
|
36
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
37
37
|
* @param {string} code
|
|
38
38
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
39
39
|
* @param {*} [options] Override http request option.
|
|
@@ -77,7 +77,7 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
77
77
|
};
|
|
78
78
|
},
|
|
79
79
|
/**
|
|
80
|
-
* undefined **Required Permissions**
|
|
80
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
81
81
|
* @param {string} code
|
|
82
82
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
83
|
* @param {*} [options] Override http request option.
|
|
@@ -121,13 +121,18 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
121
121
|
};
|
|
122
122
|
},
|
|
123
123
|
/**
|
|
124
|
-
*
|
|
124
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
125
|
+
* @summary List email messages
|
|
125
126
|
* @param {string} code
|
|
126
127
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
128
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
129
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
130
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
131
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
127
132
|
* @param {*} [options] Override http request option.
|
|
128
133
|
* @throws {RequiredError}
|
|
129
134
|
*/
|
|
130
|
-
listMessages: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
135
|
+
listMessages: async (code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
131
136
|
// verify required parameter 'code' is not null or undefined
|
|
132
137
|
assertParamExists('listMessages', 'code', code)
|
|
133
138
|
const localVarPath = `/notificationservice/v1/email-threads/{code}/messages`
|
|
@@ -149,6 +154,22 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
149
154
|
// http bearer authentication required
|
|
150
155
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
151
156
|
|
|
157
|
+
if (filter !== undefined) {
|
|
158
|
+
localVarQueryParameter['filter'] = filter;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
if (filters !== undefined) {
|
|
162
|
+
localVarQueryParameter['filters'] = filters;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
if (order !== undefined) {
|
|
166
|
+
localVarQueryParameter['order'] = order;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
if (expand !== undefined) {
|
|
170
|
+
localVarQueryParameter['expand'] = expand;
|
|
171
|
+
}
|
|
172
|
+
|
|
152
173
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
153
174
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
154
175
|
}
|
|
@@ -165,15 +186,16 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
165
186
|
};
|
|
166
187
|
},
|
|
167
188
|
/**
|
|
168
|
-
*
|
|
189
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
190
|
+
* @summary List email threads
|
|
169
191
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
170
192
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
171
193
|
* @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.
|
|
172
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
194
|
+
* @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>
|
|
173
195
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
174
|
-
* @param {string} [order]
|
|
175
|
-
* @param {string} [expand]
|
|
176
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
196
|
+
* @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>
|
|
197
|
+
* @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>
|
|
198
|
+
* @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>
|
|
177
199
|
* @param {*} [options] Override http request option.
|
|
178
200
|
* @throws {RequiredError}
|
|
179
201
|
*/
|
|
@@ -250,7 +272,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
250
272
|
const localVarAxiosParamCreator = EmailTrackingApiAxiosParamCreator(configuration)
|
|
251
273
|
return {
|
|
252
274
|
/**
|
|
253
|
-
* undefined **Required Permissions**
|
|
275
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
254
276
|
* @param {string} code
|
|
255
277
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
256
278
|
* @param {*} [options] Override http request option.
|
|
@@ -261,7 +283,7 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
261
283
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
262
284
|
},
|
|
263
285
|
/**
|
|
264
|
-
* undefined **Required Permissions**
|
|
286
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
265
287
|
* @param {string} code
|
|
266
288
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
267
289
|
* @param {*} [options] Override http request option.
|
|
@@ -272,26 +294,32 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
272
294
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
273
295
|
},
|
|
274
296
|
/**
|
|
275
|
-
*
|
|
297
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
298
|
+
* @summary List email messages
|
|
276
299
|
* @param {string} code
|
|
277
300
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
301
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
302
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
303
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
304
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
278
305
|
* @param {*} [options] Override http request option.
|
|
279
306
|
* @throws {RequiredError}
|
|
280
307
|
*/
|
|
281
|
-
async listMessages(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>> {
|
|
282
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(code, authorization, options);
|
|
308
|
+
async listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>> {
|
|
309
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(code, authorization, filter, filters, order, expand, options);
|
|
283
310
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
284
311
|
},
|
|
285
312
|
/**
|
|
286
|
-
*
|
|
313
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
314
|
+
* @summary List email threads
|
|
287
315
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
288
316
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
289
317
|
* @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.
|
|
290
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
318
|
+
* @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>
|
|
291
319
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
292
|
-
* @param {string} [order]
|
|
293
|
-
* @param {string} [expand]
|
|
294
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
320
|
+
* @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>
|
|
321
|
+
* @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>
|
|
322
|
+
* @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>
|
|
295
323
|
* @param {*} [options] Override http request option.
|
|
296
324
|
* @throws {RequiredError}
|
|
297
325
|
*/
|
|
@@ -310,7 +338,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
310
338
|
const localVarFp = EmailTrackingApiFp(configuration)
|
|
311
339
|
return {
|
|
312
340
|
/**
|
|
313
|
-
* undefined **Required Permissions**
|
|
341
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
314
342
|
* @param {string} code
|
|
315
343
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
316
344
|
* @param {*} [options] Override http request option.
|
|
@@ -320,7 +348,7 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
320
348
|
return localVarFp.closeThread(code, authorization, options).then((request) => request(axios, basePath));
|
|
321
349
|
},
|
|
322
350
|
/**
|
|
323
|
-
* undefined **Required Permissions**
|
|
351
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
324
352
|
* @param {string} code
|
|
325
353
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
326
354
|
* @param {*} [options] Override http request option.
|
|
@@ -330,25 +358,31 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
330
358
|
return localVarFp.getThread(code, authorization, options).then((request) => request(axios, basePath));
|
|
331
359
|
},
|
|
332
360
|
/**
|
|
333
|
-
*
|
|
361
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
362
|
+
* @summary List email messages
|
|
334
363
|
* @param {string} code
|
|
335
364
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
366
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
367
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
368
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
336
369
|
* @param {*} [options] Override http request option.
|
|
337
370
|
* @throws {RequiredError}
|
|
338
371
|
*/
|
|
339
|
-
listMessages(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
|
|
340
|
-
return localVarFp.listMessages(code, authorization, options).then((request) => request(axios, basePath));
|
|
372
|
+
listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
|
|
373
|
+
return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
341
374
|
},
|
|
342
375
|
/**
|
|
343
|
-
*
|
|
376
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
377
|
+
* @summary List email threads
|
|
344
378
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
345
379
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
346
380
|
* @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.
|
|
347
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
381
|
+
* @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>
|
|
348
382
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
349
|
-
* @param {string} [order]
|
|
350
|
-
* @param {string} [expand]
|
|
351
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
383
|
+
* @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>
|
|
384
|
+
* @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>
|
|
385
|
+
* @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>
|
|
352
386
|
* @param {*} [options] Override http request option.
|
|
353
387
|
* @throws {RequiredError}
|
|
354
388
|
*/
|
|
@@ -419,6 +453,34 @@ export interface EmailTrackingApiListMessagesRequest {
|
|
|
419
453
|
* @memberof EmailTrackingApiListMessages
|
|
420
454
|
*/
|
|
421
455
|
readonly authorization?: string
|
|
456
|
+
|
|
457
|
+
/**
|
|
458
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
459
|
+
* @type {string}
|
|
460
|
+
* @memberof EmailTrackingApiListMessages
|
|
461
|
+
*/
|
|
462
|
+
readonly filter?: string
|
|
463
|
+
|
|
464
|
+
/**
|
|
465
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
466
|
+
* @type {string}
|
|
467
|
+
* @memberof EmailTrackingApiListMessages
|
|
468
|
+
*/
|
|
469
|
+
readonly filters?: string
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* 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>
|
|
473
|
+
* @type {string}
|
|
474
|
+
* @memberof EmailTrackingApiListMessages
|
|
475
|
+
*/
|
|
476
|
+
readonly order?: string
|
|
477
|
+
|
|
478
|
+
/**
|
|
479
|
+
* 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
|
+
* @type {string}
|
|
481
|
+
* @memberof EmailTrackingApiListMessages
|
|
482
|
+
*/
|
|
483
|
+
readonly expand?: string
|
|
422
484
|
}
|
|
423
485
|
|
|
424
486
|
/**
|
|
@@ -449,7 +511,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
449
511
|
readonly pageToken?: string
|
|
450
512
|
|
|
451
513
|
/**
|
|
452
|
-
* Filter the response by one or multiple fields.
|
|
514
|
+
* 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>
|
|
453
515
|
* @type {string}
|
|
454
516
|
* @memberof EmailTrackingApiListThreads
|
|
455
517
|
*/
|
|
@@ -463,21 +525,21 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
463
525
|
readonly search?: string
|
|
464
526
|
|
|
465
527
|
/**
|
|
466
|
-
*
|
|
528
|
+
* 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>
|
|
467
529
|
* @type {string}
|
|
468
530
|
* @memberof EmailTrackingApiListThreads
|
|
469
531
|
*/
|
|
470
532
|
readonly order?: string
|
|
471
533
|
|
|
472
534
|
/**
|
|
473
|
-
*
|
|
535
|
+
* 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>
|
|
474
536
|
* @type {string}
|
|
475
537
|
* @memberof EmailTrackingApiListThreads
|
|
476
538
|
*/
|
|
477
539
|
readonly expand?: string
|
|
478
540
|
|
|
479
541
|
/**
|
|
480
|
-
* Filters the response by one or multiple fields.
|
|
542
|
+
* 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>
|
|
481
543
|
* @type {string}
|
|
482
544
|
* @memberof EmailTrackingApiListThreads
|
|
483
545
|
*/
|
|
@@ -492,7 +554,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
492
554
|
*/
|
|
493
555
|
export class EmailTrackingApi extends BaseAPI {
|
|
494
556
|
/**
|
|
495
|
-
* undefined **Required Permissions**
|
|
557
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
496
558
|
* @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
|
|
497
559
|
* @param {*} [options] Override http request option.
|
|
498
560
|
* @throws {RequiredError}
|
|
@@ -503,7 +565,7 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
503
565
|
}
|
|
504
566
|
|
|
505
567
|
/**
|
|
506
|
-
* undefined **Required Permissions**
|
|
568
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
507
569
|
* @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
|
|
508
570
|
* @param {*} [options] Override http request option.
|
|
509
571
|
* @throws {RequiredError}
|
|
@@ -514,18 +576,20 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
514
576
|
}
|
|
515
577
|
|
|
516
578
|
/**
|
|
517
|
-
*
|
|
579
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
580
|
+
* @summary List email messages
|
|
518
581
|
* @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
|
|
519
582
|
* @param {*} [options] Override http request option.
|
|
520
583
|
* @throws {RequiredError}
|
|
521
584
|
* @memberof EmailTrackingApi
|
|
522
585
|
*/
|
|
523
586
|
public listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig) {
|
|
524
|
-
return EmailTrackingApiFp(this.configuration).listMessages(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
587
|
+
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));
|
|
525
588
|
}
|
|
526
589
|
|
|
527
590
|
/**
|
|
528
|
-
*
|
|
591
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
592
|
+
* @summary List email threads
|
|
529
593
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
530
594
|
* @param {*} [options] Override http request option.
|
|
531
595
|
* @throws {RequiredError}
|