@energycap/energycapid-sdk-angular 1.2112.69-develop-20220131-0920 → 1.2112.73-develop-20220202-1024

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.
@@ -38,10 +38,9 @@ export declare class ApplicationInstanceService {
38
38
  /**
39
39
  * Provides details to an application instance
40
40
  *
41
- * @param applicationInstanceId
42
- * @param body Id of the application instance to return
41
+ * @param applicationInstanceId Id of the application instance to return
43
42
  */
44
- getApplicationInstanceDetails(applicationInstanceId: string, body?: string, extraHttpRequestParams?: {
43
+ getApplicationInstanceDetails(applicationInstanceId: string, extraHttpRequestParams?: {
45
44
  search: string | {
46
45
  [param: string]: string | string[];
47
46
  };
@@ -63,12 +62,13 @@ export declare class ApplicationInstanceService {
63
62
  /**
64
63
  * Provides a list of user's who have access to an application instance
65
64
  *
66
- * @param applicationInstanceId
65
+ * @param applicationInstanceId Id of the application instance to return
66
+ * @param orderBy
67
+ * @param filter
67
68
  * @param pageSize The number of elements to return in a page (defaults to 250 elements)
68
69
  * @param pageNumber The current page number
69
- * @param body Id of the application instance to return
70
70
  */
71
- getApplicationInstanceUsers(applicationInstanceId: string, pageSize?: number, pageNumber?: number, body?: string, extraHttpRequestParams?: {
71
+ getApplicationInstanceUsers(applicationInstanceId: string, orderBy?: string, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: {
72
72
  search: string | {
73
73
  [param: string]: string | string[];
74
74
  };
@@ -94,10 +94,9 @@ export declare class ApplicationInstanceService {
94
94
  /**
95
95
  * Provides details to an application instance
96
96
  *
97
- * @param applicationInstanceId
98
- * @param body Id of the application instance to return
97
+ * @param applicationInstanceId Id of the application instance to return
99
98
  */
100
- getApplicationInstanceDetailsWithHttpInfo(applicationInstanceId: string, body?: string, extraHttpRequestParams?: {
99
+ getApplicationInstanceDetailsWithHttpInfo(applicationInstanceId: string, extraHttpRequestParams?: {
101
100
  search: string | {
102
101
  [param: string]: string | string[];
103
102
  };
@@ -119,12 +118,13 @@ export declare class ApplicationInstanceService {
119
118
  /**
120
119
  * Provides a list of user's who have access to an application instance
121
120
  *
122
- * @param applicationInstanceId
121
+ * @param applicationInstanceId Id of the application instance to return
122
+ * @param orderBy
123
+ * @param filter
123
124
  * @param pageSize The number of elements to return in a page (defaults to 250 elements)
124
125
  * @param pageNumber The current page number
125
- * @param body Id of the application instance to return
126
126
  */
127
- getApplicationInstanceUsersWithHttpInfo(applicationInstanceId: string, pageSize?: number, pageNumber?: number, body?: string, extraHttpRequestParams?: {
127
+ getApplicationInstanceUsersWithHttpInfo(applicationInstanceId: string, orderBy?: string, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: {
128
128
  search: string | {
129
129
  [param: string]: string | string[];
130
130
  };
@@ -14,7 +14,8 @@ import { HttpResponse } from '@angular/common/http';
14
14
  import { Observable } from 'rxjs';
15
15
  import { AllUserPermissionsResponse } from '../model/allUserPermissionsResponse';
16
16
  import { EntityPermission } from '../model/entityPermission';
17
- import { InviteUserRequest } from '../model/inviteUserRequest';
17
+ import { InviteUsersRequest } from '../model/inviteUsersRequest';
18
+ import { InviteUsersResponse } from '../model/inviteUsersResponse';
18
19
  import { SelfCreateUserRequest } from '../model/selfCreateUserRequest';
19
20
  import { UserApplicationInstanceResponse } from '../model/userApplicationInstanceResponse';
20
21
  import { UserOrganizationResponse } from '../model/userOrganizationResponse';
@@ -69,14 +70,18 @@ export declare class UserService {
69
70
  * Return all application instances a user has access to and you are an admin to
70
71
  *
71
72
  * @param userId The user to get application instances for
73
+ * @param filter
74
+ * @param orderBy
75
+ * @param pageSize The number of elements to return in a page (defaults to 250 elements)
76
+ * @param pageNumber The current page number
72
77
  */
73
- getUserApplicationInstances(userId: string, extraHttpRequestParams?: {
78
+ getUserApplicationInstances(userId: string, filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: {
74
79
  search: string | {
75
80
  [param: string]: string | string[];
76
81
  };
77
82
  }, extraHttpRequestHeaders?: {
78
83
  [header: string]: string | string[];
79
- }): Observable<UserApplicationInstanceResponse>;
84
+ }): Observable<Array<UserApplicationInstanceResponse>>;
80
85
  /**
81
86
  * Use this method to get information about a user
82
87
  *
@@ -144,17 +149,17 @@ export declare class UserService {
144
149
  [header: string]: string | string[];
145
150
  }): Observable<Array<UserPermissionResponse>>;
146
151
  /**
147
- * Use this method to invite a user to the application Creates a user and sends an email
152
+ * Invite multiple users to an organization
148
153
  *
149
- * @param body Data used to create the user and send the invitation
154
+ * @param body The invitation containing the list of users to email invitations to, as well as organization and role information
150
155
  */
151
- inviteUser(body?: InviteUserRequest, extraHttpRequestParams?: {
156
+ inviteUsers(body?: InviteUsersRequest, extraHttpRequestParams?: {
152
157
  search: string | {
153
158
  [param: string]: string | string[];
154
159
  };
155
160
  }, extraHttpRequestHeaders?: {
156
161
  [header: string]: string | string[];
157
- }): Observable<UserResponse>;
162
+ }): Observable<InviteUsersResponse>;
158
163
  /**
159
164
  * Resends an invitation to the specified user
160
165
  *
@@ -210,14 +215,18 @@ export declare class UserService {
210
215
  * Return all application instances a user has access to and you are an admin to
211
216
  *
212
217
  * @param userId The user to get application instances for
218
+ * @param filter
219
+ * @param orderBy
220
+ * @param pageSize The number of elements to return in a page (defaults to 250 elements)
221
+ * @param pageNumber The current page number
213
222
  */
214
- getUserApplicationInstancesWithHttpInfo(userId: string, extraHttpRequestParams?: {
223
+ getUserApplicationInstancesWithHttpInfo(userId: string, filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: {
215
224
  search: string | {
216
225
  [param: string]: string | string[];
217
226
  };
218
227
  }, extraHttpRequestHeaders?: {
219
228
  [header: string]: string | string[];
220
- }): Observable<HttpResponse<UserApplicationInstanceResponse>>;
229
+ }): Observable<HttpResponse<Array<UserApplicationInstanceResponse>>>;
221
230
  /**
222
231
  * Use this method to get information about a user
223
232
  *
@@ -285,17 +294,17 @@ export declare class UserService {
285
294
  [header: string]: string | string[];
286
295
  }): Observable<HttpResponse<Array<UserPermissionResponse>>>;
287
296
  /**
288
- * Use this method to invite a user to the application Creates a user and sends an email
297
+ * Invite multiple users to an organization
289
298
  *
290
- * @param body Data used to create the user and send the invitation
299
+ * @param body The invitation containing the list of users to email invitations to, as well as organization and role information
291
300
  */
292
- inviteUserWithHttpInfo(body?: InviteUserRequest, extraHttpRequestParams?: {
301
+ inviteUsersWithHttpInfo(body?: InviteUsersRequest, extraHttpRequestParams?: {
293
302
  search: string | {
294
303
  [param: string]: string | string[];
295
304
  };
296
305
  }, extraHttpRequestHeaders?: {
297
306
  [header: string]: string | string[];
298
- }): Observable<HttpResponse<UserResponse>>;
307
+ }): Observable<HttpResponse<InviteUsersResponse>>;
299
308
  /**
300
309
  * Resends an invitation to the specified user
301
310
  *
@@ -551,11 +551,10 @@
551
551
  /**
552
552
  * Provides details to an application instance
553
553
  *
554
- * @param applicationInstanceId
555
- * @param body Id of the application instance to return
554
+ * @param applicationInstanceId Id of the application instance to return
556
555
  */
557
- ApplicationInstanceService.prototype.getApplicationInstanceDetails = function (applicationInstanceId, body, extraHttpRequestParams, extraHttpRequestHeaders) {
558
- return this.getApplicationInstanceDetailsWithHttpInfo(applicationInstanceId, body, extraHttpRequestParams, extraHttpRequestHeaders)
556
+ ApplicationInstanceService.prototype.getApplicationInstanceDetails = function (applicationInstanceId, extraHttpRequestParams, extraHttpRequestHeaders) {
557
+ return this.getApplicationInstanceDetailsWithHttpInfo(applicationInstanceId, extraHttpRequestParams, extraHttpRequestHeaders)
559
558
  .pipe(operators.map(function (response) {
560
559
  if (response.status === 204) {
561
560
  return undefined;
@@ -584,13 +583,14 @@
584
583
  /**
585
584
  * Provides a list of user&#39;s who have access to an application instance
586
585
  *
587
- * @param applicationInstanceId
586
+ * @param applicationInstanceId Id of the application instance to return
587
+ * @param orderBy
588
+ * @param filter
588
589
  * @param pageSize The number of elements to return in a page (defaults to 250 elements)
589
590
  * @param pageNumber The current page number
590
- * @param body Id of the application instance to return
591
591
  */
592
- ApplicationInstanceService.prototype.getApplicationInstanceUsers = function (applicationInstanceId, pageSize, pageNumber, body, extraHttpRequestParams, extraHttpRequestHeaders) {
593
- return this.getApplicationInstanceUsersWithHttpInfo(applicationInstanceId, pageSize, pageNumber, body, extraHttpRequestParams, extraHttpRequestHeaders)
592
+ ApplicationInstanceService.prototype.getApplicationInstanceUsers = function (applicationInstanceId, orderBy, filter, pageSize, pageNumber, extraHttpRequestParams, extraHttpRequestHeaders) {
593
+ return this.getApplicationInstanceUsersWithHttpInfo(applicationInstanceId, orderBy, filter, pageSize, pageNumber, extraHttpRequestParams, extraHttpRequestHeaders)
594
594
  .pipe(operators.map(function (response) {
595
595
  if (response.status === 204) {
596
596
  return undefined;
@@ -623,10 +623,9 @@
623
623
  /**
624
624
  * Provides details to an application instance
625
625
  *
626
- * @param applicationInstanceId
627
- * @param body Id of the application instance to return
626
+ * @param applicationInstanceId Id of the application instance to return
628
627
  */
629
- ApplicationInstanceService.prototype.getApplicationInstanceDetailsWithHttpInfo = function (applicationInstanceId, body, extraHttpRequestParams, extraHttpRequestHeaders) {
628
+ ApplicationInstanceService.prototype.getApplicationInstanceDetailsWithHttpInfo = function (applicationInstanceId, extraHttpRequestParams, extraHttpRequestHeaders) {
630
629
  var _this = this;
631
630
  var path = this.basePath + '/api/v202112/ApplicationInstance/${applicationInstanceId}/detail'
632
631
  .replace('${' + 'applicationInstanceId' + '}', String(applicationInstanceId));
@@ -663,13 +662,9 @@
663
662
  if (this.configuration.apiKeys["Authorization"]) {
664
663
  headers = headers.set('Authorization', this.configuration.apiKeys["Authorization"]);
665
664
  }
666
- var consumes = [
667
- 'application/json'
668
- ];
669
- headers = headers.set('Content-Type', consumes[0]);
665
+ var consumes = [];
670
666
  var requestOptions = {
671
667
  headers: headers,
672
- body: body == null ? '' : (consumes[0] == 'application/json' ? JSON.stringify(body) : body),
673
668
  params: queryParameters,
674
669
  withCredentials: this.configuration.withCredentials,
675
670
  observe: 'response'
@@ -730,12 +725,13 @@
730
725
  /**
731
726
  * Provides a list of user&#39;s who have access to an application instance
732
727
  *
733
- * @param applicationInstanceId
728
+ * @param applicationInstanceId Id of the application instance to return
729
+ * @param orderBy
730
+ * @param filter
734
731
  * @param pageSize The number of elements to return in a page (defaults to 250 elements)
735
732
  * @param pageNumber The current page number
736
- * @param body Id of the application instance to return
737
733
  */
738
- ApplicationInstanceService.prototype.getApplicationInstanceUsersWithHttpInfo = function (applicationInstanceId, pageSize, pageNumber, body, extraHttpRequestParams, extraHttpRequestHeaders) {
734
+ ApplicationInstanceService.prototype.getApplicationInstanceUsersWithHttpInfo = function (applicationInstanceId, orderBy, filter, pageSize, pageNumber, extraHttpRequestParams, extraHttpRequestHeaders) {
739
735
  var _this = this;
740
736
  var path = this.basePath + '/api/v202112/ApplicationInstance/${applicationInstanceId}/user'
741
737
  .replace('${' + 'applicationInstanceId' + '}', String(applicationInstanceId));
@@ -765,6 +761,12 @@
765
761
  if (applicationInstanceId === null || applicationInstanceId === undefined) {
766
762
  throw new Error('Required parameter applicationInstanceId was null or undefined when calling getApplicationInstanceUsers.');
767
763
  }
764
+ if (orderBy !== undefined) {
765
+ queryParameters = queryParameters.set('orderBy', orderBy);
766
+ }
767
+ if (filter !== undefined) {
768
+ queryParameters = queryParameters.set('filter', filter);
769
+ }
768
770
  if (pageSize !== undefined) {
769
771
  queryParameters = queryParameters.set('pageSize', pageSize);
770
772
  }
@@ -778,13 +780,9 @@
778
780
  if (this.configuration.apiKeys["Authorization"]) {
779
781
  headers = headers.set('Authorization', this.configuration.apiKeys["Authorization"]);
780
782
  }
781
- var consumes = [
782
- 'application/json'
783
- ];
784
- headers = headers.set('Content-Type', consumes[0]);
783
+ var consumes = [];
785
784
  var requestOptions = {
786
785
  headers: headers,
787
- body: body == null ? '' : (consumes[0] == 'application/json' ? JSON.stringify(body) : body),
788
786
  params: queryParameters,
789
787
  withCredentials: this.configuration.withCredentials,
790
788
  observe: 'response'
@@ -3639,9 +3637,13 @@
3639
3637
  * Return all application instances a user has access to and you are an admin to
3640
3638
  *
3641
3639
  * @param userId The user to get application instances for
3640
+ * @param filter
3641
+ * @param orderBy
3642
+ * @param pageSize The number of elements to return in a page (defaults to 250 elements)
3643
+ * @param pageNumber The current page number
3642
3644
  */
3643
- UserService.prototype.getUserApplicationInstances = function (userId, extraHttpRequestParams, extraHttpRequestHeaders) {
3644
- return this.getUserApplicationInstancesWithHttpInfo(userId, extraHttpRequestParams, extraHttpRequestHeaders)
3645
+ UserService.prototype.getUserApplicationInstances = function (userId, filter, orderBy, pageSize, pageNumber, extraHttpRequestParams, extraHttpRequestHeaders) {
3646
+ return this.getUserApplicationInstancesWithHttpInfo(userId, filter, orderBy, pageSize, pageNumber, extraHttpRequestParams, extraHttpRequestHeaders)
3645
3647
  .pipe(operators.map(function (response) {
3646
3648
  if (response.status === 204) {
3647
3649
  return undefined;
@@ -3738,12 +3740,12 @@
3738
3740
  }));
3739
3741
  };
3740
3742
  /**
3741
- * Use this method to invite a user to the application Creates a user and sends an email
3743
+ * Invite multiple users to an organization
3742
3744
  *
3743
- * @param body Data used to create the user and send the invitation
3745
+ * @param body The invitation containing the list of users to email invitations to, as well as organization and role information
3744
3746
  */
3745
- UserService.prototype.inviteUser = function (body, extraHttpRequestParams, extraHttpRequestHeaders) {
3746
- return this.inviteUserWithHttpInfo(body, extraHttpRequestParams, extraHttpRequestHeaders)
3747
+ UserService.prototype.inviteUsers = function (body, extraHttpRequestParams, extraHttpRequestHeaders) {
3748
+ return this.inviteUsersWithHttpInfo(body, extraHttpRequestParams, extraHttpRequestHeaders)
3747
3749
  .pipe(operators.map(function (response) {
3748
3750
  if (response.status === 204) {
3749
3751
  return undefined;
@@ -3896,8 +3898,12 @@
3896
3898
  * Return all application instances a user has access to and you are an admin to
3897
3899
  *
3898
3900
  * @param userId The user to get application instances for
3901
+ * @param filter
3902
+ * @param orderBy
3903
+ * @param pageSize The number of elements to return in a page (defaults to 250 elements)
3904
+ * @param pageNumber The current page number
3899
3905
  */
3900
- UserService.prototype.getUserApplicationInstancesWithHttpInfo = function (userId, extraHttpRequestParams, extraHttpRequestHeaders) {
3906
+ UserService.prototype.getUserApplicationInstancesWithHttpInfo = function (userId, filter, orderBy, pageSize, pageNumber, extraHttpRequestParams, extraHttpRequestHeaders) {
3901
3907
  var _this = this;
3902
3908
  var path = this.basePath + '/api/v202112/User/${userId}/applicationInstance'
3903
3909
  .replace('${' + 'userId' + '}', String(userId));
@@ -3927,6 +3933,18 @@
3927
3933
  if (userId === null || userId === undefined) {
3928
3934
  throw new Error('Required parameter userId was null or undefined when calling getUserApplicationInstances.');
3929
3935
  }
3936
+ if (filter !== undefined) {
3937
+ queryParameters = queryParameters.set('filter', filter);
3938
+ }
3939
+ if (orderBy !== undefined) {
3940
+ queryParameters = queryParameters.set('orderBy', orderBy);
3941
+ }
3942
+ if (pageSize !== undefined) {
3943
+ queryParameters = queryParameters.set('pageSize', pageSize);
3944
+ }
3945
+ if (pageNumber !== undefined) {
3946
+ queryParameters = queryParameters.set('pageNumber', pageNumber);
3947
+ }
3930
3948
  // to determine the Accept header
3931
3949
  var produces = [
3932
3950
  'application/json'
@@ -4225,13 +4243,13 @@
4225
4243
  return this.http.request(RequestMethod.Get, path, requestOptions);
4226
4244
  };
4227
4245
  /**
4228
- * Use this method to invite a user to the application Creates a user and sends an email
4246
+ * Invite multiple users to an organization
4229
4247
  *
4230
- * @param body Data used to create the user and send the invitation
4248
+ * @param body The invitation containing the list of users to email invitations to, as well as organization and role information
4231
4249
  */
4232
- UserService.prototype.inviteUserWithHttpInfo = function (body, extraHttpRequestParams, extraHttpRequestHeaders) {
4250
+ UserService.prototype.inviteUsersWithHttpInfo = function (body, extraHttpRequestParams, extraHttpRequestHeaders) {
4233
4251
  var _this = this;
4234
- var path = this.basePath + '/api/v202108/User/invite';
4252
+ var path = this.basePath + '/api/v202112/User/inviteUsers';
4235
4253
  var queryParameters;
4236
4254
  if (extraHttpRequestParams) {
4237
4255
  if (typeof extraHttpRequestParams.search === 'string') {
@@ -4773,12 +4791,52 @@
4773
4791
  * Do not edit the class manually.
4774
4792
  */
4775
4793
  /**
4776
- * Use this model to invite a User
4794
+ * This model represents a user invitation failure
4795
+ */
4796
+ var InviteUserFailure = /** @class */ (function () {
4797
+ function InviteUserFailure() {
4798
+ }
4799
+ return InviteUserFailure;
4800
+ }());
4801
+
4802
+ /**
4803
+ * EnergyCAP ID SDK
4804
+ * Document used to generate the EnergyCAP ID SDK
4805
+ *
4806
+ * OpenAPI spec version: 1.2112
4807
+ * Contact: support@energycap.com
4808
+ *
4809
+ * NOTE: This class is auto generated by the swagger code generator program.
4810
+ * https://github.com/swagger-api/swagger-codegen.git
4811
+ * Do not edit the class manually.
4812
+ */
4813
+ /**
4814
+ * Use this model to invite multiple users to an entity
4815
+ */
4816
+ var InviteUsersRequest = /** @class */ (function () {
4817
+ function InviteUsersRequest() {
4818
+ }
4819
+ return InviteUsersRequest;
4820
+ }());
4821
+
4822
+ /**
4823
+ * EnergyCAP ID SDK
4824
+ * Document used to generate the EnergyCAP ID SDK
4825
+ *
4826
+ * OpenAPI spec version: 1.2112
4827
+ * Contact: support@energycap.com
4828
+ *
4829
+ * NOTE: This class is auto generated by the swagger code generator program.
4830
+ * https://github.com/swagger-api/swagger-codegen.git
4831
+ * Do not edit the class manually.
4832
+ */
4833
+ /**
4834
+ * This model represents the result of the InviteUsers request
4777
4835
  */
4778
- var InviteUserRequest = /** @class */ (function () {
4779
- function InviteUserRequest() {
4836
+ var InviteUsersResponse = /** @class */ (function () {
4837
+ function InviteUsersResponse() {
4780
4838
  }
4781
- return InviteUserRequest;
4839
+ return InviteUsersResponse;
4782
4840
  }());
4783
4841
 
4784
4842
  /**
@@ -5524,7 +5582,9 @@
5524
5582
  exports.EnvironmentService = EnvironmentService;
5525
5583
  exports.HierarchicalOrganizations = HierarchicalOrganizations;
5526
5584
  exports.HierarchicalOrganizations2 = HierarchicalOrganizations2;
5527
- exports.InviteUserRequest = InviteUserRequest;
5585
+ exports.InviteUserFailure = InviteUserFailure;
5586
+ exports.InviteUsersRequest = InviteUsersRequest;
5587
+ exports.InviteUsersResponse = InviteUsersResponse;
5528
5588
  exports.LinkDataSourceRequest = LinkDataSourceRequest;
5529
5589
  exports.LoginResponse = LoginResponse;
5530
5590
  exports.LoginSourceResponse = LoginSourceResponse;