@djust-b2b/djust-front-sdk 1.29.3 → 2.0.0

package/lib/index.d.ts

@@ -1,6 +1,9 @@
 export declare const DjustSDK: {
     initialize: (initConfig: import("./settings/fetch-instance").ClientConfig) => void;
     updateConfiguration: (newConfig: Partial<import("./settings/fetch-instance").ClientConfig>) => void;
+    getPaginatedOfferInventories({ page, size, sort, productStatus, offerInventoryStatus, variantStatus, offerPriceStatus, supplierId, offersIds, offerPriceIds, currency, hasStock, idType, }: import("./services/offer-inventories/definitions").GetPaginatedOfferInventoriesParameters): Promise<import("./services/offer-inventories/definitions").GetOfferInventoriesResponse>;
+    getPaginatedOfferInventoriesV2({ page, size, sort, variantExternalId, }: import("./services/offer-inventories/definitions").GetPaginatedOfferInventoriesV2Parameters): Promise<import("./services/offer-inventories/definitions").GetOfferInventoriesV2Response>;
+    getOfferInventoryCustomFields({ externalId, page, size, sort, locale, }: import("./services/offer-inventories/definitions").GetOfferInventoryCustomFieldsParameters): Promise<import("./services/offer-inventories/definitions").GetOfferInventoryCustomFieldsResponse>;
     getIncidents({ customerAccountIds, linkedType, ids, status, idType, page, size, sort, }: import("./services/incident/definitions").getIncidentsParameters): Promise<import("./services/incident/definitions").getIncidentsResponse>;
     getIncident({ incidentId, idType, }: import("./services/incident/definitions").getIncidentParameters): Promise<import("./services/incident/definitions").getIncidentResponse>;
     createOrderLogisticIncident({ logisticOrderId, idType, customField, reasonCode, }: import("./services/incident/definitions").createOrderLogisticIncidentParameters): Promise<import("./services/incident/definitions").createOrderLogisticIncidentResponse>;

package/lib/index.js

@@ -49,6 +49,7 @@ const SupplierServices = __importStar(require("./services/supplier"));
 const CommercialOrderServices = __importStar(require("./services/commercial-order"));
 const LogisticOrderServices = __importStar(require("./services/logistic-order"));
 const IncidentServices = __importStar(require("./services/incident"));
+const OfferServices = __importStar(require("./services/offer-inventories"));
 const fetch_instance_1 = require("./settings/fetch-instance");
 exports.DjustSDK = {
     ...AuthServices,
@@ -63,6 +64,7 @@ exports.DjustSDK = {
     ...LogisticOrderServices,
     ...CommercialOrderServices,
     ...IncidentServices,
+    ...OfferServices,
     initialize: fetch_instance_1.initialize,
     updateConfiguration: fetch_instance_1.updateConfiguration,
 };

package/lib/interfaces/models/offer.d.ts

@@ -3,7 +3,8 @@ import { ProductVariantResponse } from "./product";
 import { SupplierResponse } from "./supplier";
 import { PriceDto } from "./price";
 export type PackingType = "BOX" | "BOTTLE" | "UNIT";
-export type OfferStatus = "ACTIVE" | "INACTIVE" | "DELETED";
+export type OfferStatus = "ACTIVE" | "INACTIVE" | "DELETED" | "NEW";
+export type OfferInventoryStatus = "ACTIVE" | "INACTIVE";
 export type OfferPriceType = "PUBLIC" | "GROUP" | "ACCOUNT";
 export interface OfferDto {
     currency: string;
@@ -73,6 +74,33 @@ export interface OfferResponse {
     offerPrices: OfferPriceResponse[];
     supplier: SupplierResponse;
 }
+export interface OfferInventories extends OfferResponse {
+}
+export interface OfferInventoriesV2 {
+    currency: string;
+    externalId: string;
+    externalSource: string;
+    id: string;
+    leadTimeToShip: number;
+    maxOrderQuantity: number;
+    minOrderQuantity: number;
+    minShippingPrice: number;
+    minShippingPriceAdditional: number;
+    minShippingType: string;
+    minShippingZone: string;
+    minStockAlert: number;
+    packingType: string;
+    productUnit: string;
+    quantityPerItem: number;
+    status: string;
+    stock: number;
+}
+export interface OfferInventoryCustomField {
+    externalId: string;
+    name: string;
+    value: string;
+    values: string[];
+}
 export interface DeliveryDates {
     code: string;
     deliveryTimeRange: DeliveryTime;

package/lib/interfaces/models/product.d.ts

@@ -3,7 +3,7 @@ import { SimpleUserView } from "./customer-user";
 import { BestOffer } from "./offer";
 import { NavigationCategorySimpleView } from "./navigation-category";
 import { ExternalSource, Order, PageableObject } from "./common";
-export type ProductStatus = "ACTIVE" | "INACTIVE" | "DELETED";
+export type ProductStatus = "ACTIVE" | "INACTIVE" | "DELETED" | "NEW";
 export type ProductVariantAttributeType = "TEXT" | "COLOR" | "DATE" | "BOOLEAN";
 export type UnitType = "ITEM" | "WEIGHT_METRIC" | "VOLUME_METRIC" | "LENGTH_METRIC" | "AREA_METRIC" | "WEIGHT_IMPERIAL" | "VOLUME_IMPERIAL" | "LENGTH_IMPERIAL" | "AREA_IMPERIAL";
 export type ProductIdType = "SKU" | "ID" | "EXTERNAL_ID";

package/lib/services/offer-inventories/definitions.d.ts

@@ -0,0 +1,72 @@
+import { OfferInventories, OfferInventoriesV2, OfferInventoryCustomField, OfferInventoryStatus } from "../../interfaces/models/offer";
+import { ProductStatus } from "../../interfaces/models/product";
+import { IdType, Order, PageableObject } from "../../interfaces/models/common";
+/**
+ * Requests parameters type definitions
+ */
+export interface GetPaginatedOfferInventoriesParameters {
+    page?: number;
+    size?: number;
+    sort?: string;
+    productStatus?: ProductStatus;
+    offerInventoryStatus?: OfferInventoryStatus;
+    variantStatus?: ProductStatus;
+    offerPriceStatus?: OfferInventoryStatus;
+    supplierId?: string;
+    offersIds?: string[];
+    offerPriceIds?: string[];
+    currency: string;
+    hasStock?: string;
+    idType?: IdType;
+}
+export interface GetPaginatedOfferInventoriesV2Parameters {
+    page?: number;
+    size?: number;
+    sort?: string;
+    variantExternalId?: string;
+}
+export interface GetOfferInventoriesResponse {
+    content: OfferInventories[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+    totalPages: number;
+}
+export interface GetOfferInventoriesV2Response {
+    content: OfferInventoriesV2[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+}
+export interface GetOfferInventoryCustomFieldsParameters {
+    externalId: string;
+    locale?: string;
+    page?: number;
+    size?: number;
+    sort?: string;
+}
+export interface GetOfferInventoryCustomFieldsResponse {
+    content: OfferInventoryCustomField[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+    totalPages: number;
+}

package/lib/services/offer-inventories/definitions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/services/offer-inventories/index.d.ts

@@ -0,0 +1,119 @@
+import { GetOfferInventoriesResponse, GetOfferInventoriesV2Response, GetOfferInventoryCustomFieldsParameters, GetOfferInventoryCustomFieldsResponse, GetPaginatedOfferInventoriesParameters, GetPaginatedOfferInventoriesV2Parameters } from "./definitions";
+/**
+ * @deprecated
+ * 📄 Gets offer inventories.
+ *
+ * This function retrieves offer inventories with various filtering options.
+ * The `currency` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/offer-inventories` [OFFER-550]
+ *
+ * | Parameter              | Type         | Required | Description                                 |
+ * |------------------------|--------------|----------|---------------------------------------------|
+ * | `page`                 | `number`     | ❌       | The page number to fetch (0-based index).  |
+ * | `size`                 | `number`     | ❌       | The number of items per page.              |
+ * | `sort`                 | `string`     | ❌       | The sort to apply to the results.          |
+ * | `productStatus`        | `string`     | ❌       | Filter by product status.                  |
+ * | `offerInventoryStatus` | `string`     | ❌       | Filter by offer inventory status.          |
+ * | `variantStatus`        | `string`     | ❌       | Filter by variant status.                  |
+ * | `offerPriceStatus`     | `string`     | ❌       | Filter by offer price status.              |
+ * | `supplierId`           | `string`     | ❌       | Filter by supplier ID.                     |
+ * | `offersIds`            | `string[]`   | ❌       | Filter by offer IDs.                       |
+ * | `offerPriceIds`        | `string[]`   | ❌       | Filter by offer price IDs.                 |
+ * | `currency`             | `string`     | ✅       | The currency for price formatting.         |
+ * | `hasStock`             | `string`     | ❌       | Filter by stock availability.              |
+ * | `idType`               | `string`     | ❌       | The ID type to use.                        |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetOfferInventoriesResponse` containing the offer inventories.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const inventories = await getOfferInventories({
+ *   page: 0,
+ *   size: 20,
+ *   sort: "createdAt,desc",
+ *   currency: "EUR",
+ *   hasStock: "true",
+ * });
+ * console.log(inventories);
+ * ```
+ *
+ * @deprecated This function is deprecated and will be probably removed in a future version.
+ * @param {GetPaginatedOfferInventoriesParameters} params - The parameters for the request
+ * @throws {Error} If `currency` is missing
+ * @returns {Promise<GetOfferInventoriesResponse>} A promise resolving to the response containing the offer inventories
+ */
+export declare function getPaginatedOfferInventories({ page, size, sort, productStatus, offerInventoryStatus, variantStatus, offerPriceStatus, supplierId, offersIds, offerPriceIds, currency, hasStock, idType, }: GetPaginatedOfferInventoriesParameters): Promise<GetOfferInventoriesResponse>;
+/**
+ * 📄 Gets paginated offer inventories V2.
+ *
+ * This function retrieves paginated offer inventories with filtering by variant external ID.
+ * The `variantExternalId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v2/offer-inventories` [OFFER-551]
+ *
+ * | Parameter           | Type     | Required | Description                                    |
+ * |---------------------|----------|----------|------------------------------------------------|
+ * | `page`              | `number` | ❌       | The page number to fetch (0-based index).     |
+ * | `size`              | `number` | ❌       | The number of items per page.                 |
+ * | `sort`              | `string` | ❌       | The sort to apply to the results.             |
+ * | `variantExternalId` | `string` | ✅       | The external ID of the product variant.       |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetOfferInventoriesV2Response` containing the paginated offer inventories.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const inventories = await getPaginatedOfferInventoriesV2({
+ *   variantExternalId: "variant123",
+ *   page: 0,
+ *   size: 20,
+ *   sort: "createdAt,desc",
+ * });
+ * console.log(inventories);
+ * ```
+ *
+ * @param {GetPaginatedOfferInventoriesV2Parameters} params - The parameters for the request
+ * @throws {Error} If `variantExternalId` is missing
+ * @returns {Promise<GetOfferInventoriesV2Response>} A promise resolving to the response containing the paginated offer inventories
+ */
+export declare function getPaginatedOfferInventoriesV2({ page, size, sort, variantExternalId, }: GetPaginatedOfferInventoriesV2Parameters): Promise<GetOfferInventoriesV2Response>;
+/**
+ * @deprecated
+ * 📄 Gets offer inventory custom fields.
+ *
+ * This function retrieves custom fields for a specific offer inventory identified by the `externalId`.
+ * The `externalId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/offer-inventories/${externalId}/custom-fields` [OFFER-552]
+ *
+ * | Parameter   | Type     | Required | Description                                    |
+ * |-------------|----------|----------|------------------------------------------------|
+ * | `externalId`| `string` | ✅       | The external ID of the offer inventory.       |
+ * | `page`      | `number` | ❌       | The page number to fetch (0-based index).     |
+ * | `size`      | `number` | ❌       | The number of items per page.                 |
+ * | `sort`      | `string` | ❌       | The sort to apply to the results.             |
+ * | `locale`    | `string` | ❌       | The locale for the response data.             |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetOfferInventoryCustomFieldsResponse` containing the custom fields.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const customFields = await getOfferInventoryCustomFields({
+ *   externalId: "inventory123",
+ *   page: 0,
+ *   size: 20,
+ *   sort: "name,asc",
+ *   locale: "en",
+ * });
+ * console.log(customFields);
+ * ```
+ *
+ * @deprecated This function is deprecated and will be probably removed in a future version.
+ * @param {GetOfferInventoryCustomFieldsParameters} params - The parameters for the request
+ * @throws {Error} If `externalId` is missing
+ * @returns {Promise<GetOfferInventoryCustomFieldsResponse>} A promise resolving to the response containing the custom fields
+ */
+export declare function getOfferInventoryCustomFields({ externalId, page, size, sort, locale, }: GetOfferInventoryCustomFieldsParameters): Promise<GetOfferInventoryCustomFieldsResponse>;

package/lib/services/offer-inventories/index.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPaginatedOfferInventories = getPaginatedOfferInventories;
+exports.getPaginatedOfferInventoriesV2 = getPaginatedOfferInventoriesV2;
+exports.getOfferInventoryCustomFields = getOfferInventoryCustomFields;
+const parameters_validation_1 = require("../../helpers/parameters-validation");
+const fetch_instance_1 = require("../../settings/fetch-instance");
+/**
+ * @deprecated
+ * 📄 Gets offer inventories.
+ *
+ * This function retrieves offer inventories with various filtering options.
+ * The `currency` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/offer-inventories` [OFFER-550]
+ *
+ * | Parameter              | Type         | Required | Description                                 |
+ * |------------------------|--------------|----------|---------------------------------------------|
+ * | `page`                 | `number`     | ❌       | The page number to fetch (0-based index).  |
+ * | `size`                 | `number`     | ❌       | The number of items per page.              |
+ * | `sort`                 | `string`     | ❌       | The sort to apply to the results.          |
+ * | `productStatus`        | `string`     | ❌       | Filter by product status.                  |
+ * | `offerInventoryStatus` | `string`     | ❌       | Filter by offer inventory status.          |
+ * | `variantStatus`        | `string`     | ❌       | Filter by variant status.                  |
+ * | `offerPriceStatus`     | `string`     | ❌       | Filter by offer price status.              |
+ * | `supplierId`           | `string`     | ❌       | Filter by supplier ID.                     |
+ * | `offersIds`            | `string[]`   | ❌       | Filter by offer IDs.                       |
+ * | `offerPriceIds`        | `string[]`   | ❌       | Filter by offer price IDs.                 |
+ * | `currency`             | `string`     | ✅       | The currency for price formatting.         |
+ * | `hasStock`             | `string`     | ❌       | Filter by stock availability.              |
+ * | `idType`               | `string`     | ❌       | The ID type to use.                        |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetOfferInventoriesResponse` containing the offer inventories.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const inventories = await getOfferInventories({
+ *   page: 0,
+ *   size: 20,
+ *   sort: "createdAt,desc",
+ *   currency: "EUR",
+ *   hasStock: "true",
+ * });
+ * console.log(inventories);
+ * ```
+ *
+ * @deprecated This function is deprecated and will be probably removed in a future version.
+ * @param {GetPaginatedOfferInventoriesParameters} params - The parameters for the request
+ * @throws {Error} If `currency` is missing
+ * @returns {Promise<GetOfferInventoriesResponse>} A promise resolving to the response containing the offer inventories
+ */
+async function getPaginatedOfferInventories({ page, size, sort, productStatus, offerInventoryStatus, variantStatus, offerPriceStatus, supplierId, offersIds, offerPriceIds, currency, hasStock, idType, }) {
+    (0, parameters_validation_1.required)({ currency });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/offer-inventories`,
+        params: {
+            page,
+            size,
+            sort,
+            productStatus,
+            offerInventoryStatus,
+            variantStatus,
+            offerPriceStatus,
+            supplierId,
+            offersIds,
+            offerPriceIds,
+            currency,
+            hasStock,
+            idType,
+        },
+    });
+    return data;
+}
+/**
+ * 📄 Gets paginated offer inventories V2.
+ *
+ * This function retrieves paginated offer inventories with filtering by variant external ID.
+ * The `variantExternalId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v2/offer-inventories` [OFFER-551]
+ *
+ * | Parameter           | Type     | Required | Description                                    |
+ * |---------------------|----------|----------|------------------------------------------------|
+ * | `page`              | `number` | ❌       | The page number to fetch (0-based index).     |
+ * | `size`              | `number` | ❌       | The number of items per page.                 |
+ * | `sort`              | `string` | ❌       | The sort to apply to the results.             |
+ * | `variantExternalId` | `string` | ✅       | The external ID of the product variant.       |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetOfferInventoriesV2Response` containing the paginated offer inventories.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const inventories = await getPaginatedOfferInventoriesV2({
+ *   variantExternalId: "variant123",
+ *   page: 0,
+ *   size: 20,
+ *   sort: "createdAt,desc",
+ * });
+ * console.log(inventories);
+ * ```
+ *
+ * @param {GetPaginatedOfferInventoriesV2Parameters} params - The parameters for the request
+ * @throws {Error} If `variantExternalId` is missing
+ * @returns {Promise<GetOfferInventoriesV2Response>} A promise resolving to the response containing the paginated offer inventories
+ */
+async function getPaginatedOfferInventoriesV2({ page, size, sort, variantExternalId, }) {
+    (0, parameters_validation_1.required)({ variantExternalId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v2/offer-inventories`,
+        params: {
+            variantExternalId,
+            page,
+            size,
+            sort,
+        },
+    });
+    return data;
+}
+/**
+ * @deprecated
+ * 📄 Gets offer inventory custom fields.
+ *
+ * This function retrieves custom fields for a specific offer inventory identified by the `externalId`.
+ * The `externalId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/offer-inventories/${externalId}/custom-fields` [OFFER-552]
+ *
+ * | Parameter   | Type     | Required | Description                                    |
+ * |-------------|----------|----------|------------------------------------------------|
+ * | `externalId`| `string` | ✅       | The external ID of the offer inventory.       |
+ * | `page`      | `number` | ❌       | The page number to fetch (0-based index).     |
+ * | `size`      | `number` | ❌       | The number of items per page.                 |
+ * | `sort`      | `string` | ❌       | The sort to apply to the results.             |
+ * | `locale`    | `string` | ❌       | The locale for the response data.             |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetOfferInventoryCustomFieldsResponse` containing the custom fields.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const customFields = await getOfferInventoryCustomFields({
+ *   externalId: "inventory123",
+ *   page: 0,
+ *   size: 20,
+ *   sort: "name,asc",
+ *   locale: "en",
+ * });
+ * console.log(customFields);
+ * ```
+ *
+ * @deprecated This function is deprecated and will be probably removed in a future version.
+ * @param {GetOfferInventoryCustomFieldsParameters} params - The parameters for the request
+ * @throws {Error} If `externalId` is missing
+ * @returns {Promise<GetOfferInventoryCustomFieldsResponse>} A promise resolving to the response containing the custom fields
+ */
+async function getOfferInventoryCustomFields({ externalId, page, size, sort, locale, }) {
+    (0, parameters_validation_1.required)({ externalId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/offer-inventories/${externalId}/custom-fields`,
+        params: {
+            externalId,
+            page,
+            size,
+            sort,
+            locale,
+        },
+    });
+    return data;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@djust-b2b/djust-front-sdk",
-  "version": "1.29.3",
+  "version": "2.0.0",
   "description": "DJUST Front SDK is a versatile JavaScript Software Development Kit (SDK)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",