@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.
@@ -24,7 +24,7 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
24
24
  */
25
25
  export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
26
26
  /**
27
- *
27
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
28
28
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
29
29
  * @param {string} [authorization] Bearer Token
30
30
  * @param {*} [options] Override http request option.
@@ -32,7 +32,7 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
32
32
  */
33
33
  createNotificationTemplate: (createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
34
  /**
35
- *
35
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
36
36
  * @param {number} id
37
37
  * @param {string} [authorization] Bearer Token
38
38
  * @param {*} [options] Override http request option.
@@ -40,7 +40,7 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
40
40
  */
41
41
  deleteNotificationTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
42
  /**
43
- *
43
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
44
44
  * @param {number} id
45
45
  * @param {number} id2
46
46
  * @param {string} [authorization] Bearer Token
@@ -50,21 +50,21 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
50
50
  */
51
51
  getNotificationTemplate: (id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
52
  /**
53
- *
53
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
54
54
  * @param {string} [authorization] Bearer Token
55
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
56
- * @param {any} [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 {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
58
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
59
- * @param {any} [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 {any} [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 {any} [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.
55
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
56
+ * @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.
58
+ * @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.
62
62
  * @param {*} [options] Override http request option.
63
63
  * @throws {RequiredError}
64
64
  */
65
- listNotificationTemplates: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
+ listNotificationTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
66
66
  /**
67
- *
67
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
68
68
  * @param {number} id
69
69
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
70
70
  * @param {string} [authorization] Bearer Token
@@ -79,7 +79,7 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
79
79
  */
80
80
  export declare const NotificationTemplatesApiFp: (configuration?: Configuration) => {
81
81
  /**
82
- *
82
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
83
83
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
84
84
  * @param {string} [authorization] Bearer Token
85
85
  * @param {*} [options] Override http request option.
@@ -87,7 +87,7 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
87
87
  */
88
88
  createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationTemplateResponseClass>>;
89
89
  /**
90
- *
90
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
91
91
  * @param {number} id
92
92
  * @param {string} [authorization] Bearer Token
93
93
  * @param {*} [options] Override http request option.
@@ -95,7 +95,7 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
95
95
  */
96
96
  deleteNotificationTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
97
97
  /**
98
- *
98
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
99
99
  * @param {number} id
100
100
  * @param {number} id2
101
101
  * @param {string} [authorization] Bearer Token
@@ -105,21 +105,21 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
105
105
  */
106
106
  getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotificationTemplateResponseClass>>;
107
107
  /**
108
- *
108
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
109
109
  * @param {string} [authorization] Bearer Token
110
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
111
- * @param {any} [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 {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
113
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
114
- * @param {any} [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 {any} [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 {any} [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.
110
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
111
+ * @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.
113
+ * @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.
117
117
  * @param {*} [options] Override http request option.
118
118
  * @throws {RequiredError}
119
119
  */
120
- listNotificationTemplates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNotificationTemplatesResponseClass>>;
120
+ 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
121
  /**
122
- *
122
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
123
123
  * @param {number} id
124
124
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
125
125
  * @param {string} [authorization] Bearer Token
@@ -134,7 +134,7 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
134
134
  */
135
135
  export declare const NotificationTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
136
136
  /**
137
- *
137
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
138
138
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
139
139
  * @param {string} [authorization] Bearer Token
140
140
  * @param {*} [options] Override http request option.
@@ -142,7 +142,7 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
142
142
  */
143
143
  createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateNotificationTemplateResponseClass>;
144
144
  /**
145
- *
145
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
146
146
  * @param {number} id
147
147
  * @param {string} [authorization] Bearer Token
148
148
  * @param {*} [options] Override http request option.
@@ -150,7 +150,7 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
150
150
  */
151
151
  deleteNotificationTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object>;
152
152
  /**
153
- *
153
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
154
154
  * @param {number} id
155
155
  * @param {number} id2
156
156
  * @param {string} [authorization] Bearer Token
@@ -160,21 +160,21 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
160
160
  */
161
161
  getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetNotificationTemplateResponseClass>;
162
162
  /**
163
- *
163
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
164
164
  * @param {string} [authorization] Bearer Token
165
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
166
- * @param {any} [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 {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
168
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
169
- * @param {any} [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 {any} [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 {any} [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.
165
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
166
+ * @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.
168
+ * @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.
172
172
  * @param {*} [options] Override http request option.
173
173
  * @throws {RequiredError}
174
174
  */
175
- listNotificationTemplates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListNotificationTemplatesResponseClass>;
175
+ listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNotificationTemplatesResponseClass>;
176
176
  /**
177
- *
177
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
178
178
  * @param {number} id
179
179
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
180
180
  * @param {string} [authorization] Bearer Token
@@ -266,46 +266,46 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
266
266
  readonly authorization?: string;
267
267
  /**
268
268
  * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
269
- * @type {any}
269
+ * @type {number}
270
270
  * @memberof NotificationTemplatesApiListNotificationTemplates
271
271
  */
272
- readonly pageSize?: any;
272
+ readonly pageSize?: number;
273
273
  /**
274
- * 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.
275
- * @type {any}
274
+ * 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.
275
+ * @type {string}
276
276
  * @memberof NotificationTemplatesApiListNotificationTemplates
277
277
  */
278
- readonly pageToken?: any;
278
+ readonly pageToken?: string;
279
279
  /**
280
280
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
281
- * @type {any}
281
+ * @type {string}
282
282
  * @memberof NotificationTemplatesApiListNotificationTemplates
283
283
  */
284
- readonly filter?: any;
284
+ readonly filter?: string;
285
285
  /**
286
286
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
287
- * @type {any}
287
+ * @type {string}
288
288
  * @memberof NotificationTemplatesApiListNotificationTemplates
289
289
  */
290
- readonly search?: any;
290
+ readonly search?: string;
291
291
  /**
292
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.
293
- * @type {any}
293
+ * @type {string}
294
294
  * @memberof NotificationTemplatesApiListNotificationTemplates
295
295
  */
296
- readonly order?: any;
296
+ readonly order?: string;
297
297
  /**
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.
299
- * @type {any}
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.
299
+ * @type {string}
300
300
  * @memberof NotificationTemplatesApiListNotificationTemplates
301
301
  */
302
- readonly expand?: any;
302
+ readonly expand?: string;
303
303
  /**
304
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.
305
- * @type {any}
305
+ * @type {string}
306
306
  * @memberof NotificationTemplatesApiListNotificationTemplates
307
307
  */
308
- readonly filters?: any;
308
+ readonly filters?: string;
309
309
  }
310
310
  /**
311
311
  * Request parameters for updateNotificationTemplate operation in NotificationTemplatesApi.
@@ -340,7 +340,7 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
340
340
  */
341
341
  export declare class NotificationTemplatesApi extends BaseAPI {
342
342
  /**
343
- *
343
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
344
344
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
345
345
  * @param {*} [options] Override http request option.
346
346
  * @throws {RequiredError}
@@ -348,7 +348,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
348
348
  */
349
349
  createNotificationTemplate(requestParameters: NotificationTemplatesApiCreateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationTemplateResponseClass, any>>;
350
350
  /**
351
- *
351
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
352
352
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
353
353
  * @param {*} [options] Override http request option.
354
354
  * @throws {RequiredError}
@@ -356,7 +356,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
356
356
  */
357
357
  deleteNotificationTemplate(requestParameters: NotificationTemplatesApiDeleteNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
358
358
  /**
359
- *
359
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
360
360
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
361
361
  * @param {*} [options] Override http request option.
362
362
  * @throws {RequiredError}
@@ -364,7 +364,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
364
364
  */
365
365
  getNotificationTemplate(requestParameters: NotificationTemplatesApiGetNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationTemplateResponseClass, any>>;
366
366
  /**
367
- *
367
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
368
368
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
369
369
  * @param {*} [options] Override http request option.
370
370
  * @throws {RequiredError}
@@ -372,7 +372,7 @@ export declare class NotificationTemplatesApi extends BaseAPI {
372
372
  */
373
373
  listNotificationTemplates(requestParameters?: NotificationTemplatesApiListNotificationTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationTemplatesResponseClass, any>>;
374
374
  /**
375
- *
375
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
376
376
  * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
377
377
  * @param {*} [options] Override http request option.
378
378
  * @throws {RequiredError}
@@ -97,7 +97,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
100
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
101
101
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
102
102
  * @param {string} [authorization] Bearer Token
103
103
  * @param {*} [options] Override http request option.
@@ -145,7 +145,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
145
145
  });
146
146
  },
147
147
  /**
148
- *
148
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
149
149
  * @param {number} id
150
150
  * @param {string} [authorization] Bearer Token
151
151
  * @param {*} [options] Override http request option.
@@ -192,7 +192,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
192
192
  });
193
193
  },
194
194
  /**
195
- *
195
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
196
196
  * @param {number} id
197
197
  * @param {number} id2
198
198
  * @param {string} [authorization] Bearer Token
@@ -249,15 +249,15 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
249
249
  });
250
250
  },
251
251
  /**
252
- *
252
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
253
253
  * @param {string} [authorization] Bearer Token
254
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
255
- * @param {any} [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.
256
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
257
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
258
- * @param {any} [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.
259
- * @param {any} [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.
260
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
254
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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.
256
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
257
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
258
+ * @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.
259
+ * @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.
260
+ * @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.
261
261
  * @param {*} [options] Override http request option.
262
262
  * @throws {RequiredError}
263
263
  */
@@ -320,7 +320,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
320
320
  });
321
321
  },
322
322
  /**
323
- *
323
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
324
324
  * @param {number} id
325
325
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
326
326
  * @param {string} [authorization] Bearer Token
@@ -382,7 +382,7 @@ var NotificationTemplatesApiFp = function (configuration) {
382
382
  var localVarAxiosParamCreator = (0, exports.NotificationTemplatesApiAxiosParamCreator)(configuration);
383
383
  return {
384
384
  /**
385
- *
385
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
386
386
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
387
387
  * @param {string} [authorization] Bearer Token
388
388
  * @param {*} [options] Override http request option.
@@ -402,7 +402,7 @@ var NotificationTemplatesApiFp = function (configuration) {
402
402
  });
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.
@@ -422,7 +422,7 @@ var NotificationTemplatesApiFp = function (configuration) {
422
422
  });
423
423
  },
424
424
  /**
425
- *
425
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
426
426
  * @param {number} id
427
427
  * @param {number} id2
428
428
  * @param {string} [authorization] Bearer Token
@@ -444,15 +444,15 @@ var NotificationTemplatesApiFp = function (configuration) {
444
444
  });
445
445
  },
446
446
  /**
447
- *
447
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
448
448
  * @param {string} [authorization] Bearer Token
449
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
450
- * @param {any} [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.
451
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
452
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
453
- * @param {any} [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.
454
- * @param {any} [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.
455
- * @param {any} [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.
449
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
450
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
451
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
452
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
453
+ * @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.
454
+ * @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.
455
+ * @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.
456
456
  * @param {*} [options] Override http request option.
457
457
  * @throws {RequiredError}
458
458
  */
@@ -470,7 +470,7 @@ var NotificationTemplatesApiFp = function (configuration) {
470
470
  });
471
471
  },
472
472
  /**
473
- *
473
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
474
474
  * @param {number} id
475
475
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
476
476
  * @param {string} [authorization] Bearer Token
@@ -501,7 +501,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
501
501
  var localVarFp = (0, exports.NotificationTemplatesApiFp)(configuration);
502
502
  return {
503
503
  /**
504
- *
504
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
505
505
  * @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
506
506
  * @param {string} [authorization] Bearer Token
507
507
  * @param {*} [options] Override http request option.
@@ -511,7 +511,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
511
511
  return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
512
512
  },
513
513
  /**
514
- *
514
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
515
515
  * @param {number} id
516
516
  * @param {string} [authorization] Bearer Token
517
517
  * @param {*} [options] Override http request option.
@@ -521,7 +521,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
521
521
  return localVarFp.deleteNotificationTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
522
522
  },
523
523
  /**
524
- *
524
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
525
525
  * @param {number} id
526
526
  * @param {number} id2
527
527
  * @param {string} [authorization] Bearer Token
@@ -533,15 +533,15 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
533
533
  return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
534
534
  },
535
535
  /**
536
- *
536
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
537
537
  * @param {string} [authorization] Bearer Token
538
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
539
- * @param {any} [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.
540
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
541
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
542
- * @param {any} [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.
543
- * @param {any} [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.
544
- * @param {any} [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.
538
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
539
+ * @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.
540
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
541
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
542
+ * @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.
543
+ * @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.
544
+ * @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.
545
545
  * @param {*} [options] Override http request option.
546
546
  * @throws {RequiredError}
547
547
  */
@@ -549,7 +549,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
549
549
  return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
550
550
  },
551
551
  /**
552
- *
552
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
553
553
  * @param {number} id
554
554
  * @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
555
555
  * @param {string} [authorization] Bearer Token
@@ -574,7 +574,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
574
574
  return _super !== null && _super.apply(this, arguments) || this;
575
575
  }
576
576
  /**
577
- *
577
+ * undefined **Required Permissions** \"notification-management.email-templates.create\"
578
578
  * @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
579
579
  * @param {*} [options] Override http request option.
580
580
  * @throws {RequiredError}
@@ -585,7 +585,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
585
585
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).createNotificationTemplate(requestParameters.createNotificationTemplateRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
586
586
  };
587
587
  /**
588
- *
588
+ * undefined **Required Permissions** \"notification-management.email-templates.delete\"
589
589
  * @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
590
590
  * @param {*} [options] Override http request option.
591
591
  * @throws {RequiredError}
@@ -596,7 +596,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
596
596
  return (0, exports.NotificationTemplatesApiFp)(this.configuration).deleteNotificationTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
597
597
  };
598
598
  /**
599
- *
599
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
600
600
  * @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
601
601
  * @param {*} [options] Override http request option.
602
602
  * @throws {RequiredError}
@@ -607,7 +607,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
607
607
  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); });
608
608
  };
609
609
  /**
610
- *
610
+ * undefined **Required Permissions** \"notification-management.email-templates.view\"
611
611
  * @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
612
612
  * @param {*} [options] Override http request option.
613
613
  * @throws {RequiredError}
@@ -619,7 +619,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
619
619
  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); });
620
620
  };
621
621
  /**
622
- *
622
+ * undefined **Required Permissions** \"notification-management.email-templates.update\"
623
623
  * @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
624
624
  * @param {*} [options] Override http request option.
625
625
  * @throws {RequiredError}
@@ -20,7 +20,7 @@ import { SendNotificationResponseClass } from '../models';
20
20
  */
21
21
  export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
22
22
  /**
23
- *
23
+ * undefined **Required Permissions** none
24
24
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
25
25
  * @param {string} [authorization] Bearer Token
26
26
  * @param {*} [options] Override http request option.
@@ -34,7 +34,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
34
34
  */
35
35
  export declare const NotificationsApiFp: (configuration?: Configuration) => {
36
36
  /**
37
- *
37
+ * undefined **Required Permissions** none
38
38
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
39
39
  * @param {string} [authorization] Bearer Token
40
40
  * @param {*} [options] Override http request option.
@@ -48,7 +48,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
48
48
  */
49
49
  export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
50
50
  /**
51
- *
51
+ * undefined **Required Permissions** none
52
52
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
53
53
  * @param {string} [authorization] Bearer Token
54
54
  * @param {*} [options] Override http request option.
@@ -83,7 +83,7 @@ export interface NotificationsApiSendNotificationRequest {
83
83
  */
84
84
  export declare class NotificationsApi extends BaseAPI {
85
85
  /**
86
- *
86
+ * undefined **Required Permissions** none
87
87
  * @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
88
88
  * @param {*} [options] Override http request option.
89
89
  * @throws {RequiredError}
@@ -97,7 +97,7 @@ var NotificationsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
100
+ * undefined **Required Permissions** none
101
101
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
102
102
  * @param {string} [authorization] Bearer Token
103
103
  * @param {*} [options] Override http request option.
@@ -155,7 +155,7 @@ var NotificationsApiFp = function (configuration) {
155
155
  var localVarAxiosParamCreator = (0, exports.NotificationsApiAxiosParamCreator)(configuration);
156
156
  return {
157
157
  /**
158
- *
158
+ * undefined **Required Permissions** none
159
159
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
160
160
  * @param {string} [authorization] Bearer Token
161
161
  * @param {*} [options] Override http request option.
@@ -185,7 +185,7 @@ var NotificationsApiFactory = function (configuration, basePath, axios) {
185
185
  var localVarFp = (0, exports.NotificationsApiFp)(configuration);
186
186
  return {
187
187
  /**
188
- *
188
+ * undefined **Required Permissions** none
189
189
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
190
190
  * @param {string} [authorization] Bearer Token
191
191
  * @param {*} [options] Override http request option.
@@ -209,7 +209,7 @@ var NotificationsApi = /** @class */ (function (_super) {
209
209
  return _super !== null && _super.apply(this, arguments) || this;
210
210
  }
211
211
  /**
212
- *
212
+ * undefined **Required Permissions** none
213
213
  * @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
214
214
  * @param {*} [options] Override http request option.
215
215
  * @throws {RequiredError}
package/dist/base.d.ts CHANGED
@@ -26,6 +26,14 @@ export interface LoginClass {
26
26
  accessToken: string;
27
27
  permissions: string;
28
28
  }
29
+ export interface SwitchWorkspaceRequest {
30
+ username: string;
31
+ targetWorkspace: string;
32
+ }
33
+ export interface SwitchWorkspaceResponseClass {
34
+ accessToken: string;
35
+ permissions: string;
36
+ }
29
37
  export declare enum Environment {
30
38
  Production = "https://apiv2.emil.de",
31
39
  Test = "https://apiv2-test.emil.de",
@@ -55,12 +63,13 @@ export declare class BaseAPI {
55
63
  private username?;
56
64
  private password?;
57
65
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
58
- initialize(env?: Environment): Promise<void>;
66
+ initialize(env?: Environment, targetWorkspace?: string): Promise<void>;
59
67
  private loadCredentials;
60
68
  private readConfigFile;
61
69
  private readEnvVariables;
62
70
  selectEnvironment(env: Environment): void;
63
- authorize(username: string, password: string): Promise<void>;
71
+ authorize(username: string, password: string, targetWorkspace?: string): Promise<void>;
72
+ switchWorkspace(targetWorkspace: string): Promise<void>;
64
73
  refreshTokenInternal(): Promise<string>;
65
74
  private extractRefreshToken;
66
75
  getConfiguration(): Configuration;