@emilgroup/notification-sdk-node 1.4.1-beta.0 → 1.4.1-beta.14

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.
Files changed (52) hide show
  1. package/.openapi-generator/FILES +11 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +372 -0
  4. package/api/email-tracking-api.ts +541 -0
  5. package/api.ts +4 -0
  6. package/base.ts +0 -1
  7. package/dist/api/default-api.d.ts +1 -1
  8. package/dist/api/email-messages-api.d.ts +205 -0
  9. package/dist/api/email-messages-api.js +405 -0
  10. package/dist/api/email-tracking-api.d.ts +301 -0
  11. package/dist/api/email-tracking-api.js +524 -0
  12. package/dist/api/email-verifications-api.d.ts +2 -2
  13. package/dist/api/layouts-api.d.ts +5 -5
  14. package/dist/api/notification-templates-api.d.ts +5 -5
  15. package/dist/api/notifications-api.d.ts +1 -1
  16. package/dist/api.d.ts +2 -0
  17. package/dist/api.js +2 -0
  18. package/dist/common.d.ts +1 -1
  19. package/dist/models/download-attachment-response-class.d.ts +36 -0
  20. package/dist/models/download-attachment-response-class.js +15 -0
  21. package/dist/models/email-attachment-class.d.ts +84 -0
  22. package/dist/models/email-attachment-class.js +15 -0
  23. package/dist/models/email-message-class.d.ts +140 -0
  24. package/dist/models/email-message-class.js +27 -0
  25. package/dist/models/email-thread-class.d.ts +83 -0
  26. package/dist/models/email-thread-class.js +20 -0
  27. package/dist/models/get-email-message-response-class.d.ts +25 -0
  28. package/dist/models/get-email-message-response-class.js +15 -0
  29. package/dist/models/get-email-thread-response-class.d.ts +25 -0
  30. package/dist/models/get-email-thread-response-class.js +15 -0
  31. package/dist/models/index.d.ts +9 -0
  32. package/dist/models/index.js +9 -0
  33. package/dist/models/list-email-attachments-response-class.d.ts +25 -0
  34. package/dist/models/list-email-attachments-response-class.js +15 -0
  35. package/dist/models/list-email-messages-response-class.d.ts +43 -0
  36. package/dist/models/list-email-messages-response-class.js +15 -0
  37. package/dist/models/list-email-threads-response-class.d.ts +43 -0
  38. package/dist/models/list-email-threads-response-class.js +15 -0
  39. package/dist/models/send-notification-request-dto.d.ts +44 -2
  40. package/dist/models/send-notification-request-dto.js +6 -0
  41. package/models/download-attachment-response-class.ts +42 -0
  42. package/models/email-attachment-class.ts +90 -0
  43. package/models/email-message-class.ts +150 -0
  44. package/models/email-thread-class.ts +92 -0
  45. package/models/get-email-message-response-class.ts +31 -0
  46. package/models/get-email-thread-response-class.ts +31 -0
  47. package/models/index.ts +9 -0
  48. package/models/list-email-attachments-response-class.ts +31 -0
  49. package/models/list-email-messages-response-class.ts +49 -0
  50. package/models/list-email-threads-response-class.ts +49 -0
  51. package/models/send-notification-request-dto.ts +47 -2
  52. package/package.json +3 -3
