@revenexx/node 0.1.0 → 0.1.1

package/dist/services/io.d.ts

@@ -9,6 +9,15 @@ 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';
@@ -122,6 +131,8 @@ 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';
@@ -144,6 +155,11 @@ 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';
@@ -181,6 +197,8 @@ 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';
@@ -244,7 +262,7 @@ declare class Io {
      * @param {string} params.entity -
      * @param {number} params.limit -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      */
     listBulkJobs(params?: {
         type?: any;
@@ -253,7 +271,7 @@ declare class Io {
         app?: string;
         entity?: string;
         limit?: number;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): Promise<{}>;
     /**
      * The calling tenant's bulk jobs, newest first. Jobs are created by the
      * feature blocks (import / export / A/B swap / tenant copy / sample) —
@@ -267,10 +285,10 @@ declare class Io {
      * @param {string} entity -
      * @param {number} limit -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @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<Models.ValidationFailedResponse>;
+    listBulkJobs(type?: any, status?: any, vendor?: string, app?: string, entity?: string, limit?: number): Promise<{}>;
     /**
      * Status, row counts, and progress for one bulk job.
      *
@@ -281,11 +299,11 @@ declare class Io {
      *
      * @param {string} params.id -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<Models.BulkJob>}
      */
     getBulkJob(params: {
         id: string;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): Promise<Models.BulkJob>;
     /**
      * Status, row counts, and progress for one bulk job.
      *
@@ -296,10 +314,10 @@ declare class Io {
      *
      * @param {string} id -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<Models.BulkJob>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    getBulkJob(id: string): Promise<Models.ValidationFailedResponse>;
+    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
@@ -313,9 +331,9 @@ declare class Io {
      *
      *
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      */
-    listIoEntities(): Promise<Models.ValidationFailedResponse>;
+    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
@@ -329,7 +347,7 @@ declare class Io {
      * @param {Format} params.format -
      * @param {string} params.profileId -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      */
     createExport(params: {
         app: string;
@@ -337,7 +355,7 @@ declare class Io {
         vendor: string;
         format?: Format;
         profileId?: string;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): 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
@@ -351,10 +369,10 @@ declare class Io {
      * @param {Format} format -
      * @param {string} profileId -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @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<Models.ValidationFailedResponse>;
+    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
@@ -367,11 +385,11 @@ declare class Io {
      *
      * @param {string} params.id - The export job's id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      */
     getExportUrl(params: {
         id: string;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): 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
@@ -384,10 +402,10 @@ declare class Io {
      *
      * @param {string} id - The export job's id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    getExportUrl(id: string): Promise<Models.ValidationFailedResponse>;
+    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
@@ -410,7 +428,7 @@ unlimited (reject-and-continue); `0` = fail-fast.
 sibling for diff + switch-over instead of writing live.
 
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      */
     createImport(params: {
         app: string;
@@ -423,7 +441,7 @@ sibling for diff + switch-over instead of writing live.
         mode?: Mode;
         profileId?: string;
         target?: CreateImportTarget;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): Promise<{}>;
     /**
      * Creates a `bulk_job` and dispatches the engine to import a previously
      * uploaded object into the named entity. The engine streams CSV
@@ -446,10 +464,10 @@ unlimited (reject-and-continue); `0` = fail-fast.
 sibling for diff + switch-over instead of writing live.
 
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @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<Models.ValidationFailedResponse>;
+    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.
      *
@@ -460,9 +478,9 @@ sibling for diff + switch-over instead of writing live.
      *
      *
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      */
-    listProfiles(): Promise<Models.ValidationFailedResponse>;
+    listProfiles(): Promise<{}>;
     /**
      * A tenant-secured, reusable mapping (field rename + transforms + keys)
      * for a direction (`import`/`export`), format, and entity. Runnable
@@ -486,7 +504,7 @@ empty means global — offered for every market.
 
      * @param {object} params.options - Free-form per-profile engine options.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<Models.IoProfileResource>}
      */
     createProfile(params: {
         app: string;
@@ -499,7 +517,7 @@ empty means global — offered for every market.
         mapping?: object;
         markets?: string[];
         options?: object;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): Promise<Models.IoProfileResource>;
     /**
      * A tenant-secured, reusable mapping (field rename + transforms + keys)
      * for a direction (`import`/`export`), format, and entity. Runnable
@@ -523,10 +541,10 @@ empty means global — offered for every market.
 
      * @param {object} options - Free-form per-profile engine options.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @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.ValidationFailedResponse>;
+    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.
      *
@@ -536,11 +554,11 @@ empty means global — offered for every market.
      *
      * @param {string} params.id -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      */
     deleteProfile(params: {
         id: string;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): Promise<{}>;
     /**
      * Permanently remove a saved profile owned by the calling tenant.
      *
@@ -550,10 +568,10 @@ empty means global — offered for every market.
      *
      * @param {string} id -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    deleteProfile(id: string): Promise<Models.ValidationFailedResponse>;
+    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`.
@@ -561,11 +579,11 @@ empty means global — offered for every market.
      *
      * @param {string} params.id -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<Models.IoProfileResource>}
      */
     showProfile(params: {
         id: string;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): 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`.
@@ -573,10 +591,10 @@ empty means global — offered for every market.
      *
      * @param {string} id -
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<Models.IoProfileResource>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    showProfile(id: string): Promise<Models.ValidationFailedResponse>;
+    showProfile(id: string): Promise<Models.IoProfileResource>;
     /**
      * Replace a saved profile's mapping, format, or apply mode (tenant-scoped).
      *
@@ -598,7 +616,7 @@ empty means global — offered for every market.
 
      * @param {object} params.options - Free-form per-profile engine options.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<Models.IoProfileResource>}
      */
     updateProfile(params: {
         id: string;
@@ -612,7 +630,7 @@ empty means global — offered for every market.
         mapping?: object;
         markets?: string[];
         options?: object;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): Promise<Models.IoProfileResource>;
     /**
      * Replace a saved profile's mapping, format, or apply mode (tenant-scoped).
      *
@@ -634,10 +652,10 @@ empty means global — offered for every market.
 
      * @param {object} options - Free-form per-profile engine options.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @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.ValidationFailedResponse>;
+    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.
@@ -654,13 +672,13 @@ key. Omitting it on an import answers `422` with
 `RUN_NO_OBJECT`.
 
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      */
     runProfile(params: {
         id: string;
         markets?: string[];
         objectKey?: string;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): Promise<{}>;
     /**
      * Dispatches the engine using the saved profile. An import run requires
      * `object_key` (upload first); an export run writes a generated key.
@@ -677,10 +695,10 @@ key. Omitting it on an import answers `422` with
 `RUN_NO_OBJECT`.
 
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    runProfile(id: string, markets?: string[], objectKey?: string): Promise<Models.ValidationFailedResponse>;
+    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
@@ -690,11 +708,11 @@ key. Omitting it on an import answers `422` with
      *
      * @param {string} params.extension - File extension for the generated key.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      */
     createUpload(params?: {
         extension?: string;
-    }): Promise<Models.ValidationFailedResponse>;
+    }): Promise<{}>;
     /**
      * Returns a short-lived signed S3 `PUT` URL (+ required headers) and
      * the `object_key` to reference in a subsequent `/io/imports`. The
@@ -704,10 +722,10 @@ key. Omitting it on an import answers `422` with
      *
      * @param {string} extension - File extension for the generated key.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.ValidationFailedResponse>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createUpload(extension?: string): Promise<Models.ValidationFailedResponse>;
+    createUpload(extension?: string): Promise<{}>;
 }
 
 export { Io };

package/dist/services/io.js

@@ -92,7 +92,7 @@ class Io {
    * 
    *
    * @throws {RevenexxException}
-   * @returns {Promise<Models.ValidationFailedResponse>}
+   * @returns {Promise<{}>}
    */
   listIoEntities() {
     const apiPath = "/v1/io/entities";
@@ -278,7 +278,7 @@ class Io {
    * 
    *
    * @throws {RevenexxException}
-   * @returns {Promise<Models.ValidationFailedResponse>}
+   * @returns {Promise<{}>}
    */
   listProfiles() {
     const apiPath = "/v1/io/profiles";