edge-impulse-api 1.93.26 → 1.93.28

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

@@ -161,6 +161,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<EntityCreatedResponse>;
     /**
      * Add a new file to an existing data item.
@@ -173,6 +176,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Bulk adds data items that already exist in a storage bucket. The bucket path specified should contain folders. Each folder is added as a data item in Edge Impulse.
@@ -184,6 +190,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<StartJobResponse>;
     /**
      * Add a new data item. You can add a maximum of 10000 files directly through this API. Use `addOrganizationDataFile` to add additional files.
@@ -201,6 +210,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<EntityCreatedResponse>;
     /**
      * Add a new research dataset
@@ -212,6 +224,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<StartJobResponse>;
     /**
      * Change the dataset for selected data items.
@@ -226,6 +241,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<StartJobResponse>;
     /**
      * Clear all checklist flags for selected data items.
@@ -239,6 +257,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<StartJobResponse>;
     /**
      * Create a new storage bucket in the Edge Impulse infra. This API is only available through JWT token authentication.
@@ -250,6 +271,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<CreateOrganizationBucketResponse>;
     /**
      * Creates a signed link to securely upload data to s3 bucket directly from the client.
@@ -262,6 +286,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<CreateSignedUploadLinkResponse>;
     /**
      * Delete a file from a dataset
@@ -274,6 +301,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Delete a single file from a data item.
@@ -286,6 +316,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Delete a data item. This will remove items the items from the underlying storage if your dataset has \"bucketPath\" set.
@@ -297,6 +330,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Delete all data for selected data items. This removes all data in the underlying data bucket.
@@ -310,6 +346,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<StartJobResponse>;
     /**
      * Download a file from a dataset. Will return a signed URL to the bucket.
@@ -322,6 +361,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<DownloadPortalFileResponse>;
     /**
      * Download all files in the given folder in a dataset, ignoring any subdirectories.
@@ -334,6 +376,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<Buffer>;
     /**
      * Download a single file from a data item.
@@ -346,6 +391,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<Buffer>;
     /**
      * Download all data for selected data items. This function does not query the underlying bucket.
@@ -359,6 +407,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<Buffer>;
     /**
      * Download all data for this data item.
@@ -371,6 +422,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<Buffer>;
     /**
      * Get storage bucket details.
@@ -382,6 +436,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GetOrganizationBucketResponse>;
     /**
      * Get a data item. This will HEAD the underlying bucket to retrieve the last file information.
@@ -394,6 +451,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GetOrganizationDataItemResponse>;
     /**
      * Get all transformation jobs that ran for a data item. If limit / offset is not provided then max. 20 results are returned.
@@ -407,6 +467,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GetOrganizationDataItemTransformJobsResponse>;
     /**
      * Get information about a dataset
@@ -418,6 +481,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GetOrganizationDatasetResponse>;
     /**
      * Hide a dataset (does not remove underlying data)
@@ -429,6 +495,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * List all files and directories in specified prefix.
@@ -441,6 +510,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<ListPortalFilesInFolderResponse>;
     /**
      * Retrieve all configured storage buckets. This does not list the secret key.
@@ -451,6 +523,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<ListOrganizationBucketsResponse>;
     /**
      * Lists all data items. This can be filtered by the ?filter parameter.
@@ -465,6 +540,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<ListOrganizationDataResponse>;
     /**
      * Lists all files included by the filter.
@@ -479,6 +557,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<ListOrganizationFilesResponse>;
     /**
      * Bulk update the metadata of many data items in one go. This requires you to submit a CSV file with headers, one of which the columns should be named \'name\'. The other columns are used as metadata keys.
@@ -491,6 +572,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<StartJobResponse>;
     /**
      * Preview files and directories in a default dataset for the given prefix, with support for wildcards. This is an internal API used when starting a transformation job.
@@ -503,6 +587,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<PreviewDefaultFilesInFolderResponse>;
     /**
      * Preview a single file from a data item (same as downloadOrganizationDataFile but w/ content-disposition inline and could be truncated).
@@ -515,6 +602,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<Buffer>;
     /**
      * Update all data items. HEADs all underlying buckets to retrieve the last file information. Use this API after uploading data directly to S3. If your dataset has bucketId and bucketPath set then this will also remove items that have been removed from S3.
@@ -526,6 +616,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<StartJobResponse>;
     /**
      * Remove a storage bucket and associated datasets. This will render any data in this storage bucket unreachable.
@@ -537,6 +630,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Rename a file in a dataset
@@ -549,6 +645,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Updates storage bucket details. This only updates fields that were set in the request body. Before updating the bucket details, it is required to verify the connection using the POST /api/organizations/{organizationId}/buckets/verify endpoint.  The verification process: 1. Call the verify endpoint with the new bucket details. 2. Poll the verify endpoint until it responds with `connectionStatus: connected`. 3. If the endpoint responds with `connectionStatus: error`, the verification has failed.  Only proceed with updating the bucket details after receiving a `connected` status. The polling interval and timeout should be determined based on your application\'s requirements.
@@ -561,6 +660,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Update the data item metadata.
@@ -573,6 +675,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Set information about a dataset
@@ -585,6 +690,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<GenericApiResponse>;
     /**
      * Verify whether we can reach a dataset (and return some random files, used for data sources)
@@ -596,6 +704,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<VerifyOrganizationBucketResponse>;
     /**
      * Verify whether we can reach a bucket before adding it.
@@ -608,6 +719,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<VerifyOrganizationBucketResponse>;
     /**
      * Verify connectivity to a storage bucket and optionally list its contents. This endpoint allows you to: 1. Check if the provided bucket credentials are valid and the bucket is accessible. 2. Optionally list files in the bucket up to a specified limit. 3. Validate the bucket configuration before adding it to the organization.  The request can include details such as the bucket name, region, credentials, and listing options. The response provides information about the bucket\'s accessibility and, if requested, a list of files in the bucket.  Important note on verification process: - For S3-compatible storage backends: Verification is expected to be immediate. - For Azure buckets: Verification takes longer. Users are required to poll this endpoint until the connectionStatus changes from \'connecting\' to \'connected\'.  When dealing with Azure buckets, implement a polling mechanism to check the status periodically until it\'s confirmed as connected.
@@ -619,6 +733,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<VerifyOrganizationBucketResponse>;
     /**
      * View a file that\'s located in a dataset (requires JWT auth). File might be converted (e.g. Parquet) or truncated (e.g. CSV).
@@ -631,6 +748,9 @@ export declare class OrganizationDataApi {
         headers: {
             [name: string]: string;
         };
+        responseHeadersCallback?: (headers: {
+            [name: string]: string;
+        }) => void;
     }): Promise<Buffer>;
 }
 export {};