@djust-b2b/djust-front-sdk 1.13.0 → 1.15.0

package/lib/services/custom-field/definitions.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var SealedTarget;
+(function (SealedTarget) {
+    SealedTarget[SealedTarget["OFFER"] = 0] = "OFFER";
+    SealedTarget[SealedTarget["ACCOUNT"] = 1] = "ACCOUNT";
+    SealedTarget[SealedTarget["NAVIGATION_CATEGORY"] = 2] = "NAVIGATION_CATEGORY";
+    SealedTarget[SealedTarget["SUPPLIER"] = 3] = "SUPPLIER";
+    SealedTarget[SealedTarget["CUSTOMER_USER"] = 4] = "CUSTOMER_USER";
+    SealedTarget[SealedTarget["CUSTOMER_ORGANISATION"] = 5] = "CUSTOMER_ORGANISATION";
+    SealedTarget[SealedTarget["ORDER_LOGISTIC"] = 6] = "ORDER_LOGISTIC";
+    SealedTarget[SealedTarget["ORDER_COMMERCIAL"] = 7] = "ORDER_COMMERCIAL";
+    SealedTarget[SealedTarget["ORDER_LOGISTIC_LINE"] = 8] = "ORDER_LOGISTIC_LINE";
+    SealedTarget[SealedTarget["QUOTE"] = 9] = "QUOTE";
+    SealedTarget[SealedTarget["QUOTE_LINE"] = 10] = "QUOTE_LINE";
+    SealedTarget[SealedTarget["ORDER_INCIDENT"] = 11] = "ORDER_INCIDENT";
+    SealedTarget[SealedTarget["THREAD_MESSAGE"] = 12] = "THREAD_MESSAGE";
+})(SealedTarget || (SealedTarget = {}));
+var ExternalSource;
+(function (ExternalSource) {
+    ExternalSource[ExternalSource["MIRAKL"] = 0] = "MIRAKL";
+    ExternalSource[ExternalSource["CLIENT"] = 1] = "CLIENT";
+    ExternalSource[ExternalSource["NOT_DEFINED"] = 2] = "NOT_DEFINED";
+    ExternalSource[ExternalSource["EXTERN"] = 3] = "EXTERN";
+    ExternalSource[ExternalSource["SYSTEM"] = 4] = "SYSTEM";
+})(ExternalSource || (ExternalSource = {}));
+var CustomFieldRole;
+(function (CustomFieldRole) {
+    CustomFieldRole[CustomFieldRole["PRODUCT_TAX_RATE"] = 0] = "PRODUCT_TAX_RATE";
+    CustomFieldRole[CustomFieldRole["SHIPPING_TAX_RATE"] = 1] = "SHIPPING_TAX_RATE";
+    CustomFieldRole[CustomFieldRole["SHIPPING_TAX_CODE"] = 2] = "SHIPPING_TAX_CODE";
+    CustomFieldRole[CustomFieldRole["PRODUCT_TAX_CODE"] = 3] = "PRODUCT_TAX_CODE";
+    CustomFieldRole[CustomFieldRole["ORDERS_MANAGED_INTERNALLY"] = 4] = "ORDERS_MANAGED_INTERNALLY";
+    CustomFieldRole[CustomFieldRole["OFFER_VALIDITY_START_DATE"] = 5] = "OFFER_VALIDITY_START_DATE";
+    CustomFieldRole[CustomFieldRole["OFFER_VALIDITY_END_DATE"] = 6] = "OFFER_VALIDITY_END_DATE";
+    CustomFieldRole[CustomFieldRole["AUTOMATIC_ORDER_VALIDATION"] = 7] = "AUTOMATIC_ORDER_VALIDATION";
+})(CustomFieldRole || (CustomFieldRole = {}));
+var CustomFieldStatus;
+(function (CustomFieldStatus) {
+    CustomFieldStatus[CustomFieldStatus["ACTIVE"] = 0] = "ACTIVE";
+    CustomFieldStatus[CustomFieldStatus["INACTIVE"] = 1] = "INACTIVE";
+})(CustomFieldStatus || (CustomFieldStatus = {}));
+var CustomFieldType;
+(function (CustomFieldType) {
+    CustomFieldType[CustomFieldType["LONG_TEXT"] = 0] = "LONG_TEXT";
+    CustomFieldType[CustomFieldType["TEXT"] = 1] = "TEXT";
+    CustomFieldType[CustomFieldType["NUMBER"] = 2] = "NUMBER";
+    CustomFieldType[CustomFieldType["METRIC"] = 3] = "METRIC";
+    CustomFieldType[CustomFieldType["DATE"] = 4] = "DATE";
+    CustomFieldType[CustomFieldType["LIST_TEXT"] = 5] = "LIST_TEXT";
+    CustomFieldType[CustomFieldType["LIST_METRIC"] = 6] = "LIST_METRIC";
+    CustomFieldType[CustomFieldType["LIST_NUMBER"] = 7] = "LIST_NUMBER";
+    CustomFieldType[CustomFieldType["BOOLEAN"] = 8] = "BOOLEAN";
+    CustomFieldType[CustomFieldType["MEDIA"] = 9] = "MEDIA";
+})(CustomFieldType || (CustomFieldType = {}));
+var CustomFieldIdType;
+(function (CustomFieldIdType) {
+    CustomFieldIdType[CustomFieldIdType["BUSINESS_ID"] = 0] = "BUSINESS_ID";
+    CustomFieldIdType[CustomFieldIdType["EXTERNAL_ID"] = 1] = "EXTERNAL_ID";
+})(CustomFieldIdType || (CustomFieldIdType = {}));

