totalum-api-sdk 3.0.4 → 3.0.6

package/dist/common/interfaces.d.ts

@@ -8,7 +8,7 @@ export interface ErrorResult {
     }[];
 }
 export interface TotalumApiResponse<T> {
-    data?: T;
+    data: T;
     errors?: ErrorResult | null;
     metadata?: any;
 }
@@ -95,6 +95,85 @@ export interface DataProperties {
 export interface NestedQuery {
     [tableName: string]: any;
 }
+/**
+ * Query options for sdk.crud.query(tableName, queryOptions).
+ * System keys use _ prefix. All other keys are property names (child expansions).
+ *
+ * Example:
+ * ```
+ * sdk.crud.query('company', {
+ *   _filter: { country: "Spain" },
+ *   _sort: { name: "asc" },
+ *   _limit: 10,
+ *   employee: {
+ *     _has: true,
+ *     _filter: { status: "active" },
+ *     _count: true,
+ *     task: true
+ *   }
+ * })
+ * ```
+ */
+export interface QueryOptions {
+    _filter?: QueryFilter;
+    _sort?: {
+        [key: string]: 'asc' | 'desc' | 1 | -1;
+    };
+    _limit?: number;
+    _offset?: number;
+    _has?: boolean | 'some' | 'none' | 'every';
+    _include?: boolean;
+    _count?: boolean;
+    _aggregate?: QueryAggregateOptions;
+    _groupBy?: string | string[];
+    _select?: {
+        [fieldName: string]: true;
+    };
+    _omit?: {
+        [fieldName: string]: true;
+    };
+    [propertyName: string]: QueryOptions | boolean | string | string[] | QueryFilter | QueryAggregateOptions | {
+        [key: string]: any;
+    } | number | undefined;
+}
+/**
+ * Object-based filter for query endpoint.
+ * Keys are field names, values are exact matches or operator objects.
+ * Use _or for OR conditions.
+ *
+ * Example:
+ * ```
+ * { name: "Acme", status: { in: ["active", "pending"] }, _or: [{ role: "admin" }, { role: "mod" }] }
+ * ```
+ */
+export interface QueryFilter {
+    _or?: QueryFilter[];
+    [fieldName: string]: any;
+}
+/**
+ * Aggregation options (Prisma-style).
+ * Used with _aggregate in query().
+ *
+ * Example:
+ * ```
+ * { _sum: { amount: true }, _avg: { amount: true }, _count: true }
+ * ```
+ */
+export interface QueryAggregateOptions {
+    _sum?: {
+        [fieldName: string]: true;
+    };
+    _avg?: {
+        [fieldName: string]: true;
+    };
+    _min?: {
+        [fieldName: string]: true;
+    };
+    _max?: {
+        [fieldName: string]: true;
+    };
+    _count?: true;
+}
 export interface AuthOptions {
     token?: {
         accessToken: string;

package/dist/common/response-types.d.ts

@@ -115,6 +115,7 @@ export interface OpenAIChatCompletionResponse {
 }
 export interface ImageGenerationResponse {
     fileName: string;
+    imageUrl: string;
 }
 export interface LookupFilterResult {
     result: DataValues[] | number;

package/dist/index.d.ts

@@ -6,10 +6,12 @@ import { CrudService } from './services/CrudService';
 import { NotificationService } from './services/NotificationService';
 import { StatisticService } from './services/StatisticService';
 import { EmailService } from './services/EmailService';
+import { ScrappingService } from './services/ScrappingService';
 export * from './common/interfaces';
 export * from './common/response-types';
 export { EmailPayloadI } from './services/EmailService';
 export { TotalumError } from './common/fetch-client';
+export { ScrapeRequestBody, ExtractRequestBody, ScreenshotRequestBody, SearchAndExtractRequestBody, ScrapeResponseData, ExtractResponseData, ScreenshotResponseData, SearchAndExtractResponseData, SearchAndExtractResult, ScrapflyPresetName, ScrapflyExtractionModel } from './services/ScrappingService';
 export declare class TotalumApiSdk {
     private authOptions;
     private _baseUrl;
@@ -22,6 +24,7 @@ export declare class TotalumApiSdk {
     notification: NotificationService;
     statistic: StatisticService;
     email: EmailService;
+    scrapping: ScrappingService;
     constructor(authOptions: AuthOptions);
     changeBaseUrl(newBaseUrl: string): void;
     private setRequestData;

package/dist/index.js

@@ -23,6 +23,7 @@ const CrudService_1 = require("./services/CrudService");
 const NotificationService_1 = require("./services/NotificationService");
 const StatisticService_1 = require("./services/StatisticService");
 const EmailService_1 = require("./services/EmailService");
+const ScrappingService_1 = require("./services/ScrappingService");
 // Export all interfaces and types
 __exportStar(require("./common/interfaces"), exports);
 __exportStar(require("./common/response-types"), exports);
@@ -69,6 +70,7 @@ class TotalumApiSdk {
         this.notification = new NotificationService_1.NotificationService(this.client);
         this.statistic = new StatisticService_1.StatisticService(this.client);
         this.email = new EmailService_1.EmailService(this.client);
+        this.scrapping = new ScrappingService_1.ScrappingService(this.client);
     }
 }
 exports.TotalumApiSdk = TotalumApiSdk;

package/dist/services/CrudService.d.ts

@@ -1,4 +1,4 @@
-import { FilterSearchQueryI, NestedQuery, TotalumApiResponse } from "../common/interfaces";
+import { FilterSearchQueryI, NestedQuery, QueryOptions, TotalumApiResponse } from "../common/interfaces";
 import { DataValues, DeleteObjectResponse, UpdatesRecordResponse } from "../common/response-types";
 import { FetchClient } from "../common/fetch-client";
 export declare class CrudService {
@@ -10,7 +10,7 @@ export declare class CrudService {
      * @param {string} id - The ID of the record.
      * @returns {Promise<TotalumApiResponse<T>>} - A promise that resolves to the record data.
      */
-    getRecordById<T = DataValues>(tableName: string, id: string): Promise<TotalumApiResponse<T>>;
+    getRecordById<T = DataValues>(tableName: string, id: string): Promise<TotalumApiResponse<any>>;
     /**
      * Fetches the historic updates of a record by its ID.
      * @param {string} recordId - The ID of the record to fetch the historic updates.
@@ -20,18 +20,53 @@ export declare class CrudService {
     /**
      * Fetches records with optional filtering, sorting, and pagination.
      * The response data is an array of records. If returnCount is true, a metadata object with count is also returned.
+     * @deprecated Use `query()` instead, which supports nested relations, filtering, sorting, pagination, and more.
      * @param {string} tableName - The type of the record. (table name)
      * @param {FilterSearchQueryI} query - Optional query parameters for filtering.
      * @returns {Promise<TotalumApiResponse<T[]>>} - A promise that resolves to an array of records.
      */
-    getRecords<T = DataValues>(tableName: string, query?: FilterSearchQueryI): Promise<TotalumApiResponse<T[]>>;
+    getRecords<T = DataValues>(tableName: string, query?: FilterSearchQueryI): Promise<TotalumApiResponse<any[]>>;
     /**
-     * Fetches nested data across related tables.
+     * Fetches nested data across related tables. The query tree uses table names as keys.
+     * @deprecated Use `query()` instead, which supports nested relations, filtering, sorting, pagination, and more.
      * @param {NestedQuery} nestedQuery - The nested query structure.
      * @param {any} options - Optional configuration.
      * @returns {Promise<TotalumApiResponse<T[]>>} - A promise that resolves to nested data array.
      */
-    getNestedData<T = DataValues>(nestedQuery: NestedQuery, options?: any): Promise<TotalumApiResponse<T[]>>;
+    getNestedData<T extends DataValues = DataValues>(nestedQuery: NestedQuery, options?: any): Promise<TotalumApiResponse<T[]>>;
+    /**
+     * Powerful query endpoint for fetching records with nested relations, filtering, sorting, pagination,
+     * parent filtering by children (_has), child counts (_count), and response shaping (_include).
+     *
+     * @param {string} tableName - The root table to query.
+     * @param {QueryOptions} queryOptions - Query options with _ prefixed system keys and property names as child expansions.
+     * @returns {Promise<TotalumApiResponse<T[]>>} - Nested records matching the query.
+     *
+     * @example
+     * ```typescript
+     * // Simple: get companies with their employees
+     * sdk.crud.query('company', { employee: true })
+     *
+     * // Advanced: companies in Spain with active employees, count tasks
+     * sdk.crud.query('company', {
+     *   _filter: { country: "Spain" },
+     *   _sort: { name: "asc" },
+     *   _limit: 10,
+     *   employee: {
+     *     _has: true,
+     *     _filter: { status: { in: ["active", "probation"] } },
+     *     _count: true,
+     *     task: { _sort: { createdAt: "desc" }, _limit: 5 }
+     *   }
+     * })
+     * ```
+     */
+    query<T extends DataValues = DataValues>(tableName: string, queryOptions?: QueryOptions): Promise<TotalumApiResponse<T[]>>;
+    /**
+     * Recursively encodes dots in _sort keys to @ so they survive express-mongo-sanitize.
+     * The server restores @ → . before processing.
+     */
+    private encodeSortKeys;
     /**
      * Deletes a record by its ID.
      * @param {string} tableName - The type of the record. (table name)
@@ -46,14 +81,14 @@ export declare class CrudService {
      * @param {T} properties - The properties to update.
      * @returns {Promise<TotalumApiResponse<T>>} - A promise that resolves to the updated record.
      */
-    editRecordById<T = DataValues>(tableName: string, id: string, properties: Partial<T>): Promise<TotalumApiResponse<T>>;
+    editRecordById<T = DataValues>(tableName: string, id: string, properties: Partial<any>): Promise<TotalumApiResponse<any>>;
     /**
      * Creates a new record.
      * @param {string} tableName - The type of the record. (table name)
-     * @param {T} record - The record data to create.
+     * @param {Partial<DataValues>} record - The record data to create.
      * @returns {Promise<TotalumApiResponse<T>>} - A promise that resolves to the created record.
      */
-    createRecord<T = DataValues>(tableName: string, record: Partial<T>): Promise<TotalumApiResponse<T>>;
+    createRecord<T = DataValues>(tableName: string, record: Partial<any>): Promise<TotalumApiResponse<any>>;
     /**
      * Adds a many-to-many reference between records.
      * @param {string} type - The type id of the record (table name)
@@ -76,11 +111,12 @@ export declare class CrudService {
     dropManyToManyReferenceRecord(type: string, id: string, propertyName: string, referenceId: string): Promise<TotalumApiResponse<DeleteObjectResponse>>;
     /**
      * Gets many-to-many reference records with optional filtering.
+     * @deprecated Use `query()` instead, which supports nested relations including many-to-many.
      * @param {string} type - The type id of the record (table name)
      * @param {string} id - The id of the record that we want to get many to many references
      * @param {string} propertyName - The property that we want to get many to many references
      * @param {FilterSearchQueryI} query - The query to filter and sort the results
      * @returns {Promise<TotalumApiResponse<T[]>>}
      */
-    getManyToManyReferencesRecords<T = DataValues>(type: string, id: string, propertyName: string, query?: FilterSearchQueryI): Promise<TotalumApiResponse<T[]>>;
+    getManyToManyReferencesRecords<T = DataValues>(type: string, id: string, propertyName: string, query?: FilterSearchQueryI): Promise<TotalumApiResponse<any[]>>;
 }

package/dist/services/CrudService.js

@@ -42,6 +42,7 @@ class CrudService {
     /**
      * Fetches records with optional filtering, sorting, and pagination.
      * The response data is an array of records. If returnCount is true, a metadata object with count is also returned.
+     * @deprecated Use `query()` instead, which supports nested relations, filtering, sorting, pagination, and more.
      * @param {string} tableName - The type of the record. (table name)
      * @param {FilterSearchQueryI} query - Optional query parameters for filtering.
      * @returns {Promise<TotalumApiResponse<T[]>>} - A promise that resolves to an array of records.
@@ -53,7 +54,8 @@ class CrudService {
         });
     }
     /**
-     * Fetches nested data across related tables.
+     * Fetches nested data across related tables. The query tree uses table names as keys.
+     * @deprecated Use `query()` instead, which supports nested relations, filtering, sorting, pagination, and more.
      * @param {NestedQuery} nestedQuery - The nested query structure.
      * @param {any} options - Optional configuration.
      * @returns {Promise<TotalumApiResponse<T[]>>} - A promise that resolves to nested data array.
@@ -64,6 +66,65 @@ class CrudService {
             return this.client.post(url, { nestedQuery: nestedQuery, options: options });
         });
     }
+    /**
+     * Powerful query endpoint for fetching records with nested relations, filtering, sorting, pagination,
+     * parent filtering by children (_has), child counts (_count), and response shaping (_include).
+     *
+     * @param {string} tableName - The root table to query.
+     * @param {QueryOptions} queryOptions - Query options with _ prefixed system keys and property names as child expansions.
+     * @returns {Promise<TotalumApiResponse<T[]>>} - Nested records matching the query.
+     *
+     * @example
+     * ```typescript
+     * // Simple: get companies with their employees
+     * sdk.crud.query('company', { employee: true })
+     *
+     * // Advanced: companies in Spain with active employees, count tasks
+     * sdk.crud.query('company', {
+     *   _filter: { country: "Spain" },
+     *   _sort: { name: "asc" },
+     *   _limit: 10,
+     *   employee: {
+     *     _has: true,
+     *     _filter: { status: { in: ["active", "probation"] } },
+     *     _count: true,
+     *     task: { _sort: { createdAt: "desc" }, _limit: 5 }
+     *   }
+     * })
+     * ```
+     */
+    query(tableName, queryOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = utils_1.UtilsService.getUrl('', endpoints_1.endpoints.crud.query);
+            const sanitized = queryOptions ? this.encodeSortKeys(queryOptions) : {};
+            return this.client.post(url, { tableName, queryOptions: sanitized });
+        });
+    }
+    /**
+     * Recursively encodes dots in _sort keys to @ so they survive express-mongo-sanitize.
+     * The server restores @ → . before processing.
+     */
+    encodeSortKeys(options) {
+        if (!options || typeof options !== 'object')
+            return options;
+        const result = {};
+        for (const key of Object.keys(options)) {
+            if (key === '_sort' && typeof options[key] === 'object') {
+                const encoded = {};
+                for (const sortKey of Object.keys(options[key])) {
+                    encoded[sortKey.replace(/\./g, '@')] = options[key][sortKey];
+                }
+                result[key] = encoded;
+            }
+            else if (typeof options[key] === 'object' && options[key] !== null && !Array.isArray(options[key])) {
+                result[key] = this.encodeSortKeys(options[key]);
+            }
+            else {
+                result[key] = options[key];
+            }
+        }
+        return result;
+    }
     /**
      * Deletes a record by its ID.
      * @param {string} tableName - The type of the record. (table name)
@@ -99,7 +160,7 @@ class CrudService {
     /**
      * Creates a new record.
      * @param {string} tableName - The type of the record. (table name)
-     * @param {T} record - The record data to create.
+     * @param {Partial<DataValues>} record - The record data to create.
      * @returns {Promise<TotalumApiResponse<T>>} - A promise that resolves to the created record.
      */
     createRecord(tableName, record) {
@@ -146,6 +207,7 @@ class CrudService {
     }
     /**
      * Gets many-to-many reference records with optional filtering.
+     * @deprecated Use `query()` instead, which supports nested relations including many-to-many.
      * @param {string} type - The type id of the record (table name)
      * @param {string} id - The id of the record that we want to get many to many references
      * @param {string} propertyName - The property that we want to get many to many references

package/dist/services/EmailService.js

@@ -31,7 +31,8 @@ class EmailService {
                     errors: {
                         errorCode: 'TOO_MANY_ATTACHMENTS',
                         errorMessage: `Maximum number of attachments is 10. Received ${emailPayload.attachments.length}.`
-                    }
+                    },
+                    data: null
                 };
             }
             // Validate attachment URLs
@@ -42,7 +43,8 @@ class EmailService {
                             errors: {
                                 errorCode: 'INVALID_ATTACHMENT_URL',
                                 errorMessage: `Attachment ${attachment.filename} must have a valid URL`
-                            }
+                            },
+                            data: null
                         };
                     }
                     if (!attachment.url.startsWith('http://') && !attachment.url.startsWith('https://')) {
@@ -50,7 +52,8 @@ class EmailService {
                             errors: {
                                 errorCode: 'INVALID_ATTACHMENT_URL',
                                 errorMessage: `Attachment ${attachment.filename} must have a valid HTTP/HTTPS URL`
-                            }
+                            },
+                            data: null
                         };
                     }
                 }

package/dist/services/FilterService.d.ts

@@ -17,12 +17,13 @@ export declare class FilterService {
     lookUpFilter(idPage: string, query: FilterLookupSearchQueryI, idsOfMultipleNodesToSearch?: string[], returnCount?: boolean): Promise<TotalumApiResponse<LookupFilterResult>>;
     /**
      * Filters data across nested related tables (like a SQL join).
+     * @deprecated Use `crud.query()` instead, which supports nested relations with filtering, sorting, _has, and more.
      * @param {NestedQueryFilterI} nestedQuery - The nested query to filter by
      * @param {string} tableNameToGetResults - The table that you want to get the results from
      * @param {filterNestedOptionsI} filterOptions - Extra options for the filter like pagination and sort
      * @returns {Promise<TotalumApiResponse<T[]>>} - Array of filtered items
      */
-    nestedFilter<T = DataValues>(nestedQuery: NestedQueryFilterI, tableNameToGetResults: string, filterOptions?: filterNestedOptionsI): Promise<TotalumApiResponse<T[]>>;
+    nestedFilter<T = DataValues>(nestedQuery: NestedQueryFilterI, tableNameToGetResults: string, filterOptions?: filterNestedOptionsI): Promise<TotalumApiResponse<any[]>>;
     /**
      * Runs a custom MongoDB aggregation query.
      * @param {string} type - The table name that will be at the top of the MongoDB aggregation

package/dist/services/FilterService.js

@@ -40,6 +40,7 @@ class FilterService {
     }
     /**
      * Filters data across nested related tables (like a SQL join).
+     * @deprecated Use `crud.query()` instead, which supports nested relations with filtering, sorting, _has, and more.
      * @param {NestedQueryFilterI} nestedQuery - The nested query to filter by
      * @param {string} tableNameToGetResults - The table that you want to get the results from
      * @param {filterNestedOptionsI} filterOptions - Extra options for the filter like pagination and sort

package/dist/services/OpenaiService.d.ts

@@ -1,5 +1,5 @@
 import { TotalumApiResponse } from "../common/interfaces";
-import { OpenAICompletionResponse, OpenAIChatCompletionResponse } from "../common/response-types";
+import { OpenAICompletionResponse, OpenAIChatCompletionResponse, ImageGenerationResponse } from "../common/response-types";
 import { FetchClient } from "../common/fetch-client";
 import { ChatCompletionCreateParamsBase } from "openai/resources/chat/completions";
 import { CompletionCreateParamsBase } from "openai/resources/completions";
@@ -20,16 +20,48 @@ export declare class OpenaiService {
      */
     createChatCompletion(body: ChatCompletionCreateParamsBase): Promise<TotalumApiResponse<OpenAIChatCompletionResponse>>;
     /**
-     * Generates an image using OpenAI DALL·E.
+     * Generates an image from scratch using OpenAI gpt-image-1.
      * @param {object} body - The image generation parameters
-     * @param {string} body.prompt - The prompt describing the image
-     * @param {'256x256' | '512x512' | '1024x1024'} body.size - The size of the generated image
-     * @param {string} body.fileName - The file name to save the image
-     * @returns {Promise<TotalumApiResponse<string>>} - The generated image filename
+     * @param {string} body.prompt - The prompt describing the image to generate
+     * @param {string} body.fileName - The file name to save the generated image
+     * @param {'1024x1024' | '1536x1024' | '1024x1536' | 'auto'} [body.size] - Image dimensions (default: 'auto')
+     * @param {'low' | 'medium' | 'high' | 'auto'} [body.quality] - Rendering quality (default: 'auto')
+     * @param {'png' | 'jpeg' | 'webp'} [body.output_format] - Output file format (default: 'png')
+     * @param {'transparent' | 'opaque' | 'auto'} [body.background] - Background transparency (default: 'auto')
+     * @returns {Promise<TotalumApiResponse<ImageGenerationResponse>>} - The generated image filename and signed URL
      */
     generateImage(body: {
         prompt: string;
-        size: '256x256' | '512x512' | '1024x1024';
         fileName: string;
-    }): Promise<TotalumApiResponse<string>>;
+        size?: '1024x1024' | '1536x1024' | '1024x1536' | 'auto';
+        quality?: 'low' | 'medium' | 'high' | 'auto';
+        output_format?: 'png' | 'jpeg' | 'webp';
+        background?: 'transparent' | 'opaque' | 'auto';
+    }): Promise<TotalumApiResponse<ImageGenerationResponse>>;
+    /**
+     * Edits or transforms existing image(s) using OpenAI gpt-image-1.
+     * Supports: editing existing images, using images as style reference, combining multiple images, masked editing.
+     * @param {object} body - The image edit parameters
+     * @param {string} body.prompt - Description of the desired edit or transformation
+     * @param {string[]} body.imageUrls - Array of image URLs to edit (1-16 images). Can be signed GCS URLs or external URLs.
+     * @param {string} body.fileName - The file name to save the resulting image
+     * @param {string} [body.maskUrl] - URL to a PNG mask image with alpha channel. Transparent areas indicate where the first image should be edited.
+     * @param {'1024x1024' | '1536x1024' | '1024x1536' | 'auto'} [body.size] - Output image dimensions (default: 'auto')
+     * @param {'low' | 'medium' | 'high' | 'auto'} [body.quality] - Rendering quality (default: 'auto')
+     * @param {'png' | 'jpeg' | 'webp'} [body.output_format] - Output file format (default: 'png')
+     * @param {'transparent' | 'opaque' | 'auto'} [body.background] - Background transparency (default: 'auto')
+     * @param {'high' | 'low'} [body.input_fidelity] - How closely to match input images. 'high' preserves details (faces), 'low' allows creative freedom (default: 'low')
+     * @returns {Promise<TotalumApiResponse<ImageGenerationResponse>>} - The resulting image filename and signed URL
+     */
+    editImage(body: {
+        prompt: string;
+        imageUrls: string[];
+        fileName: string;
+        maskUrl?: string;
+        size?: '1024x1024' | '1536x1024' | '1024x1536' | 'auto';
+        quality?: 'low' | 'medium' | 'high' | 'auto';
+        output_format?: 'png' | 'jpeg' | 'webp';
+        background?: 'transparent' | 'opaque' | 'auto';
+        input_fidelity?: 'high' | 'low';
+    }): Promise<TotalumApiResponse<ImageGenerationResponse>>;
 }

package/dist/services/OpenaiService.js

@@ -40,12 +40,15 @@ class OpenaiService {
         });
     }
     /**
-     * Generates an image using OpenAI DALL·E.
+     * Generates an image from scratch using OpenAI gpt-image-1.
      * @param {object} body - The image generation parameters
-     * @param {string} body.prompt - The prompt describing the image
-     * @param {'256x256' | '512x512' | '1024x1024'} body.size - The size of the generated image
-     * @param {string} body.fileName - The file name to save the image
-     * @returns {Promise<TotalumApiResponse<string>>} - The generated image filename
+     * @param {string} body.prompt - The prompt describing the image to generate
+     * @param {string} body.fileName - The file name to save the generated image
+     * @param {'1024x1024' | '1536x1024' | '1024x1536' | 'auto'} [body.size] - Image dimensions (default: 'auto')
+     * @param {'low' | 'medium' | 'high' | 'auto'} [body.quality] - Rendering quality (default: 'auto')
+     * @param {'png' | 'jpeg' | 'webp'} [body.output_format] - Output file format (default: 'png')
+     * @param {'transparent' | 'opaque' | 'auto'} [body.background] - Background transparency (default: 'auto')
+     * @returns {Promise<TotalumApiResponse<ImageGenerationResponse>>} - The generated image filename and signed URL
      */
     generateImage(body) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -53,5 +56,26 @@ class OpenaiService {
             return this.client.post(url, body);
         });
     }
