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