package/lib/services/custom-field/index.d.ts

@@ -0,0 +1,121 @@
+import type { GetCustomFieldParameters, GetCustomFieldResponse, PostMediaCustomFieldParameters } from "./definitions";
+/**
+ * APICODE(listPaginatedCustomFields)
+ * Retrieves custom fields.
+ *
+ * This function allows fetching custom fields based on the provided parameters.
+ *
+ * @param {GetCustomFieldParameters} params - The parameters for retrieving custom fields, including:
+ * #### fieldType - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The type of the custom field to retrieve.
+ * #### includeInactive - `boolean`
+ *
+ * Whether to include inactive custom fields in the response.
+ * #### limit - `number`
+ *
+ * The maximum number of custom fields to return.
+ * #### offset - `number`
+ *
+ * The number of custom fields to skip before starting to collect the result set.
+ *
+ * @returns {Promise<GetCustomFieldResponse>} - An object containing the retrieved custom fields.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const customFields = await getCustomFields({ fieldType: 'text', includeInactive: false });
+ * ```
+ #### output
+ * ```json
+ * {
+ *   "content": [
+ *     {
+ *       "externalId": "field1",
+ *       "externalSource": "MIRAKL",
+ *       "faceted": true,
+ *       "id": "field1",
+ *       "indexable": true,
+ *       "mandatory": true,
+ *       "name": "Field 1",
+ *       "role": "PRODUCT_TAX_RATE",
+ *       "sealedTarget": true,
+ *       "searchable": true,
+ *       "sortable": true,
+ *       "status": "ACTIVE",
+ *       "type": "TEXT"
+ *     },
+ *     {
+ *       "externalId": "field2",
+ *       "externalSource": "CLIENT",
+ *       "faceted": false,
+ *       "id": "field2",
+ *       "indexable": false,
+ *       "mandatory": false,
+ *       "name": "Field 2",
+ *       "role": "SHIPPING_TAX_CODE",
+ *       "sealedTarget": false,
+ *       "searchable": false,
+ *       "sortable": false,
+ *       "status": "INACTIVE",
+ *       "type": "LONG_TEXT"
+ *     }
+ *   ],
+ *   "empty": false,
+ *   "first": true,
+ *   "last": false,
+ *   "number": 0,
+ *   "numberOfElements": 2,
+ *   "pageable": {
+ *     "page": 0,
+ *     "size": 10,
+ *     "sort": []
+ *   },
+ *   "size": 10,
+ *   "sort": [],
+ *   "totalElemets": 2,
+ *   "totalPages": 1
+ * }
+ * ```
+ */
+export declare function getCustomFields(params: GetCustomFieldParameters): Promise<GetCustomFieldResponse>;
+/**
+ * APICODE(postMediaCustomField)
+ * Publishes a media custom field.
+ *
+ * This function allows publishing a media file associated with a specific custom field.
+ *
+ * @param {PostMediaCustomFieldParameters} params - The parameters for publishing the media field, including:
+ * #### id - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The identifier of the custom field to which the media is associated.
+ * #### customFieldIdType - `string` | <strong style={{ color: 'red' }}>required</strong></strong>
+ *
+ * The type of the custom field identifier (e.g., 'externalId').
+ * #### sealedTarget - `boolean`
+ *
+ * Indicates whether the media should be sealed.
+ * #### fileName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The name of the media file being uploaded.
+ * #### fileSize - `number` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The size of the media file in bytes.
+ *
+ * @returns {Promise<string>} - A promise that resolves to the url where post the media.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const mediaId = await postMediaCustomField(
+ *  {
+ *    id: 'field1',
+ *    customFieldIdType: 'externalId',
+ *    sealedTarget: true,
+ *    fileName: 'image.jpg',
+ *    fileSize: 2048
+ *  }
+ * );
+ * ```
+ */
+export declare function postMediaCustomField(params: PostMediaCustomFieldParameters): Promise<string>;

