@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,382 @@
1
+ /**
2
+ * EMIL NotificationService
3
+ * The EMIL NotificationService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateNotificationTemplateRequestDto } from '../models';
16
+ import { CreateNotificationTemplateResponseClass } from '../models';
17
+ import { GetNotificationTemplateResponseClass } from '../models';
18
+ import { ListNotificationTemplatesResponseClass } from '../models';
19
+ import { UpdateNotificationTemplateRequestDto } from '../models';
20
+ import { UpdateNotificationTemplateResponseClass } from '../models';
21
+ /**
22
+ * NotificationTemplatesApi - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
28
+ * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
29
+ * @param {string} [authorization] Bearer Token
30
+ * @param {*} [options] Override http request option.
31
+ * @throws {RequiredError}
32
+ */
33
+ createNotificationTemplate: (createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
+ /**
35
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
36
+ * @param {number} id
37
+ * @param {string} [authorization] Bearer Token
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ deleteNotificationTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
+ /**
43
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
44
+ * @param {number} id
45
+ * @param {number} id2
46
+ * @param {string} [authorization] Bearer Token
47
+ * @param {string} [expand]
48
+ * @param {*} [options] Override http request option.
49
+ * @throws {RequiredError}
50
+ */
51
+ getNotificationTemplate: (id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
+ /**
53
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
54
+ * @param {string} [authorization] Bearer Token
55
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
56
+ * @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.
57
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
58
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
59
+ * @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.
60
+ * @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.
61
+ * @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.
62
+ * @param {*} [options] Override http request option.
63
+ * @throws {RequiredError}
64
+ */
65
+ listNotificationTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
66
+ /**
67
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
68
+ * @param {number} id
69
+ * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
70
+ * @param {string} [authorization] Bearer Token
71
+ * @param {*} [options] Override http request option.
72
+ * @throws {RequiredError}
73
+ */
74
+ updateNotificationTemplate: (id: number, updateNotificationTemplateRequestDto: UpdateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
75
+ };
76
+ /**
77
+ * NotificationTemplatesApi - functional programming interface
78
+ * @export
79
+ */
80
+ export declare const NotificationTemplatesApiFp: (configuration?: Configuration) => {
81
+ /**
82
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
83
+ * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
84
+ * @param {string} [authorization] Bearer Token
85
+ * @param {*} [options] Override http request option.
86
+ * @throws {RequiredError}
87
+ */
88
+ createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationTemplateResponseClass>>;
89
+ /**
90
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
91
+ * @param {number} id
92
+ * @param {string} [authorization] Bearer Token
93
+ * @param {*} [options] Override http request option.
94
+ * @throws {RequiredError}
95
+ */
96
+ deleteNotificationTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
97
+ /**
98
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
99
+ * @param {number} id
100
+ * @param {number} id2
101
+ * @param {string} [authorization] Bearer Token
102
+ * @param {string} [expand]
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotificationTemplateResponseClass>>;
107
+ /**
108
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
109
+ * @param {string} [authorization] Bearer Token
110
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
111
+ * @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.
112
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
113
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
114
+ * @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.
115
+ * @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.
116
+ * @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.
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNotificationTemplatesResponseClass>>;
121
+ /**
122
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
123
+ * @param {number} id
124
+ * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
125
+ * @param {string} [authorization] Bearer Token
126
+ * @param {*} [options] Override http request option.
127
+ * @throws {RequiredError}
128
+ */
129
+ updateNotificationTemplate(id: number, updateNotificationTemplateRequestDto: UpdateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateNotificationTemplateResponseClass>>;
130
+ };
131
+ /**
132
+ * NotificationTemplatesApi - factory interface
133
+ * @export
134
+ */
135
+ export declare const NotificationTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
136
+ /**
137
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
138
+ * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
139
+ * @param {string} [authorization] Bearer Token
140
+ * @param {*} [options] Override http request option.
141
+ * @throws {RequiredError}
142
+ */
143
+ createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateNotificationTemplateResponseClass>;
144
+ /**
145
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
146
+ * @param {number} id
147
+ * @param {string} [authorization] Bearer Token
148
+ * @param {*} [options] Override http request option.
149
+ * @throws {RequiredError}
150
+ */
151
+ deleteNotificationTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object>;
152
+ /**
153
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
154
+ * @param {number} id
155
+ * @param {number} id2
156
+ * @param {string} [authorization] Bearer Token
157
+ * @param {string} [expand]
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetNotificationTemplateResponseClass>;
162
+ /**
163
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
164
+ * @param {string} [authorization] Bearer Token
165
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
166
+ * @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.
167
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
168
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
169
+ * @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.
170
+ * @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.
171
+ * @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.
172
+ * @param {*} [options] Override http request option.
173
+ * @throws {RequiredError}
174
+ */
175
+ listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNotificationTemplatesResponseClass>;
176
+ /**
177
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
178
+ * @param {number} id
179
+ * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
180
+ * @param {string} [authorization] Bearer Token
181
+ * @param {*} [options] Override http request option.
182
+ * @throws {RequiredError}
183
+ */
184
+ updateNotificationTemplate(id: number, updateNotificationTemplateRequestDto: UpdateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateNotificationTemplateResponseClass>;
185
+ };
186
+ /**
187
+ * Request parameters for createNotificationTemplate operation in NotificationTemplatesApi.
188
+ * @export
189
+ * @interface NotificationTemplatesApiCreateNotificationTemplateRequest
190
+ */
191
+ export interface NotificationTemplatesApiCreateNotificationTemplateRequest {
192
+ /**
193
+ *
194
+ * @type {CreateNotificationTemplateRequestDto}
195
+ * @memberof NotificationTemplatesApiCreateNotificationTemplate
196
+ */
197
+ readonly createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto;
198
+ /**
199
+ * Bearer Token
200
+ * @type {string}
201
+ * @memberof NotificationTemplatesApiCreateNotificationTemplate
202
+ */
203
+ readonly authorization?: string;
204
+ }
205
+ /**
206
+ * Request parameters for deleteNotificationTemplate operation in NotificationTemplatesApi.
207
+ * @export
208
+ * @interface NotificationTemplatesApiDeleteNotificationTemplateRequest
209
+ */
210
+ export interface NotificationTemplatesApiDeleteNotificationTemplateRequest {
211
+ /**
212
+ *
213
+ * @type {number}
214
+ * @memberof NotificationTemplatesApiDeleteNotificationTemplate
215
+ */
216
+ readonly id: number;
217
+ /**
218
+ * Bearer Token
219
+ * @type {string}
220
+ * @memberof NotificationTemplatesApiDeleteNotificationTemplate
221
+ */
222
+ readonly authorization?: string;
223
+ }
224
+ /**
225
+ * Request parameters for getNotificationTemplate operation in NotificationTemplatesApi.
226
+ * @export
227
+ * @interface NotificationTemplatesApiGetNotificationTemplateRequest
228
+ */
229
+ export interface NotificationTemplatesApiGetNotificationTemplateRequest {
230
+ /**
231
+ *
232
+ * @type {number}
233
+ * @memberof NotificationTemplatesApiGetNotificationTemplate
234
+ */
235
+ readonly id: number;
236
+ /**
237
+ *
238
+ * @type {number}
239
+ * @memberof NotificationTemplatesApiGetNotificationTemplate
240
+ */
241
+ readonly id2: number;
242
+ /**
243
+ * Bearer Token
244
+ * @type {string}
245
+ * @memberof NotificationTemplatesApiGetNotificationTemplate
246
+ */
247
+ readonly authorization?: string;
248
+ /**
249
+ *
250
+ * @type {string}
251
+ * @memberof NotificationTemplatesApiGetNotificationTemplate
252
+ */
253
+ readonly expand?: string;
254
+ }
255
+ /**
256
+ * Request parameters for listNotificationTemplates operation in NotificationTemplatesApi.
257
+ * @export
258
+ * @interface NotificationTemplatesApiListNotificationTemplatesRequest
259
+ */
260
+ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
261
+ /**
262
+ * Bearer Token
263
+ * @type {string}
264
+ * @memberof NotificationTemplatesApiListNotificationTemplates
265
+ */
266
+ readonly authorization?: string;
267
+ /**
268
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
269
+ * @type {number}
270
+ * @memberof NotificationTemplatesApiListNotificationTemplates
271
+ */
272
+ readonly pageSize?: number;
273
+ /**
274
+ * 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.
275
+ * @type {string}
276
+ * @memberof NotificationTemplatesApiListNotificationTemplates
277
+ */
278
+ readonly pageToken?: string;
279
+ /**
280
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
281
+ * @type {string}
282
+ * @memberof NotificationTemplatesApiListNotificationTemplates
283
+ */
284
+ readonly filter?: string;
285
+ /**
286
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
287
+ * @type {string}
288
+ * @memberof NotificationTemplatesApiListNotificationTemplates
289
+ */
290
+ readonly search?: string;
291
+ /**
292
+ * 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
+ * @type {string}
294
+ * @memberof NotificationTemplatesApiListNotificationTemplates
295
+ */
296
+ readonly order?: string;
297
+ /**
298
+ * 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.
299
+ * @type {string}
300
+ * @memberof NotificationTemplatesApiListNotificationTemplates
301
+ */
302
+ readonly expand?: string;
303
+ /**
304
+ * 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.
305
+ * @type {string}
306
+ * @memberof NotificationTemplatesApiListNotificationTemplates
307
+ */
308
+ readonly filters?: string;
309
+ }
310
+ /**
311
+ * Request parameters for updateNotificationTemplate operation in NotificationTemplatesApi.
312
+ * @export
313
+ * @interface NotificationTemplatesApiUpdateNotificationTemplateRequest
314
+ */
315
+ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
316
+ /**
317
+ *
318
+ * @type {number}
319
+ * @memberof NotificationTemplatesApiUpdateNotificationTemplate
320
+ */
321
+ readonly id: number;
322
+ /**
323
+ *
324
+ * @type {UpdateNotificationTemplateRequestDto}
325
+ * @memberof NotificationTemplatesApiUpdateNotificationTemplate
326
+ */
327
+ readonly updateNotificationTemplateRequestDto: UpdateNotificationTemplateRequestDto;
328
+ /**
329
+ * Bearer Token
330
+ * @type {string}
331
+ * @memberof NotificationTemplatesApiUpdateNotificationTemplate
332
+ */
333
+ readonly authorization?: string;
334
+ }
335
+ /**
336
+ * NotificationTemplatesApi - object-oriented interface
337
+ * @export
338
+ * @class NotificationTemplatesApi
339
+ * @extends {BaseAPI}
340
+ */
341
+ export declare class NotificationTemplatesApi extends BaseAPI {
342
+ /**
343
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
344
+ * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
345
+ * @param {*} [options] Override http request option.
346
+ * @throws {RequiredError}
347
+ * @memberof NotificationTemplatesApi
348
+ */
349
+ createNotificationTemplate(requestParameters: NotificationTemplatesApiCreateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationTemplateResponseClass, any, {}>>;
350
+ /**
351
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
352
+ * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
353
+ * @param {*} [options] Override http request option.
354
+ * @throws {RequiredError}
355
+ * @memberof NotificationTemplatesApi
356
+ */
357
+ deleteNotificationTemplate(requestParameters: NotificationTemplatesApiDeleteNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
358
+ /**
359
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
360
+ * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
361
+ * @param {*} [options] Override http request option.
362
+ * @throws {RequiredError}
363
+ * @memberof NotificationTemplatesApi
364
+ */
365
+ getNotificationTemplate(requestParameters: NotificationTemplatesApiGetNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationTemplateResponseClass, any, {}>>;
366
+ /**
367
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
368
+ * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
369
+ * @param {*} [options] Override http request option.
370
+ * @throws {RequiredError}
371
+ * @memberof NotificationTemplatesApi
372
+ */
373
+ listNotificationTemplates(requestParameters?: NotificationTemplatesApiListNotificationTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationTemplatesResponseClass, any, {}>>;
374
+ /**
375
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
376
+ * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
377
+ * @param {*} [options] Override http request option.
378
+ * @throws {RequiredError}
379
+ * @memberof NotificationTemplatesApi
380
+ */
381
+ updateNotificationTemplate(requestParameters: NotificationTemplatesApiUpdateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateNotificationTemplateResponseClass, any, {}>>;
382
+ }