@emilgroup/notification-sdk 0.8.1-beta.4 → 0.8.1-beta.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +36 -24
  4. package/api/email-subscriptions-api.ts +559 -0
  5. package/api/email-tracking-api.ts +263 -32
  6. package/api/email-verifications-api.ts +16 -8
  7. package/api/layouts-api.ts +56 -36
  8. package/api/msgraph-webhooks-api.ts +278 -0
  9. package/api/notification-templates-api.ts +56 -36
  10. package/api/notifications-api.ts +115 -4
  11. package/api.ts +4 -0
  12. package/dist/api/email-messages-api.d.ts +36 -24
  13. package/dist/api/email-messages-api.js +34 -22
  14. package/dist/api/email-subscriptions-api.d.ts +319 -0
  15. package/dist/api/email-subscriptions-api.js +537 -0
  16. package/dist/api/email-tracking-api.d.ts +162 -32
  17. package/dist/api/email-tracking-api.js +227 -28
  18. package/dist/api/email-verifications-api.d.ts +16 -8
  19. package/dist/api/email-verifications-api.js +16 -8
  20. package/dist/api/layouts-api.d.ts +56 -36
  21. package/dist/api/layouts-api.js +52 -32
  22. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  23. package/dist/api/msgraph-webhooks-api.js +305 -0
  24. package/dist/api/notification-templates-api.d.ts +56 -36
  25. package/dist/api/notification-templates-api.js +52 -32
  26. package/dist/api/notifications-api.d.ts +65 -4
  27. package/dist/api/notifications-api.js +101 -4
  28. package/dist/api.d.ts +2 -0
  29. package/dist/api.js +2 -0
  30. package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
  31. package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
  32. package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
  33. package/dist/models/assign-email-thread-entity-response-class.js +15 -0
  34. package/dist/models/email-message-class.d.ts +55 -7
  35. package/dist/models/email-message-class.js +16 -2
  36. package/dist/models/email-subscription-class.d.ts +104 -0
  37. package/dist/models/email-subscription-class.js +23 -0
  38. package/dist/models/email-thread-class.d.ts +6 -5
  39. package/dist/models/entity-ref-class.d.ts +37 -0
  40. package/dist/models/entity-ref-class.js +22 -0
  41. package/dist/models/get-email-subscription-response-class.d.ts +25 -0
  42. package/dist/models/get-email-subscription-response-class.js +15 -0
  43. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  44. package/dist/models/grpc-send-email-request-dto.js +22 -0
  45. package/dist/models/index.d.ts +14 -0
  46. package/dist/models/index.js +14 -0
  47. package/dist/models/inline-attachment-dto.d.ts +36 -0
  48. package/dist/models/inline-attachment-dto.js +15 -0
  49. package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
  50. package/dist/models/list-email-subscriptions-response-class.js +15 -0
  51. package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
  52. package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
  53. package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
  54. package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
  55. package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
  56. package/dist/models/renew-email-subscription-response-class.js +15 -0
  57. package/dist/models/send-email-request-dto.d.ts +131 -0
  58. package/dist/models/send-email-request-dto.js +22 -0
  59. package/dist/models/send-email-response-class.d.ts +24 -0
  60. package/dist/models/send-email-response-class.js +15 -0
  61. package/dist/models/send-notification-request-dto.d.ts +10 -1
  62. package/dist/models/send-notification-request-dto.js +2 -1
  63. package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
  64. package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
  65. package/models/assign-email-thread-entity-body-dto.ts +52 -0
  66. package/models/assign-email-thread-entity-response-class.ts +31 -0
  67. package/models/email-message-class.ts +59 -8
  68. package/models/email-subscription-class.ts +113 -0
  69. package/models/email-thread-class.ts +6 -5
  70. package/models/entity-ref-class.ts +46 -0
  71. package/models/get-email-subscription-response-class.ts +31 -0
  72. package/models/grpc-send-email-request-dto.ts +144 -0
  73. package/models/index.ts +14 -0
  74. package/models/inline-attachment-dto.ts +42 -0
  75. package/models/list-email-subscriptions-response-class.ts +49 -0
  76. package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
  77. package/models/reconcile-email-subscriptions-response-class.ts +54 -0
  78. package/models/renew-email-subscription-response-class.ts +31 -0
  79. package/models/send-email-request-dto.ts +138 -0
  80. package/models/send-email-response-class.ts +30 -0
  81. package/models/send-notification-request-dto.ts +9 -2
  82. package/models/unassign-email-thread-entity-response-class.ts +31 -0
  83. package/package.json +1 -1
@@ -24,7 +24,8 @@ import { UpdateLayoutResponseClass } from '../models';
24
24
  */
