@emilgroup/notification-sdk 0.1.1-beta.0

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