edge-impulse-api 1.22.2 → 1.32.24444

package/build/library/sdk/api/userApi.js

@@ -144,9 +144,9 @@ class UserApi {
     /**
      * Activate the current user account (requires an activation code). This function is only available through a JWT token.
      * @summary Activate current user
-     * @param activateUserRequest
+     * @param activateUserOrVerifyEmailRequest
      */
-    async activateCurrentUser(activateUserRequest, options = { headers: {} }) {
+    async activateCurrentUser(activateUserOrVerifyEmailRequest, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/user/activate';
         let localVarQueryParameters = {};
         let localVarHeaderParams = Object.assign({
@@ -161,9 +161,9 @@ class UserApi {
             localVarHeaderParams.Accept = produces.join(',');
         }
         let localVarFormParams = {};
-        // verify required parameter 'activateUserRequest' is not null or undefined
-        if (activateUserRequest === null || activateUserRequest === undefined) {
-            throw new Error('Required parameter activateUserRequest was null or undefined when calling activateCurrentUser.');
+        // verify required parameter 'activateUserOrVerifyEmailRequest' is not null or undefined
+        if (activateUserOrVerifyEmailRequest === null || activateUserOrVerifyEmailRequest === undefined) {
+            throw new Error('Required parameter activateUserOrVerifyEmailRequest was null or undefined when calling activateCurrentUser.');
         }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
@@ -176,7 +176,7 @@ class UserApi {
             useQuerystring: this._useQuerystring,
             agentOptions: { keepAlive: false },
             json: true,
-            body: models_1.ObjectSerializer.serialize(activateUserRequest, "ActivateUserRequest")
+            body: models_1.ObjectSerializer.serialize(activateUserOrVerifyEmailRequest, "ActivateUserOrVerifyEmailRequest")
         };
         let authenticationPromise = Promise.resolve();
         authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
@@ -218,9 +218,9 @@ class UserApi {
      * Activate a user account (requires an activation code). This function is only available through a JWT token.
      * @summary Activate user
      * @param userId User ID
-     * @param activateUserRequest
+     * @param activateUserOrVerifyEmailRequest
      */
-    async activateUser(userId, activateUserRequest, options = { headers: {} }) {
+    async activateUser(userId, activateUserOrVerifyEmailRequest, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/users/{userId}/activate'
             .replace('{' + 'userId' + '}', encodeURIComponent(String(userId)));
         let localVarQueryParameters = {};
@@ -240,9 +240,9 @@ class UserApi {
         if (userId === null || userId === undefined) {
             throw new Error('Required parameter userId was null or undefined when calling activateUser.');
         }
-        // verify required parameter 'activateUserRequest' is not null or undefined
-        if (activateUserRequest === null || activateUserRequest === undefined) {
-            throw new Error('Required parameter activateUserRequest was null or undefined when calling activateUser.');
+        // verify required parameter 'activateUserOrVerifyEmailRequest' is not null or undefined
+        if (activateUserOrVerifyEmailRequest === null || activateUserOrVerifyEmailRequest === undefined) {
+            throw new Error('Required parameter activateUserOrVerifyEmailRequest was null or undefined when calling activateUser.');
         }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
@@ -255,7 +255,7 @@ class UserApi {
             useQuerystring: this._useQuerystring,
             agentOptions: { keepAlive: false },
             json: true,
-            body: models_1.ObjectSerializer.serialize(activateUserRequest, "ActivateUserRequest")
+            body: models_1.ObjectSerializer.serialize(activateUserOrVerifyEmailRequest, "ActivateUserOrVerifyEmailRequest")
         };
         let authenticationPromise = Promise.resolve();
         authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
@@ -658,6 +658,76 @@ class UserApi {
             });
         });
     }
+    /**
+     * Creates an enterprise trial user and a new trial organization, and redirects the user to the new organization.
+     * @summary Create enterprise trial user
+     * @param createEnterpriseTrialUserRequest Trial request
+     */
+    async createEnterpriseTrialUser(createEnterpriseTrialUserRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api-user-create-enterprise-trial';
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'createEnterpriseTrialUserRequest' is not null or undefined
+        if (createEnterpriseTrialUserRequest === null || createEnterpriseTrialUserRequest === undefined) {
+            throw new Error('Required parameter createEnterpriseTrialUserRequest was null or undefined when calling createEnterpriseTrialUser.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+            body: models_1.ObjectSerializer.serialize(createEnterpriseTrialUserRequest, "CreateEnterpriseTrialUserRequest")
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "CreateEnterpriseTrialResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Creates an evaluation user and a new project, and redirects the user to the new project.
      * @summary Create evaluation user
@@ -1213,8 +1283,8 @@ class UserApi {
         });
     }
     /**
-     * Tells whether the user needs to set its password.
-     * @summary Get user password state
+     * Tells whether a user is registered and whether it needs to set its password.
+     * @summary Get user registration state
      * @param usernameOrEmail Username or email
      */
     async getUserNeedToSetPassword(usernameOrEmail, options = { headers: {} }) {
@@ -1422,6 +1492,79 @@ class UserApi {
             });
         });
     }
+    /**
+     * Get a list of all enterprise trials for a user. This function is only available through a JWT token.
+     * @summary Get enterprise trials
+     * @param userId User ID
+     */
+    async listEnterpriseTrialsUser(userId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/users/{userId}/trials'
+            .replace('{' + 'userId' + '}', encodeURIComponent(String(userId)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'userId' is not null or undefined
+        if (userId === null || userId === undefined) {
+            throw new Error('Required parameter userId was null or undefined when calling listEnterpriseTrialsUser.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "ListEnterpriseTrialsResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * List all organizational storage buckets that the current user has access to. This function is only available through a JWT token.
      * @summary Get buckets current user
@@ -2061,6 +2204,85 @@ class UserApi {
             });
         });
     }
+    /**
+     * Send an upgrade to Enterprise request to Edge Impulse.
+     * @summary Send upgrade request
+     * @param userId User ID
+     * @param enterpriseUpgradeOrTrialExtensionRequest
+     */
+    async sendUserUpgradeRequest(userId, enterpriseUpgradeOrTrialExtensionRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/users/{userId}/upgrade'
+            .replace('{' + 'userId' + '}', encodeURIComponent(String(userId)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'userId' is not null or undefined
+        if (userId === null || userId === undefined) {
+            throw new Error('Required parameter userId was null or undefined when calling sendUserUpgradeRequest.');
+        }
+        // verify required parameter 'enterpriseUpgradeOrTrialExtensionRequest' is not null or undefined
+        if (enterpriseUpgradeOrTrialExtensionRequest === null || enterpriseUpgradeOrTrialExtensionRequest === undefined) {
+            throw new Error('Required parameter enterpriseUpgradeOrTrialExtensionRequest was null or undefined when calling sendUserUpgradeRequest.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+            body: models_1.ObjectSerializer.serialize(enterpriseUpgradeOrTrialExtensionRequest, "EnterpriseUpgradeOrTrialExtensionRequest")
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "GenericApiResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Set the password for a new SSO user. This function is only available through an SSO access token.
      * @summary Set password for SSO user
@@ -2137,6 +2359,79 @@ class UserApi {
             });
         });
     }
+    /**
+     * Create an enterprise trial for the current user. Users can only go through a trial once.
+     * @summary Start enterprise trial
+     * @param startEnterpriseTrialRequest
+     */
+    async startEnterpriseTrial(startEnterpriseTrialRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/user/trial';
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'startEnterpriseTrialRequest' is not null or undefined
+        if (startEnterpriseTrialRequest === null || startEnterpriseTrialRequest === undefined) {
+            throw new Error('Required parameter startEnterpriseTrialRequest was null or undefined when calling startEnterpriseTrial.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+            body: models_1.ObjectSerializer.serialize(startEnterpriseTrialRequest, "StartEnterpriseTrialRequest")
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "CreateEnterpriseTrialResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Update user properties such as name. This function is only available through a JWT token.
      * @summary Update current user
@@ -2447,6 +2742,79 @@ class UserApi {
             });
         });
     }
+    /**
+     * Dismiss a notification
+     * @summary Dismiss a notification
+     * @param userDismissNotificationRequest
+     */
+    async userDismissNotification(userDismissNotificationRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/user/dismiss-notification';
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'userDismissNotificationRequest' is not null or undefined
+        if (userDismissNotificationRequest === null || userDismissNotificationRequest === undefined) {
+            throw new Error('Required parameter userDismissNotificationRequest was null or undefined when calling userDismissNotification.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+            body: models_1.ObjectSerializer.serialize(userDismissNotificationRequest, "UserDismissNotificationRequest")
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "GenericApiResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Verify whether the reset password code for the user is valid.
      * @summary Verify reset password code