@energycap/energycapid-sdk-angular 1.2108.37 → 1.2112.41-develop-20211220-1233

package/api/api.d.ts

@@ -6,6 +6,8 @@ export * from './auth.service';
 import { AuthService } from './auth.service';
 export * from './dataSource.service';
 import { DataSourceService } from './dataSource.service';
+export * from './domainJoinType.service';
+import { DomainJoinTypeService } from './domainJoinType.service';
 export * from './environment.service';
 import { EnvironmentService } from './environment.service';
 export * from './me.service';
@@ -16,4 +18,4 @@ export * from './organizationApplication.service';
 import { OrganizationApplicationService } from './organizationApplication.service';
 export * from './user.service';
 import { UserService } from './user.service';
-export declare const APIS: (typeof ApplicationService | typeof ApplicationInstanceService | typeof AuthService | typeof DataSourceService | typeof EnvironmentService | typeof MeService | typeof OrganizationService | typeof OrganizationApplicationService | typeof UserService)[];
+export declare const APIS: (typeof ApplicationService | typeof ApplicationInstanceService | typeof AuthService | typeof DataSourceService | typeof DomainJoinTypeService | typeof EnvironmentService | typeof MeService | typeof OrganizationService | typeof OrganizationApplicationService | typeof UserService)[];

package/api/application.service.d.ts

@@ -2,7 +2,7 @@
  * EnergyCAP ID SDK
  * Document used to generate the EnergyCAP ID SDK
  *
- * OpenAPI spec version: 1.2108
+ * OpenAPI spec version: 1.2112
  * Contact: support@energycap.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.

package/api/applicationInstance.service.d.ts

@@ -2,7 +2,7 @@
  * EnergyCAP ID SDK
  * Document used to generate the EnergyCAP ID SDK
  *
- * OpenAPI spec version: 1.2108
+ * OpenAPI spec version: 1.2112
  * Contact: support@energycap.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -12,8 +12,10 @@
 import { HttpClient, HttpHeaders } from '@angular/common/http';
 import { HttpResponse } from '@angular/common/http';
 import { Observable } from 'rxjs';
+import { ApplicationInstanceDetailResponse } from '../model/applicationInstanceDetailResponse';
 import { ApplicationInstanceRedirectResponse } from '../model/applicationInstanceRedirectResponse';
 import { ApplicationInstanceResponse } from '../model/applicationInstanceResponse';