@@ -0,0 +1,541 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { GetEmailThreadResponseClass } from '../models';
25
+ // @ts-ignore
26
+ import { ListEmailMessagesResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { ListEmailThreadsResponseClass } from '../models';
29
+ // URLSearchParams not necessarily used
30
+ // @ts-ignore
31
+ import { URL, URLSearchParams } from 'url';
32
+ const FormData = require('form-data');
33
+ /**
34
+ * EmailTrackingApi - axios parameter creator
35
+ * @export
36
+ */
37
+ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
38
+ return {
39
+ /**
40
+ * undefined **Required Permissions** none
41
+ * @param {string} code
42
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ closeThread: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
47
+ // verify required parameter 'code' is not null or undefined
48
+ assertParamExists('closeThread', 'code', code)
49
+ const localVarPath = `/notificationservice/v1/email-threads/{code}/close`
50
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
51
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
52
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
53
+ let baseOptions;
54
+ let baseAccessToken;
55
+ if (configuration) {
56
+ baseOptions = configuration.baseOptions;
57
+ baseAccessToken = configuration.accessToken;
58
+ }
59
+
60
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
61
+ const localVarHeaderParameter = {} as any;
62
+ const localVarQueryParameter = {} as any;
63
+
64
+ // authentication bearer required
65
+ // http bearer authentication required
66
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
67
+
68
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
69
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
70
+ }
71
+
72
+
73
+
74
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
75
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
76
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77
+
78
+ return {
79
+ url: toPathString(localVarUrlObj),
80
+ options: localVarRequestOptions,
81
+ };
82
+ },
83
+ /**
84
+ * undefined **Required Permissions** none
85
+ * @param {string} code
86
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ getThread: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
91
+ // verify required parameter 'code' is not null or undefined
92
+ assertParamExists('getThread', 'code', code)
93
+ const localVarPath = `/notificationservice/v1/email-threads/{code}`
94
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
95
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
96
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
97
+ let baseOptions;
98
+ let baseAccessToken;
99
+ if (configuration) {
100
+ baseOptions = configuration.baseOptions;
101
+ baseAccessToken = configuration.accessToken;
102
+ }
103
+
104
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
105
+ const localVarHeaderParameter = {} as any;
106
+ const localVarQueryParameter = {} as any;
107
+
108
+ // authentication bearer required
109
+ // http bearer authentication required
110
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
111
+
112
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
113
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
114
+ }
115
+
116
+
117
+
118
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
119
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
120
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
121
+
122
+ return {
123
+ url: toPathString(localVarUrlObj),
124
+ options: localVarRequestOptions,
125
+ };
126
+ },
127
+ /**
128
+ * undefined **Required Permissions** none
129
+ * @param {string} code
130
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ */
134
+ listMessages: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
135
+ // verify required parameter 'code' is not null or undefined
136
+ assertParamExists('listMessages', 'code', code)
137
+ const localVarPath = `/notificationservice/v1/email-threads/{code}/messages`
138
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
139
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
140
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
141
+ let baseOptions;
142
+ let baseAccessToken;
143
+ if (configuration) {
144
+ baseOptions = configuration.baseOptions;
145
+ baseAccessToken = configuration.accessToken;
146
+ }
147
+
148
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
149
+ const localVarHeaderParameter = {} as any;
150
+ const localVarQueryParameter = {} as any;
151
+
152
+ // authentication bearer required
153
+ // http bearer authentication required
154
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
155
+
156
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
157
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
158
+ }
159
+
160
+
161
+
162
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
163
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
164
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
165
+
166
+ return {
167
+ url: toPathString(localVarUrlObj),
168
+ options: localVarRequestOptions,
169
+ };
170
+ },
171
+ /**
172
+ * undefined **Required Permissions** none
173
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
174
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
175
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
176
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
177
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
178
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
179
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
180
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
181
+ * @param {*} [options] Override http request option.
182
+ * @throws {RequiredError}
183
+ */
184
+ listThreads: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
185
+ const localVarPath = `/notificationservice/v1/email-threads`;
186
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
187
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
188
+ let baseOptions;
189
+ let baseAccessToken;
190
+ if (configuration) {
191
+ baseOptions = configuration.baseOptions;
192
+ baseAccessToken = configuration.accessToken;
193
+ }
194
+
195
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
196
+ const localVarHeaderParameter = {} as any;
197
+ const localVarQueryParameter = {} as any;
198
+
199
+ // authentication bearer required
200
+ // http bearer authentication required
201
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
202
+
203
+ if (pageSize !== undefined) {
204
+ localVarQueryParameter['pageSize'] = pageSize;
205
+ }
206
+
207
+ if (pageToken !== undefined) {
208
+ localVarQueryParameter['pageToken'] = pageToken;
209
+ }
210
+
211
+ if (filter !== undefined) {
212
+ localVarQueryParameter['filter'] = filter;
213
+ }
214
+
215
+ if (search !== undefined) {
216
+ localVarQueryParameter['search'] = search;
217
+ }
218
+
219
+ if (order !== undefined) {
220
+ localVarQueryParameter['order'] = order;
221
+ }
222
+
223
+ if (expand !== undefined) {
224
+ localVarQueryParameter['expand'] = expand;
225
+ }
226
+
227
+ if (filters !== undefined) {
228
+ localVarQueryParameter['filters'] = filters;
229
+ }
230
+
231
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
232
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
233
+ }
234
+
235
+
236
+
237
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
238
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
239
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
240
+
241
+ return {
242
+ url: toPathString(localVarUrlObj),
243
+ options: localVarRequestOptions,
244
+ };
245
+ },
246
+ }
247
+ };
248
+
249
+ /**
250
+ * EmailTrackingApi - functional programming interface
251
+ * @export
252
+ */
253
+ export const EmailTrackingApiFp = function(configuration?: Configuration) {
254
+ const localVarAxiosParamCreator = EmailTrackingApiAxiosParamCreator(configuration)
255
+ return {
256
+ /**
257
+ * undefined **Required Permissions** none
258
+ * @param {string} code
259
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
260
+ * @param {*} [options] Override http request option.
261
+ * @throws {RequiredError}
262
+ */
263
+ async closeThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>> {
264
+ const localVarAxiosArgs = await localVarAxiosParamCreator.closeThread(code, authorization, options);
265
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
266
+ },
267
+ /**
268
+ * undefined **Required Permissions** none
269
+ * @param {string} code
270
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
271
+ * @param {*} [options] Override http request option.
272
+ * @throws {RequiredError}
273
+ */
274
+ async getThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>> {
275
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getThread(code, authorization, options);
276
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
277
+ },
278
+ /**
279
+ * undefined **Required Permissions** none
280
+ * @param {string} code
281
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
282
+ * @param {*} [options] Override http request option.
283
+ * @throws {RequiredError}
284
+ */
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);
287
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
288
+ },
289
+ /**
290
+ * undefined **Required Permissions** none
291
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
292
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
293
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
294
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
295
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
296
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
297
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
298
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
299
+ * @param {*} [options] Override http request option.
300
+ * @throws {RequiredError}
301
+ */
302
+ async listThreads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailThreadsResponseClass>> {
303
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listThreads(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
304
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
305
+ },
306
+ }
307
+ };
308
+
309
+ /**
310
+ * EmailTrackingApi - factory interface
311
+ * @export
312
+ */
313
+ export const EmailTrackingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
314
+ const localVarFp = EmailTrackingApiFp(configuration)
315
+ return {
316
+ /**
317
+ * undefined **Required Permissions** none
318
+ * @param {string} code
319
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
320
+ * @param {*} [options] Override http request option.
321
+ * @throws {RequiredError}
322
+ */
323
+ closeThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass> {
324
+ return localVarFp.closeThread(code, authorization, options).then((request) => request(axios, basePath));
325
+ },
326
+ /**
327
+ * undefined **Required Permissions** none
328
+ * @param {string} code
329
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
330
+ * @param {*} [options] Override http request option.
331
+ * @throws {RequiredError}
332
+ */
333
+ getThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass> {
334
+ return localVarFp.getThread(code, authorization, options).then((request) => request(axios, basePath));
335
+ },
336
+ /**
337
+ * undefined **Required Permissions** none
338
+ * @param {string} code
339
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
340
+ * @param {*} [options] Override http request option.
341
+ * @throws {RequiredError}
342
+ */
343
+ listMessages(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
344
+ return localVarFp.listMessages(code, authorization, options).then((request) => request(axios, basePath));
345
+ },
346
+ /**
347
+ * undefined **Required Permissions** none
348
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
349
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
350
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
351
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
352
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
353
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
354
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
355
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
356
+ * @param {*} [options] Override http request option.
357
+ * @throws {RequiredError}
358
+ */
359
+ listThreads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailThreadsResponseClass> {
360
+ return localVarFp.listThreads(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
361
+ },
362
+ };
363
+ };
364
+
365
+ /**
366
+ * Request parameters for closeThread operation in EmailTrackingApi.
367
+ * @export
368
+ * @interface EmailTrackingApiCloseThreadRequest
369
+ */
370
+ export interface EmailTrackingApiCloseThreadRequest {
371
+ /**
372
+ *
373
+ * @type {string}
374
+ * @memberof EmailTrackingApiCloseThread
375
+ */
376
+ readonly code: string
377
+
378
+ /**
379
+ * Bearer Token: provided by the login endpoint under the name accessToken.
380
+ * @type {string}
381
+ * @memberof EmailTrackingApiCloseThread
382
+ */
383
+ readonly authorization?: string
384
+ }
385
+
386
+ /**
387
+ * Request parameters for getThread operation in EmailTrackingApi.
388
+ * @export
389
+ * @interface EmailTrackingApiGetThreadRequest
390
+ */
391
+ export interface EmailTrackingApiGetThreadRequest {
392
+ /**
393
+ *
394
+ * @type {string}
395
+ * @memberof EmailTrackingApiGetThread
396
+ */
397
+ readonly code: string
398
+
399
+ /**
400
+ * Bearer Token: provided by the login endpoint under the name accessToken.
401
+ * @type {string}
402
+ * @memberof EmailTrackingApiGetThread
403
+ */
404
+ readonly authorization?: string
405
+ }
406
+
407
+ /**
408
+ * Request parameters for listMessages operation in EmailTrackingApi.
409
+ * @export
410
+ * @interface EmailTrackingApiListMessagesRequest
411
+ */
412
+ export interface EmailTrackingApiListMessagesRequest {
413
+ /**
414
+ *
415
+ * @type {string}
416
+ * @memberof EmailTrackingApiListMessages
417
+ */
418
+ readonly code: string
419
+
420
+ /**
421
+ * Bearer Token: provided by the login endpoint under the name accessToken.
422
+ * @type {string}
423
+ * @memberof EmailTrackingApiListMessages
424
+ */
425
+ readonly authorization?: string
426
+ }
427
+
428
+ /**
429
+ * Request parameters for listThreads operation in EmailTrackingApi.
430
+ * @export
431
+ * @interface EmailTrackingApiListThreadsRequest
432
+ */
433
+ export interface EmailTrackingApiListThreadsRequest {
434
+ /**
435
+ * Bearer Token: provided by the login endpoint under the name accessToken.
436
+ * @type {string}
437
+ * @memberof EmailTrackingApiListThreads
438
+ */
439
+ readonly authorization?: string
440
+
441
+ /**
442
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
443
+ * @type {number}
444
+ * @memberof EmailTrackingApiListThreads
445
+ */
446
+ readonly pageSize?: number
447
+
448
+ /**
449
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
450
+ * @type {string}
451
+ * @memberof EmailTrackingApiListThreads
452
+ */
453
+ readonly pageToken?: string
454
+
455
+ /**
456
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
457
+ * @type {string}
458
+ * @memberof EmailTrackingApiListThreads
459
+ */
460
+ readonly filter?: string
461
+
462
+ /**
463
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
464
+ * @type {string}
465
+ * @memberof EmailTrackingApiListThreads
466
+ */
467
+ readonly search?: string
468
+
469
+ /**
470
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
471
+ * @type {string}
472
+ * @memberof EmailTrackingApiListThreads
473
+ */
474
+ readonly order?: string
475
+
476
+ /**
477
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
478
+ * @type {string}
479
+ * @memberof EmailTrackingApiListThreads
480
+ */
481
+ readonly expand?: string
482
+
483
+ /**
484
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
485
+ * @type {string}
486
+ * @memberof EmailTrackingApiListThreads
487
+ */
488
+ readonly filters?: string
489
+ }
490
+
491
+ /**
492
+ * EmailTrackingApi - object-oriented interface
493
+ * @export
494
+ * @class EmailTrackingApi
495
+ * @extends {BaseAPI}
496
+ */
497
+ export class EmailTrackingApi extends BaseAPI {
498
+ /**
499
+ * undefined **Required Permissions** none
500
+ * @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
501
+ * @param {*} [options] Override http request option.
502
+ * @throws {RequiredError}
503
+ * @memberof EmailTrackingApi
504
+ */
505
+ public closeThread(requestParameters: EmailTrackingApiCloseThreadRequest, options?: AxiosRequestConfig) {
506
+ return EmailTrackingApiFp(this.configuration).closeThread(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
507
+ }
508
+
509
+ /**
510
+ * undefined **Required Permissions** none
511
+ * @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
512
+ * @param {*} [options] Override http request option.
513
+ * @throws {RequiredError}
514
+ * @memberof EmailTrackingApi
515
+ */
516
+ public getThread(requestParameters: EmailTrackingApiGetThreadRequest, options?: AxiosRequestConfig) {
517
+ return EmailTrackingApiFp(this.configuration).getThread(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
518
+ }
519
+
520
+ /**
521
+ * undefined **Required Permissions** none
522
+ * @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
523
+ * @param {*} [options] Override http request option.
524
+ * @throws {RequiredError}
525
+ * @memberof EmailTrackingApi
526
+ */
527
+ public listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig) {
528
+ return EmailTrackingApiFp(this.configuration).listMessages(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
529
+ }
530
+
531
+ /**
532
+ * undefined **Required Permissions** none
533
+ * @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
534
+ * @param {*} [options] Override http request option.
535
+ * @throws {RequiredError}
536
+ * @memberof EmailTrackingApi
537
+ */
538
+ public listThreads(requestParameters: EmailTrackingApiListThreadsRequest = {}, options?: AxiosRequestConfig) {
539
+ 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));
540
+ }
541
+ }
package/api.ts CHANGED
@@ -25,6 +25,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
25
25
  // @ts-ignore