+    /**
+     * Edits or transforms existing image(s) using OpenAI gpt-image-1.
+     * Supports: editing existing images, using images as style reference, combining multiple images, masked editing.
+     * @param {object} body - The image edit parameters
+     * @param {string} body.prompt - Description of the desired edit or transformation
+     * @param {string[]} body.imageUrls - Array of image URLs to edit (1-16 images). Can be signed GCS URLs or external URLs.
+     * @param {string} body.fileName - The file name to save the resulting image
+     * @param {string} [body.maskUrl] - URL to a PNG mask image with alpha channel. Transparent areas indicate where the first image should be edited.
+     * @param {'1024x1024' | '1536x1024' | '1024x1536' | 'auto'} [body.size] - Output image dimensions (default: 'auto')
+     * @param {'low' | 'medium' | 'high' | 'auto'} [body.quality] - Rendering quality (default: 'auto')
+     * @param {'png' | 'jpeg' | 'webp'} [body.output_format] - Output file format (default: 'png')
+     * @param {'transparent' | 'opaque' | 'auto'} [body.background] - Background transparency (default: 'auto')
+     * @param {'high' | 'low'} [body.input_fidelity] - How closely to match input images. 'high' preserves details (faces), 'low' allows creative freedom (default: 'low')
+     * @returns {Promise<TotalumApiResponse<ImageGenerationResponse>>} - The resulting image filename and signed URL
+     */
+    editImage(body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = utils_1.UtilsService.getUrl('', endpoints_1.endpoints.openai.editImage);
+            return this.client.post(url, body);
+        });
+    }
 }
 exports.OpenaiService = OpenaiService;