@emilgroup/notification-sdk 0.8.1-beta.4 → 0.8.1-beta.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +16 -0
- package/README.md +2 -2
- package/api/email-messages-api.ts +36 -24
- package/api/email-subscriptions-api.ts +559 -0
- package/api/email-tracking-api.ts +263 -32
- package/api/email-verifications-api.ts +16 -8
- package/api/layouts-api.ts +56 -36
- package/api/msgraph-webhooks-api.ts +278 -0
- package/api/notification-templates-api.ts +56 -36
- package/api/notifications-api.ts +115 -4
- package/api.ts +4 -0
- package/dist/api/email-messages-api.d.ts +36 -24
- package/dist/api/email-messages-api.js +34 -22
- package/dist/api/email-subscriptions-api.d.ts +319 -0
- package/dist/api/email-subscriptions-api.js +537 -0
- package/dist/api/email-tracking-api.d.ts +162 -32
- package/dist/api/email-tracking-api.js +227 -28
- package/dist/api/email-verifications-api.d.ts +16 -8
- package/dist/api/email-verifications-api.js +16 -8
- package/dist/api/layouts-api.d.ts +56 -36
- package/dist/api/layouts-api.js +52 -32
- package/dist/api/msgraph-webhooks-api.d.ts +168 -0
- package/dist/api/msgraph-webhooks-api.js +305 -0
- package/dist/api/notification-templates-api.d.ts +56 -36
- package/dist/api/notification-templates-api.js +52 -32
- package/dist/api/notifications-api.d.ts +65 -4
- package/dist/api/notifications-api.js +101 -4
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
- package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
- package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
- package/dist/models/assign-email-thread-entity-response-class.js +15 -0
- package/dist/models/email-message-class.d.ts +55 -7
- package/dist/models/email-message-class.js +16 -2
- package/dist/models/email-subscription-class.d.ts +104 -0
- package/dist/models/email-subscription-class.js +23 -0
- package/dist/models/email-thread-class.d.ts +6 -5
- package/dist/models/entity-ref-class.d.ts +37 -0
- package/dist/models/entity-ref-class.js +22 -0
- package/dist/models/get-email-subscription-response-class.d.ts +25 -0
- package/dist/models/get-email-subscription-response-class.js +15 -0
- package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
- package/dist/models/grpc-send-email-request-dto.js +22 -0
- package/dist/models/index.d.ts +14 -0
- package/dist/models/index.js +14 -0
- package/dist/models/inline-attachment-dto.d.ts +36 -0
- package/dist/models/inline-attachment-dto.js +15 -0
- package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
- package/dist/models/list-email-subscriptions-response-class.js +15 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
- package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
- package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
- package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
- package/dist/models/renew-email-subscription-response-class.js +15 -0
- package/dist/models/send-email-request-dto.d.ts +131 -0
- package/dist/models/send-email-request-dto.js +22 -0
- package/dist/models/send-email-response-class.d.ts +24 -0
- package/dist/models/send-email-response-class.js +15 -0
- package/dist/models/send-notification-request-dto.d.ts +10 -1
- package/dist/models/send-notification-request-dto.js +2 -1
- package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
- package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
- package/models/assign-email-thread-entity-body-dto.ts +52 -0
- package/models/assign-email-thread-entity-response-class.ts +31 -0
- package/models/email-message-class.ts +59 -8
- package/models/email-subscription-class.ts +113 -0
- package/models/email-thread-class.ts +6 -5
- package/models/entity-ref-class.ts +46 -0
- package/models/get-email-subscription-response-class.ts +31 -0
- package/models/grpc-send-email-request-dto.ts +144 -0
- package/models/index.ts +14 -0
- package/models/inline-attachment-dto.ts +42 -0
- package/models/list-email-subscriptions-response-class.ts +49 -0
- package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
- package/models/reconcile-email-subscriptions-response-class.ts +54 -0
- package/models/renew-email-subscription-response-class.ts +31 -0
- package/models/send-email-request-dto.ts +138 -0
- package/models/send-email-response-class.ts +30 -0
- package/models/send-notification-request-dto.ts +9 -2
- package/models/unassign-email-thread-entity-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -21,11 +21,17 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import { AssignEmailThreadEntityBodyDto } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { AssignEmailThreadEntityResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
24
28
|
import { GetEmailThreadResponseClass } from '../models';
|
|
25
29
|
// @ts-ignore
|
|
26
30
|
import { ListEmailMessagesResponseClass } from '../models';
|
|
27
31
|
// @ts-ignore
|
|
28
32
|
import { ListEmailThreadsResponseClass } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
import { UnassignEmailThreadEntityResponseClass } from '../models';
|
|
29
35
|
/**
|
|
30
36
|
* EmailTrackingApi - axios parameter creator
|
|
31
37
|
* @export
|
|
@@ -33,7 +39,59 @@ import { ListEmailThreadsResponseClass } from '../models';
|
|
|
33
39
|
export const EmailTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
40
|
return {
|
|
35
41
|
/**
|
|
36
|
-
*
|
|
42
|
+
* Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
|
|
43
|
+
* @summary Assign an email thread to an entity
|
|
44
|
+
* @param {string} code
|
|
45
|
+
* @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
|
|
46
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
47
|
+
* @param {*} [options] Override http request option.
|
|
48
|
+
* @throws {RequiredError}
|
|
49
|
+
*/
|
|
50
|
+
assignEntity: async (code: string, assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51
|
+
// verify required parameter 'code' is not null or undefined
|
|
52
|
+
assertParamExists('assignEntity', 'code', code)
|
|
53
|
+
// verify required parameter 'assignEmailThreadEntityBodyDto' is not null or undefined
|
|
54
|
+
assertParamExists('assignEntity', 'assignEmailThreadEntityBodyDto', assignEmailThreadEntityBodyDto)
|
|
55
|
+
const localVarPath = `/notificationservice/v1/email-threads/{code}/entity`
|
|
56
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
57
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
58
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59
|
+
let baseOptions;
|
|
60
|
+
let baseAccessToken;
|
|
61
|
+
if (configuration) {
|
|
62
|
+
baseOptions = configuration.baseOptions;
|
|
63
|
+
baseAccessToken = configuration.accessToken;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
67
|
+
const localVarHeaderParameter = {} as any;
|
|
68
|
+
const localVarQueryParameter = {} as any;
|
|
69
|
+
|
|
70
|
+
// authentication bearer required
|
|
71
|
+
// http bearer authentication required
|
|
72
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
73
|
+
|
|
74
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
75
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
81
|
+
|
|
82
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
83
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
84
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
85
|
+
localVarRequestOptions.data = serializeDataIfNeeded(assignEmailThreadEntityBodyDto, localVarRequestOptions, configuration)
|
|
86
|
+
|
|
87
|
+
return {
|
|
88
|
+
url: toPathString(localVarUrlObj),
|
|
89
|
+
options: localVarRequestOptions,
|
|
90
|
+
};
|
|
91
|
+
},
|
|
92
|
+
/**
|
|
93
|
+
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
94
|
+
* @summary Close the email thread
|
|
37
95
|
* @param {string} code
|
|
38
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
39
97
|
* @param {*} [options] Override http request option.
|
|
@@ -77,7 +135,8 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
77
135
|
};
|
|
78
136
|
},
|
|
79
137
|
/**
|
|
80
|
-
*
|
|
138
|
+
* Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
139
|
+
* @summary Retrieve the email thread
|
|
81
140
|
* @param {string} code
|
|
82
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
142
|
* @param {*} [options] Override http request option.
|
|
@@ -121,12 +180,12 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
121
180
|
};
|
|
122
181
|
},
|
|
123
182
|
/**
|
|
124
|
-
*
|
|
183
|
+
* Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
125
184
|
* @summary List email messages
|
|
126
185
|
* @param {string} code
|
|
127
186
|
* @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>
|
|
187
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
188
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
130
189
|
* @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
190
|
* @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>
|
|
132
191
|
* @param {*} [options] Override http request option.
|
|
@@ -186,16 +245,16 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
186
245
|
};
|
|
187
246
|
},
|
|
188
247
|
/**
|
|
189
|
-
*
|
|
248
|
+
* Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
190
249
|
* @summary List email threads
|
|
191
250
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
192
251
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
193
252
|
* @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.
|
|
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>
|
|
253
|
+
* @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, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
195
254
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
196
255
|
* @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
256
|
* @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>
|
|
257
|
+
* @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, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
199
258
|
* @param {*} [options] Override http request option.
|
|
200
259
|
* @throws {RequiredError}
|
|
201
260
|
*/
|
|
@@ -252,6 +311,51 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
252
311
|
|
|
253
312
|
|
|
254
313
|
|
|
314
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
315
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
316
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
317
|
+
|
|
318
|
+
return {
|
|
319
|
+
url: toPathString(localVarUrlObj),
|
|
320
|
+
options: localVarRequestOptions,
|
|
321
|
+
};
|
|
322
|
+
},
|
|
323
|
+
/**
|
|
324
|
+
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
325
|
+
* @summary Unassign an email thread from its entity
|
|
326
|
+
* @param {string} code
|
|
327
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
328
|
+
* @param {*} [options] Override http request option.
|
|
329
|
+
* @throws {RequiredError}
|
|
330
|
+
*/
|
|
331
|
+
unassignEntity: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
332
|
+
// verify required parameter 'code' is not null or undefined
|
|
333
|
+
assertParamExists('unassignEntity', 'code', code)
|
|
334
|
+
const localVarPath = `/notificationservice/v1/email-threads/{code}/entity`
|
|
335
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
336
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
337
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
338
|
+
let baseOptions;
|
|
339
|
+
let baseAccessToken;
|
|
340
|
+
if (configuration) {
|
|
341
|
+
baseOptions = configuration.baseOptions;
|
|
342
|
+
baseAccessToken = configuration.accessToken;
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
346
|
+
const localVarHeaderParameter = {} as any;
|
|
347
|
+
const localVarQueryParameter = {} as any;
|
|
348
|
+
|
|
349
|
+
// authentication bearer required
|
|
350
|
+
// http bearer authentication required
|
|
351
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
352
|
+
|
|
353
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
354
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
255
359
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
256
360
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
257
361
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -272,7 +376,21 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
272
376
|
const localVarAxiosParamCreator = EmailTrackingApiAxiosParamCreator(configuration)
|
|
273
377
|
return {
|
|
274
378
|
/**
|
|
275
|
-
*
|
|
379
|
+
* Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
|
|
380
|
+
* @summary Assign an email thread to an entity
|
|
381
|
+
* @param {string} code
|
|
382
|
+
* @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
|
|
383
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
384
|
+
* @param {*} [options] Override http request option.
|
|
385
|
+
* @throws {RequiredError}
|
|
386
|
+
*/
|
|
387
|
+
async assignEntity(code: string, assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignEmailThreadEntityResponseClass>> {
|
|
388
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.assignEntity(code, assignEmailThreadEntityBodyDto, authorization, options);
|
|
389
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
390
|
+
},
|
|
391
|
+
/**
|
|
392
|
+
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
393
|
+
* @summary Close the email thread
|
|
276
394
|
* @param {string} code
|
|
277
395
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
278
396
|
* @param {*} [options] Override http request option.
|
|
@@ -283,7 +401,8 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
283
401
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
284
402
|
},
|
|
285
403
|
/**
|
|
286
|
-
*
|
|
404
|
+
* Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
405
|
+
* @summary Retrieve the email thread
|
|
287
406
|
* @param {string} code
|
|
288
407
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
289
408
|
* @param {*} [options] Override http request option.
|
|
@@ -294,12 +413,12 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
294
413
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
295
414
|
},
|
|
296
415
|
/**
|
|
297
|
-
*
|
|
416
|
+
* Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
298
417
|
* @summary List email messages
|
|
299
418
|
* @param {string} code
|
|
300
419
|
* @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>
|
|
420
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
421
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
303
422
|
* @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
423
|
* @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>
|
|
305
424
|
* @param {*} [options] Override http request option.
|
|
@@ -310,16 +429,16 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
310
429
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
311
430
|
},
|
|
312
431
|
/**
|
|
313
|
-
*
|
|
432
|
+
* Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
314
433
|
* @summary List email threads
|
|
315
434
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
316
435
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
317
436
|
* @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.
|
|
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>
|
|
437
|
+
* @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, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
319
438
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
320
439
|
* @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
440
|
* @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>
|
|
441
|
+
* @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, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
323
442
|
* @param {*} [options] Override http request option.
|
|
324
443
|
* @throws {RequiredError}
|
|
325
444
|
*/
|
|
@@ -327,6 +446,18 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
327
446
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listThreads(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
328
447
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
329
448
|
},
|
|
449
|
+
/**
|
|
450
|
+
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
451
|
+
* @summary Unassign an email thread from its entity
|
|
452
|
+
* @param {string} code
|
|
453
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
454
|
+
* @param {*} [options] Override http request option.
|
|
455
|
+
* @throws {RequiredError}
|
|
456
|
+
*/
|
|
457
|
+
async unassignEntity(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnassignEmailThreadEntityResponseClass>> {
|
|
458
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.unassignEntity(code, authorization, options);
|
|
459
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
460
|
+
},
|
|
330
461
|
}
|
|
331
462
|
};
|
|
332
463
|
|
|
@@ -338,7 +469,20 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
338
469
|
const localVarFp = EmailTrackingApiFp(configuration)
|
|
339
470
|
return {
|
|
340
471
|
/**
|
|
341
|
-
*
|
|
472
|
+
* Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
|
|
473
|
+
* @summary Assign an email thread to an entity
|
|
474
|
+
* @param {string} code
|
|
475
|
+
* @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
|
|
476
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
477
|
+
* @param {*} [options] Override http request option.
|
|
478
|
+
* @throws {RequiredError}
|
|
479
|
+
*/
|
|
480
|
+
assignEntity(code: string, assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto, authorization?: string, options?: any): AxiosPromise<AssignEmailThreadEntityResponseClass> {
|
|
481
|
+
return localVarFp.assignEntity(code, assignEmailThreadEntityBodyDto, authorization, options).then((request) => request(axios, basePath));
|
|
482
|
+
},
|
|
483
|
+
/**
|
|
484
|
+
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
485
|
+
* @summary Close the email thread
|
|
342
486
|
* @param {string} code
|
|
343
487
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
344
488
|
* @param {*} [options] Override http request option.
|
|
@@ -348,7 +492,8 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
348
492
|
return localVarFp.closeThread(code, authorization, options).then((request) => request(axios, basePath));
|
|
349
493
|
},
|
|
350
494
|
/**
|
|
351
|
-
*
|
|
495
|
+
* Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
496
|
+
* @summary Retrieve the email thread
|
|
352
497
|
* @param {string} code
|
|
353
498
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
354
499
|
* @param {*} [options] Override http request option.
|
|
@@ -358,12 +503,12 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
358
503
|
return localVarFp.getThread(code, authorization, options).then((request) => request(axios, basePath));
|
|
359
504
|
},
|
|
360
505
|
/**
|
|
361
|
-
*
|
|
506
|
+
* Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
362
507
|
* @summary List email messages
|
|
363
508
|
* @param {string} code
|
|
364
509
|
* @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>
|
|
510
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
511
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
367
512
|
* @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
513
|
* @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>
|
|
369
514
|
* @param {*} [options] Override http request option.
|
|
@@ -373,25 +518,64 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
373
518
|
return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
374
519
|
},
|
|
375
520
|
/**
|
|
376
|
-
*
|
|
521
|
+
* Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
377
522
|
* @summary List email threads
|
|
378
523
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
379
524
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
380
525
|
* @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.
|
|
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>
|
|
526
|
+
* @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, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
382
527
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
383
528
|
* @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
529
|
* @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>
|
|
530
|
+
* @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, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
386
531
|
* @param {*} [options] Override http request option.
|
|
387
532
|
* @throws {RequiredError}
|
|
388
533
|
*/
|
|
389
534
|
listThreads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailThreadsResponseClass> {
|
|
390
535
|
return localVarFp.listThreads(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
391
536
|
},
|
|
537
|
+
/**
|
|
538
|
+
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
539
|
+
* @summary Unassign an email thread from its entity
|
|
540
|
+
* @param {string} code
|
|
541
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
542
|
+
* @param {*} [options] Override http request option.
|
|
543
|
+
* @throws {RequiredError}
|
|
544
|
+
*/
|
|
545
|
+
unassignEntity(code: string, authorization?: string, options?: any): AxiosPromise<UnassignEmailThreadEntityResponseClass> {
|
|
546
|
+
return localVarFp.unassignEntity(code, authorization, options).then((request) => request(axios, basePath));
|
|
547
|
+
},
|
|
392
548
|
};
|
|
393
549
|
};
|
|
394
550
|
|
|
551
|
+
/**
|
|
552
|
+
* Request parameters for assignEntity operation in EmailTrackingApi.
|
|
553
|
+
* @export
|
|
554
|
+
* @interface EmailTrackingApiAssignEntityRequest
|
|
555
|
+
*/
|
|
556
|
+
export interface EmailTrackingApiAssignEntityRequest {
|
|
557
|
+
/**
|
|
558
|
+
*
|
|
559
|
+
* @type {string}
|
|
560
|
+
* @memberof EmailTrackingApiAssignEntity
|
|
561
|
+
*/
|
|
562
|
+
readonly code: string
|
|
563
|
+
|
|
564
|
+
/**
|
|
565
|
+
*
|
|
566
|
+
* @type {AssignEmailThreadEntityBodyDto}
|
|
567
|
+
* @memberof EmailTrackingApiAssignEntity
|
|
568
|
+
*/
|
|
569
|
+
readonly assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto
|
|
570
|
+
|
|
571
|
+
/**
|
|
572
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
573
|
+
* @type {string}
|
|
574
|
+
* @memberof EmailTrackingApiAssignEntity
|
|
575
|
+
*/
|
|
576
|
+
readonly authorization?: string
|
|
577
|
+
}
|
|
578
|
+
|
|
395
579
|
/**
|
|
396
580
|
* Request parameters for closeThread operation in EmailTrackingApi.
|
|
397
581
|
* @export
|
|
@@ -455,14 +639,14 @@ export interface EmailTrackingApiListMessagesRequest {
|
|
|
455
639
|
readonly authorization?: string
|
|
456
640
|
|
|
457
641
|
/**
|
|
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>
|
|
642
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
459
643
|
* @type {string}
|
|
460
644
|
* @memberof EmailTrackingApiListMessages
|
|
461
645
|
*/
|
|
462
646
|
readonly filter?: string
|
|
463
647
|
|
|
464
648
|
/**
|
|
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>
|
|
649
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
466
650
|
* @type {string}
|
|
467
651
|
* @memberof EmailTrackingApiListMessages
|
|
468
652
|
*/
|
|
@@ -511,7 +695,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
511
695
|
readonly pageToken?: string
|
|
512
696
|
|
|
513
697
|
/**
|
|
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>
|
|
698
|
+
* 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, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
515
699
|
* @type {string}
|
|
516
700
|
* @memberof EmailTrackingApiListThreads
|
|
517
701
|
*/
|
|
@@ -539,13 +723,34 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
539
723
|
readonly expand?: string
|
|
540
724
|
|
|
541
725
|
/**
|
|
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>
|
|
726
|
+
* 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, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
543
727
|
* @type {string}
|
|
544
728
|
* @memberof EmailTrackingApiListThreads
|
|
545
729
|
*/
|
|
546
730
|
readonly filters?: string
|
|
547
731
|
}
|
|
548
732
|
|
|
733
|
+
/**
|
|
734
|
+
* Request parameters for unassignEntity operation in EmailTrackingApi.
|
|
735
|
+
* @export
|
|
736
|
+
* @interface EmailTrackingApiUnassignEntityRequest
|
|
737
|
+
*/
|
|
738
|
+
export interface EmailTrackingApiUnassignEntityRequest {
|
|
739
|
+
/**
|
|
740
|
+
*
|
|
741
|
+
* @type {string}
|
|
742
|
+
* @memberof EmailTrackingApiUnassignEntity
|
|
743
|
+
*/
|
|
744
|
+
readonly code: string
|
|
745
|
+
|
|
746
|
+
/**
|
|
747
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
748
|
+
* @type {string}
|
|
749
|
+
* @memberof EmailTrackingApiUnassignEntity
|
|
750
|
+
*/
|
|
751
|
+
readonly authorization?: string
|
|
752
|
+
}
|
|
753
|
+
|
|
549
754
|
/**
|
|
550
755
|
* EmailTrackingApi - object-oriented interface
|
|
551
756
|
* @export
|
|
@@ -554,7 +759,20 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
554
759
|
*/
|
|
555
760
|
export class EmailTrackingApi extends BaseAPI {
|
|
556
761
|
/**
|
|
557
|
-
*
|
|
762
|
+
* Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
|
|
763
|
+
* @summary Assign an email thread to an entity
|
|
764
|
+
* @param {EmailTrackingApiAssignEntityRequest} requestParameters Request parameters.
|
|
765
|
+
* @param {*} [options] Override http request option.
|
|
766
|
+
* @throws {RequiredError}
|
|
767
|
+
* @memberof EmailTrackingApi
|
|
768
|
+
*/
|
|
769
|
+
public assignEntity(requestParameters: EmailTrackingApiAssignEntityRequest, options?: AxiosRequestConfig) {
|
|
770
|
+
return EmailTrackingApiFp(this.configuration).assignEntity(requestParameters.code, requestParameters.assignEmailThreadEntityBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
771
|
+
}
|
|
772
|
+
|
|
773
|
+
/**
|
|
774
|
+
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
775
|
+
* @summary Close the email thread
|
|
558
776
|
* @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
|
|
559
777
|
* @param {*} [options] Override http request option.
|
|
560
778
|
* @throws {RequiredError}
|
|
@@ -565,7 +783,8 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
565
783
|
}
|
|
566
784
|
|
|
567
785
|
/**
|
|
568
|
-
*
|
|
786
|
+
* Retrieves the details of the email thread with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
787
|
+
* @summary Retrieve the email thread
|
|
569
788
|
* @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
|
|
570
789
|
* @param {*} [options] Override http request option.
|
|
571
790
|
* @throws {RequiredError}
|
|
@@ -576,7 +795,7 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
576
795
|
}
|
|
577
796
|
|
|
578
797
|
/**
|
|
579
|
-
*
|
|
798
|
+
* Returns the email messages of the email thread with the given code. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
580
799
|
* @summary List email messages
|
|
581
800
|
* @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
|
|
582
801
|
* @param {*} [options] Override http request option.
|
|
@@ -588,7 +807,7 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
588
807
|
}
|
|
589
808
|
|
|
590
809
|
/**
|
|
591
|
-
*
|
|
810
|
+
* Returns a list of email threads. A thread groups an email sent for an entity together with its replies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
592
811
|
* @summary List email threads
|
|
593
812
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
594
813
|
* @param {*} [options] Override http request option.
|
|
@@ -598,4 +817,16 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
598
817
|
public listThreads(requestParameters: EmailTrackingApiListThreadsRequest = {}, options?: AxiosRequestConfig) {
|
|
599
818
|
return EmailTrackingApiFp(this.configuration).listThreads(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
600
819
|
}
|
|
820
|
+
|
|
821
|
+
/**
|
|
822
|
+
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
823
|
+
* @summary Unassign an email thread from its entity
|
|
824
|
+
* @param {EmailTrackingApiUnassignEntityRequest} requestParameters Request parameters.
|
|
825
|
+
* @param {*} [options] Override http request option.
|
|
826
|
+
* @throws {RequiredError}
|
|
827
|
+
* @memberof EmailTrackingApi
|
|
828
|
+
*/
|
|
829
|
+
public unassignEntity(requestParameters: EmailTrackingApiUnassignEntityRequest, options?: AxiosRequestConfig) {
|
|
830
|
+
return EmailTrackingApiFp(this.configuration).unassignEntity(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
831
|
+
}
|
|
601
832
|
}
|
|
@@ -35,7 +35,8 @@ import { InitiateEmailVerificationResponseClass } from '../models';
|
|
|
35
35
|
export const EmailVerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
39
|
+
* @summary Complete an email verification
|
|
39
40
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
40
41
|
* @param {string} [authorization] Bearer Token
|
|
41
42
|
* @param {*} [options] Override http request option.
|
|
@@ -81,7 +82,8 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
|
|
|
81
82
|
};
|
|
82
83
|
},
|
|
83
84
|
/**
|
|
84
|
-
*
|
|
85
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
86
|
+
* @summary Initiate an email verification
|
|
85
87
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
86
88
|
* @param {string} [authorization] Bearer Token
|
|
87
89
|
* @param {*} [options] Override http request option.
|
|
@@ -137,7 +139,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
|
|
|
137
139
|
const localVarAxiosParamCreator = EmailVerificationsApiAxiosParamCreator(configuration)
|
|
138
140
|
return {
|
|
139
141
|
/**
|
|
140
|
-
*
|
|
142
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
143
|
+
* @summary Complete an email verification
|
|
141
144
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
142
145
|
* @param {string} [authorization] Bearer Token
|
|
143
146
|
* @param {*} [options] Override http request option.
|
|
@@ -148,7 +151,8 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
|
|
|
148
151
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
149
152
|
},
|
|
150
153
|
/**
|
|
151
|
-
*
|
|
154
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
155
|
+
* @summary Initiate an email verification
|
|
152
156
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
153
157
|
* @param {string} [authorization] Bearer Token
|
|
154
158
|
* @param {*} [options] Override http request option.
|
|
@@ -169,7 +173,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
|
|
|
169
173
|
const localVarFp = EmailVerificationsApiFp(configuration)
|
|
170
174
|
return {
|
|
171
175
|
/**
|
|
172
|
-
*
|
|
176
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
177
|
+
* @summary Complete an email verification
|
|
173
178
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
174
179
|
* @param {string} [authorization] Bearer Token
|
|
175
180
|
* @param {*} [options] Override http request option.
|
|
@@ -179,7 +184,8 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
|
|
|
179
184
|
return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then((request) => request(axios, basePath));
|
|
180
185
|
},
|
|
181
186
|
/**
|
|
182
|
-
*
|
|
187
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
188
|
+
* @summary Initiate an email verification
|
|
183
189
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
184
190
|
* @param {string} [authorization] Bearer Token
|
|
185
191
|
* @param {*} [options] Override http request option.
|
|
@@ -241,7 +247,8 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
|
|
|
241
247
|
*/
|
|
242
248
|
export class EmailVerificationsApi extends BaseAPI {
|
|
243
249
|
/**
|
|
244
|
-
*
|
|
250
|
+
* Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
|
|
251
|
+
* @summary Complete an email verification
|
|
245
252
|
* @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
|
|
246
253
|
* @param {*} [options] Override http request option.
|
|
247
254
|
* @throws {RequiredError}
|
|
@@ -252,7 +259,8 @@ export class EmailVerificationsApi extends BaseAPI {
|
|
|
252
259
|
}
|
|
253
260
|
|
|
254
261
|
/**
|
|
255
|
-
*
|
|
262
|
+
* Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
|
|
263
|
+
* @summary Initiate an email verification
|
|
256
264
|
* @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
|
|
257
265
|
* @param {*} [options] Override http request option.
|
|
258
266
|
* @throws {RequiredError}
|