26
26
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
27
27
  import { DefaultApi } from './api';
28
+ import { EmailMessagesApi } from './api';
29
+ import { EmailTrackingApi } from './api';
28
30
  import { EmailVerificationsApi } from './api';
29
31
  import { LayoutsApi } from './api';
30
32
  import { NotificationTemplatesApi } from './api';
@@ -32,6 +34,8 @@ import { NotificationsApi } from './api';
32
34
 
33
35
 
34
36
  export * from './api/default-api';
37
+ export * from './api/email-messages-api';
38
+ export * from './api/email-tracking-api';
35
39
  export * from './api/email-verifications-api';
36
40
  export * from './api/layouts-api';
37
41
  export * from './api/notification-templates-api';
package/base.ts CHANGED
@@ -186,7 +186,6 @@ export class BaseAPI {
186
186
  await this.switchWorkspace(targetWorkspace);
187
187
  }
188
188
  }
189
-
190
189
  async switchWorkspace(targetWorkspace: string): Promise<void> {
191
190
  const options: AxiosRequestConfig = {
192
191
  method: 'POST',
@@ -66,5 +66,5 @@ export declare class DefaultApi extends BaseAPI {
66
66
  * @throws {RequiredError}
67
67
  * @memberof DefaultApi
68
68
  */
69
- check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any>>;
69
+ check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any, {}>>;
70
70
  }