package/lib/services/custom-field/index.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCustomFields = getCustomFields;
+exports.postMediaCustomField = postMediaCustomField;
+/**
+ * @packageDocumentation
+ *
+ * @document documents/custom-field.md
+ */
+const fetch_instance_1 = require("../../settings/fetch-instance");
+/**
+ * APICODE(listPaginatedCustomFields)
+ * Retrieves custom fields.
+ *
+ * This function allows fetching custom fields based on the provided parameters.
+ *
+ * @param {GetCustomFieldParameters} params - The parameters for retrieving custom fields, including:
+ * #### fieldType - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The type of the custom field to retrieve.
+ * #### includeInactive - `boolean`
+ *
+ * Whether to include inactive custom fields in the response.
+ * #### limit - `number`
+ *
+ * The maximum number of custom fields to return.
+ * #### offset - `number`
+ *
+ * The number of custom fields to skip before starting to collect the result set.
+ *
+ * @returns {Promise<GetCustomFieldResponse>} - An object containing the retrieved custom fields.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const customFields = await getCustomFields({ fieldType: 'text', includeInactive: false });
+ * ```
+ #### output
+ * ```json
+ * {
+ *   "content": [
+ *     {
+ *       "externalId": "field1",
+ *       "externalSource": "MIRAKL",
+ *       "faceted": true,
+ *       "id": "field1",
+ *       "indexable": true,
+ *       "mandatory": true,
+ *       "name": "Field 1",
+ *       "role": "PRODUCT_TAX_RATE",
+ *       "sealedTarget": true,
+ *       "searchable": true,
+ *       "sortable": true,
+ *       "status": "ACTIVE",
+ *       "type": "TEXT"
+ *     },
+ *     {
+ *       "externalId": "field2",
+ *       "externalSource": "CLIENT",
+ *       "faceted": false,
+ *       "id": "field2",
+ *       "indexable": false,
+ *       "mandatory": false,
+ *       "name": "Field 2",
+ *       "role": "SHIPPING_TAX_CODE",
+ *       "sealedTarget": false,
+ *       "searchable": false,
+ *       "sortable": false,
+ *       "status": "INACTIVE",
+ *       "type": "LONG_TEXT"
+ *     }
+ *   ],
+ *   "empty": false,
+ *   "first": true,
+ *   "last": false,
+ *   "number": 0,
+ *   "numberOfElements": 2,
+ *   "pageable": {
+ *     "page": 0,
+ *     "size": 10,
+ *     "sort": []
+ *   },
+ *   "size": 10,
+ *   "sort": [],
+ *   "totalElemets": 2,
+ *   "totalPages": 1
+ * }
+ * ```
+ */
+async function getCustomFields(params) {
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v2/shop/custom-fields`,
+        params,
+    });
+    return data;
+}
+/**
+ * APICODE(postMediaCustomField)
+ * Publishes a media custom field.
+ *
+ * This function allows publishing a media file associated with a specific custom field.
+ *
+ * @param {PostMediaCustomFieldParameters} params - The parameters for publishing the media field, including:
+ * #### id - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The identifier of the custom field to which the media is associated.
+ * #### customFieldIdType - `string` | <strong style={{ color: 'red' }}>required</strong></strong>
+ *
+ * The type of the custom field identifier (e.g., 'externalId').
+ * #### sealedTarget - `boolean`
+ *
+ * Indicates whether the media should be sealed.
+ * #### fileName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The name of the media file being uploaded.
+ * #### fileSize - `number` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The size of the media file in bytes.
+ *
+ * @returns {Promise<string>} - A promise that resolves to the url where post the media.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const mediaId = await postMediaCustomField(
+ *  {
+ *    id: 'field1',
+ *    customFieldIdType: 'externalId',
+ *    sealedTarget: true,
+ *    fileName: 'image.jpg',
+ *    fileSize: 2048
+ *  }
+ * );
+ * ```
+ */
+async function postMediaCustomField(params) {
+    const { id, customFieldIdType, sealedTarget, fileName, fileSize } = params;
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v2/shop/custom-fields/${id}/media`,
+        params: { customFieldIdType, sealedTarget, fileName, fileSize },
+    });
+    return data;
+}