@energycap/energycapid-sdk-angular 1.2112.49-develop-20211222-1650 → 1.2112.53-ECAPID-356-ApplicationInstance-Get-API-20220106-1621
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/api/api.d.ts +3 -1
- package/api/applicationInstance.service.d.ts +2 -8
- package/api/me.service.d.ts +25 -0
- package/api/notification.service.d.ts +134 -0
- package/bundles/energycap-energycapid-sdk-angular.umd.js +560 -47
- package/bundles/energycap-energycapid-sdk-angular.umd.js.map +1 -1
- package/bundles/energycap-energycapid-sdk-angular.umd.min.js +2 -2
- package/bundles/energycap-energycapid-sdk-angular.umd.min.js.map +1 -1
- package/energycap-energycapid-sdk-angular.metadata.json +1 -1
- package/esm2015/api/api.js +4 -2
- package/esm2015/api/applicationInstance.service.js +4 -19
- package/esm2015/api/me.service.js +65 -1
- package/esm2015/api/notification.service.js +332 -0
- package/esm2015/api.module.js +3 -2
- package/esm2015/model/models.js +8 -1
- package/esm2015/model/notificationBadgeResponse.js +14 -0
- package/esm2015/model/notificationCategory.js +14 -0
- package/esm2015/model/notificationResponse.js +14 -0
- package/esm2015/model/notificationSettingRequest.js +14 -0
- package/esm2015/model/notificationType.js +14 -0
- package/esm2015/model/notificationUpdateRequest.js +14 -0
- package/esm2015/model/updateResult.js +14 -0
- package/esm2015/model/userResponse.js +1 -1
- package/fesm2015/energycap-energycapid-sdk-angular.js +521 -48
- package/fesm2015/energycap-energycapid-sdk-angular.js.map +1 -1
- package/model/models.d.ts +7 -0
- package/model/notificationBadgeResponse.d.ts +25 -0
- package/model/notificationCategory.d.ts +25 -0
- package/model/notificationResponse.d.ts +35 -0
- package/model/notificationSettingRequest.d.ts +17 -0
- package/model/notificationType.d.ts +27 -0
- package/model/notificationUpdateRequest.d.ts +21 -0
- package/model/updateResult.d.ts +15 -0
- package/model/userResponse.d.ts +4 -0
- package/package.json +1 -1
package/api/api.d.ts
CHANGED
|
@@ -12,10 +12,12 @@ export * from './environment.service';
|
|
|
12
12
|
import { EnvironmentService } from './environment.service';
|
|
13
13
|
export * from './me.service';
|
|
14
14
|
import { MeService } from './me.service';
|
|
15
|
+
export * from './notification.service';
|
|
16
|
+
import { NotificationService } from './notification.service';
|
|
15
17
|
export * from './organization.service';
|
|
16
18
|
import { OrganizationService } from './organization.service';
|
|
17
19
|
export * from './organizationApplication.service';
|
|
18
20
|
import { OrganizationApplicationService } from './organizationApplication.service';
|
|
19
21
|
export * from './user.service';
|
|
20
22
|
import { UserService } from './user.service';
|
|
21
|
-
export declare const APIS: (typeof ApplicationService | typeof ApplicationInstanceService | typeof AuthService | typeof DataSourceService | typeof DomainJoinTypeService | typeof EnvironmentService | typeof MeService | typeof OrganizationService | typeof OrganizationApplicationService | typeof UserService)[];
|
|
23
|
+
export declare const APIS: (typeof ApplicationService | typeof ApplicationInstanceService | typeof AuthService | typeof DataSourceService | typeof DomainJoinTypeService | typeof EnvironmentService | typeof MeService | typeof NotificationService | typeof OrganizationService | typeof OrganizationApplicationService | typeof UserService)[];
|
|
@@ -78,16 +78,13 @@ export declare class ApplicationInstanceService {
|
|
|
78
78
|
/**
|
|
79
79
|
* Provides a list of all available application instances to which the logged in user has access
|
|
80
80
|
*
|
|
81
|
-
* @param organizationName Filter by an exact name of an organization
|
|
82
|
-
* @param dataSourceName Filter by an exact name of a data source
|
|
83
|
-
* @param targetHost Filter by a host name containing an alias
|
|
84
81
|
* @param onlyAdmin Defaults to false. If false, returns all application instances to which the current user has access. If set to true will only return results where the logged in user has admin access
|
|
85
82
|
* @param orderBy
|
|
86
83
|
* @param filter
|
|
87
84
|
* @param pageSize The number of elements to return in a page (defaults to 250 elements)
|
|
88
85
|
* @param pageNumber The current page number
|
|
89
86
|
*/
|
|
90
|
-
getApplicationInstances(
|
|
87
|
+
getApplicationInstances(onlyAdmin?: boolean, orderBy?: string, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: {
|
|
91
88
|
search: string | {
|
|
92
89
|
[param: string]: string | string[];
|
|
93
90
|
};
|
|
@@ -137,16 +134,13 @@ export declare class ApplicationInstanceService {
|
|
|
137
134
|
/**
|
|
138
135
|
* Provides a list of all available application instances to which the logged in user has access
|
|
139
136
|
*
|
|
140
|
-
* @param organizationName Filter by an exact name of an organization
|
|
141
|
-
* @param dataSourceName Filter by an exact name of a data source
|
|
142
|
-
* @param targetHost Filter by a host name containing an alias
|
|
143
137
|
* @param onlyAdmin Defaults to false. If false, returns all application instances to which the current user has access. If set to true will only return results where the logged in user has admin access
|
|
144
138
|
* @param orderBy
|
|
145
139
|
* @param filter
|
|
146
140
|
* @param pageSize The number of elements to return in a page (defaults to 250 elements)
|
|
147
141
|
* @param pageNumber The current page number
|
|
148
142
|
*/
|
|
149
|
-
getApplicationInstancesWithHttpInfo(
|
|
143
|
+
getApplicationInstancesWithHttpInfo(onlyAdmin?: boolean, orderBy?: string, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: {
|
|
150
144
|
search: string | {
|
|
151
145
|
[param: string]: string | string[];
|
|
152
146
|
};
|
package/api/me.service.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ import { HttpClient, HttpHeaders } from '@angular/common/http';
|
|
|
13
13
|
import { HttpResponse } from '@angular/common/http';
|
|
14
14
|
import { Observable } from 'rxjs';
|
|
15
15
|
import { LinkDataSourceRequest } from '../model/linkDataSourceRequest';
|
|
16
|
+
import { NotificationSettingRequest } from '../model/notificationSettingRequest';
|
|
16
17
|
import { UpdateMeRequest } from '../model/updateMeRequest';
|
|
17
18
|
import { UserResponse } from '../model/userResponse';
|
|
18
19
|
import { Configuration } from '../configuration';
|
|
@@ -69,6 +70,18 @@ export declare class MeService {
|
|
|
69
70
|
}, extraHttpRequestHeaders?: {
|
|
70
71
|
[header: string]: string | string[];
|
|
71
72
|
}): Observable<UserResponse>;
|
|
73
|
+
/**
|
|
74
|
+
* Use this method to update the currently authenticated user's notification settings
|
|
75
|
+
*
|
|
76
|
+
* @param body The user notification settings to update
|
|
77
|
+
*/
|
|
78
|
+
updateMyNotificationSetting(body?: NotificationSettingRequest, extraHttpRequestParams?: {
|
|
79
|
+
search: string | {
|
|
80
|
+
[param: string]: string | string[];
|
|
81
|
+
};
|
|
82
|
+
}, extraHttpRequestHeaders?: {
|
|
83
|
+
[header: string]: string | string[];
|
|
84
|
+
}): Observable<UserResponse>;
|
|
72
85
|
/**
|
|
73
86
|
* Use this method to get information about the currently authenticated user
|
|
74
87
|
*
|
|
@@ -104,4 +117,16 @@ export declare class MeService {
|
|
|
104
117
|
}, extraHttpRequestHeaders?: {
|
|
105
118
|
[header: string]: string | string[];
|
|
106
119
|
}): Observable<HttpResponse<UserResponse>>;
|
|
120
|
+
/**
|
|
121
|
+
* Use this method to update the currently authenticated user's notification settings
|
|
122
|
+
*
|
|
123
|
+
* @param body The user notification settings to update
|
|
124
|
+
*/
|
|
125
|
+
updateMyNotificationSettingWithHttpInfo(body?: NotificationSettingRequest, extraHttpRequestParams?: {
|
|
126
|
+
search: string | {
|
|
127
|
+
[param: string]: string | string[];
|
|
128
|
+
};
|
|
129
|
+
}, extraHttpRequestHeaders?: {
|
|
130
|
+
[header: string]: string | string[];
|
|
131
|
+
}): Observable<HttpResponse<UserResponse>>;
|
|
107
132
|
}
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EnergyCAP ID SDK
|
|
3
|
+
* Document used to generate the EnergyCAP ID SDK
|
|
4
|
+
*
|
|
5
|
+
* OpenAPI spec version: 1.2112
|
|
6
|
+
* Contact: support@energycap.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by the swagger code generator program.
|
|
9
|
+
* https://github.com/swagger-api/swagger-codegen.git
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { HttpClient, HttpHeaders } from '@angular/common/http';
|
|
13
|
+
import { HttpResponse } from '@angular/common/http';
|
|
14
|
+
import { Observable } from 'rxjs';
|
|
15
|
+
import { NotificationBadgeResponse } from '../model/notificationBadgeResponse';
|
|
16
|
+
import { NotificationResponse } from '../model/notificationResponse';
|
|
17
|
+
import { NotificationUpdateRequest } from '../model/notificationUpdateRequest';
|
|
18
|
+
import { UpdateResult } from '../model/updateResult';
|
|
19
|
+
import { Configuration } from '../configuration';
|
|
20
|
+
export declare class NotificationService {
|
|
21
|
+
protected http: HttpClient;
|
|
22
|
+
protected basePath: string;
|
|
23
|
+
defaultHeaders: HttpHeaders;
|
|
24
|
+
configuration: Configuration;
|
|
25
|
+
constructor(http: HttpClient, basePath: string, configuration: Configuration);
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* Extends object by coping non-existing properties.
|
|
29
|
+
* @param objA object to be extended
|
|
30
|
+
* @param objB source object
|
|
31
|
+
*/
|
|
32
|
+
private extendObj;
|
|
33
|
+
/**
|
|
34
|
+
* @param consumes string[] mime-types
|
|
35
|
+
* @return true: consumes contains 'multipart/form-data', false: otherwise
|
|
36
|
+
*/
|
|
37
|
+
private canConsumeForm;
|
|
38
|
+
/**
|
|
39
|
+
* Get the last 250 notifications for the current user
|
|
40
|
+
*
|
|
41
|
+
*/
|
|
42
|
+
getMyNotifications(extraHttpRequestParams?: {
|
|
43
|
+
search: string | {
|
|
44
|
+
[param: string]: string | string[];
|
|
45
|
+
};
|
|
46
|
+
}, extraHttpRequestHeaders?: {
|
|
47
|
+
[header: string]: string | string[];
|
|
48
|
+
}): Observable<Array<NotificationResponse>>;
|
|
49
|
+
/**
|
|
50
|
+
* Get a specific notification for the current user
|
|
51
|
+
*
|
|
52
|
+
* @param notificationId Id of the notification to get
|
|
53
|
+
*/
|
|
54
|
+
getNotification(notificationId: string, extraHttpRequestParams?: {
|
|
55
|
+
search: string | {
|
|
56
|
+
[param: string]: string | string[];
|
|
57
|
+
};
|
|
58
|
+
}, extraHttpRequestHeaders?: {
|
|
59
|
+
[header: string]: string | string[];
|
|
60
|
+
}): Observable<NotificationResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* Get total number of notifications that are unread and unarchived for the current user. Use lastCheckDateTimeUtc to get the number of new notifications since the passed in date and time. By default, only the latest 250 notifications will be taken into account. Use the 'noLimit' query parameter to override this behavior.
|
|
63
|
+
*
|
|
64
|
+
* @param lastCheckDateTimeUtc Used when calculating the number of new notifications. Must be a UTC DateTime in the format yyyy-MM-ddTHH:mm:ssZ. If not passed the TotalNotifications and NewNotifications will be equal.
|
|
65
|
+
* @param noLimit If true, will return the badge totals for all of the user's notifications, not just the 250 most recent ones
|
|
66
|
+
*/
|
|
67
|
+
getNotificationBadgeTotals(lastCheckDateTimeUtc?: Date, noLimit?: boolean, extraHttpRequestParams?: {
|
|
68
|
+
search: string | {
|
|
69
|
+
[param: string]: string | string[];
|
|
70
|
+
};
|
|
71
|
+
}, extraHttpRequestHeaders?: {
|
|
72
|
+
[header: string]: string | string[];
|
|
73
|
+
}): Observable<NotificationBadgeResponse>;
|
|
74
|
+
/**
|
|
75
|
+
* Update a list of notifications based on the notification ids and action passed in Only notifications for the current user can be updated
|
|
76
|
+
*
|
|
77
|
+
* @param body List of notification ids and action to perform
|
|
78
|
+
*/
|
|
79
|
+
updateListOfNotifications(body?: NotificationUpdateRequest, extraHttpRequestParams?: {
|
|
80
|
+
search: string | {
|
|
81
|
+
[param: string]: string | string[];
|
|
82
|
+
};
|
|
83
|
+
}, extraHttpRequestHeaders?: {
|
|
84
|
+
[header: string]: string | string[];
|
|
85
|
+
}): Observable<UpdateResult>;
|
|
86
|
+
/**
|
|
87
|
+
* Get the last 250 notifications for the current user
|
|
88
|
+
*
|
|
89
|
+
*/
|
|
90
|
+
getMyNotificationsWithHttpInfo(extraHttpRequestParams?: {
|
|
91
|
+
search: string | {
|
|
92
|
+
[param: string]: string | string[];
|
|
93
|
+
};
|
|
94
|
+
}, extraHttpRequestHeaders?: {
|
|
95
|
+
[header: string]: string | string[];
|
|
96
|
+
}): Observable<HttpResponse<Array<NotificationResponse>>>;
|
|
97
|
+
/**
|
|
98
|
+
* Get a specific notification for the current user
|
|
99
|
+
*
|
|
100
|
+
* @param notificationId Id of the notification to get
|
|
101
|
+
*/
|
|
102
|
+
getNotificationWithHttpInfo(notificationId: string, extraHttpRequestParams?: {
|
|
103
|
+
search: string | {
|
|
104
|
+
[param: string]: string | string[];
|
|
105
|
+
};
|
|
106
|
+
}, extraHttpRequestHeaders?: {
|
|
107
|
+
[header: string]: string | string[];
|
|
108
|
+
}): Observable<HttpResponse<NotificationResponse>>;
|
|
109
|
+
/**
|
|
110
|
+
* Get total number of notifications that are unread and unarchived for the current user. Use lastCheckDateTimeUtc to get the number of new notifications since the passed in date and time. By default, only the latest 250 notifications will be taken into account. Use the 'noLimit' query parameter to override this behavior.
|
|
111
|
+
*
|
|
112
|
+
* @param lastCheckDateTimeUtc Used when calculating the number of new notifications. Must be a UTC DateTime in the format yyyy-MM-ddTHH:mm:ssZ. If not passed the TotalNotifications and NewNotifications will be equal.
|
|
113
|
+
* @param noLimit If true, will return the badge totals for all of the user's notifications, not just the 250 most recent ones
|
|
114
|
+
*/
|
|
115
|
+
getNotificationBadgeTotalsWithHttpInfo(lastCheckDateTimeUtc?: Date, noLimit?: boolean, extraHttpRequestParams?: {
|
|
116
|
+
search: string | {
|
|
117
|
+
[param: string]: string | string[];
|
|
118
|
+
};
|
|
119
|
+
}, extraHttpRequestHeaders?: {
|
|
120
|
+
[header: string]: string | string[];
|
|
121
|
+
}): Observable<HttpResponse<NotificationBadgeResponse>>;
|
|
122
|
+
/**
|
|
123
|
+
* Update a list of notifications based on the notification ids and action passed in Only notifications for the current user can be updated
|
|
124
|
+
*
|
|
125
|
+
* @param body List of notification ids and action to perform
|
|
126
|
+
*/
|
|
127
|
+
updateListOfNotificationsWithHttpInfo(body?: NotificationUpdateRequest, extraHttpRequestParams?: {
|
|
128
|
+
search: string | {
|
|
129
|
+
[param: string]: string | string[];
|
|
130
|
+
};
|
|
131
|
+
}, extraHttpRequestHeaders?: {
|
|
132
|
+
[header: string]: string | string[];
|
|
133
|
+
}): Observable<HttpResponse<UpdateResult>>;
|
|
134
|
+
}
|