@emilgroup/notification-sdk 0.8.1-beta.26 → 0.8.1-beta.28

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.
@@ -22,7 +22,8 @@ import { InitiateEmailVerificationResponseClass } from '../models';
22
22
  */
23
23
  export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * undefined **Required Permissions** none
25
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
26
+ * @summary Complete an email verification
26
27
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
27
28
  * @param {string} [authorization] Bearer Token
28
29
  * @param {*} [options] Override http request option.
@@ -30,7 +31,8 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
30
31
  */
31
32
  completeEmailVerification: (completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
33
  /**
33
- * undefined **Required Permissions** none
34
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
35
+ * @summary Initiate an email verification
34
36
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
35
37
  * @param {string} [authorization] Bearer Token
36
38
  * @param {*} [options] Override http request option.
@@ -44,7 +46,8 @@ export declare const EmailVerificationsApiAxiosParamCreator: (configuration?: Co
44
46
  */
45
47
  export declare const EmailVerificationsApiFp: (configuration?: Configuration) => {
46
48
  /**
47
- * undefined **Required Permissions** none
49
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
50
+ * @summary Complete an email verification
48
51
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
49
52
  * @param {string} [authorization] Bearer Token
50
53
  * @param {*} [options] Override http request option.
@@ -52,7 +55,8 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
52
55
  */
53
56
  completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompleteEmailVerificationResponseClass>>;
54
57
  /**
55
- * undefined **Required Permissions** none
58
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
59
+ * @summary Initiate an email verification
56
60
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
57
61
  * @param {string} [authorization] Bearer Token
58
62
  * @param {*} [options] Override http request option.
@@ -66,7 +70,8 @@ export declare const EmailVerificationsApiFp: (configuration?: Configuration) =>
66
70
  */
67
71
  export declare const EmailVerificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
68
72
  /**
69
- * undefined **Required Permissions** none
73
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
74
+ * @summary Complete an email verification
70
75
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
71
76
  * @param {string} [authorization] Bearer Token
72
77
  * @param {*} [options] Override http request option.
@@ -74,7 +79,8 @@ export declare const EmailVerificationsApiFactory: (configuration?: Configuratio
74
79
  */
75
80
  completeEmailVerification(completeEmailVerificationDto: CompleteEmailVerificationDto, authorization?: string, options?: any): AxiosPromise<CompleteEmailVerificationResponseClass>;
76
81
  /**
77
- * undefined **Required Permissions** none
82
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
83
+ * @summary Initiate an email verification
78
84
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
79
85
  * @param {string} [authorization] Bearer Token
80
86
  * @param {*} [options] Override http request option.
@@ -128,7 +134,8 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
128
134
  */
129
135
  export declare class EmailVerificationsApi extends BaseAPI {
130
136
  /**
131
- * undefined **Required Permissions** none
137
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
138
+ * @summary Complete an email verification
132
139
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
133
140
  * @param {*} [options] Override http request option.
134
141
  * @throws {RequiredError}
@@ -136,7 +143,8 @@ export declare class EmailVerificationsApi extends BaseAPI {
136
143
  */
137
144
  completeEmailVerification(requestParameters: EmailVerificationsApiCompleteEmailVerificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompleteEmailVerificationResponseClass, any, {}>>;
138
145
  /**
139
- * undefined **Required Permissions** none
146
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
147
+ * @summary Initiate an email verification
140
148
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
141
149
  * @param {*} [options] Override http request option.
142
150
  * @throws {RequiredError}
@@ -93,7 +93,8 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * undefined **Required Permissions** none
96
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
97
+ * @summary Complete an email verification
97
98
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -141,7 +142,8 @@ var EmailVerificationsApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- * undefined **Required Permissions** none
145
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
146
+ * @summary Initiate an email verification
145
147
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
146
148
  * @param {string} [authorization] Bearer Token
147
149
  * @param {*} [options] Override http request option.
@@ -199,7 +201,8 @@ var EmailVerificationsApiFp = function (configuration) {
199
201
  var localVarAxiosParamCreator = (0, exports.EmailVerificationsApiAxiosParamCreator)(configuration);
200
202
  return {
201
203
  /**
202
- * undefined **Required Permissions** none
204
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
205
+ * @summary Complete an email verification
203
206
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
204
207
  * @param {string} [authorization] Bearer Token
205
208
  * @param {*} [options] Override http request option.
@@ -219,7 +222,8 @@ var EmailVerificationsApiFp = function (configuration) {
219
222
  });
220
223
  },
221
224
  /**
222
- * undefined **Required Permissions** none
225
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
226
+ * @summary Initiate an email verification
223
227
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
224
228
  * @param {string} [authorization] Bearer Token
225
229
  * @param {*} [options] Override http request option.
@@ -249,7 +253,8 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
249
253
  var localVarFp = (0, exports.EmailVerificationsApiFp)(configuration);
250
254
  return {
251
255
  /**
252
- * undefined **Required Permissions** none
256
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
257
+ * @summary Complete an email verification
253
258
  * @param {CompleteEmailVerificationDto} completeEmailVerificationDto
254
259
  * @param {string} [authorization] Bearer Token
255
260
  * @param {*} [options] Override http request option.
@@ -259,7 +264,8 @@ var EmailVerificationsApiFactory = function (configuration, basePath, axios) {
259
264
  return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then(function (request) { return request(axios, basePath); });
260
265
  },
261
266
  /**
262
- * undefined **Required Permissions** none
267
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
268
+ * @summary Initiate an email verification
263
269
  * @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
264
270
  * @param {string} [authorization] Bearer Token
265
271
  * @param {*} [options] Override http request option.
@@ -283,7 +289,8 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
283
289
  return _super !== null && _super.apply(this, arguments) || this;
284
290
  }
285
291
  /**
286
- * undefined **Required Permissions** none
292
+ * Verifies the token sent to the given email address. Returns `result: true` when the token is valid. **Required Permissions** none
293
+ * @summary Complete an email verification
287
294
  * @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
288
295
  * @param {*} [options] Override http request option.
289
296
  * @throws {RequiredError}
@@ -294,7 +301,8 @@ var EmailVerificationsApi = /** @class */ (function (_super) {
294
301
  return (0, exports.EmailVerificationsApiFp)(this.configuration).completeEmailVerification(requestParameters.completeEmailVerificationDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
295
302
  };
296
303
  /**
297
- * undefined **Required Permissions** none
304
+ * Sends a verification token to the given email address. Use the complete endpoint to verify the token. **Required Permissions** none
305
+ * @summary Initiate an email verification
298
306
  * @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
299
307
  * @param {*} [options] Override http request option.
300
308
  * @throws {RequiredError}
@@ -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}