@revenexx/node 0.4.0 → 0.5.0

package/dist/services/products-data-model.d.mts

@@ -385,6 +385,7 @@ import '../enums/procurement-vocabulary-summary-name.mjs';
 import '../enums/procurement-vocabulary-value-tone.mjs';
 import '../enums/product-categories-source.mjs';
 import '../enums/product-channels-assign-request-mode.mjs';
+import '../enums/product-defaults-result-reason.mjs';
 import '../enums/product-grid-column-source.mjs';
 import '../enums/product-label-source.mjs';
 import '../enums/product-label-attribute-source.mjs';
@@ -1828,6 +1829,25 @@ declare class ProductsDataModel {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     productsAttributesUpdate(id: string, active?: boolean, code?: string, config?: object, entityRef?: string, entityType?: string, externalId?: string, externalRefs?: object, groupId?: string, isFilterable?: boolean, isUnique?: boolean, labels?: object, localizable?: boolean, metadata?: object, position?: number, scopable?: boolean, sourceData?: object, sourceSyncedAt?: string, type?: string, usableInGrid?: boolean, validation?: object): Promise<Models.Attributes>;
+    /**
+     * Creates the smallest catalog model a tenant can work with, for a tenant that has none: the product attributes `name` (text, localizable), `description` (textarea, localizable) and `images` (asset_collection), and the family `standard` („Standard“) carrying the three, with `name` as its label attribute and required, and `images` as its image attribute. It writes only into a tenant without any attribute or family — the rows an earlier run of this call wrote excepted, so a run that stopped half-way is finished by the next. A tenant with one attribute or family of its own is answered `seeded: false` with `reason: not_empty` and nothing is written. Idempotent: a second run writes nothing. The model is founded without a market. The install announcement runs the same seeding, but it is not reliably delivered, so support can call this for an existing empty tenant.
+     *
+     * @param {object} params.data - Request body
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ProductDefaultsResult>}
+     */
+    productsDefaultsRun(params: {
+        data: object;
+    }): Promise<Models.ProductDefaultsResult>;
+    /**
+     * Creates the smallest catalog model a tenant can work with, for a tenant that has none: the product attributes `name` (text, localizable), `description` (textarea, localizable) and `images` (asset_collection), and the family `standard` („Standard“) carrying the three, with `name` as its label attribute and required, and `images` as its image attribute. It writes only into a tenant without any attribute or family — the rows an earlier run of this call wrote excepted, so a run that stopped half-way is finished by the next. A tenant with one attribute or family of its own is answered `seeded: false` with `reason: not_empty` and nothing is written. Idempotent: a second run writes nothing. The model is founded without a market. The install announcement runs the same seeding, but it is not reliably delivered, so support can call this for an existing empty tenant.
+     *
+     * @param {object} data - Request body
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ProductDefaultsResult>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    productsDefaultsRun(data: object): Promise<Models.ProductDefaultsResult>;
     /**
      * A family decides WHICH attributes a product has — the set is `family_attributes`, and every family-driven surface follows from it. It also names which attribute carries the display name (`label_attribute`) and which carries the main image. A product with no family has no required attributes at all, so its completeness cannot be measured and its name never resolves past the SKU; `POST /products/{id}/family` is the call that ends that state.
      *

package/dist/services/products-data-model.d.ts

@@ -385,6 +385,7 @@ import '../enums/procurement-vocabulary-summary-name.js';
 import '../enums/procurement-vocabulary-value-tone.js';
 import '../enums/product-categories-source.js';
 import '../enums/product-channels-assign-request-mode.js';
+import '../enums/product-defaults-result-reason.js';
 import '../enums/product-grid-column-source.js';
 import '../enums/product-label-source.js';
 import '../enums/product-label-attribute-source.js';
@@ -1828,6 +1829,25 @@ declare class ProductsDataModel {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     productsAttributesUpdate(id: string, active?: boolean, code?: string, config?: object, entityRef?: string, entityType?: string, externalId?: string, externalRefs?: object, groupId?: string, isFilterable?: boolean, isUnique?: boolean, labels?: object, localizable?: boolean, metadata?: object, position?: number, scopable?: boolean, sourceData?: object, sourceSyncedAt?: string, type?: string, usableInGrid?: boolean, validation?: object): Promise<Models.Attributes>;
+    /**
+     * Creates the smallest catalog model a tenant can work with, for a tenant that has none: the product attributes `name` (text, localizable), `description` (textarea, localizable) and `images` (asset_collection), and the family `standard` („Standard“) carrying the three, with `name` as its label attribute and required, and `images` as its image attribute. It writes only into a tenant without any attribute or family — the rows an earlier run of this call wrote excepted, so a run that stopped half-way is finished by the next. A tenant with one attribute or family of its own is answered `seeded: false` with `reason: not_empty` and nothing is written. Idempotent: a second run writes nothing. The model is founded without a market. The install announcement runs the same seeding, but it is not reliably delivered, so support can call this for an existing empty tenant.
+     *
+     * @param {object} params.data - Request body
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ProductDefaultsResult>}
+     */
+    productsDefaultsRun(params: {
+        data: object;
+    }): Promise<Models.ProductDefaultsResult>;
+    /**
+     * Creates the smallest catalog model a tenant can work with, for a tenant that has none: the product attributes `name` (text, localizable), `description` (textarea, localizable) and `images` (asset_collection), and the family `standard` („Standard“) carrying the three, with `name` as its label attribute and required, and `images` as its image attribute. It writes only into a tenant without any attribute or family — the rows an earlier run of this call wrote excepted, so a run that stopped half-way is finished by the next. A tenant with one attribute or family of its own is answered `seeded: false` with `reason: not_empty` and nothing is written. Idempotent: a second run writes nothing. The model is founded without a market. The install announcement runs the same seeding, but it is not reliably delivered, so support can call this for an existing empty tenant.
+     *
+     * @param {object} data - Request body
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ProductDefaultsResult>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    productsDefaultsRun(data: object): Promise<Models.ProductDefaultsResult>;
     /**
      * A family decides WHICH attributes a product has — the set is `family_attributes`, and every family-driven surface follows from it. It also names which attribute carries the display name (`label_attribute`) and which carries the main image. A product with no family has no required attributes at all, so its completeness cannot be measured and its name never resolves past the SKU; `POST /products/{id}/family` is the call that ends that state.
      *

package/dist/services/products-data-model.js

@@ -1536,6 +1536,35 @@ class ProductsDataModel {
       apiPayload
     );
   }
+  productsDefaultsRun(paramsOrFirst) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst) && "data" in paramsOrFirst) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        data: paramsOrFirst
+      };
+    }
+    const data = params.data;
+    if (typeof data === "undefined") {
+      throw new client.RevenexxException('Missing required parameter: "data"');
+    }
+    const apiPath = "/v1/products/defaults";
+    const apiPayload = {};
+    if (typeof data !== "undefined") {
+      Object.assign(apiPayload, data);
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "post",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
   productsFamiliesList(paramsOrFirst, ...rest) {
     let params;
     if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {