@emilgroup/notification-sdk-node 1.4.0 → 1.4.1-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/default-api.ts +8 -4
- package/api/email-verifications-api.ts +8 -8
- package/api/layouts-api.ts +60 -60
- package/api/notification-templates-api.ts +60 -60
- package/api/notifications-api.ts +4 -4
- package/base.ts +47 -5
- package/common.ts +2 -2
- package/configuration.ts +9 -0
- package/dist/api/default-api.d.ts +8 -4
- package/dist/api/default-api.js +8 -4
- package/dist/api/email-verifications-api.d.ts +8 -8
- package/dist/api/email-verifications-api.js +8 -8
- package/dist/api/layouts-api.d.ts +60 -60
- package/dist/api/layouts-api.js +41 -41
- package/dist/api/notification-templates-api.d.ts +60 -60
- package/dist/api/notification-templates-api.js +41 -41
- package/dist/api/notifications-api.d.ts +4 -4
- package/dist/api/notifications-api.js +4 -4
- package/dist/base.d.ts +11 -2
- package/dist/base.js +43 -4
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +6 -0
- package/dist/configuration.js +8 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/notification-sdk-node@1.4.0 --save
|
|
20
|
+
npm install @emilgroup/notification-sdk-node@1.4.1-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/notification-sdk-node@1.4.0
|
|
24
|
+
yarn add @emilgroup/notification-sdk-node@1.4.1-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `LayoutApi`.
|
package/api/default-api.ts
CHANGED
|
@@ -35,7 +35,8 @@ const FormData = require('form-data');
|
|
|
35
35
|
export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
39
|
+
* @summary Health Check
|
|
39
40
|
* @param {*} [options] Override http request option.
|
|
40
41
|
* @throws {RequiredError}
|
|
41
42
|
*/
|
|
@@ -76,7 +77,8 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
76
77
|
const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
|
|
77
78
|
return {
|
|
78
79
|
/**
|
|
79
|
-
*
|
|
80
|
+
* Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
81
|
+
* @summary Health Check
|
|
80
82
|
* @param {*} [options] Override http request option.
|
|
81
83
|
* @throws {RequiredError}
|
|
82
84
|
*/
|
|
@@ -95,7 +97,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
95
97
|
const localVarFp = DefaultApiFp(configuration)
|
|
96
98
|
return {
|
|
97
99
|
/**
|
|
98
|
-
*
|
|
100
|
+
* Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
101
|
+
* @summary Health Check
|
|
99
102
|
* @param {*} [options] Override http request option.
|
|
100
103
|
* @throws {RequiredError}
|
|
101
104
|
*/
|
|
@@ -113,7 +116,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
113
116
|
*/
|
|
114
117
|
export class DefaultApi extends BaseAPI {
|
|
115
118
|
/**
|
|
116
|
-
*
|
|
119
|
+
* Returns the health status of the notification service. This endpoint is used to monitor the operational status of the notification service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
120
|
+
* @summary Health Check
|
|
117
121
|
* @param {*} [options] Override http request option.
|
|
118
122
|
* @throws {RequiredError}
|
|
119
123
|
* @memberof DefaultApi
|
|
@@ -39,7 +39,7 @@ const FormData = require('form-data');
|
|
|
39
39
|
export const EmailVerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* undefined **Required Permissions** none
|
|
43
43
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
44
44
|
* @param {string} [authorization] Bearer Token
|
|
45
45
|
* @param {*} [options] Override http request option.
|
|
@@ -85,7 +85,7 @@ export const EmailVerificationsApiAxiosParamCreator = function (configuration?:
|
|
|
85
85
|
};
|
|
86
86
|
},
|
|
87
87
|
/**
|
|
88
|
-
*
|
|
88
|
+
* undefined **Required Permissions** none
|
|
89
89
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
90
90
|
* @param {string} [authorization] Bearer Token
|
|
91
91
|
* @param {*} [options] Override http request option.
|
|
@@ -141,7 +141,7 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
|
|
|
141
141
|
const localVarAxiosParamCreator = EmailVerificationsApiAxiosParamCreator(configuration)
|
|
142
142
|
return {
|
|
143
143
|
/**
|
|
144
|
-
*
|
|
144
|
+
* undefined **Required Permissions** none
|
|
145
145
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
146
146
|
* @param {string} [authorization] Bearer Token
|
|
147
147
|
* @param {*} [options] Override http request option.
|
|
@@ -152,7 +152,7 @@ export const EmailVerificationsApiFp = function(configuration?: Configuration) {
|
|
|
152
152
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
153
153
|
},
|
|
154
154
|
/**
|
|
155
|
-
*
|
|
155
|
+
* undefined **Required Permissions** none
|
|
156
156
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
157
157
|
* @param {string} [authorization] Bearer Token
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
@@ -173,7 +173,7 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
|
|
|
173
173
|
const localVarFp = EmailVerificationsApiFp(configuration)
|
|
174
174
|
return {
|
|
175
175
|
/**
|
|
176
|
-
*
|
|
176
|
+
* undefined **Required Permissions** none
|
|
177
177
|
* @param {CompleteEmailVerificationDto} completeEmailVerificationDto
|
|
178
178
|
* @param {string} [authorization] Bearer Token
|
|
179
179
|
* @param {*} [options] Override http request option.
|
|
@@ -183,7 +183,7 @@ export const EmailVerificationsApiFactory = function (configuration?: Configurat
|
|
|
183
183
|
return localVarFp.completeEmailVerification(completeEmailVerificationDto, authorization, options).then((request) => request(axios, basePath));
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
*
|
|
186
|
+
* undefined **Required Permissions** none
|
|
187
187
|
* @param {InitiateEmailVerificationDto} initiateEmailVerificationDto
|
|
188
188
|
* @param {string} [authorization] Bearer Token
|
|
189
189
|
* @param {*} [options] Override http request option.
|
|
@@ -245,7 +245,7 @@ export interface EmailVerificationsApiInitiateEmailVerificationRequest {
|
|
|
245
245
|
*/
|
|
246
246
|
export class EmailVerificationsApi extends BaseAPI {
|
|
247
247
|
/**
|
|
248
|
-
*
|
|
248
|
+
* undefined **Required Permissions** none
|
|
249
249
|
* @param {EmailVerificationsApiCompleteEmailVerificationRequest} requestParameters Request parameters.
|
|
250
250
|
* @param {*} [options] Override http request option.
|
|
251
251
|
* @throws {RequiredError}
|
|
@@ -256,7 +256,7 @@ export class EmailVerificationsApi extends BaseAPI {
|
|
|
256
256
|
}
|
|
257
257
|
|
|
258
258
|
/**
|
|
259
|
-
*
|
|
259
|
+
* undefined **Required Permissions** none
|
|
260
260
|
* @param {EmailVerificationsApiInitiateEmailVerificationRequest} requestParameters Request parameters.
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
262
262
|
* @throws {RequiredError}
|
package/api/layouts-api.ts
CHANGED
|
@@ -43,7 +43,7 @@ const FormData = require('form-data');
|
|
|
43
43
|
export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
44
|
return {
|
|
45
45
|
/**
|
|
46
|
-
*
|
|
46
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
47
47
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
48
48
|
* @param {string} [authorization] Bearer Token
|
|
49
49
|
* @param {*} [options] Override http request option.
|
|
@@ -89,7 +89,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
89
89
|
};
|
|
90
90
|
},
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
93
93
|
* @param {number} id
|
|
94
94
|
* @param {string} [authorization] Bearer Token
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
@@ -133,7 +133,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
133
133
|
};
|
|
134
134
|
},
|
|
135
135
|
/**
|
|
136
|
-
*
|
|
136
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
137
137
|
* @param {number} id
|
|
138
138
|
* @param {number} id2 Layout id
|
|
139
139
|
* @param {string} [authorization] Bearer Token
|
|
@@ -184,19 +184,19 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
184
184
|
};
|
|
185
185
|
},
|
|
186
186
|
/**
|
|
187
|
-
*
|
|
187
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
188
188
|
* @param {string} [authorization] Bearer Token
|
|
189
|
-
* @param {
|
|
190
|
-
* @param {
|
|
191
|
-
* @param {
|
|
192
|
-
* @param {
|
|
193
|
-
* @param {
|
|
194
|
-
* @param {
|
|
195
|
-
* @param {
|
|
189
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
191
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
192
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
|
+
* @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.
|
|
194
|
+
* @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.
|
|
195
|
+
* @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.
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
199
|
-
listLayouts: async (authorization?: string, pageSize?:
|
|
199
|
+
listLayouts: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
200
200
|
const localVarPath = `/notificationservice/v1/layouts`;
|
|
201
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -259,7 +259,7 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
259
259
|
};
|
|
260
260
|
},
|
|
261
261
|
/**
|
|
262
|
-
*
|
|
262
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
263
263
|
* @param {number} id
|
|
264
264
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
265
265
|
* @param {string} [authorization] Bearer Token
|
|
@@ -319,7 +319,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
|
|
|
319
319
|
const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
|
|
320
320
|
return {
|
|
321
321
|
/**
|
|
322
|
-
*
|
|
322
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
323
323
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
324
324
|
* @param {string} [authorization] Bearer Token
|
|
325
325
|
* @param {*} [options] Override http request option.
|
|
@@ -330,7 +330,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
|
|
|
330
330
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
331
331
|
},
|
|
332
332
|
/**
|
|
333
|
-
*
|
|
333
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
334
334
|
* @param {number} id
|
|
335
335
|
* @param {string} [authorization] Bearer Token
|
|
336
336
|
* @param {*} [options] Override http request option.
|
|
@@ -341,7 +341,7 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
|
|
|
341
341
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
342
342
|
},
|
|
343
343
|
/**
|
|
344
|
-
*
|
|
344
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
345
345
|
* @param {number} id
|
|
346
346
|
* @param {number} id2 Layout id
|
|
347
347
|
* @param {string} [authorization] Bearer Token
|
|
@@ -353,24 +353,24 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
|
|
|
353
353
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
354
354
|
},
|
|
355
355
|
/**
|
|
356
|
-
*
|
|
356
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
357
357
|
* @param {string} [authorization] Bearer Token
|
|
358
|
-
* @param {
|
|
359
|
-
* @param {
|
|
360
|
-
* @param {
|
|
361
|
-
* @param {
|
|
362
|
-
* @param {
|
|
363
|
-
* @param {
|
|
364
|
-
* @param {
|
|
358
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
359
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
360
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
361
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
362
|
+
* @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.
|
|
363
|
+
* @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.
|
|
364
|
+
* @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.
|
|
365
365
|
* @param {*} [options] Override http request option.
|
|
366
366
|
* @throws {RequiredError}
|
|
367
367
|
*/
|
|
368
|
-
async listLayouts(authorization?: string, pageSize?:
|
|
368
|
+
async 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>> {
|
|
369
369
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
370
370
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
371
371
|
},
|
|
372
372
|
/**
|
|
373
|
-
*
|
|
373
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
374
374
|
* @param {number} id
|
|
375
375
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
376
376
|
* @param {string} [authorization] Bearer Token
|
|
@@ -392,7 +392,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
|
|
|
392
392
|
const localVarFp = LayoutsApiFp(configuration)
|
|
393
393
|
return {
|
|
394
394
|
/**
|
|
395
|
-
*
|
|
395
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
396
396
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
397
397
|
* @param {string} [authorization] Bearer Token
|
|
398
398
|
* @param {*} [options] Override http request option.
|
|
@@ -402,7 +402,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
|
|
|
402
402
|
return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
403
403
|
},
|
|
404
404
|
/**
|
|
405
|
-
*
|
|
405
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
406
406
|
* @param {number} id
|
|
407
407
|
* @param {string} [authorization] Bearer Token
|
|
408
408
|
* @param {*} [options] Override http request option.
|
|
@@ -412,7 +412,7 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
|
|
|
412
412
|
return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
|
|
413
413
|
},
|
|
414
414
|
/**
|
|
415
|
-
*
|
|
415
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
416
416
|
* @param {number} id
|
|
417
417
|
* @param {number} id2 Layout id
|
|
418
418
|
* @param {string} [authorization] Bearer Token
|
|
@@ -423,23 +423,23 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
|
|
|
423
423
|
return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
|
|
424
424
|
},
|
|
425
425
|
/**
|
|
426
|
-
*
|
|
426
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
427
427
|
* @param {string} [authorization] Bearer Token
|
|
428
|
-
* @param {
|
|
429
|
-
* @param {
|
|
430
|
-
* @param {
|
|
431
|
-
* @param {
|
|
432
|
-
* @param {
|
|
433
|
-
* @param {
|
|
434
|
-
* @param {
|
|
428
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
429
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
430
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
431
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
432
|
+
* @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.
|
|
433
|
+
* @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.
|
|
434
|
+
* @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.
|
|
435
435
|
* @param {*} [options] Override http request option.
|
|
436
436
|
* @throws {RequiredError}
|
|
437
437
|
*/
|
|
438
|
-
listLayouts(authorization?: string, pageSize?:
|
|
438
|
+
listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLayoutsResponseClass> {
|
|
439
439
|
return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
440
440
|
},
|
|
441
441
|
/**
|
|
442
|
-
*
|
|
442
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
443
443
|
* @param {number} id
|
|
444
444
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
445
445
|
* @param {string} [authorization] Bearer Token
|
|
@@ -537,52 +537,52 @@ export interface LayoutsApiListLayoutsRequest {
|
|
|
537
537
|
|
|
538
538
|
/**
|
|
539
539
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
540
|
-
* @type {
|
|
540
|
+
* @type {number}
|
|
541
541
|
* @memberof LayoutsApiListLayouts
|
|
542
542
|
*/
|
|
543
|
-
readonly pageSize?:
|
|
543
|
+
readonly pageSize?: number
|
|
544
544
|
|
|
545
545
|
/**
|
|
546
|
-
* 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=1,
|
|
547
|
-
* @type {
|
|
546
|
+
* 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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
547
|
+
* @type {string}
|
|
548
548
|
* @memberof LayoutsApiListLayouts
|
|
549
549
|
*/
|
|
550
|
-
readonly pageToken?:
|
|
550
|
+
readonly pageToken?: string
|
|
551
551
|
|
|
552
552
|
/**
|
|
553
553
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
554
|
-
* @type {
|
|
554
|
+
* @type {string}
|
|
555
555
|
* @memberof LayoutsApiListLayouts
|
|
556
556
|
*/
|
|
557
|
-
readonly filter?:
|
|
557
|
+
readonly filter?: string
|
|
558
558
|
|
|
559
559
|
/**
|
|
560
560
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
561
|
-
* @type {
|
|
561
|
+
* @type {string}
|
|
562
562
|
* @memberof LayoutsApiListLayouts
|
|
563
563
|
*/
|
|
564
|
-
readonly search?:
|
|
564
|
+
readonly search?: string
|
|
565
565
|
|
|
566
566
|
/**
|
|
567
567
|
* 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.
|
|
568
|
-
* @type {
|
|
568
|
+
* @type {string}
|
|
569
569
|
* @memberof LayoutsApiListLayouts
|
|
570
570
|
*/
|
|
571
|
-
readonly order?:
|
|
571
|
+
readonly order?: string
|
|
572
572
|
|
|
573
573
|
/**
|
|
574
|
-
* 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
|
|
575
|
-
* @type {
|
|
574
|
+
* 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.
|
|
575
|
+
* @type {string}
|
|
576
576
|
* @memberof LayoutsApiListLayouts
|
|
577
577
|
*/
|
|
578
|
-
readonly expand?:
|
|
578
|
+
readonly expand?: string
|
|
579
579
|
|
|
580
580
|
/**
|
|
581
581
|
* 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.
|
|
582
|
-
* @type {
|
|
582
|
+
* @type {string}
|
|
583
583
|
* @memberof LayoutsApiListLayouts
|
|
584
584
|
*/
|
|
585
|
-
readonly filters?:
|
|
585
|
+
readonly filters?: string
|
|
586
586
|
}
|
|
587
587
|
|
|
588
588
|
/**
|
|
@@ -621,7 +621,7 @@ export interface LayoutsApiUpdateLayoutRequest {
|
|
|
621
621
|
*/
|
|
622
622
|
export class LayoutsApi extends BaseAPI {
|
|
623
623
|
/**
|
|
624
|
-
*
|
|
624
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
625
625
|
* @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
|
|
626
626
|
* @param {*} [options] Override http request option.
|
|
627
627
|
* @throws {RequiredError}
|
|
@@ -632,7 +632,7 @@ export class LayoutsApi extends BaseAPI {
|
|
|
632
632
|
}
|
|
633
633
|
|
|
634
634
|
/**
|
|
635
|
-
*
|
|
635
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
636
636
|
* @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
|
|
637
637
|
* @param {*} [options] Override http request option.
|
|
638
638
|
* @throws {RequiredError}
|
|
@@ -643,7 +643,7 @@ export class LayoutsApi extends BaseAPI {
|
|
|
643
643
|
}
|
|
644
644
|
|
|
645
645
|
/**
|
|
646
|
-
*
|
|
646
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
647
647
|
* @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
|
|
648
648
|
* @param {*} [options] Override http request option.
|
|
649
649
|
* @throws {RequiredError}
|
|
@@ -654,7 +654,7 @@ export class LayoutsApi extends BaseAPI {
|
|
|
654
654
|
}
|
|
655
655
|
|
|
656
656
|
/**
|
|
657
|
-
*
|
|
657
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
658
658
|
* @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
|
|
659
659
|
* @param {*} [options] Override http request option.
|
|
660
660
|
* @throws {RequiredError}
|
|
@@ -665,7 +665,7 @@ export class LayoutsApi extends BaseAPI {
|
|
|
665
665
|
}
|
|
666
666
|
|
|
667
667
|
/**
|
|
668
|
-
*
|
|
668
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
669
669
|
* @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
|
|
670
670
|
* @param {*} [options] Override http request option.
|
|
671
671
|
* @throws {RequiredError}
|