@revenexx/node 0.0.2 → 0.1.1

package/dist/services/io.d.ts

@@ -0,0 +1,731 @@
+import { Client } from '../client.js';
+import { Models } from '../models.js';
+import { Format } from '../enums/format.js';
+import { Mode } from '../enums/mode.js';
+import { CreateImportTarget } from '../enums/create-import-target.js';
+import { Direction } from '../enums/direction.js';
+import { ApplyMode } from '../enums/apply-mode.js';
+import '../query.js';
+import '../enums/address-type-row-tone.js';
+import '../enums/address-type-row-create-request-tone.js';
+import '../enums/address-type-row-update-request-tone.js';
+import '../enums/approval-rule-approver-type.js';
+import '../enums/approval-rule-condition.js';
+import '../enums/approval-rule-effect.js';
+import '../enums/approval-rule-create-request-approver-type.js';
+import '../enums/approval-rule-create-request-condition.js';
+import '../enums/approval-rule-create-request-effect.js';
+import '../enums/approval-rule-update-request-approver-type.js';
+import '../enums/approval-rule-update-request-condition.js';
+import '../enums/approval-rule-update-request-effect.js';
+import '../enums/assets-source.js';
+import '../enums/attribute-value-bucket.js';
+import '../enums/auth-mail-source.js';
+import '../enums/recovery-mail-source.js';
+import '../enums/registration-status.js';
+import '../enums/budget-change-reason.js';
+import '../enums/budget-movement-result-status.js';
+import '../enums/cart-status.js';
+import '../enums/cart-merge-strategy.js';
+import '../enums/cart-price-snapshot-mode.js';
+import '../enums/cart-io-format.js';
+import '../enums/cart-export-format.js';
+import '../enums/cart-item-type.js';
+import '../enums/cart-vocabulary-tone.js';
+import '../enums/cart-vocabulary-name.js';
+import '../enums/cart-vocabulary-source.js';
+import '../enums/cart-vocabulary-ref-name.js';
+import '../enums/categories-rule-match.js';
+import '../enums/category-rule-operator.js';
+import '../enums/category-rule-match.js';
+import '../enums/channel-status.js';
+import '../enums/channel-unassigned-visibility.js';
+import '../enums/channel-unresolved-reason.js';
+import '../enums/channel-context-source.js';
+import '../enums/channel-inactive-behavior.js';
+import '../enums/channel-policy-source.js';
+import '../enums/channel-policy-tenant-default.js';
+import '../enums/channel-unassigned-policy.js';
+import '../enums/channel-type-tone.js';
+import '../enums/channel-visibility-reason.js';
+import '../enums/channel-vocabulary-tone.js';
+import '../enums/channel-vocabulary-name.js';
+import '../enums/channel-vocabulary-source.js';
+import '../enums/channel-vocabulary-ref-name.js';
+import '../enums/contact-registration-status.js';
+import '../enums/contact-status.js';
+import '../enums/contact-activity-kind.js';
+import '../enums/contact-create-request-registration-status.js';
+import '../enums/contact-event-kind-tone.js';
+import '../enums/contact-event-kind-create-request-tone.js';
+import '../enums/contact-event-kind-update-request-tone.js';
+import '../enums/contact-update-request-registration-status.js';
+import '../enums/cost-center-budget-type.js';
+import '../enums/cost-center-restriction-type.js';
+import '../enums/cost-center-restriction-create-request-type.js';
+import '../enums/cost-center-restriction-update-request-type.js';
+import '../enums/payment-fee-type.js';
+import '../enums/payment-method-kind.js';
+import '../enums/form-status.js';
+import '../enums/form-submission-status.js';
+import '../enums/form-notify-source.js';
+import '../enums/form-submission-prune-request-status.js';
+import '../enums/forms-vocabulary-tone.js';
+import '../enums/forms-vocabulary-name.js';
+import '../enums/forms-vocabulary-summary-name.js';
+import '../enums/inventory-vocabulary-default-tone.js';
+import '../enums/inventory-vocabulary-source.js';
+import '../enums/cart-io-apply-mode.js';
+import '../enums/cart-io-direction.js';
+import '../enums/cart-io-entity.js';
+import '../enums/io-profile-resource-apply-mode.js';
+import '../enums/io-profile-resource-direction.js';
+import '../enums/lifecycle-stage-tone.js';
+import '../enums/lifecycle-stage-create-request-tone.js';
+import '../enums/lifecycle-stage-update-request-tone.js';
+import '../enums/location-type.js';
+import '../enums/market-status.js';
+import '../enums/market-default-locale-source.js';
+import '../enums/market-locale-fallback.js';
+import '../enums/market-locale-granularity.js';
+import '../enums/market-pricing-source.js';
+import '../enums/market-tax-basis.js';
+import '../enums/market-readiness-check-id.js';
+import '../enums/market-readiness-severity.js';
+import '../enums/markets-vocabulary-tone.js';
+import '../enums/markets-vocabulary-name.js';
+import '../enums/markets-vocabulary-source.js';
+import '../enums/markets-vocabulary-summary-name.js';
+import '../enums/order-fulfillment-status.js';
+import '../enums/order-payment-status.js';
+import '../enums/order-status.js';
+import '../enums/order-cancellation-scope.js';
+import '../enums/order-comment-visibility.js';
+import '../enums/order-item-type.js';
+import '../enums/order-list-kind-tone.js';
+import '../enums/order-list-kind-row-tone.js';
+import '../enums/order-list-cart-mode.js';
+import '../enums/order-list-vocabulary-default-tone.js';
+import '../enums/order-list-vocabulary-name.js';
+import '../enums/order-list-vocabulary-source.js';
+import '../enums/order-list-vocabulary-tone.js';
+import '../enums/order-return-status.js';
+import '../enums/order-return-settlement.js';
+import '../enums/order-return-refusal.js';
+import '../enums/order-vocabulary-tone.js';
+import '../enums/order-vocabulary-name.js';
+import '../enums/order-vocabulary-source.js';
+import '../enums/order-vocabulary-summary-name.js';
+import '../enums/order-resolution-stage.js';
+import '../enums/organization-status.js';
+import '../enums/page-status.js';
+import '../enums/pages-vocabulary-app.js';
+import '../enums/pages-vocabulary-tone.js';
+import '../enums/pages-vocabulary-name.js';
+import '../enums/pages-vocabulary-source.js';
+import '../enums/pages-vocabulary-index-app.js';
+import '../enums/payment-dunning-stage.js';
+import '../enums/payment-failure-code.js';
+import '../enums/payment-status.js';
+import '../enums/payment-term-tone.js';
+import '../enums/payment-term-create-request-tone.js';
+import '../enums/payment-term-update-request-tone.js';
+import '../enums/payment-vocabulary-tone.js';
+import '../enums/pending-approval-approver-type.js';
+import '../enums/pending-approval-status.js';
+import '../enums/price-ending-rule.js';
+import '../enums/price-entries-adjust-response-rounding.js';
+import '../enums/price-entries-adjust-response-rounding-mode.js';
+import '../enums/price-entries-bulk-mode.js';
+import '../enums/price-rounding-mode.js';
+import '../enums/price-entry-type.js';
+import '../enums/price-list-status.js';
+import '../enums/price-list-tax-basis.js';
+import '../enums/price-currency-source.js';
+import '../enums/price-list-tiebreak.js';
+import '../enums/price-tax-inclusive-default.js';
+import '../enums/price-tax-unresolved-reason.js';
+import '../enums/price-tax-market-source.js';
+import '../enums/price-vocabulary-tone.js';
+import '../enums/price-vocabulary-name.js';
+import '../enums/price-vocabulary-source.js';
+import '../enums/price-vocabulary-ref-name.js';
+import '../enums/product-categories-source.js';
+import '../enums/product-grid-column-source.js';
+import '../enums/product-label-source.js';
+import '../enums/product-label-attribute-source.js';
+import '../enums/products-kind.js';
+import '../enums/purchase-request-status.js';
+import '../enums/purchase-request-event-name.js';
+import '../enums/purchase-request-item-type.js';
+import '../enums/purchase-request-item-create-request-type.js';
+import '../enums/purchase-request-item-update-request-type.js';
+import '../enums/reorder-point-source.js';
+import '../enums/reservation-status.js';
+import '../enums/price-on-request-reason.js';
+import '../enums/price-tax-basis.js';
+import '../enums/price-tax-basis-source.js';
+import '../enums/role-catalog-response-source.js';
+import '../enums/segment-rule-match.js';
+import '../enums/segment-member-source.js';
+import '../enums/segment-rule-operator.js';
+import '../enums/segment-rule-preview-request-rule-match.js';
+import '../enums/segment-rule-preview-request-target.js';
+import '../enums/segment-rule-preview-response-rule-match.js';
+import '../enums/segment-rule-preview-response-target.js';
+import '../enums/segment-rules-target.js';
+import '../enums/shipping-carrier-status.js';
+import '../enums/shipping-method-matrix-basis.js';
+import '../enums/shipping-method-pricing-type.js';
+import '../enums/shipping-carrier-source.js';
+import '../enums/shipping-rate-pricing-type.js';
+import '../enums/shipping-tax-source.js';
+import '../enums/shipping-free-above-basis.js';
+import '../enums/shipping-rates-basis-matrix-basis-default.js';
+import '../enums/shipping-service-level-create-request-tone.js';
+import '../enums/shipping-service-level-row-tone.js';
+import '../enums/shipping-service-level-update-request-tone.js';
+import '../enums/shipping-tax-unresolved-reason.js';
+import '../enums/shipping-tax-market-source.js';
+import '../enums/shipping-tax-context-via.js';
+import '../enums/shipping-tracking-carrier-status.js';
+import '../enums/shipping-vocabulary-default-tone.js';
+import '../enums/shipping-vocabulary-source.js';
+import '../enums/shipping-vocabulary-tone.js';
+import '../enums/shipping-weight-unit-create-request-tone.js';
+import '../enums/shipping-weight-unit-row-tone.js';
+import '../enums/shipping-weight-unit-update-request-tone.js';
+import '../enums/stock-movement-type.js';
+import '../enums/store-asset-request-visibility.js';
+import '../enums/submit-item-type.js';
+import '../enums/submit-result-outcome.js';
+import '../enums/validation-failed-response-status.js';
+import '../enums/vocabulary-default-tone.js';
+import '../enums/vocabulary-source.js';
+import '../enums/vocabulary-tone.js';
+import '../enums/attribute-boolean-status.js';
+import '../enums/attribute-datetime-status.js';
+import '../enums/attribute-email-status.js';
+import '../enums/attribute-enum-status.js';
+import '../enums/attribute-float-status.js';
+import '../enums/attribute-integer-status.js';
+import '../enums/attribute-ip-status.js';
+import '../enums/attribute-line-status.js';
+import '../enums/attribute-longtext-status.js';
+import '../enums/attribute-mediumtext-status.js';
+import '../enums/attribute-point-status.js';
+import '../enums/attribute-polygon-status.js';
+import '../enums/attribute-relationship-status.js';
+import '../enums/attribute-string-status.js';
+import '../enums/attribute-text-status.js';
+import '../enums/attribute-url-status.js';
+import '../enums/attribute-varchar-status.js';
+import '../enums/column-boolean-status.js';
+import '../enums/column-datetime-status.js';
+import '../enums/column-email-status.js';
+import '../enums/column-enum-status.js';
+import '../enums/column-float-status.js';
+import '../enums/column-integer-status.js';
+import '../enums/column-ip-status.js';
+import '../enums/column-line-status.js';
+import '../enums/column-longtext-status.js';
+import '../enums/column-mediumtext-status.js';
+import '../enums/column-point-status.js';
+import '../enums/column-polygon-status.js';
+import '../enums/column-relationship-status.js';
+import '../enums/column-string-status.js';
+import '../enums/column-text-status.js';
+import '../enums/column-url-status.js';
+import '../enums/column-varchar-status.js';
+import '../enums/database-type.js';
+import '../enums/deployment-status.js';
+import '../enums/execution-status.js';
+import '../enums/execution-trigger.js';
+import '../enums/health-antivirus-status.js';
+import '../enums/health-status-status.js';
+import '../enums/index-status.js';
+import '../enums/message-2-status.js';
+
+declare class Io {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * The calling tenant's bulk jobs, newest first. Jobs are created by the
+     * feature blocks (import / export / A/B swap / tenant copy / sample) —
+     * never here; this surface is read-only.
+     *
+     *
+     * @param {any} params.type -
+     * @param {any} params.status -
+     * @param {string} params.vendor -
+     * @param {string} params.app -
+     * @param {string} params.entity -
+     * @param {number} params.limit -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    listBulkJobs(params?: {
+        type?: any;
+        status?: any;
+        vendor?: string;
+        app?: string;
+        entity?: string;
+        limit?: number;
+    }): Promise<{}>;
+    /**
+     * The calling tenant's bulk jobs, newest first. Jobs are created by the
+     * feature blocks (import / export / A/B swap / tenant copy / sample) —
+     * never here; this surface is read-only.
+     *
+     *
+     * @param {any} type -
+     * @param {any} status -
+     * @param {string} vendor -
+     * @param {string} app -
+     * @param {string} entity -
+     * @param {number} limit -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listBulkJobs(type?: any, status?: any, vendor?: string, app?: string, entity?: string, limit?: number): Promise<{}>;
+    /**
+     * Status, row counts, and progress for one bulk job.
+     *
+     * Tenant-scoped: an id belonging to another tenant is filtered out and
+     * is therefore indistinguishable from a non-existent one — which is the
+     * intent.
+     *
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.BulkJob>}
+     */
+    getBulkJob(params: {
+        id: string;
+    }): Promise<Models.BulkJob>;
+    /**
+     * Status, row counts, and progress for one bulk job.
+     *
+     * Tenant-scoped: an id belonging to another tenant is filtered out and
+     * is therefore indistinguishable from a non-existent one — which is the
+     * intent.
+     *
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.BulkJob>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getBulkJob(id: string): Promise<Models.BulkJob>;
+    /**
+     * Flat list of the entities the calling tenant's installed apps expose,
+     * sorted by vendor, app, entity. Feeds the entity pickers of the
+     * Integration Studio I/O nodes.
+     *
+     * The app set comes from `baseline.tenant_app_versions`. Per app the
+     * entity list is resolved from the tenant's pinned schema version; when
+     * that pointer is stale (missing or not applied) it falls back to the
+     * latest applied version of `(vendor, app)`. Apps with no applied
+     * schema at all contribute no entities.
+     *
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    listIoEntities(): Promise<{}>;
+    /**
+     * Creates a `bulk_job` and dispatches the engine to export the tenant's
+     * rows for an entity. CSV/XML stream row-by-row into an S3 multipart
+     * upload (flat RAM); JSON/XLSX are buffered. The response carries the
+     * object key the result will be written to.
+     *
+     *
+     * @param {string} params.app -
+     * @param {string} params.entity -
+     * @param {string} params.vendor -
+     * @param {Format} params.format -
+     * @param {string} params.profileId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    createExport(params: {
+        app: string;
+        entity: string;
+        vendor: string;
+        format?: Format;
+        profileId?: string;
+    }): Promise<{}>;
+    /**
+     * Creates a `bulk_job` and dispatches the engine to export the tenant's
+     * rows for an entity. CSV/XML stream row-by-row into an S3 multipart
+     * upload (flat RAM); JSON/XLSX are buffered. The response carries the
+     * object key the result will be written to.
+     *
+     *
+     * @param {string} app -
+     * @param {string} entity -
+     * @param {string} vendor -
+     * @param {Format} format -
+     * @param {string} profileId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createExport(app: string, entity: string, vendor: string, format?: Format, profileId?: string): Promise<{}>;
+    /**
+     * Mints a short-TTL signed S3 `GET` URL for the object a completed
+     * export wrote. Tenant-scoped: an id belonging to another tenant — or
+     * to a job that is not an export — is indistinguishable from a
+     * non-existent one and answers `404`.
+     *
+     * The job must have reached `completed` or `partial`; any earlier
+     * state answers `409` and carries the current `job_status`.
+     *
+     *
+     * @param {string} params.id - The export job's id.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    getExportUrl(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     * Mints a short-TTL signed S3 `GET` URL for the object a completed
+     * export wrote. Tenant-scoped: an id belonging to another tenant — or
+     * to a job that is not an export — is indistinguishable from a
+     * non-existent one and answers `404`.
+     *
+     * The job must have reached `completed` or `partial`; any earlier
+     * state answers `409` and carries the current `job_status`.
+     *
+     *
+     * @param {string} id - The export job's id.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getExportUrl(id: string): Promise<{}>;
+    /**
+     * Creates a `bulk_job` and dispatches the engine to import a previously
+     * uploaded object into the named entity. The engine streams CSV
+     * row-by-row (flat RAM at 1M+ rows) and COPYs into the entity's staging
+     * sibling before a merge / content-hash delta into the target.
+     *
+     *
+     * @param {string} params.app -
+     * @param {string} params.entity -
+     * @param {string} params.objectKey -
+     * @param {string} params.vendor -
+     * @param {Format} params.format -
+     * @param {string[]} params.keys - Natural-key columns for upsert / delta.
+     * @param {number} params.maxRejects - Rejected rows tolerated before the import fails. Omit for
+unlimited (reject-and-continue); `0` = fail-fast.
+
+     * @param {Mode} params.mode -
+     * @param {string} params.profileId -
+     * @param {CreateImportTarget} params.target - `shadow` stages the dataset into the A/B `{table}__shadow`
+sibling for diff + switch-over instead of writing live.
+
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    createImport(params: {
+        app: string;
+        entity: string;
+        objectKey: string;
+        vendor: string;
+        format?: Format;
+        keys?: string[];
+        maxRejects?: number;
+        mode?: Mode;
+        profileId?: string;
+        target?: CreateImportTarget;
+    }): Promise<{}>;
+    /**
+     * Creates a `bulk_job` and dispatches the engine to import a previously
+     * uploaded object into the named entity. The engine streams CSV
+     * row-by-row (flat RAM at 1M+ rows) and COPYs into the entity's staging
+     * sibling before a merge / content-hash delta into the target.
+     *
+     *
+     * @param {string} app -
+     * @param {string} entity -
+     * @param {string} objectKey -
+     * @param {string} vendor -
+     * @param {Format} format -
+     * @param {string[]} keys - Natural-key columns for upsert / delta.
+     * @param {number} maxRejects - Rejected rows tolerated before the import fails. Omit for
+unlimited (reject-and-continue); `0` = fail-fast.
+
+     * @param {Mode} mode -
+     * @param {string} profileId -
+     * @param {CreateImportTarget} target - `shadow` stages the dataset into the A/B `{table}__shadow`
+sibling for diff + switch-over instead of writing live.
+
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createImport(app: string, entity: string, objectKey: string, vendor: string, format?: Format, keys?: string[], maxRejects?: number, mode?: Mode, profileId?: string, target?: CreateImportTarget): Promise<{}>;
+    /**
+     * The calling tenant's saved profiles, ordered by name.
+     *
+     * When `X-Revenexx-Market` is present the listing is filtered to the
+     * profiles offered for that market — global profiles (`markets: null`)
+     * plus those whose `markets` contain it. Omit the header to get every
+     * profile, which is what the management view wants.
+     *
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    listProfiles(): Promise<{}>;
+    /**
+     * A tenant-secured, reusable mapping (field rename + transforms + keys)
+     * for a direction (`import`/`export`), format, and entity. Runnable
+     * on-click via `/io/profiles/{id}/run`.
+     *
+     *
+     * @param {string} params.app -
+     * @param {Direction} params.direction -
+     * @param {string} params.entity -
+     * @param {string} params.format -
+     * @param {string} params.name -
+     * @param {string} params.vendor -
+     * @param {ApplyMode} params.applyMode -
+     * @param {object} params.mapping - Field mapping. `fields[]` carry `target` (DB column),
+`source` (external name) and ordered `transforms`; `keys[]`
+are natural-key columns. Optional `max_rejects`/`target`
+ride along for import runs.
+
+     * @param {string[]} params.markets - Markets this profile applies to (n:m). Omitted, `null` or
+empty means global — offered for every market.
+
+     * @param {object} params.options - Free-form per-profile engine options.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.IoProfileResource>}
+     */
+    createProfile(params: {
+        app: string;
+        direction: Direction;
+        entity: string;
+        format: string;
+        name: string;
+        vendor: string;
+        applyMode?: ApplyMode;
+        mapping?: object;
+        markets?: string[];
+        options?: object;
+    }): Promise<Models.IoProfileResource>;
+    /**
+     * A tenant-secured, reusable mapping (field rename + transforms + keys)
+     * for a direction (`import`/`export`), format, and entity. Runnable
+     * on-click via `/io/profiles/{id}/run`.
+     *
+     *
+     * @param {string} app -
+     * @param {Direction} direction -
+     * @param {string} entity -
+     * @param {string} format -
+     * @param {string} name -
+     * @param {string} vendor -
+     * @param {ApplyMode} applyMode -
+     * @param {object} mapping - Field mapping. `fields[]` carry `target` (DB column),
+`source` (external name) and ordered `transforms`; `keys[]`
+are natural-key columns. Optional `max_rejects`/`target`
+ride along for import runs.
+
+     * @param {string[]} markets - Markets this profile applies to (n:m). Omitted, `null` or
+empty means global — offered for every market.
+
+     * @param {object} options - Free-form per-profile engine options.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.IoProfileResource>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createProfile(app: string, direction: Direction, entity: string, format: string, name: string, vendor: string, applyMode?: ApplyMode, mapping?: object, markets?: string[], options?: object): Promise<Models.IoProfileResource>;
+    /**
+     * Permanently remove a saved profile owned by the calling tenant.
+     *
+     * Idempotent, and deliberately not a `404` path: deleting an id that
+     * does not belong to the tenant still answers `200`, with `deleted: 0`.
+     *
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    deleteProfile(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     * Permanently remove a saved profile owned by the calling tenant.
+     *
+     * Idempotent, and deliberately not a `404` path: deleting an id that
+     * does not belong to the tenant still answers `200`, with `deleted: 0`.
+     *
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteProfile(id: string): Promise<{}>;
+    /**
+     * A single saved profile. Tenant-scoped: an id owned by another tenant
+     * is indistinguishable from a non-existent one and answers `404`.
+     *
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.IoProfileResource>}
+     */
+    showProfile(params: {
+        id: string;
+    }): Promise<Models.IoProfileResource>;
+    /**
+     * A single saved profile. Tenant-scoped: an id owned by another tenant
+     * is indistinguishable from a non-existent one and answers `404`.
+     *
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.IoProfileResource>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    showProfile(id: string): Promise<Models.IoProfileResource>;
+    /**
+     * Replace a saved profile's mapping, format, or apply mode (tenant-scoped).
+     *
+     * @param {string} params.id -
+     * @param {string} params.app -
+     * @param {Direction} params.direction -
+     * @param {string} params.entity -
+     * @param {string} params.format -
+     * @param {string} params.name -
+     * @param {string} params.vendor -
+     * @param {ApplyMode} params.applyMode -
+     * @param {object} params.mapping - Field mapping. `fields[]` carry `target` (DB column),
+`source` (external name) and ordered `transforms`; `keys[]`
+are natural-key columns. Optional `max_rejects`/`target`
+ride along for import runs.
+
+     * @param {string[]} params.markets - Markets this profile applies to (n:m). Omitted, `null` or
+empty means global — offered for every market.
+
+     * @param {object} params.options - Free-form per-profile engine options.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.IoProfileResource>}
+     */
+    updateProfile(params: {
+        id: string;
+        app: string;
+        direction: Direction;
+        entity: string;
+        format: string;
+        name: string;
+        vendor: string;
+        applyMode?: ApplyMode;
+        mapping?: object;
+        markets?: string[];
+        options?: object;
+    }): Promise<Models.IoProfileResource>;
+    /**
+     * Replace a saved profile's mapping, format, or apply mode (tenant-scoped).
+     *
+     * @param {string} id -
+     * @param {string} app -
+     * @param {Direction} direction -
+     * @param {string} entity -
+     * @param {string} format -
+     * @param {string} name -
+     * @param {string} vendor -
+     * @param {ApplyMode} applyMode -
+     * @param {object} mapping - Field mapping. `fields[]` carry `target` (DB column),
+`source` (external name) and ordered `transforms`; `keys[]`
+are natural-key columns. Optional `max_rejects`/`target`
+ride along for import runs.
+
+     * @param {string[]} markets - Markets this profile applies to (n:m). Omitted, `null` or
+empty means global — offered for every market.
+
+     * @param {object} options - Free-form per-profile engine options.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.IoProfileResource>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateProfile(id: string, app: string, direction: Direction, entity: string, format: string, name: string, vendor: string, applyMode?: ApplyMode, mapping?: object, markets?: string[], options?: object): Promise<Models.IoProfileResource>;
+    /**
+     * Dispatches the engine using the saved profile. An import run requires
+     * `object_key` (upload first); an export run writes a generated key.
+     *
+     *
+     * @param {string} params.id -
+     * @param {string[]} params.markets - Target market(s) the imported rows are assigned to (n:m).
+Overrides the profile's own `markets` for this run; an
+empty array means global (no assignment).
+
+     * @param {string} params.objectKey - The uploaded object to import. Required for an import
+run; ignored for an export run, which generates its own
+key. Omitting it on an import answers `422` with
+`RUN_NO_OBJECT`.
+
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    runProfile(params: {
+        id: string;
+        markets?: string[];
+        objectKey?: string;
+    }): Promise<{}>;
+    /**
+     * Dispatches the engine using the saved profile. An import run requires
+     * `object_key` (upload first); an export run writes a generated key.
+     *
+     *
+     * @param {string} id -
+     * @param {string[]} markets - Target market(s) the imported rows are assigned to (n:m).
+Overrides the profile's own `markets` for this run; an
+empty array means global (no assignment).
+
+     * @param {string} objectKey - The uploaded object to import. Required for an import
+run; ignored for an export run, which generates its own
+key. Omitting it on an import answers `422` with
+`RUN_NO_OBJECT`.
+
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    runProfile(id: string, markets?: string[], objectKey?: string): Promise<{}>;
+    /**
+     * Returns a short-lived signed S3 `PUT` URL (+ required headers) and
+     * the `object_key` to reference in a subsequent `/io/imports`. The
+     * client uploads bytes directly to object storage — never through
+     * Baseline.
+     *
+     *
+     * @param {string} params.extension - File extension for the generated key.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    createUpload(params?: {
+        extension?: string;
+    }): Promise<{}>;
+    /**
+     * Returns a short-lived signed S3 `PUT` URL (+ required headers) and
+     * the `object_key` to reference in a subsequent `/io/imports`. The
+     * client uploads bytes directly to object storage — never through
+     * Baseline.
+     *
+     *
+     * @param {string} extension - File extension for the generated key.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createUpload(extension?: string): Promise<{}>;
+}
+
+export { Io };