edge-impulse-api 1.22.1 → 1.25.33

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

@@ -0,0 +1,180 @@
+/**
+ * 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.
+ */
+/// <reference types="node" />
+import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetOrganizationDataItemResponse } from '../model/getOrganizationDataItemResponse';
+import { UpdateOrganizationDataItemRequest } from '../model/updateOrganizationDataItemRequest';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum OrganizationAllowGuestAccessApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type addOrganizationDataFileFormParams = {
+    files: Array<RequestFile>;
+};
+declare type deleteOrganizationDataFileQueryParams = {
+    fileName: string;
+};
+declare type downloadOrganizationDataFileQueryParams = {
+    fileName: string;
+};
+declare type downloadOrganizationDataItemQueryParams = {
+    dataset?: string;
+    dataIds: string;
+    filter?: string;
+};
+declare type downloadOrganizationSingleDataItemQueryParams = {
+    filter?: string;
+};
+declare type getOrganizationDataItemQueryParams = {
+    filter?: string;
+};
+declare type previewOrganizationDataFileQueryParams = {
+    fileName: string;
+};
+export declare type OrganizationAllowGuestAccessApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class OrganizationAllowGuestAccessApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: OrganizationAllowGuestAccessApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: OrganizationAllowGuestAccessApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: OrganizationAllowGuestAccessApiOpts);
+    get opts(): OrganizationAllowGuestAccessApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: OrganizationAllowGuestAccessApiApiKeys, value: string | undefined): void;
+    /**
+     * Add a new file to an existing data item.
+     * @summary Add files
+     * @param organizationId Organization ID
+     * @param dataId Data ID
+     * @param files
+     */
+    addOrganizationDataFile(organizationId: number, dataId: number, params: addOrganizationDataFileFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Delete a single file from a data item.
+     * @summary Delete file
+     * @param organizationId Organization ID
+     * @param dataId Data ID
+     * @param fileName File name
+     */
+    deleteOrganizationDataFile(organizationId: number, dataId: number, queryParams: deleteOrganizationDataFileQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Delete a data item. This will remove items the items from the underlying storage if your dataset has \"bucketPath\" set.
+     * @summary Delete data
+     * @param organizationId Organization ID
+     * @param dataId Data ID
+     */
+    deleteOrganizationDataItem(organizationId: number, dataId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Download a single file from a data item.
+     * @summary Download file
+     * @param organizationId Organization ID
+     * @param dataId Data ID
+     * @param fileName File name
+     */
+    downloadOrganizationDataFile(organizationId: number, dataId: number, queryParams: downloadOrganizationDataFileQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Download all data for selected data items. This function does not query the underlying bucket.
+     * @summary Download data
+     * @param organizationId Organization ID
+     * @param dataIds Data IDs as an Array
+     * @param dataset Selected dataset
+     * @param filter Data filter in SQL WHERE format, where you can reference \&#39;dataset\&#39;, \&#39;bucket\&#39;, \&#39;name\&#39;, \&#39;total_file_count\&#39;, \&#39;total_file_size\&#39;, \&#39;created\&#39; and any metadata label through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
+     */
+    downloadOrganizationDataItem(organizationId: number, queryParams: downloadOrganizationDataItemQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Download all data for this data item.
+     * @summary Download data
+     * @param organizationId Organization ID
+     * @param dataId Data ID
+     * @param filter Data filter in SQL WHERE format, where you can reference \&#39;dataset\&#39;, \&#39;bucket\&#39;, \&#39;name\&#39;, \&#39;total_file_count\&#39;, \&#39;total_file_size\&#39;, \&#39;created\&#39; and any metadata label through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
+     */
+    downloadOrganizationSingleDataItem(organizationId: number, dataId: number, queryParams: downloadOrganizationSingleDataItemQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Get a data item. This will HEAD the underlying bucket to retrieve the last file information.
+     * @summary Get data metadata
+     * @param organizationId Organization ID
+     * @param dataId Data ID
+     * @param filter Data filter in SQL WHERE format, where you can reference \&#39;dataset\&#39;, \&#39;bucket\&#39;, \&#39;name\&#39;, \&#39;total_file_count\&#39;, \&#39;total_file_size\&#39;, \&#39;created\&#39; and any metadata label through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
+     */
+    getOrganizationDataItem(organizationId: number, dataId: number, queryParams: getOrganizationDataItemQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataItemResponse>;
+    /**
+     * Preview a single file from a data item (same as downloadOrganizationDataFile but w/ content-disposition inline).
+     * @summary Preview file
+     * @param organizationId Organization ID
+     * @param dataId Data ID
+     * @param fileName File name
+     */
+    previewOrganizationDataFile(organizationId: number, dataId: number, queryParams: previewOrganizationDataFileQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Update the data item metadata.
+     * @summary Update data metadata
+     * @param organizationId Organization ID
+     * @param dataId Data ID
+     * @param updateOrganizationDataItemRequest
+     */
+    updateOrganizationDataItem(organizationId: number, dataId: number, updateOrganizationDataItemRequest: UpdateOrganizationDataItemRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+}
+export {};

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

@@ -250,7 +250,7 @@ class OrganizationAllowGuestAccessApi {
         });
     }
     /**
-     * Delete a data item. This does not remove the items from the underlying storage.
+     * Delete a data item. This will remove items the items from the underlying storage if your dataset has \"bucketPath\" set.
      * @summary Delete data
      * @param organizationId Organization ID
      * @param dataId Data ID

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

@@ -0,0 +1,344 @@
+/**
+ * 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 { AddOrganizationDeployBlockResponse } from '../model/addOrganizationDeployBlockResponse';
+import { AddOrganizationDspBlockRequest } from '../model/addOrganizationDspBlockRequest';
+import { AddOrganizationDspBlockResponse } from '../model/addOrganizationDspBlockResponse';
+import { AddOrganizationSecretRequest } from '../model/addOrganizationSecretRequest';
+import { AddOrganizationSecretResponse } from '../model/addOrganizationSecretResponse';
+import { AddOrganizationTransferLearningBlockRequest } from '../model/addOrganizationTransferLearningBlockRequest';
+import { AddOrganizationTransferLearningBlockResponse } from '../model/addOrganizationTransferLearningBlockResponse';
+import { AddOrganizationTransformationBlockRequest } from '../model/addOrganizationTransformationBlockRequest';
+import { AddOrganizationTransformationBlockResponse } from '../model/addOrganizationTransformationBlockResponse';
+import { GenericApiResponse } from '../model/genericApiResponse';
+import { ListOrganizationDeployBlocksResponse } from '../model/listOrganizationDeployBlocksResponse';
+import { ListOrganizationDspBlocksResponse } from '../model/listOrganizationDspBlocksResponse';
+import { ListOrganizationSecretsResponse } from '../model/listOrganizationSecretsResponse';
+import { ListOrganizationTransferLearningBlocksResponse } from '../model/listOrganizationTransferLearningBlocksResponse';
+import { ListOrganizationTransformationBlocksResponse } from '../model/listOrganizationTransformationBlocksResponse';
+import { UpdateOrganizationDspBlockRequest } from '../model/updateOrganizationDspBlockRequest';
+import { UpdateOrganizationTransferLearningBlockRequest } from '../model/updateOrganizationTransferLearningBlockRequest';
+import { UpdateOrganizationTransformationBlockRequest } from '../model/updateOrganizationTransformationBlockRequest';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum OrganizationBlocksApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type addOrganizationDeployBlockFormParams = {
+    name: string;
+    dockerContainer: string;
+    description: string;
+    cliArguments: string;
+    requestsCpu?: number;
+    requestsMemory?: number;
+    limitsCpu?: number;
+    limitsMemory?: number;
+    photo?: RequestFile;
+    integrateUrl?: string;
+    privileged?: boolean;
+    mountLearnBlock?: boolean;
+    supportsEonCompiler?: boolean;
+    showOptimizations?: boolean;
+    category?: string;
+};
+declare type updateOrganizationDeployBlockFormParams = {
+    name?: string;
+    dockerContainer?: string;
+    description?: string;
+    cliArguments?: string;
+    requestsCpu?: number;
+    requestsMemory?: number;
+    limitsCpu?: number;
+    limitsMemory?: number;
+    photo?: RequestFile;
+    integrateUrl?: string;
+    privileged?: boolean;
+    mountLearnBlock?: boolean;
+    supportsEonCompiler?: boolean;
+    showOptimizations?: boolean;
+    category?: string;
+};
+export declare type OrganizationBlocksApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class OrganizationBlocksApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: OrganizationBlocksApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: OrganizationBlocksApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: OrganizationBlocksApiOpts);
+    get opts(): OrganizationBlocksApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: OrganizationBlocksApiApiKeys, value: string | undefined): void;
+    /**
+     * Adds a deploy block.
+     * @summary Add deploy block
+     * @param organizationId Organization ID
+     * @param name
+     * @param dockerContainer
+     * @param description
+     * @param cliArguments
+     * @param requestsCpu
+     * @param requestsMemory
+     * @param limitsCpu
+     * @param limitsMemory
+     * @param photo
+     * @param integrateUrl
+     * @param privileged
+     * @param mountLearnBlock
+     * @param supportsEonCompiler
+     * @param showOptimizations
+     * @param category
+     */
+    addOrganizationDeployBlock(organizationId: number, params: addOrganizationDeployBlockFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AddOrganizationDeployBlockResponse>;
+    /**
+     * Adds a dsp block.
+     * @summary Add dsp block
+     * @param organizationId Organization ID
+     * @param addOrganizationDspBlockRequest
+     */
+    addOrganizationDspBlock(organizationId: number, addOrganizationDspBlockRequest: AddOrganizationDspBlockRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AddOrganizationDspBlockResponse>;
+    /**
+     * Adds a secret.
+     * @summary Add secret
+     * @param organizationId Organization ID
+     * @param addOrganizationSecretRequest
+     */
+    addOrganizationSecret(organizationId: number, addOrganizationSecretRequest: AddOrganizationSecretRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AddOrganizationSecretResponse>;
+    /**
+     * Adds a transfer learning block.
+     * @summary Add transfer learning block
+     * @param organizationId Organization ID
+     * @param addOrganizationTransferLearningBlockRequest
+     */
+    addOrganizationTransferLearningBlock(organizationId: number, addOrganizationTransferLearningBlockRequest: AddOrganizationTransferLearningBlockRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AddOrganizationTransferLearningBlockResponse>;
+    /**
+     * Adds a transformation block.
+     * @summary Add transformation block
+     * @param organizationId Organization ID
+     * @param addOrganizationTransformationBlockRequest
+     */
+    addOrganizationTransformationBlock(organizationId: number, addOrganizationTransformationBlockRequest: AddOrganizationTransformationBlockRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AddOrganizationTransformationBlockResponse>;
+    /**
+     * Deletes a deploy block.
+     * @summary Delete deploy block
+     * @param organizationId Organization ID
+     * @param deployId Deploy block ID.
+     */
+    deleteOrganizationDeployBlock(organizationId: number, deployId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Deletes a dsp block.
+     * @summary Delete dsp block
+     * @param organizationId Organization ID
+     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
+     */
+    deleteOrganizationDspBlock(organizationId: number, dspId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Deletes a transfer learning block.
+     * @summary Delete transfer learning block
+     * @param organizationId Organization ID
+     * @param secretId Secret ID
+     */
+    deleteOrganizationSecret(organizationId: number, secretId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Deletes a transfer learning block.
+     * @summary Delete transfer learning block
+     * @param organizationId Organization ID
+     * @param transferLearningId Transfer learning ID
+     */
+    deleteOrganizationTransferLearningBlock(organizationId: number, transferLearningId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Deletes a transformation block.
+     * @summary Delete transformation block
+     * @param organizationId Organization ID
+     * @param transformationId Transformation block ID.
+     */
+    deleteOrganizationTransformationBlock(organizationId: number, transformationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Retrieve all deploy blocks.
+     * @summary Get deploy blocks
+     * @param organizationId Organization ID
+     */
+    listOrganizationDeployBlocks(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListOrganizationDeployBlocksResponse>;
+    /**
+     * Retrieve all dsp blocks.
+     * @summary Get dsp blocks
+     * @param organizationId Organization ID
+     */
+    listOrganizationDspBlocks(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListOrganizationDspBlocksResponse>;
+    /**
+     * Retrieve all secrets.
+     * @summary Get secrets
+     * @param organizationId Organization ID
+     */
+    listOrganizationSecrets(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListOrganizationSecretsResponse>;
+    /**
+     * Retrieve all transfer learning blocks.
+     * @summary Get transfer learning blocks
+     * @param organizationId Organization ID
+     */
+    listOrganizationTransferLearningBlocks(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListOrganizationTransferLearningBlocksResponse>;
+    /**
+     * Retrieve all transformation blocks.
+     * @summary Get transformation blocks
+     * @param organizationId Organization ID
+     */
+    listOrganizationTransformationBlocks(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListOrganizationTransformationBlocksResponse>;
+    /**
+     * Retry launch a dsp block.
+     * @summary Retry connection to dsp block
+     * @param organizationId Organization ID
+     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
+     */
+    retryOrganizationDspBlock(organizationId: number, dspId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Updates a deploy block. Only values in the body will be updated.
+     * @summary Update deploy block
+     * @param organizationId Organization ID
+     * @param deployId Deploy block ID.
+     * @param name
+     * @param dockerContainer
+     * @param description
+     * @param cliArguments
+     * @param requestsCpu
+     * @param requestsMemory
+     * @param limitsCpu
+     * @param limitsMemory
+     * @param photo
+     * @param integrateUrl
+     * @param privileged
+     * @param mountLearnBlock
+     * @param supportsEonCompiler
+     * @param showOptimizations
+     * @param category
+     */
+    updateOrganizationDeployBlock(organizationId: number, deployId: number, params: updateOrganizationDeployBlockFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Updates a dsp block. Only values in the body will be updated.
+     * @summary Update dsp block
+     * @param organizationId Organization ID
+     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
+     * @param updateOrganizationDspBlockRequest
+     */
+    updateOrganizationDspBlock(organizationId: number, dspId: number, updateOrganizationDspBlockRequest: UpdateOrganizationDspBlockRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Updates a transfer learning block. Only values in the body will be updated.
+     * @summary Update transfer learning block
+     * @param organizationId Organization ID
+     * @param transferLearningId Transfer learning ID
+     * @param updateOrganizationTransferLearningBlockRequest
+     */
+    updateOrganizationTransferLearningBlock(organizationId: number, transferLearningId: number, updateOrganizationTransferLearningBlockRequest: UpdateOrganizationTransferLearningBlockRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Updates a transformation block. Only values in the body will be updated.
+     * @summary Update transformation block
+     * @param organizationId Organization ID
+     * @param transformationId Transformation block ID.
+     * @param updateOrganizationTransformationBlockRequest
+     */
+    updateOrganizationTransformationBlock(organizationId: number, transformationId: number, updateOrganizationTransformationBlockRequest: UpdateOrganizationTransformationBlockRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+}
+export {};