+import { ApplicationInstanceUserResponse } from '../model/applicationInstanceUserResponse';
 import { Configuration } from '../configuration';
 export declare class ApplicationInstanceService {
     protected http: HttpClient;
@@ -33,6 +35,19 @@ export declare class ApplicationInstanceService {
      * @return true: consumes contains 'multipart/form-data', false: otherwise
      */
     private canConsumeForm;
+    /**
+     * Provides details to an application instance
+     *
+     * @param applicationInstanceId
+     * @param body Id of the application instance to return
+     */
+    getApplicationInstanceDetails(applicationInstanceId: string, body?: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<Array<ApplicationInstanceDetailResponse>>;
     /**
      * Provides the data needed to redirect the user to the specified application instance
      * If the Application Instance is configured with an Alias, the exchange URL from the Alias will be returned instead of that from the associated Application Environment.
@@ -45,6 +60,19 @@ export declare class ApplicationInstanceService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<ApplicationInstanceRedirectResponse>;
+    /**
+     * Provides a list of user&#39;s who have access to an application instance
+     *
+     * @param applicationInstanceId
+     * @param body Id of the application instance to return
+     */
+    getApplicationInstanceUsers(applicationInstanceId: string, body?: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<Array<ApplicationInstanceUserResponse>>;
     /**
      * Provides a list of all available application instances to which the logged in user has access
      *
@@ -52,14 +80,29 @@ export declare class ApplicationInstanceService {
      * @param dataSourceName Filter by an exact name of a data source
      * @param targetHost Filter by a host name containing an alias
      * @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
+     * @param orderBy
+     * @param filter
      */
-    getApplicationInstances(organizationName?: string, dataSourceName?: string, targetHost?: string, onlyAdmin?: boolean, extraHttpRequestParams?: {
+    getApplicationInstances(organizationName?: string, dataSourceName?: string, targetHost?: string, onlyAdmin?: boolean, orderBy?: string, filter?: string, extraHttpRequestParams?: {
         search: string | {
             [param: string]: string | string[];
         };
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<Array<ApplicationInstanceResponse>>;
+    /**
+     * Provides details to an application instance
+     *
+     * @param applicationInstanceId
+     * @param body Id of the application instance to return
+     */
+    getApplicationInstanceDetailsWithHttpInfo(applicationInstanceId: string, body?: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<Array<ApplicationInstanceDetailResponse>>>;
     /**
      * Provides the data needed to redirect the user to the specified application instance
      * If the Application Instance is configured with an Alias, the exchange URL from the Alias will be returned instead of that from the associated Application Environment.
@@ -72,6 +115,19 @@ export declare class ApplicationInstanceService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<HttpResponse<ApplicationInstanceRedirectResponse>>;
+    /**
+     * Provides a list of user&#39;s who have access to an application instance
+     *
+     * @param applicationInstanceId
+     * @param body Id of the application instance to return
+     */
+    getApplicationInstanceUsersWithHttpInfo(applicationInstanceId: string, body?: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<Array<ApplicationInstanceUserResponse>>>;
     /**
      * Provides a list of all available application instances to which the logged in user has access
      *
@@ -79,8 +135,10 @@ export declare class ApplicationInstanceService {
      * @param dataSourceName Filter by an exact name of a data source
      * @param targetHost Filter by a host name containing an alias
      * @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
+     * @param orderBy
+     * @param filter
      */
-    getApplicationInstancesWithHttpInfo(organizationName?: string, dataSourceName?: string, targetHost?: string, onlyAdmin?: boolean, extraHttpRequestParams?: {
+    getApplicationInstancesWithHttpInfo(organizationName?: string, dataSourceName?: string, targetHost?: string, onlyAdmin?: boolean, orderBy?: string, filter?: string, extraHttpRequestParams?: {
         search: string | {
             [param: string]: string | string[];
         };

package/api/auth.service.d.ts

@@ -2,7 +2,7 @@
  * EnergyCAP ID SDK
  * Document used to generate the EnergyCAP ID SDK
  *
- * OpenAPI spec version: 1.2108
+ * OpenAPI spec version: 1.2112
  * Contact: support@energycap.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.

package/api/dataSource.service.d.ts

@@ -2,7 +2,7 @@
  * EnergyCAP ID SDK
  * Document used to generate the EnergyCAP ID SDK
  *
- * OpenAPI spec version: 1.2108
+ * OpenAPI spec version: 1.2112
  * Contact: support@energycap.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.

package/api/domainJoinType.service.d.ts

@@ -0,0 +1,57 @@
+/**
+ * EnergyCAP ID SDK
+ * Document used to generate the EnergyCAP ID SDK
+ *
+ * OpenAPI spec version: 1.2112
+ * Contact: support@energycap.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+import { HttpClient, HttpHeaders } from '@angular/common/http';
+import { HttpResponse } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { DomainJoinTypeResponse } from '../model/domainJoinTypeResponse';
+import { Configuration } from '../configuration';
+export declare class DomainJoinTypeService {
+    protected http: HttpClient;
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    constructor(http: HttpClient, basePath: string, configuration: Configuration);
+    /**
+     *
+     * Extends object by coping non-existing properties.
+     * @param objA object to be extended
+     * @param objB source object
+     */
+    private extendObj;
+    /**
+     * @param consumes string[] mime-types
+     * @return true: consumes contains 'multipart/form-data', false: otherwise
+     */
+    private canConsumeForm;
+    /**
+     * Gets a list of all Domain Join Types
+     *
+     */
+    getDomainJoinTypes(extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<Array<DomainJoinTypeResponse>>;
+    /**
+     * Gets a list of all Domain Join Types
+     *
+     */
+    getDomainJoinTypesWithHttpInfo(extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<Array<DomainJoinTypeResponse>>>;
+}

package/api/environment.service.d.ts

@@ -2,7 +2,7 @@
  * EnergyCAP ID SDK
  * Document used to generate the EnergyCAP ID SDK
  *
- * OpenAPI spec version: 1.2108
+ * OpenAPI spec version: 1.2112
  * Contact: support@energycap.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.

package/api/me.service.d.ts

@@ -2,7 +2,7 @@
  * EnergyCAP ID SDK
  * Document used to generate the EnergyCAP ID SDK
  *
- * OpenAPI spec version: 1.2108
+ * OpenAPI spec version: 1.2112
  * Contact: support@energycap.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.

package/api/organization.service.d.ts

@@ -2,7 +2,7 @@
  * EnergyCAP ID SDK
  * Document used to generate the EnergyCAP ID SDK
  *
- * OpenAPI spec version: 1.2108
+ * OpenAPI spec version: 1.2112
  * Contact: support@energycap.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -12,7 +12,14 @@
 import { HttpClient, HttpHeaders } from '@angular/common/http';
 import { HttpResponse } from '@angular/common/http';
 import { Observable } from 'rxjs';
+import { CreateOrganizationRequest } from '../model/createOrganizationRequest';
+import { HierarchicalOrganizations } from '../model/hierarchicalOrganizations';
+import { OrganizationAccessControlResponse } from '../model/organizationAccessControlResponse';
+import { OrganizationDetailResponse } from '../model/organizationDetailResponse';
 import { OrganizationResponse } from '../model/organizationResponse';
+import { OrganizationUserResponse } from '../model/organizationUserResponse';
+import { UpdateOrganizationAccessControlRequest } from '../model/updateOrganizationAccessControlRequest';
+import { UpdateOrganizationDetailsRequest } from '../model/updateOrganizationDetailsRequest';
 import { Configuration } from '../configuration';
 export declare class OrganizationService {
     protected http: HttpClient;
@@ -32,6 +39,31 @@ export declare class OrganizationService {
      * @return true: consumes contains 'multipart/form-data', false: otherwise
      */
     private canConsumeForm;
+    /**
+     * Create a new organization
+     *
+     * @param organizationId
+     * @param body
+     */
+    createOrganization(organizationId: string, body?: CreateOrganizationRequest, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<OrganizationResponse>;
+    /**
+     * Gets organization access control data  You must be an admin to the organizaion to get this information
+     *
+     * @param organizationId The organization identifier
+     */
+    getOrganizationAccessControl(organizationId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<OrganizationAccessControlResponse>;
     /**
      * Gets information about an Organization
      *
@@ -44,6 +76,41 @@ export declare class OrganizationService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<OrganizationResponse>;
+    /**
+     * Gets additional detail information about an Organization  You must be an admin to the organizaion to get this information
+     *
+     * @param organizationId The organization identifier
+     */
+    getOrganizationDetails(organizationId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<OrganizationDetailResponse>;
+    /**
+     * Returns the entire oranizaion hiearchy  If there are more than 100 organizations a 403 is returned.
+     *
+     */
+    getOrganizationHierarchy(extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<Array<HierarchicalOrganizations>>;
+    /**
+     * Gets users linked to an organization
+     *
+     * @param organizationId The organization identifier
+     */
+    getOrganizationUsers(organizationId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<Array<OrganizationUserResponse>>;
     /**
      * Gets the organizations to which the logged in user has access
      *
@@ -56,6 +123,69 @@ export declare class OrganizationService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<Array<OrganizationResponse>>;
+    /**
+     *
+     *
+     * @param query
+     */
+    searchOrganizations(query?: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<Array<OrganizationResponse>>;
+    /**
+     * Update organization access control data  You must be an admin to the organizaion to get this information
+     *
+     * @param organizationId The organization identifier
+     * @param body
+     */
+    updateOrganizationAccessControl(organizationId: string, body?: UpdateOrganizationAccessControlRequest, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<OrganizationAccessControlResponse>;
+    /**
+     * Update organization details  You must be an admin to the organizaion to get this information
+     *
+     * @param organizationId The organization identifier
+     * @param body
+     */
+    updateOrganizationDetails(organizationId: string, body?: UpdateOrganizationDetailsRequest, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<OrganizationDetailResponse>;
+    /**
+     * Create a new organization
+     *
+     * @param organizationId
+     * @param body
+     */
+    createOrganizationWithHttpInfo(organizationId: string, body?: CreateOrganizationRequest, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<OrganizationResponse>>;
+    /**
+     * Gets organization access control data  You must be an admin to the organizaion to get this information
+     *
+     * @param organizationId The organization identifier
+     */
+    getOrganizationAccessControlWithHttpInfo(organizationId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<OrganizationAccessControlResponse>>;
     /**
      * Gets information about an Organization
      *
@@ -68,6 +198,41 @@ export declare class OrganizationService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<HttpResponse<OrganizationResponse>>;
+    /**
+     * Gets additional detail information about an Organization  You must be an admin to the organizaion to get this information
+     *
+     * @param organizationId The organization identifier
+     */
+    getOrganizationDetailsWithHttpInfo(organizationId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<OrganizationDetailResponse>>;
+    /**
+     * Returns the entire oranizaion hiearchy  If there are more than 100 organizations a 403 is returned.
+     *
+     */
+    getOrganizationHierarchyWithHttpInfo(extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<Array<HierarchicalOrganizations>>>;
+    /**
+     * Gets users linked to an organization
+     *
+     * @param organizationId The organization identifier
+     */
+    getOrganizationUsersWithHttpInfo(organizationId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<Array<OrganizationUserResponse>>>;
     /**
      * Gets the organizations to which the logged in user has access
      *
@@ -80,4 +245,42 @@ export declare class OrganizationService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<HttpResponse<Array<OrganizationResponse>>>;
+    /**
+     *
+     *
+     * @param query
+     */
+    searchOrganizationsWithHttpInfo(query?: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<Array<OrganizationResponse>>>;
+    /**
+     * Update organization access control data  You must be an admin to the organizaion to get this information
+     *
+     * @param organizationId The organization identifier
+     * @param body
+     */
+    updateOrganizationAccessControlWithHttpInfo(organizationId: string, body?: UpdateOrganizationAccessControlRequest, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<OrganizationAccessControlResponse>>;
+    /**
+     * Update organization details  You must be an admin to the organizaion to get this information
+     *
+     * @param organizationId The organization identifier
+     * @param body
+     */
+    updateOrganizationDetailsWithHttpInfo(organizationId: string, body?: UpdateOrganizationDetailsRequest, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<OrganizationDetailResponse>>;
 }

package/api/organizationApplication.service.d.ts

@@ -2,7 +2,7 @@
  * EnergyCAP ID SDK
  * Document used to generate the EnergyCAP ID SDK
  *
- * OpenAPI spec version: 1.2108
+ * OpenAPI spec version: 1.2112
  * Contact: support@energycap.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.

package/api/user.service.d.ts

@@ -2,7 +2,7 @@
  * EnergyCAP ID SDK
  * Document used to generate the EnergyCAP ID SDK
  *
- * OpenAPI spec version: 1.2108
+ * OpenAPI spec version: 1.2112
  * Contact: support@energycap.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -16,6 +16,8 @@ import { AllUserPermissionsResponse } from '../model/allUserPermissionsResponse'
 import { EntityPermission } from '../model/entityPermission';
 import { InviteUserRequest } from '../model/inviteUserRequest';
 import { SelfCreateUserRequest } from '../model/selfCreateUserRequest';
+import { UserApplicationInstanceResponse } from '../model/userApplicationInstanceResponse';
+import { UserOrganizationResponse } from '../model/userOrganizationResponse';
 import { UserPermissionRequest } from '../model/userPermissionRequest';
 import { UserPermissionResponse } from '../model/userPermissionResponse';
 import { UserResponse } from '../model/userResponse';
@@ -63,6 +65,18 @@ export declare class UserService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<any>;
+    /**
+     * Return all application instances a user has access to and you are an admin to
+     *
+     * @param userId The user to get application instances for
+     */
+    getUserApplicationInstances(userId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<UserApplicationInstanceResponse>;
     /**
      * Use this method to get information about a user
      *
@@ -75,6 +89,18 @@ export declare class UserService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<UserResponse>;
+    /**
+     * Return all organization a user has access to and you are an admin to
+     *
+     * @param userId The user to get application instances for
+     */
+    getUserOrganizations(userId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<UserOrganizationResponse>;
     /**
      * Gets information regarding the specified entity to which the specified user has access. Only if the logged in user is in administrator will information be available.  If the user does not have access, no entry will be returned.
      *
@@ -176,6 +202,18 @@ export declare class UserService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<HttpResponse<any>>;
+    /**
+     * Return all application instances a user has access to and you are an admin to
+     *
+     * @param userId The user to get application instances for
+     */
+    getUserApplicationInstancesWithHttpInfo(userId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<UserApplicationInstanceResponse>>;
     /**
      * Use this method to get information about a user
      *
@@ -188,6 +226,18 @@ export declare class UserService {
     }, extraHttpRequestHeaders?: {
         [header: string]: string | string[];
     }): Observable<HttpResponse<UserResponse>>;
+    /**
+     * Return all organization a user has access to and you are an admin to
+     *
+     * @param userId The user to get application instances for
+     */
+    getUserOrganizationsWithHttpInfo(userId: string, extraHttpRequestParams?: {
+        search: string | {
+            [param: string]: string | string[];
+        };
+    }, extraHttpRequestHeaders?: {
+        [header: string]: string | string[];
+    }): Observable<HttpResponse<UserOrganizationResponse>>;
     /**
      * Gets information regarding the specified entity to which the specified user has access. Only if the logged in user is in administrator will information be available.  If the user does not have access, no entry will be returned.
      *