25
25
  export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration) => {
26
26
  /**
27
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
27
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
28
+ * @summary Create the layout
28
29
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
29
30
  * @param {string} [authorization] Bearer Token
30
31
  * @param {*} [options] Override http request option.
@@ -32,7 +33,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
32
33
  */
33
34
  createLayout: (createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
35
  /**
35
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
36
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
37
+ * @summary Delete the layout
36
38
  * @param {number} id
37
39
  * @param {string} [authorization] Bearer Token
38
40
  * @param {*} [options] Override http request option.
@@ -40,7 +42,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
40
42
  */
41
43
  deleteLayout: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
44
  /**
43
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
45
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
46
+ * @summary Retrieve the layout
44
47
  * @param {number} id
45
48
  * @param {number} id2 Layout id
46
49
  * @param {string} [authorization] Bearer Token
@@ -49,21 +52,23 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
49
52
  */
50
53
  getLayout: (id: number, id2: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51
54
  /**
52
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
55
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
56
+ * @summary List layouts
53
57
  * @param {string} [authorization] Bearer Token
54
58
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
55
59
  * @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.
60
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
57
61
  * @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.
62
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
63
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
64
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
61
65
  * @param {*} [options] Override http request option.
62
66
  * @throws {RequiredError}
63
67
  */
64
68
  listLayouts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
69
  /**
66
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
70
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
71
+ * @summary Update the layout
67
72
  * @param {number} id
68
73
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
69
74
  * @param {string} [authorization] Bearer Token
@@ -78,7 +83,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
78
83
  */
79
84
  export declare const LayoutsApiFp: (configuration?: Configuration) => {
80
85
  /**
81
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
86
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
87
+ * @summary Create the layout
82
88
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
83
89
  * @param {string} [authorization] Bearer Token
84
90
  * @param {*} [options] Override http request option.
@@ -86,7 +92,8 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
86
92
  */
87
93
  createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>>;
88
94
  /**
89
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
95
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
96
+ * @summary Delete the layout
90
97
  * @param {number} id
91
98
  * @param {string} [authorization] Bearer Token
92
99
  * @param {*} [options] Override http request option.
@@ -94,7 +101,8 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
94
101
  */
95
102
  deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
96
103
  /**
97
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
104
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
105
+ * @summary Retrieve the layout
98
106
  * @param {number} id
99
107
  * @param {number} id2 Layout id
100
108
  * @param {string} [authorization] Bearer Token
@@ -103,21 +111,23 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
103
111
  */
104
112
  getLayout(id: number, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>>;
105
113
  /**
106
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
114
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
115
+ * @summary List layouts
107
116
  * @param {string} [authorization] Bearer Token
108
117
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
109
118
  * @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.
119
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
111
120
  * @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.
121
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
122
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
123
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
115
124
  * @param {*} [options] Override http request option.
116
125
  * @throws {RequiredError}
117
126
  */
118
127
  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
128
  /**
120
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
129
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
130
+ * @summary Update the layout
121
131
  * @param {number} id
122
132
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
123
133
  * @param {string} [authorization] Bearer Token
@@ -132,7 +142,8 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
132
142
  */
133
143
  export declare const LayoutsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
134
144
  /**
135
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
145
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
146
+ * @summary Create the layout
136
147
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
137
148
  * @param {string} [authorization] Bearer Token
138
149
  * @param {*} [options] Override http request option.
@@ -140,7 +151,8 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
140
151
  */
141
152
  createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass>;
142
153
  /**
143
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
154
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
155
+ * @summary Delete the layout
144
156
  * @param {number} id
145
157
  * @param {string} [authorization] Bearer Token
146
158
  * @param {*} [options] Override http request option.
@@ -148,7 +160,8 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
148
160
  */
149
161
  deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<object>;
150
162
  /**
151
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
163
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
164
+ * @summary Retrieve the layout
152
165
  * @param {number} id
153
166
  * @param {number} id2 Layout id
154
167
  * @param {string} [authorization] Bearer Token
@@ -157,21 +170,23 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
157
170
  */
158
171
  getLayout(id: number, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass>;
159
172
  /**
160
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
173
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
174
+ * @summary List layouts
161
175
  * @param {string} [authorization] Bearer Token
162
176
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
163
177
  * @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.
178
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
165
179
  * @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.
180
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
181
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
182
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
169
183
  * @param {*} [options] Override http request option.
170
184
  * @throws {RequiredError}
171
185
  */
172
186
  listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLayoutsResponseClass>;
173
187
  /**
174
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
188
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
189
+ * @summary Update the layout
175
190
  * @param {number} id
176
191
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
177
192
  * @param {string} [authorization] Bearer Token
@@ -268,7 +283,7 @@ export interface LayoutsApiListLayoutsRequest {
268
283
  */
269
284
  readonly pageToken?: string;
270
285
  /**
271
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
286
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
272
287
  * @type {string}
273
288
  * @memberof LayoutsApiListLayouts
274
289
  */
@@ -280,19 +295,19 @@ export interface LayoutsApiListLayoutsRequest {
280
295
  */
281
296
  readonly search?: string;
282
297
  /**
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.
298
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
284
299
  * @type {string}
285
300
  * @memberof LayoutsApiListLayouts
286
301
  */
287
302
  readonly order?: string;
288
303
  /**
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.
304
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
290
305
  * @type {string}
291
306
  * @memberof LayoutsApiListLayouts
292
307
  */
293
308
  readonly expand?: string;
294
309
  /**
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.
310
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
296
311
  * @type {string}
297
312
  * @memberof LayoutsApiListLayouts
298
313
  */
@@ -331,7 +346,8 @@ export interface LayoutsApiUpdateLayoutRequest {
331
346
  */
332
347
  export declare class LayoutsApi extends BaseAPI {
333
348
  /**
334
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
349
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
350
+ * @summary Create the layout
335
351
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
336
352
  * @param {*} [options] Override http request option.
337
353
  * @throws {RequiredError}
@@ -339,7 +355,8 @@ export declare class LayoutsApi extends BaseAPI {
339
355
  */
340
356
  createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any, {}>>;
341
357
  /**
342
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
358
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
359
+ * @summary Delete the layout
343
360
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
344
361
  * @param {*} [options] Override http request option.
345
362
  * @throws {RequiredError}
@@ -347,7 +364,8 @@ export declare class LayoutsApi extends BaseAPI {
347
364
  */
348
365
  deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
349
366
  /**
350
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
367
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
368
+ * @summary Retrieve the layout
351
369
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
352
370
  * @param {*} [options] Override http request option.
353
371
  * @throws {RequiredError}
@@ -355,7 +373,8 @@ export declare class LayoutsApi extends BaseAPI {
355
373
  */
356
374
  getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any, {}>>;
357
375
  /**
358
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
376
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
377
+ * @summary List layouts
359
378
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
360
379
  * @param {*} [options] Override http request option.
361
380
  * @throws {RequiredError}
@@ -363,7 +382,8 @@ export declare class LayoutsApi extends BaseAPI {
363
382
  */
364
383
  listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any, {}>>;
365
384
  /**
366
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
385
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
386
+ * @summary Update the layout
367
387
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
368
388
  * @param {*} [options] Override http request option.
369
389
  * @throws {RequiredError}
@@ -93,7 +93,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
96
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
97
+ * @summary Create the layout
97
98
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -141,7 +142,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
145
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
146
+ * @summary Delete the layout
145
147
  * @param {number} id
146
148
  * @param {string} [authorization] Bearer Token
147
149
  * @param {*} [options] Override http request option.
@@ -188,7 +190,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
188
190
  });
189
191
  },
190
192
  /**
191
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
193
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
194
+ * @summary Retrieve the layout
192
195
  * @param {number} id
193
196
  * @param {number} id2 Layout id
194
197
  * @param {string} [authorization] Bearer Token
@@ -241,15 +244,16 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
241
244
  });
242
245
  },
243
246
  /**
244
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
247
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
248
+ * @summary List layouts
245
249
  * @param {string} [authorization] Bearer Token
246
250
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
247
251
  * @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.
248
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
252
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
249
253
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
250
- * @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.
251
- * @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.
252
- * @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.
254
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
255
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
256
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
253
257
  * @param {*} [options] Override http request option.
254
258
  * @throws {RequiredError}
255
259
  */
@@ -312,7 +316,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
312
316
  });
313
317
  },
314
318
  /**
315
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
319
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
320
+ * @summary Update the layout
316
321
  * @param {number} id
317
322
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
318
323
  * @param {string} [authorization] Bearer Token
@@ -374,7 +379,8 @@ var LayoutsApiFp = function (configuration) {
374
379
  var localVarAxiosParamCreator = (0, exports.LayoutsApiAxiosParamCreator)(configuration);
375
380
  return {
376
381
  /**
377
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
382
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
383
+ * @summary Create the layout
378
384
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
379
385
  * @param {string} [authorization] Bearer Token
380
386
  * @param {*} [options] Override http request option.
@@ -394,7 +400,8 @@ var LayoutsApiFp = function (configuration) {
394
400
  });
395
401
  },
396
402
  /**
397
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
403
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
404
+ * @summary Delete the layout
398
405
  * @param {number} id
399
406
  * @param {string} [authorization] Bearer Token
400
407
  * @param {*} [options] Override http request option.
@@ -414,7 +421,8 @@ var LayoutsApiFp = function (configuration) {
414
421
  });
415
422
  },
416
423
  /**
417
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
424
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
425
+ * @summary Retrieve the layout
418
426
  * @param {number} id
419
427
  * @param {number} id2 Layout id
420
428
  * @param {string} [authorization] Bearer Token
@@ -435,15 +443,16 @@ var LayoutsApiFp = function (configuration) {
435
443
  });
436
444
  },
437
445
  /**
438
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
446
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
447
+ * @summary List layouts
439
448
  * @param {string} [authorization] Bearer Token
440
449
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
441
450
  * @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.
442
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
451
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
443
452
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
444
- * @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.
445
- * @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.
446
- * @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.
453
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
454
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
455
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
447
456
  * @param {*} [options] Override http request option.
448
457
  * @throws {RequiredError}
449
458
  */
@@ -461,7 +470,8 @@ var LayoutsApiFp = function (configuration) {
461
470
  });
462
471
  },
463
472
  /**
464
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
473
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
474
+ * @summary Update the layout
465
475
  * @param {number} id
466
476
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
467
477
  * @param {string} [authorization] Bearer Token
@@ -492,7 +502,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
492
502
  var localVarFp = (0, exports.LayoutsApiFp)(configuration);
493
503
  return {
494
504
  /**
495
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
505
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
506
+ * @summary Create the layout
496
507
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
497
508
  * @param {string} [authorization] Bearer Token
498
509
  * @param {*} [options] Override http request option.
@@ -502,7 +513,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
502
513
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
503
514
  },
504
515
  /**
505
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
516
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
517
+ * @summary Delete the layout
506
518
  * @param {number} id
507
519
  * @param {string} [authorization] Bearer Token
508
520
  * @param {*} [options] Override http request option.
@@ -512,7 +524,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
512
524
  return localVarFp.deleteLayout(id, authorization, options).then(function (request) { return request(axios, basePath); });
513
525
  },
514
526
  /**
515
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
527
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
528
+ * @summary Retrieve the layout
516
529
  * @param {number} id
517
530
  * @param {number} id2 Layout id
518
531
  * @param {string} [authorization] Bearer Token
@@ -523,15 +536,16 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
523
536
  return localVarFp.getLayout(id, id2, authorization, options).then(function (request) { return request(axios, basePath); });
524
537
  },
525
538
  /**
526
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
539
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
540
+ * @summary List layouts
527
541
  * @param {string} [authorization] Bearer Token
528
542
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
529
543
  * @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.
530
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
544
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
531
545
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
532
- * @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.
533
- * @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.
534
- * @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.
546
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
547
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: headerTemplate, footerTemplate&lt;i&gt;
548
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, name, slug&lt;/i&gt;
535
549
  * @param {*} [options] Override http request option.
536
550
  * @throws {RequiredError}
537
551
  */
@@ -539,7 +553,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
539
553
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
540
554
  },
541
555
  /**
542
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
556
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
557
+ * @summary Update the layout
543
558
  * @param {number} id
544
559
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
545
560
  * @param {string} [authorization] Bearer Token
@@ -564,7 +579,8 @@ var LayoutsApi = /** @class */ (function (_super) {
564
579
  return _super !== null && _super.apply(this, arguments) || this;
565
580
  }
566
581
  /**
567
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
582
+ * Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
583
+ * @summary Create the layout
568
584
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
569
585
  * @param {*} [options] Override http request option.
570
586
  * @throws {RequiredError}
@@ -575,7 +591,8 @@ var LayoutsApi = /** @class */ (function (_super) {
575
591
  return (0, exports.LayoutsApiFp)(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
576
592
  };
577
593
  /**
578
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
594
+ * Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
595
+ * @summary Delete the layout
579
596
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
580
597
  * @param {*} [options] Override http request option.
581
598
  * @throws {RequiredError}
@@ -586,7 +603,8 @@ var LayoutsApi = /** @class */ (function (_super) {
586
603
  return (0, exports.LayoutsApiFp)(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
587
604
  };
588
605
  /**
589
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
606
+ * Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
607
+ * @summary Retrieve the layout
590
608
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
591
609
  * @param {*} [options] Override http request option.
592
610
  * @throws {RequiredError}
@@ -597,7 +615,8 @@ var LayoutsApi = /** @class */ (function (_super) {
597
615
  return (0, exports.LayoutsApiFp)(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
598
616
  };
599
617
  /**
600
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
618
+ * Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
619
+ * @summary List layouts
601
620
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
602
621
  * @param {*} [options] Override http request option.
603
622
  * @throws {RequiredError}
@@ -609,7 +628,8 @@ var LayoutsApi = /** @class */ (function (_super) {
609
628
  return (0, exports.LayoutsApiFp)(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
610
629
  };
611
630
  /**
612
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
631
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
632
+ * @summary Update the layout
613
633
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
614
634
  * @param {*} [options] Override http request option.
615
635
  * @throws {RequiredError}