edge-impulse-api 1.93.9 → 1.93.10

package/build/browser/edge-impulse-api.d.ts

@@ -5259,6 +5259,17 @@ export class OrganizationCreateProjectApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Creates a signed link to securely upload a custom block archive directly to S3.
+     * @summary Create pre-signed S3 upload link for a custom block archive
+     * @param organizationId Organization ID
+     * @param createCustomBlockUploadLinkRequest
+     */
+    createCustomBlockUploadLink(organizationId: number, createCustomBlockUploadLinkRequest: CreateCustomBlockUploadLinkRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateCustomBlockUploadLinkResponse>;
     /**
      * Remove a transformation job. This will stop all running jobs.
      * @summary Delete transformation job
@@ -5282,6 +5293,17 @@ export class OrganizationCreateProjectApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Verifies a staged custom block archive and starts a custom block build job.
+     * @summary Finalize custom block upload
+     * @param organizationId Organization ID
+     * @param finalizeCustomBlockUploadRequest
+     */
+    finalizeCustomBlockUpload(organizationId: number, finalizeCustomBlockUploadRequest: FinalizeCustomBlockUploadRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
     /**
      * Get the current status of a transformation job job.
      * @summary Get transformation job status
@@ -9926,7 +9948,7 @@ export class RawDataApi {
         };
     }): Promise<RebalanceDatasetResponse>;
     /**
-     * Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data. Returns immediately on small datasets, or starts a job on larger datasets. To get the dataset ratio (as returned by the v1 endpoint), use getDatasetRatio.
+     * Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data. Returns immediately on small datasets, or starts a job on larger datasets. To get the dataset ratio (as returned by the v1 endpoint), use getDatasetRatio. For richer, more powerful dataset splitting with configurable ratios, stratification, and grouping, use splitDataset (`/v1/api/{projectId}/split`).
      * @summary Rebalance dataset
      * @param projectId Project ID
      */
@@ -13841,6 +13863,50 @@ export type CountSamplesResponse = {
 };
 
 
+export type CreateCustomBlockUploadLinkRequest = {
+    /**
+    * file name
+    */
+    fileName: string;
+    /**
+    * file size in bytes
+    */
+    fileSize: number;
+    /**
+    * hash to identify file changes
+    */
+    fileHash: string;
+    type: CreateCustomBlockUploadLinkRequestTypeEnum;
+    blockId: number;
+};
+export type CreateCustomBlockUploadLinkRequestTypeEnum = 'transform' | 'deploy' | 'dsp' | 'transferLearning';
+export const CreateCustomBlockUploadLinkRequestTypeEnumValues: string[];
+
+
+export type CreateCustomBlockUploadLinkResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    /**
+    * S3 Upload Link
+    */
+    url?: string;
+    /**
+    * S3 File Tag
+    */
+    ETag?: string;
+    /**
+    * S3 object key for the staged upload
+    */
+    uploadKey: string;
+};
+
+
 export type CreateDeveloperProfileResponse = {
     /**
     * Whether the operation succeeded
@@ -16755,6 +16821,30 @@ export type Feature = 'signup-thank-you-page' | 'stripe-live-mode' | 'azure-stor
 export const FeatureValues: string[];
 
 
+export type FinalizeCustomBlockUploadRequest = {
+    /**
+    * S3 object key for the staged upload
+    */
+    uploadKey: string;
+    /**
+    * file name
+    */
+    fileName: string;
+    /**
+    * file size in bytes
+    */
+    fileSize: number;
+    /**
+    * hash to identify file changes
+    */
+    fileHash: string;
+    type: FinalizeCustomBlockUploadRequestTypeEnum;
+    blockId: number;
+};
+export type FinalizeCustomBlockUploadRequestTypeEnum = 'transform' | 'deploy' | 'dsp' | 'transferLearning';
+export const FinalizeCustomBlockUploadRequestTypeEnumValues: string[];
+
+
 export type FindSegmentSampleRequest = {
     /**
     * If set, the segments are automatically shifted randomly, to make the dataset distribution more uniform.

package/build/browser/edge-impulse-api.js

@@ -25921,6 +25921,74 @@ class OrganizationCreateProjectApi {
         const response = await fetch(url, requestOptions);
         return this.handleResponse(response, 'GenericApiResponse');
     }
+    /**
+     * Creates a signed link to securely upload a custom block archive directly to S3.
+     * @summary Create pre-signed S3 upload link for a custom block archive
+     * @param organizationId Organization ID
+     * @param createCustomBlockUploadLinkRequest
+     */
+    async createCustomBlockUploadLink(organizationId, createCustomBlockUploadLinkRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/organizations/{organizationId}/custom-block/upload-link'
+            .replace('{' + 'organizationId' + '}', encodeURIComponent(String(organizationId)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            ...(typeof window === "undefined" ? { "User-Agent": "edgeimpulse-api nodejs" } : {}),
+            'Content-Type': 'application/json',
+            ...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 'organizationId' is not null or undefined
+        if (organizationId === null || organizationId === undefined) {
+            throw new Error('Required parameter organizationId was null or undefined when calling createCustomBlockUploadLink.');
+        }
+        // verify required parameter 'createCustomBlockUploadLinkRequest' is not null or undefined
+        if (createCustomBlockUploadLinkRequest === null || createCustomBlockUploadLinkRequest === undefined) {
+            throw new Error('Required parameter createCustomBlockUploadLinkRequest was null or undefined when calling createCustomBlockUploadLink.');
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'POST',
+            headers: { ...localVarHeaderParams },
+        };
+        localVarRequestOptions.body = JSON.stringify(createCustomBlockUploadLinkRequest);
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        return this.handleResponse(response, 'CreateCustomBlockUploadLinkResponse');
+    }
     /**
      * Remove a transformation job. This will stop all running jobs.
      * @summary Delete transformation job
@@ -26063,6 +26131,74 @@ class OrganizationCreateProjectApi {
         const response = await fetch(url, requestOptions);
         return this.handleResponse(response, 'GenericApiResponse');
     }
+    /**
+     * Verifies a staged custom block archive and starts a custom block build job.
+     * @summary Finalize custom block upload
+     * @param organizationId Organization ID
+     * @param finalizeCustomBlockUploadRequest
+     */
+    async finalizeCustomBlockUpload(organizationId, finalizeCustomBlockUploadRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/organizations/{organizationId}/custom-block/finalize'
+            .replace('{' + 'organizationId' + '}', encodeURIComponent(String(organizationId)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            ...(typeof window === "undefined" ? { "User-Agent": "edgeimpulse-api nodejs" } : {}),
+            'Content-Type': 'application/json',
+            ...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 'organizationId' is not null or undefined
+        if (organizationId === null || organizationId === undefined) {
+            throw new Error('Required parameter organizationId was null or undefined when calling finalizeCustomBlockUpload.');
+        }
+        // verify required parameter 'finalizeCustomBlockUploadRequest' is not null or undefined
+        if (finalizeCustomBlockUploadRequest === null || finalizeCustomBlockUploadRequest === undefined) {
+            throw new Error('Required parameter finalizeCustomBlockUploadRequest was null or undefined when calling finalizeCustomBlockUpload.');
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'POST',
+            headers: { ...localVarHeaderParams },
+        };
+        localVarRequestOptions.body = JSON.stringify(finalizeCustomBlockUploadRequest);
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        return this.handleResponse(response, 'StartJobResponse');
+    }
     /**
      * Get the current status of a transformation job job.
      * @summary Get transformation job status
@@ -48652,7 +48788,7 @@ class RawDataApi {
         return this.handleResponse(response, 'RebalanceDatasetResponse');
     }
     /**
-     * Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data. Returns immediately on small datasets, or starts a job on larger datasets. To get the dataset ratio (as returned by the v1 endpoint), use getDatasetRatio.
+     * Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data. Returns immediately on small datasets, or starts a job on larger datasets. To get the dataset ratio (as returned by the v1 endpoint), use getDatasetRatio. For richer, more powerful dataset splitting with configurable ratios, stratification, and grouping, use splitDataset (`/v1/api/{projectId}/split`).
      * @summary Rebalance dataset
      * @param projectId Project ID
      */
@@ -56945,6 +57081,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 });
 
 
+define("library/sdk/model/createCustomBlockUploadLinkRequest", ["require", "exports"], function (require, exports) {
+"use strict";
+// Generated by studio/openapi/generate-models/convert.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCustomBlockUploadLinkRequestTypeEnumValues = void 0;
+exports.CreateCustomBlockUploadLinkRequestTypeEnumValues = ['transform', 'deploy', 'dsp', 'transferLearning'];
+});
+
+
+define("library/sdk/model/createCustomBlockUploadLinkResponse", ["require", "exports"], function (require, exports) {
+"use strict";
+// Generated by studio/openapi/generate-models/convert.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+});
+
+
 define("library/sdk/model/createDeveloperProfileResponse", ["require", "exports"], function (require, exports) {
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts
@@ -58033,6 +58185,15 @@ exports.FeatureValues = ['signup-thank-you-page', 'stripe-live-mode', 'azure-sto
 });
 
 
+define("library/sdk/model/finalizeCustomBlockUploadRequest", ["require", "exports"], function (require, exports) {
+"use strict";
+// Generated by studio/openapi/generate-models/convert.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FinalizeCustomBlockUploadRequestTypeEnumValues = void 0;
+exports.FinalizeCustomBlockUploadRequestTypeEnumValues = ['transform', 'deploy', 'dsp', 'transferLearning'];
+});
+
+
 define("library/sdk/model/findSegmentSampleRequest", ["require", "exports"], function (require, exports) {
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts
@@ -59677,6 +59838,8 @@ __exportStar(require("./convertUserRequest"), exports);
 __exportStar(require("./cosineSimilarityData"), exports);
 __exportStar(require("./cosineSimilarityIssue"), exports);
 __exportStar(require("./countSamplesResponse"), exports);
+__exportStar(require("./createCustomBlockUploadLinkRequest"), exports);
+__exportStar(require("./createCustomBlockUploadLinkResponse"), exports);
 __exportStar(require("./createDeveloperProfileResponse"), exports);
 __exportStar(require("./createDeviceRequest"), exports);
 __exportStar(require("./createEnterpriseTrialResponse"), exports);
@@ -59822,6 +59985,7 @@ __exportStar(require("./exportKerasBlockDataRequest"), exports);
 __exportStar(require("./exportOriginalDataRequest"), exports);
 __exportStar(require("./exportWavDataRequest"), exports);
 __exportStar(require("./feature"), exports);
+__exportStar(require("./finalizeCustomBlockUploadRequest"), exports);
 __exportStar(require("./findSegmentSampleRequest"), exports);
 __exportStar(require("./findSegmentSampleResponse"), exports);
 __exportStar(require("./findSyntiantPosteriorRequest"), exports);