@sureel/sdk 1.15.1 → 1.15.2-rc.2

package/esm/api/sureel-api.js

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Sureel API
- * ### 🔐 OAuth Authentication To access the Sureel API, the following set of variables will be necessary:      {       \"auth_url\": \"https://sureel.eu.auth0.com/oauth/token\",       \"client_id\": \"<Your-Client-Id>\",       \"client_secret\": \"<Your-Client-Secret>\",       \"audience\": \"https://api.sureel.ai\"     }  Note: We provide the `client_id` and `client_secret` separately.  **Token Request Example:**      curl --request POST \\       --url https://sureel.eu.auth0.com/oauth/token \\       --header \'content-type: application/json\' \\       --data \'{         \"client_id\": \"<Your-Client-Id>\",         \"client_secret\": \"<Your-Client-Secret>\",         \"audience\": \"https://api.sureel.ai\",         \"grant_type\": \"client_credentials\"       }\'  Include the token in your API requests:      Authorization: Bearer <your_token>  **Troubleshooting** - Ensure your token hasn’t expired - Check the Authorization header format - Confirm you\'re using the correct audience   ### 📥 Getting the Request Result You can retrieve processing results in two ways:  - **Polling**:   For audio requests, retrieve results from the <a href=\"#tag/audio-ai/paths/~1v1~1ai~1audio-ldm~1%7BrequestId%7D/get\">/v1/ai/audio-ldm/{requestId}</a> endpoint; for image requests, use the <a href=\"#tag/image-ai/operation/getResultByRequestId\">/v1/ai/ldm/{requestId}</a> endpoint. Make sure the `requestId` is obtained from the POST response. Processing time may vary.  - **Webhooks**: Include a `webhook_url` (and optional `webhook_key`) in your POST body to receive results asynchronously.  **Troubleshooting** - Verify the webhook URL is publicly accessible - Check that your server handles the webhook key - Ensure the request is fully processed   ### 📦 Using the SDK If you\'re building with Node.js or TypeScript, you can use our official SDK for easier integration: <a href=\"https://www.npmjs.com/package/@sureel/sdk\" target=\"_blank\">@sureel/sdk on npm</a>.  ### 🧠 Reading Temporal Attribution Results - `duration`: Length (in seconds) of each analysis window - `period`: Interval (in seconds) between segment starts  If `duration > period`, the analysis uses overlapping segments to improve accuracy. If both values are `-1`, the full song is analyzed in one pass.
+ * ### 🔐 OAuth Authentication To access the Sureel API, the following set of variables will be necessary:      {       \"auth_url\": \"https://dev-p48agspfw4i7fkld.eu.auth0.com/oauth/token\",       \"client_id\": \"<Your-Client-Id>\",       \"client_secret\": \"<Your-Client-Secret>\",       \"audience\": \"https://api.dev.reelx.xyz/\"     }  Note: We provide the `client_id` and `client_secret` separately.  **Token Request Example:**      curl --request POST \\       --url https://dev-p48agspfw4i7fkld.eu.auth0.com/oauth/token \\       --header \'content-type: application/json\' \\       --data \'{         \"client_id\": \"<Your-Client-Id>\",         \"client_secret\": \"<Your-Client-Secret>\",         \"audience\": \"https://api.dev.reelx.xyz/\",         \"grant_type\": \"client_credentials\"       }\'  Include the token in your API requests:      Authorization: Bearer <your_token>  **Troubleshooting** - Ensure your token hasn’t expired - Check the Authorization header format - Confirm you\'re using the correct audience   ### 📥 Getting the Request Result You can retrieve processing results in two ways:  - **Polling**:   For audio requests, retrieve results from the <a href=\"#tag/audio-ai/paths/~1v1~1ai~1audio-ldm~1%7BrequestId%7D/get\">/v1/ai/audio-ldm/{requestId}</a> endpoint; for image requests, use the <a href=\"#tag/image-ai/operation/getResultByRequestId\">/v1/ai/ldm/{requestId}</a> endpoint. Make sure the `requestId` is obtained from the POST response. Processing time may vary.  - **Webhooks**: Include a `webhook_url` (and optional `webhook_key`) in your POST body to receive results asynchronously.  **Troubleshooting** - Verify the webhook URL is publicly accessible - Check that your server handles the webhook key - Ensure the request is fully processed   ### 📦 Using the SDK If you\'re building with Node.js or TypeScript, you can use our official SDK for easier integration: <a href=\"https://www.npmjs.com/package/@sureel/sdk\" target=\"_blank\">@sureel/sdk on npm</a>.  ### 🧠 Reading Temporal Attribution Results - `duration`: Length (in seconds) of each analysis window - `period`: Interval (in seconds) between segment starts  If `duration > period`, the analysis uses overlapping segments to improve accuracy. If both values are `-1`, the full song is analyzed in one pass.
  *
  * The version of the OpenAPI document:
  *
