@emilgroup/notification-sdk 0.8.1-beta.27 → 0.8.1-beta.29

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 (45) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +148 -16
  4. package/api/email-tracking-api.ts +24 -16
  5. package/api/email-verifications-api.ts +16 -8
  6. package/api/layouts-api.ts +56 -36
  7. package/api/notification-templates-api.ts +56 -36
  8. package/api/notifications-api.ts +115 -4
  9. package/dist/api/email-messages-api.d.ts +94 -16
  10. package/dist/api/email-messages-api.js +127 -16
  11. package/dist/api/email-tracking-api.d.ts +24 -16
  12. package/dist/api/email-tracking-api.js +24 -16
  13. package/dist/api/email-verifications-api.d.ts +16 -8
  14. package/dist/api/email-verifications-api.js +16 -8
  15. package/dist/api/layouts-api.d.ts +56 -36
  16. package/dist/api/layouts-api.js +52 -32
  17. package/dist/api/notification-templates-api.d.ts +56 -36
  18. package/dist/api/notification-templates-api.js +52 -32
  19. package/dist/api/notifications-api.d.ts +65 -4
  20. package/dist/api/notifications-api.js +101 -4
  21. package/dist/models/assign-email-message-entity-body-dto.d.ts +43 -0
  22. package/dist/models/assign-email-message-entity-body-dto.js +22 -0
  23. package/dist/models/assign-email-message-entity-response-class.d.ts +25 -0
  24. package/dist/models/assign-email-message-entity-response-class.js +15 -0
  25. package/dist/models/email-message-class.d.ts +2 -1
  26. package/dist/models/email-message-class.js +2 -1
  27. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  28. package/dist/models/grpc-send-email-request-dto.js +22 -0
  29. package/dist/models/index.d.ts +6 -0
  30. package/dist/models/index.js +6 -0
  31. package/dist/models/inline-attachment-dto.d.ts +36 -0
  32. package/dist/models/inline-attachment-dto.js +15 -0
  33. package/dist/models/send-email-request-dto.d.ts +131 -0
  34. package/dist/models/send-email-request-dto.js +22 -0
  35. package/dist/models/send-email-response-class.d.ts +24 -0
  36. package/dist/models/send-email-response-class.js +15 -0
  37. package/models/assign-email-message-entity-body-dto.ts +52 -0
  38. package/models/assign-email-message-entity-response-class.ts +31 -0
  39. package/models/email-message-class.ts +3 -2
  40. package/models/grpc-send-email-request-dto.ts +144 -0
  41. package/models/index.ts +6 -0
  42. package/models/inline-attachment-dto.ts +42 -0
  43. package/models/send-email-request-dto.ts +138 -0
  44. package/models/send-email-response-class.ts +30 -0
  45. package/package.json +1 -1
@@ -24,7 +24,8 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
24
24
  */
25
25
  export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
26
26
  /**
27
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
27
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
28
+ * @summary Create the notification template
28
29
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
29
30
  * @param {string} [authorization] Bearer Token
30
31
  * @param {*} [options] Override http request option.
@@ -32,7 +33,8 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
32
33
  */
33
34
  createNotificationTemplate: (createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
35
  /**
35
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
36
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
37
+ * @summary Delete the notification template
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 NotificationTemplatesApiAxiosParamCreator: (configuration?:
40
42
  */
41
43
  deleteNotificationTemplate: (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 notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
46
+ * @summary Retrieve the notification template
44
47
  * @param {number} id
45
48
  * @param {number} id2
46
49
  * @param {string} [authorization] Bearer Token
@@ -50,21 +53,23 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
50
53
  */
51
54
  getNotificationTemplate: (id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
55
  /**
53
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
56
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
57
+ * @summary List notification templates
54
58
  * @param {string} [authorization] Bearer Token
55
59
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
56
60
  * @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.
61
+ * @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: name, slug&lt;/i&gt;
58
62
  * @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.
63
+ * @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, name, createdAt&lt;/i&gt;
64
+ * @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
65
+ * @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: name, slug&lt;/i&gt;
62
66
  * @param {*} [options] Override http request option.
63
67
  * @throws {RequiredError}
64
68
  */
65
69
  listNotificationTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
66
70
  /**
67
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
71
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
72
+ * @summary Update the notification template
68
73
  * @param {number} id
69
74
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
70
75
  * @param {string} [authorization] Bearer Token
@@ -79,7 +84,8 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
79
84
  */
80
85
  export declare const NotificationTemplatesApiFp: (configuration?: Configuration) => {
81
86
  /**
82
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
87
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
88
+ * @summary Create the notification template
83
89
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
84
90
  * @param {string} [authorization] Bearer Token
85
91
  * @param {*} [options] Override http request option.
@@ -87,7 +93,8 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
87
93
  */
88
94
  createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationTemplateResponseClass>>;
89
95
  /**
90
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
96
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
97
+ * @summary Delete the notification template
91
98
  * @param {number} id
92
99
  * @param {string} [authorization] Bearer Token
93
100
  * @param {*} [options] Override http request option.
@@ -95,7 +102,8 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
95
102
  */
96
103
  deleteNotificationTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
97
104
  /**
98
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
105
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
106
+ * @summary Retrieve the notification template
99
107
  * @param {number} id
100
108
  * @param {number} id2
101
109
  * @param {string} [authorization] Bearer Token
@@ -105,21 +113,23 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
105
113
  */
106
114
  getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotificationTemplateResponseClass>>;
107
115
  /**
108
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
116
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
117
+ * @summary List notification templates
109
118
  * @param {string} [authorization] Bearer Token
110
119
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
111
120
  * @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.
121
+ * @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: name, slug&lt;/i&gt;
113
122
  * @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.
123
+ * @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, name, createdAt&lt;/i&gt;
124
+ * @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
125
+ * @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: name, slug&lt;/i&gt;
117
126
  * @param {*} [options] Override http request option.
118
127
  * @throws {RequiredError}
119
128
  */
120
129
  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
130
  /**
122
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
131
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
132
+ * @summary Update the notification template
123
133
  * @param {number} id
124
134
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
125
135
  * @param {string} [authorization] Bearer Token
@@ -134,7 +144,8 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
134
144
  */
135
145
  export declare const NotificationTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
136
146
  /**
137
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
147
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
148
+ * @summary Create the notification template
138
149
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
139
150
  * @param {string} [authorization] Bearer Token
140
151
  * @param {*} [options] Override http request option.
@@ -142,7 +153,8 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
142
153
  */
143
154
  createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateNotificationTemplateResponseClass>;
144
155
  /**
145
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
156
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
157
+ * @summary Delete the notification template
146
158
  * @param {number} id
147
159
  * @param {string} [authorization] Bearer Token
148
160
  * @param {*} [options] Override http request option.
@@ -150,7 +162,8 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
150
162
  */
151
163
  deleteNotificationTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object>;
152
164
  /**
153
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
165
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
166
+ * @summary Retrieve the notification template
154
167
  * @param {number} id
155
168
  * @param {number} id2
156
169
  * @param {string} [authorization] Bearer Token
@@ -160,21 +173,23 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
160
173
  */
161
174
  getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetNotificationTemplateResponseClass>;
162
175
  /**
163
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
176
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
177
+ * @summary List notification templates
164
178
  * @param {string} [authorization] Bearer Token
165
179
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
166
180
  * @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.
181
+ * @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: name, slug&lt;/i&gt;
168
182
  * @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.
183
+ * @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, name, createdAt&lt;/i&gt;
184
+ * @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
185
+ * @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: name, slug&lt;/i&gt;
172
186
  * @param {*} [options] Override http request option.
173
187
  * @throws {RequiredError}
174
188
  */
175
189
  listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNotificationTemplatesResponseClass>;
176
190
  /**
177
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
191
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
192
+ * @summary Update the notification template
178
193
  * @param {number} id
179
194
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
180
195
  * @param {string} [authorization] Bearer Token
@@ -277,7 +292,7 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
277
292
  */
278
293
  readonly pageToken?: string;
279
294
  /**
280
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
295
+ * 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: name, slug&lt;/i&gt;
281
296
  * @type {string}
282
297
  * @memberof NotificationTemplatesApiListNotificationTemplates
283
298
  */
@@ -289,19 +304,19 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
289
304
  */
290
305
  readonly search?: string;
291
306
  /**
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.
307
+ * 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, name, createdAt&lt;/i&gt;
293
308
  * @type {string}
294
309
  * @memberof NotificationTemplatesApiListNotificationTemplates
295
310
  */
296
311
  readonly order?: string;
297
312
  /**
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.
313
+ * 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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
299
314
  * @type {string}
300
315
  * @memberof NotificationTemplatesApiListNotificationTemplates
301
316
  */
302
317
  readonly expand?: string;
303
318
  /**
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.
319
+ * 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: name, slug&lt;/i&gt;
305
320
  * @type {string}
306
321
  * @memberof NotificationTemplatesApiListNotificationTemplates
307
322
  */
@@ -340,7 +355,8 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
340
355
  */
341
356
  export declare class NotificationTemplatesApi extends BaseAPI {
342
357
  /**
343
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
358
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
359
+ * @summary Create the notification template
344
360
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
345
361
  * @param {*} [options] Override http request option.
346
362
  * @throws {RequiredError}
@@ -348,7 +364,8 @@ export declare class NotificationTemplatesApi extends BaseAPI {
348
364
  */
349
365
  createNotificationTemplate(requestParameters: NotificationTemplatesApiCreateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationTemplateResponseClass, any, {}>>;
350
366
  /**
351
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
367
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
368
+ * @summary Delete the notification template
352
369
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
353
370
  * @param {*} [options] Override http request option.
354
371
  * @throws {RequiredError}
@@ -356,7 +373,8 @@ export declare class NotificationTemplatesApi extends BaseAPI {
356
373
  */
357
374
  deleteNotificationTemplate(requestParameters: NotificationTemplatesApiDeleteNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
358
375
  /**
359
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
376
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
377
+ * @summary Retrieve the notification template
360
378
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
361
379
  * @param {*} [options] Override http request option.
362
380
  * @throws {RequiredError}
@@ -364,7 +382,8 @@ export declare class NotificationTemplatesApi extends BaseAPI {
364
382
  */
365
383
  getNotificationTemplate(requestParameters: NotificationTemplatesApiGetNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationTemplateResponseClass, any, {}>>;
366
384
  /**
367
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
385
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
386
+ * @summary List notification templates
368
387
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
369
388
  * @param {*} [options] Override http request option.
370
389
  * @throws {RequiredError}
@@ -372,7 +391,8 @@ export declare class NotificationTemplatesApi extends BaseAPI {
372
391
  */
373
392
  listNotificationTemplates(requestParameters?: NotificationTemplatesApiListNotificationTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationTemplatesResponseClass, any, {}>>;
374
393
  /**
375
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
394
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
395
+ * @summary Update the notification template
376
396
  * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
377
397
  * @param {*} [options] Override http request option.
378
398
  * @throws {RequiredError}
@@ -93,7 +93,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
96
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
97
+ * @summary Create the notification template
97
98
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -141,7 +142,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
145
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
146
+ * @summary Delete the notification template
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 NotificationTemplatesApiAxiosParamCreator = function (configuration) {
188
190
  });
189
191
  },
190
192
  /**
191
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
193
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
194
+ * @summary Retrieve the notification template
192
195
  * @param {number} id
193
196
  * @param {number} id2
194
197
  * @param {string} [authorization] Bearer Token
@@ -245,15 +248,16 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
245
248
  });
246
249
  },
247
250
  /**
248
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
251
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
252
+ * @summary List notification templates
249
253
  * @param {string} [authorization] Bearer Token
250
254
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
251
255
  * @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.
252
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
256
+ * @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: name, slug&lt;/i&gt;
253
257
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
254
- * @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.
255
- * @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.
256
- * @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.
258
+ * @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, name, createdAt&lt;/i&gt;
259
+ * @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
260
+ * @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: name, slug&lt;/i&gt;
257
261
  * @param {*} [options] Override http request option.
258
262
  * @throws {RequiredError}
259
263
  */
@@ -316,7 +320,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
316
320
  });
317
321
  },
318
322
  /**
319
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
323
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
324
+ * @summary Update the notification template
320
325
  * @param {number} id
321
326
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
322
327
  * @param {string} [authorization] Bearer Token
@@ -378,7 +383,8 @@ var NotificationTemplatesApiFp = function (configuration) {
378
383
  var localVarAxiosParamCreator = (0, exports.NotificationTemplatesApiAxiosParamCreator)(configuration);
379
384
  return {
380
385
  /**
381
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
386
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
387
+ * @summary Create the notification template
382
388
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
383
389
  * @param {string} [authorization] Bearer Token
384
390
  * @param {*} [options] Override http request option.
@@ -398,7 +404,8 @@ var NotificationTemplatesApiFp = function (configuration) {
398
404
  });
399
405
  },
400
406
  /**
401
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
407
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
408
+ * @summary Delete the notification template
402
409
  * @param {number} id
403
410
  * @param {string} [authorization] Bearer Token
404
411
  * @param {*} [options] Override http request option.
@@ -418,7 +425,8 @@ var NotificationTemplatesApiFp = function (configuration) {
418
425
  });
419
426
  },
420
427
  /**
421
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
428
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
429
+ * @summary Retrieve the notification template
422
430
  * @param {number} id
423
431
  * @param {number} id2
424
432
  * @param {string} [authorization] Bearer Token
@@ -440,15 +448,16 @@ var NotificationTemplatesApiFp = function (configuration) {
440
448
  });
441
449
  },
442
450
  /**
443
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
451
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
452
+ * @summary List notification templates
444
453
  * @param {string} [authorization] Bearer Token
445
454
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
446
455
  * @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.
447
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
456
+ * @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: name, slug&lt;/i&gt;
448
457
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
449
- * @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.
450
- * @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.
451
- * @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.
458
+ * @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, name, createdAt&lt;/i&gt;
459
+ * @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
460
+ * @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: name, slug&lt;/i&gt;
452
461
  * @param {*} [options] Override http request option.
453
462
  * @throws {RequiredError}
454
463
  */
@@ -466,7 +475,8 @@ var NotificationTemplatesApiFp = function (configuration) {
466
475
  });
467
476
  },
468
477
  /**
469
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
478
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
479
+ * @summary Update the notification template
470
480
  * @param {number} id
471
481
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
472
482
  * @param {string} [authorization] Bearer Token
@@ -497,7 +507,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
497
507
  var localVarFp = (0, exports.NotificationTemplatesApiFp)(configuration);
498
508
  return {
499
509
  /**
500
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
510
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
511
+ * @summary Create the notification template
501
512
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
502
513
  * @param {string} [authorization] Bearer Token
503
514
  * @param {*} [options] Override http request option.
@@ -507,7 +518,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
507
518
  return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
508
519
  },
509
520
  /**
510
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
521
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
522
+ * @summary Delete the notification template
511
523
  * @param {number} id
512
524
  * @param {string} [authorization] Bearer Token
513
525
  * @param {*} [options] Override http request option.
@@ -517,7 +529,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
517
529
  return localVarFp.deleteNotificationTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
518
530
  },
519
531
  /**
520
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
532
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
533
+ * @summary Retrieve the notification template
521
534
  * @param {number} id
522
535
  * @param {number} id2
523
536
  * @param {string} [authorization] Bearer Token
@@ -529,15 +542,16 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
529
542
  return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
530
543
  },
531
544
  /**
532
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
545
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
546
+ * @summary List notification templates
533
547
  * @param {string} [authorization] Bearer Token
534
548
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
535
549
  * @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.
536
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
550
+ * @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: name, slug&lt;/i&gt;
537
551
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
538
- * @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.
539
- * @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.
540
- * @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.
552
+ * @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, name, createdAt&lt;/i&gt;
553
+ * @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias&lt;i&gt;
554
+ * @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: name, slug&lt;/i&gt;
541
555
  * @param {*} [options] Override http request option.
542
556
  * @throws {RequiredError}
543
557
  */
@@ -545,7 +559,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
545
559
  return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
546
560
  },
547
561
  /**
548
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
562
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
563
+ * @summary Update the notification template
549
564
  * @param {number} id
550
565
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
551
566
  * @param {string} [authorization] Bearer Token
@@ -570,7 +585,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
570
585
  return _super !== null && _super.apply(this, arguments) || this;
571
586
  }
572
587
  /**
573
- * undefined **Required Permissions** \"notification-management.email-templates.create\"
588
+ * Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
589
+ * @summary Create the notification template
574
590
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
575
591
  * @param {*} [options] Override http request option.
576
592
  * @throws {RequiredError}
@@ -581,7 +597,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
581
597
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).createNotificationTemplate(requestParameters.createNotificationTemplateRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
582
598
  };
583
599
  /**
584
- * undefined **Required Permissions** \"notification-management.email-templates.delete\"
600
+ * Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
601
+ * @summary Delete the notification template
585
602
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
586
603
  * @param {*} [options] Override http request option.
587
604
  * @throws {RequiredError}
@@ -592,7 +609,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
592
609
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).deleteNotificationTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
593
610
  };
594
611
  /**
595
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
612
+ * Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
613
+ * @summary Retrieve the notification template
596
614
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
597
615
  * @param {*} [options] Override http request option.
598
616
  * @throws {RequiredError}
@@ -603,7 +621,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
603
621
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).getNotificationTemplate(requestParameters.id, requestParameters.id2, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
604
622
  };
605
623
  /**
606
- * undefined **Required Permissions** \"notification-management.email-templates.view\"
624
+ * Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
625
+ * @summary List notification templates
607
626
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
608
627
  * @param {*} [options] Override http request option.
609
628
  * @throws {RequiredError}
@@ -615,7 +634,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
615
634
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).listNotificationTemplates(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); });
616
635
  };
617
636
  /**
618
- * undefined **Required Permissions** \"notification-management.email-templates.update\"
637
+ * Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
638
+ * @summary Update the notification template
619
639
  * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
620
640
  * @param {*} [options] Override http request option.
621
641
  * @throws {RequiredError}