edge-impulse-api 1.22.1 → 1.22.2

package/build/library/api.d.ts

@@ -0,0 +1,69 @@
+import { AuthApi, ClassifyApi, DSPApi, DeploymentApi, DevicesApi, ExportApi, HealthApi, ImpulseApi, JobsApi, LearnApi, LoginApi, OptimizationApi, OrganizationBlocksApi, OrganizationCreateProjectApi, OrganizationDataApi, OrganizationJobsApi, OrganizationPipelinesApi, OrganizationPortalsApi, OrganizationsApi, ProjectsApi, RawDataApi, ThemesApi, UploadPortalApi, UserApi, WhitelabelsApi, ThirdPartyAuthApi, AdminApi, PerformanceCalibrationApi, MetricsApi } from './sdk/api';
+export declare type EdgeImpulseApiOpts = {
+    endpoint?: string;
+    debug?: boolean;
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare type EdgeImpulseApiAuthOpts = {
+    method: 'apiKey';
+    apiKey: string;
+} | {
+    method: 'jwtToken';
+    jwtToken: string;
+};
+export declare class EdgeImpulseApi {
+    private _opts;
+    admin: AdminApi;
+    auth: AuthApi;
+    classify: ClassifyApi;
+    dsp: DSPApi;
+    deployment: DeploymentApi;
+    devices: DevicesApi;
+    export: ExportApi;
+    health: HealthApi;
+    impulse: ImpulseApi;
+    jobs: JobsApi;
+    learn: LearnApi;
+    login: LoginApi;
+    metrics: MetricsApi;
+    optimization: OptimizationApi;
+    organizationBlocks: OrganizationBlocksApi;
+    organizationCreateProject: OrganizationCreateProjectApi;
+    organizationData: OrganizationDataApi;
+    organizationJobs: OrganizationJobsApi;
+    organizationPipelines: OrganizationPipelinesApi;
+    organizationPortals: OrganizationPortalsApi;
+    organizations: OrganizationsApi;
+    performanceCalibration: PerformanceCalibrationApi;
+    projects: ProjectsApi;
+    rawData: RawDataApi;
+    themes: ThemesApi;
+    thirdPartyAuth: ThirdPartyAuthApi;
+    uploadPortal: UploadPortalApi;
+    user: UserApi;
+    whitelabels: WhitelabelsApi;
+    /**
+     * Initialize the API
+     * @param opts An object with { auth, endpoint }.
+     */
+    constructor(opts?: EdgeImpulseApiOpts);
+    authenticate(opts: EdgeImpulseApiAuthOpts): Promise<void>;
+    runJobUntilCompletion(opts: {
+        type: 'project';
+        projectId: number;
+        jobId: number;
+    } | {
+        type: 'organization';
+        organizationId: number;
+        jobId: number;
+    }, dataCallback?: (ev: string) => void): Promise<void>;
+    private runProjectJobUntilCompletion;
+    private getProjectWebsocket;
+    private runOrgJobUntilCompletion;
+    private getOrgWebsocket;
+    private sleep;
+    private waitForJobImpl;
+    private getWebsocketImpl;
+}

package/build/library/index.d.ts

@@ -0,0 +1,3 @@
+import { EdgeImpulseApi } from "./api";
+export { EdgeImpulseApi };
+export * from './sdk/model/models';

package/build/library/sdk/api/adminApi.d.ts

@@ -0,0 +1,386 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AdminAddOrUpdateSSODomainIdPsRequest } from '../model/adminAddOrUpdateSSODomainIdPsRequest';
+import { AdminAddProjectUserRequest } from '../model/adminAddProjectUserRequest';
+import { AdminCreateOrganizationRequest } from '../model/adminCreateOrganizationRequest';
+import { AdminGetMetricsResponse } from '../model/adminGetMetricsResponse';
+import { AdminGetOrganizationsResponse } from '../model/adminGetOrganizationsResponse';
+import { AdminGetSSODomainIdPsResponse } from '../model/adminGetSSODomainIdPsResponse';
+import { AdminGetSSOSettingsResponse } from '../model/adminGetSSOSettingsResponse';
+import { AdminGetUserIdsResponse } from '../model/adminGetUserIdsResponse';
+import { AdminGetUserMetricsResponse } from '../model/adminGetUserMetricsResponse';
+import { AdminGetUserResponse } from '../model/adminGetUserResponse';
+import { AdminGetUsersResponse } from '../model/adminGetUsersResponse';
+import { AdminListProjectsResponse } from '../model/adminListProjectsResponse';
+import { AdminOrganizationInfoResponse } from '../model/adminOrganizationInfoResponse';
+import { AdminUpdateOrganizationRequest } from '../model/adminUpdateOrganizationRequest';
+import { AdminUpdateUserPermissionsRequest } from '../model/adminUpdateUserPermissionsRequest';
+import { AdminUpdateUserRequest } from '../model/adminUpdateUserRequest';
+import { CreateOrganizationResponse } from '../model/createOrganizationResponse';
+import { FindUserResponse } from '../model/findUserResponse';
+import { GenericApiResponse } from '../model/genericApiResponse';
+import { ProjectInfoResponse } from '../model/projectInfoResponse';
+import { UpdateProjectRequest } from '../model/updateProjectRequest';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+export declare enum AdminApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type adminDeleteOrganizationQueryParams = {
+    fullDeletion?: boolean;
+};
+declare type adminDeleteUserQueryParams = {
+    fullDeletion?: boolean;
+};
+declare type adminFindUserQueryParams = {
+    query: string;
+};
+declare type adminGetOrganizationsQueryParams = {
+    active?: number;
+    sort?: string;
+    limit?: number;
+    offset?: number;
+    search?: string;
+};
+declare type adminGetProjectsQueryParams = {
+    active?: number;
+    sort?: string;
+    limit?: number;
+    offset?: number;
+    search?: string;
+};
+declare type adminGetUsersQueryParams = {
+    active?: number;
+    tier?: 'free' | 'pro' | 'enterprise';
+    fields?: string;
+    sort?: string;
+    limit?: number;
+    offset?: number;
+    search?: string;
+};
+export declare type AdminApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class AdminApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: AdminApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: AdminApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: AdminApiOpts);
+    get opts(): AdminApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: AdminApiApiKeys, value: string | undefined): void;
+    /**
+     * Admin-only API to set the list of identity provider for a given domain.
+     * @summary Add or update SSO settings for a domain
+     * @param domainName Email domain name
+     * @param adminAddOrUpdateSSODomainIdPsRequest
+     */
+    adminAddOrUpdateSSODomainIdPs(domainName: string, adminAddOrUpdateSSODomainIdPsRequest: AdminAddOrUpdateSSODomainIdPsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to add a user to a project. If no user is provided, the current user is used.
+     * @summary Add user to a project
+     * @param projectId Project ID
+     * @param adminAddProjectUserRequest
+     */
+    adminAddUserToProject(projectId: number, adminAddProjectUserRequest?: AdminAddProjectUserRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * DEPRECATED. Admin-only API to add the current user to a project.
+     * @summary Add current user to a project
+     * @param projectId Project ID
+     */
+    adminAddUserToProjectDeprecated(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to create a new organization.
+     * @summary Create a new organization
+     * @param adminCreateOrganizationRequest
+     */
+    adminCreateOrganization(adminCreateOrganizationRequest: AdminCreateOrganizationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateOrganizationResponse>;
+    /**
+     * Admin-only API to delete an organization. If `fullDeletion` is set, it deletes the organization\'s identifiable information and files. Otherwise, it soft deletes the organization by setting its `delete_date` value.
+     * @summary Delete an organization
+     * @param organizationId Organization ID
+     * @param fullDeletion Set to true for full deletion
+     */
+    adminDeleteOrganization(organizationId: number, queryParams: adminDeleteOrganizationQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete a project.
+     * @summary Delete a project
+     * @param projectId Project ID
+     */
+    adminDeleteProject(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete the list of identity providers for a given domain.
+     * @summary Delete SSO settings for a domain
+     * @param domainName Email domain name
+     */
+    adminDeleteSSODomainIdPs(domainName: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete a user. If `fullDeletion` is set, it deletes the user\'s identifiable information and files. Otherwise, it soft deletes the user by setting it\'s `delete_date` value.
+     * @summary Delete a user
+     * @param userId User ID
+     * @param fullDeletion Set to true for full deletion
+     */
+    adminDeleteUser(userId: number, queryParams: adminDeleteUserQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * DEPRECATED. Admin-only API to find a user by username or email address.
+     * @summary Find a user
+     * @param query Part of e-mail address or username
+     */
+    adminFindUser(queryParams: adminFindUserQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<FindUserResponse>;
+    /**
+     * DEPRECATED. Admin-only API to get list of all users that have been active in the past 30 days.
+     * @summary Get all user IDs (active last 30 days)
+     */
+    adminGetAllActiveUserIds(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserIdsResponse>;
+    /**
+     * DEPRECATED. Admin-only API to get list of all users.
+     * @summary Get all user IDs
+     */
+    adminGetAllUserIds(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserIdsResponse>;
+    /**
+     * Admin-only API to get global metrics.
+     * @summary Get global metrics
+     */
+    adminGetMetrics(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetMetricsResponse>;
+    /**
+     * Admin-only API to list all information about this organization.
+     * @summary Organization information
+     * @param organizationId Organization ID
+     */
+    adminGetOrganizationInfo(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminOrganizationInfoResponse>;
+    /**
+     * Admin-only API to get the list of all organizations.
+     * @summary Get all organizations
+     * @param active Whether to search for entities (users, orgs) active in the last X days
+     * @param sort Fields and order to sort query by
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     * @param search Search query
+     */
+    adminGetOrganizations(queryParams: adminGetOrganizationsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationsResponse>;
+    /**
+     * Admin-only API to get project information.
+     * @summary Get project
+     * @param projectId Project ID
+     */
+    adminGetProject(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ProjectInfoResponse>;
+    /**
+     * Admin-only API to get the list of all projects.
+     * @summary Get all projects
+     * @param active Whether to search for entities (users, orgs) active in the last X days
+     * @param sort Fields and order to sort query by
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     * @param search Search query
+     */
+    adminGetProjects(queryParams: adminGetProjectsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminListProjectsResponse>;
+    /**
+     * Admin-only API to get the list of identity providers enabled for a given domain.
+     * @summary Get SSO settings for a domain
+     * @param domainName Email domain name
+     */
+    adminGetSSODomainIdPs(domainName: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetSSODomainIdPsResponse>;
+    /**
+     * Admin-only API to get the SSO settings.
+     * @summary Get SSO settings
+     */
+    adminGetSSOSettings(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetSSOSettingsResponse>;
+    /**
+     * Admin-only API to get information about a user.
+     * @summary Get user
+     * @param userId User ID
+     */
+    adminGetUser(userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserResponse>;
+    /**
+     * Admin-only API to get marketing metrics about a user.
+     * @summary Get user metrics
+     * @param userId User ID
+     */
+    adminGetUserMetrics(userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserMetricsResponse>;
+    /**
+     * Admin-only API to get the list of all registered users.
+     * @summary Get all users
+     * @param active Whether to search for entities (users, orgs) active in the last X days
+     * @param tier Whether to search for free, pro or enterprise entities (users, projects)
+     * @param fields Comma separated list of fields to fetch in a query
+     * @param sort Fields and order to sort query by
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     * @param search Search query
+     */
+    adminGetUsers(queryParams: adminGetUsersQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUsersResponse>;
+    /**
+     * Admin-only API to remove a user from a project.
+     * @summary Remove user from a project
+     * @param projectId Project ID
+     * @param userId User ID
+     */
+    adminRemoveUserFromProject(projectId: number, userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * DEPRECATED. Admin-only API to remove the current user from a project.
+     * @summary Remove current user from a project
+     * @param projectId Project ID
+     */
+    adminRemoveUserFromProjectDeprecated(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update organization properties such as name and logo.
+     * @summary Update organization
+     * @param organizationId Organization ID
+     * @param adminUpdateOrganizationRequest
+     */
+    adminUpdateOrganization(organizationId: number, adminUpdateOrganizationRequest: AdminUpdateOrganizationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update project properties.
+     * @summary Update project
+     * @param projectId Project ID
+     * @param updateProjectRequest
+     */
+    adminUpdateProject(projectId: number, updateProjectRequest: UpdateProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update user properties.
+     * @summary Update user
+     * @param userId User ID
+     * @param adminUpdateUserRequest
+     */
+    adminUpdateUser(userId: number, adminUpdateUserRequest: AdminUpdateUserRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update the list of permissions for a user.
+     * @summary Update user permissions
+     * @param userId User ID
+     * @param adminUpdateUserPermissionsRequest
+     */
+    adminUpdateUserPermissions(userId: number, adminUpdateUserPermissionsRequest: AdminUpdateUserPermissionsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+}
+export {};

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

@@ -2040,6 +2040,85 @@ class AdminApi {
             });
         });
     }
+    /**
+     * Admin-only API to update the list of permissions for a user.
+     * @summary Update user permissions
+     * @param userId User ID
+     * @param adminUpdateUserPermissionsRequest
+     */
+    async adminUpdateUserPermissions(userId, adminUpdateUserPermissionsRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/admin/users/{userId}/permissions'
+            .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 adminUpdateUserPermissions.');
+        }
+        // verify required parameter 'adminUpdateUserPermissionsRequest' is not null or undefined
+        if (adminUpdateUserPermissionsRequest === null || adminUpdateUserPermissionsRequest === undefined) {
+            throw new Error('Required parameter adminUpdateUserPermissionsRequest was null or undefined when calling adminUpdateUserPermissions.');
+        }
+        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(adminUpdateUserPermissionsRequest, "AdminUpdateUserPermissionsRequest")
+        };
+        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
 }
 exports.AdminApi = AdminApi;
 //# sourceMappingURL=adminApi.js.map