@@ -491,6 +491,45 @@ export const SureelApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Ingest a DDEX ERN 4.3 release. The manifest is fetched (or extracted from a ZIP), per-track metadata (titles, ISRCs, durations, contributors) is extracted, and one collection is created. Multi-release deliveries are rejected with 400.
+         * @summary Create a collection from a DDEX ERN 4.3 delivery
+         * @param {CreateCollectionFromDdexContentTypeEnum} contentType
+         * @param {CreateCollectionFromDdexRequest} createCollectionFromDdexRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCollectionFromDdex: async (contentType, createCollectionFromDdexRequest, options = {}) => {
+            // verify required parameter 'contentType' is not null or undefined
+            assertParamExists("createCollectionFromDdex", "contentType", contentType);
+            // verify required parameter 'createCollectionFromDdexRequest' is not null or undefined
+            assertParamExists("createCollectionFromDdex", "createCollectionFromDdexRequest", createCollectionFromDdexRequest);
+            const localVarPath = `/v1/ai/artist/collection/from-ddex`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: "POST" }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2", ["read:ldm"], configuration);
+            localVarHeaderParameter["Content-Type"] = "application/json";
+            if (contentType != null) {
+                localVarHeaderParameter["Content-Type"] = String(contentType);
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(createCollectionFromDdexRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Create cover art for your music album or single. By default, each user has a limit of 100 requests per minute.
          * @summary Music cover art
@@ -2122,7 +2161,7 @@ export const SureelApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Upload audio, image, video, or metadata files as form-data for use with other endpoints. Allowed file extensions: - Audio: .wav, .mp3, .m4a, .flac - Image: .jpeg, .jpg, .png, .tif - Video: .mp4 - Metadata: .json, .npy  All uploads are securely stored on the server for a limited time. Maximum file size: 200MB.
+         * Upload audio, image, video, metadata, or archive files as form-data for use with other endpoints. Allowed file extensions: - Audio: .wav, .mp3, .m4a, .flac - Image: .jpeg, .jpg, .png, .tif - Video: .mp4 - Metadata: .json, .npy, .xml - Archive: .zip  All uploads are securely stored on the server for a limited time. Maximum file size: 200MB. For files larger than 200MB (e.g. DDEX ZIPs), use `/files/generate-upload-urls` instead.
          * @summary Upload files as form-data
          * @param {UploadFilesContentTypeEnum} contentType
          * @param {string} contentType2
@@ -2389,6 +2428,21 @@ export const SureelApiFp = function (configuration) {
             const localVarOperationServerBasePath = (_c = (_b = operationServerMap["SureelApi.createCollection"]) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Ingest a DDEX ERN 4.3 release. The manifest is fetched (or extracted from a ZIP), per-track metadata (titles, ISRCs, durations, contributors) is extracted, and one collection is created. Multi-release deliveries are rejected with 400.
+         * @summary Create a collection from a DDEX ERN 4.3 delivery
+         * @param {CreateCollectionFromDdexContentTypeEnum} contentType
+         * @param {CreateCollectionFromDdexRequest} createCollectionFromDdexRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createCollectionFromDdex(contentType, createCollectionFromDdexRequest, options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createCollectionFromDdex(contentType, createCollectionFromDdexRequest, options);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = operationServerMap["SureelApi.createCollectionFromDdex"]) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Create cover art for your music album or single. By default, each user has a limit of 100 requests per minute.
          * @summary Music cover art
@@ -3022,7 +3076,7 @@ export const SureelApiFp = function (configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Upload audio, image, video, or metadata files as form-data for use with other endpoints. Allowed file extensions: - Audio: .wav, .mp3, .m4a, .flac - Image: .jpeg, .jpg, .png, .tif - Video: .mp4 - Metadata: .json, .npy  All uploads are securely stored on the server for a limited time. Maximum file size: 200MB.
+         * Upload audio, image, video, metadata, or archive files as form-data for use with other endpoints. Allowed file extensions: - Audio: .wav, .mp3, .m4a, .flac - Image: .jpeg, .jpg, .png, .tif - Video: .mp4 - Metadata: .json, .npy, .xml - Archive: .zip  All uploads are securely stored on the server for a limited time. Maximum file size: 200MB. For files larger than 200MB (e.g. DDEX ZIPs), use `/files/generate-upload-urls` instead.
          * @summary Upload files as form-data
          * @param {UploadFilesContentTypeEnum} contentType
          * @param {string} contentType2
@@ -3216,6 +3270,19 @@ export const SureelApiFactory = function (configuration, basePath, axios) {
                 .createCollection(contentType, createCollectionRequest, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Ingest a DDEX ERN 4.3 release. The manifest is fetched (or extracted from a ZIP), per-track metadata (titles, ISRCs, durations, contributors) is extracted, and one collection is created. Multi-release deliveries are rejected with 400.
+         * @summary Create a collection from a DDEX ERN 4.3 delivery
+         * @param {CreateCollectionFromDdexContentTypeEnum} contentType
+         * @param {CreateCollectionFromDdexRequest} createCollectionFromDdexRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCollectionFromDdex(contentType, createCollectionFromDdexRequest, options) {
+            return localVarFp
+                .createCollectionFromDdex(contentType, createCollectionFromDdexRequest, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * Create cover art for your music album or single. By default, each user has a limit of 100 requests per minute.
          * @summary Music cover art
@@ -3767,7 +3834,7 @@ export const SureelApiFactory = function (configuration, basePath, axios) {
                 .then((request) => request(axios, basePath));
         },
         /**
-         * Upload audio, image, video, or metadata files as form-data for use with other endpoints. Allowed file extensions: - Audio: .wav, .mp3, .m4a, .flac - Image: .jpeg, .jpg, .png, .tif - Video: .mp4 - Metadata: .json, .npy  All uploads are securely stored on the server for a limited time. Maximum file size: 200MB.
+         * Upload audio, image, video, metadata, or archive files as form-data for use with other endpoints. Allowed file extensions: - Audio: .wav, .mp3, .m4a, .flac - Image: .jpeg, .jpg, .png, .tif - Video: .mp4 - Metadata: .json, .npy, .xml - Archive: .zip  All uploads are securely stored on the server for a limited time. Maximum file size: 200MB. For files larger than 200MB (e.g. DDEX ZIPs), use `/files/generate-upload-urls` instead.
          * @summary Upload files as form-data
          * @param {UploadFilesContentTypeEnum} contentType
          * @param {string} contentType2
@@ -3969,6 +4036,20 @@ export class SureelApi extends BaseAPI {
             .createCollection(contentType, createCollectionRequest, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Ingest a DDEX ERN 4.3 release. The manifest is fetched (or extracted from a ZIP), per-track metadata (titles, ISRCs, durations, contributors) is extracted, and one collection is created. Multi-release deliveries are rejected with 400.
+     * @summary Create a collection from a DDEX ERN 4.3 delivery
+     * @param {CreateCollectionFromDdexContentTypeEnum} contentType
+     * @param {CreateCollectionFromDdexRequest} createCollectionFromDdexRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SureelApi
+     */
+    createCollectionFromDdex(contentType, createCollectionFromDdexRequest, options) {
+        return SureelApiFp(this.configuration)
+            .createCollectionFromDdex(contentType, createCollectionFromDdexRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Create cover art for your music album or single. By default, each user has a limit of 100 requests per minute.
      * @summary Music cover art
@@ -4561,7 +4642,7 @@ export class SureelApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Upload audio, image, video, or metadata files as form-data for use with other endpoints. Allowed file extensions: - Audio: .wav, .mp3, .m4a, .flac - Image: .jpeg, .jpg, .png, .tif - Video: .mp4 - Metadata: .json, .npy  All uploads are securely stored on the server for a limited time. Maximum file size: 200MB.
+     * Upload audio, image, video, metadata, or archive files as form-data for use with other endpoints. Allowed file extensions: - Audio: .wav, .mp3, .m4a, .flac - Image: .jpeg, .jpg, .png, .tif - Video: .mp4 - Metadata: .json, .npy, .xml - Archive: .zip  All uploads are securely stored on the server for a limited time. Maximum file size: 200MB. For files larger than 200MB (e.g. DDEX ZIPs), use `/files/generate-upload-urls` instead.
      * @summary Upload files as form-data
      * @param {UploadFilesContentTypeEnum} contentType
      * @param {string} contentType2
@@ -4661,6 +4742,12 @@ export const ControlNetContentTypeEnum = {
 export const CreateCollectionContentTypeEnum = {
     ApplicationJson: "application/json",
 };
+/**
+ * @export
+ */
+export const CreateCollectionFromDdexContentTypeEnum = {
+    ApplicationJson: "application/json",
+};
 /**
  * @export
  */
@@ -4843,6 +4930,7 @@ export const UploadFilesContentTypeEnum = {
     Image: "image",
     Video: "video",
     Metadata: "metadata",
+    Archive: "archive",
 };
 /**
  * @export