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

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

@@ -1,121 +1,76 @@
 import type { GetCustomFieldParameters, GetCustomFieldResponse, PostMediaCustomFieldParameters } from "./definitions";
 /**
- * APICODE(listPaginatedCustomFields)
- * Retrieves custom fields.
+ * 📋 Retrieves custom fields.
  *
- * This function allows fetching custom fields based on the provided parameters.
+ * This function fetches 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>
+ * 🛠 **Endpoint**: `GET /v2/shop/custom-fields`
  *
- * The type of the custom field to retrieve.
- * #### includeInactive - `boolean`
+ * | **Parameter**        | **Type**   | **Required** | **Description**                                                           |
+ * |----------------------|------------|--------------|---------------------------------------------------------------------------|
+ * | `fieldType`          | `string`   | ✅           | The type of 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 results.  |
  *
- * Whether to include inactive custom fields in the response.
- * #### limit - `number`
+ * 📤 **Returns**:
+ * A `Promise<GetCustomFieldResponse>` containing the retrieved custom fields.
  *
- * 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
+ * 🛠 **Example Usage**:
  * ```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
- * }
+ * const customFields = await getCustomFields({
+ *   fieldType: 'text',
+ *   includeInactive: false,
+ *   limit: 10,
+ *   offset: 0,
+ * });
  * ```
+ *
+ * @param {GetCustomFieldParameters} params - The parameters for fetching custom fields:
+ *   - `fieldType` - The type of custom field to retrieve.
+ *   - `includeInactive` (optional) - Whether to include inactive custom fields.
+ *   - `limit` (optional) - The maximum number of fields to return.
+ *   - `offset` (optional) - The number of fields to skip before collecting results.
+ *
+ * @returns {Promise<GetCustomFieldResponse>} - The response containing the retrieved custom fields.
  */
 export declare function getCustomFields(params: GetCustomFieldParameters): Promise<GetCustomFieldResponse>;
 /**
- * APICODE(postMediaCustomField)
- * Publishes a media custom field.
+ * 🎥 Publishes a media custom field.
  *
- * This function allows publishing a media file associated with a specific custom field.
+ * This function allows uploading 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>
+ * 🛠 **Endpoint**: `POST /v2/shop/custom-fields/{id}/media`
  *
- * The identifier of the custom field to which the media is associated.
- * #### customFieldIdType - `string` | <strong style={{ color: 'red' }}>required</strong></strong>
+ * | **Parameter**         | **Type**   | **Required** | **Description**                                                      |
+ * |-----------------------|------------|--------------|----------------------------------------------------------------------|
+ * | `id`                 | `string`   | ✅           | The ID of the custom field associated with the media.                |
+ * | `customFieldIdType`  | `string`   | ✅           | The type of the custom field identifier (e.g., `externalId`).        |
+ * | `sealedTarget`       | `boolean`  |              | Indicates whether the media should be sealed.                        |
+ * | `fileName`           | `string`   | ✅           | The name of the media file being uploaded.                           |
+ * | `fileSize`           | `number`   | ✅           | The size of the media file in bytes.                                 |
  *
- * The type of the custom field identifier (e.g., 'externalId').
- * #### sealedTarget - `boolean`
+ * 📤 **Returns**:
+ * A `Promise<string>` containing the URL where the media can be uploaded.
  *
- * 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
+ * 🛠 **Example Usage**:
  * ```typescript
- * const mediaId = await postMediaCustomField(
- *  {
- *    id: 'field1',
- *    customFieldIdType: 'externalId',
- *    sealedTarget: true,
- *    fileName: 'image.jpg',
- *    fileSize: 2048
- *  }
- * );
+ * const mediaUrl = await postMediaCustomField({
+ *   id: 'field1',
+ *   customFieldIdType: 'externalId',
+ *   sealedTarget: true,
+ *   fileName: 'image.jpg',
+ *   fileSize: 2048,
+ * });
  * ```
+ *
+ * @param {PostMediaCustomFieldParameters} params - The parameters for uploading a media custom field:
+ *   - `id` - The ID of the custom field.
+ *   - `customFieldIdType` - The type of the custom field identifier.
+ *   - `sealedTarget` (optional) - Whether the media should be sealed.
+ *   - `fileName` - The name of the media file.
+ *   - `fileSize` - The size of the media file in bytes.
+ *
+ * @returns {Promise<string>} - The URL for uploading the media file.
  */
 export declare function postMediaCustomField(params: PostMediaCustomFieldParameters): Promise<string>;

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

@@ -2,90 +2,41 @@
 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.
+ * 📋 Retrieves custom fields.
  *
- * @param {GetCustomFieldParameters} params - The parameters for retrieving custom fields, including:
- * #### fieldType - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * This function fetches custom fields based on the provided parameters.
  *
- * The type of the custom field to retrieve.
- * #### includeInactive - `boolean`
+ * 🛠 **Endpoint**: `GET /v2/shop/custom-fields`
  *
- * Whether to include inactive custom fields in the response.
- * #### limit - `number`
+ * | **Parameter**        | **Type**   | **Required** | **Description**                                                           |
+ * |----------------------|------------|--------------|---------------------------------------------------------------------------|
+ * | `fieldType`          | `string`   | ✅           | The type of 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 results.  |
  *
- * The maximum number of custom fields to return.
- * #### offset - `number`
+ * 📤 **Returns**:
+ * A `Promise<GetCustomFieldResponse>` containing the retrieved custom fields.
  *
- * 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
+ * 🛠 **Example Usage**:
  * ```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
- * }
+ * const customFields = await getCustomFields({
+ *   fieldType: 'text',
+ *   includeInactive: false,
+ *   limit: 10,
+ *   offset: 0,
+ * });
  * ```
+ *
+ * @param {GetCustomFieldParameters} params - The parameters for fetching custom fields:
+ *   - `fieldType` - The type of custom field to retrieve.
+ *   - `includeInactive` (optional) - Whether to include inactive custom fields.
+ *   - `limit` (optional) - The maximum number of fields to return.
+ *   - `offset` (optional) - The number of fields to skip before collecting results.
+ *
+ * @returns {Promise<GetCustomFieldResponse>} - The response containing the retrieved custom fields.
  */
 async function getCustomFields(params) {
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
@@ -96,43 +47,42 @@ async function getCustomFields(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>
+ * 🎥 Publishes a media custom field.
  *
- * The type of the custom field identifier (e.g., 'externalId').
- * #### sealedTarget - `boolean`
+ * This function allows uploading a media file associated with a specific custom field.
  *
- * Indicates whether the media should be sealed.
- * #### fileName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `POST /v2/shop/custom-fields/{id}/media`
  *
- * The name of the media file being uploaded.
- * #### fileSize - `number` | <strong style={{ color: 'red' }}>required</strong>
+ * | **Parameter**         | **Type**   | **Required** | **Description**                                                      |
+ * |-----------------------|------------|--------------|----------------------------------------------------------------------|
+ * | `id`                 | `string`   | ✅           | The ID of the custom field associated with the media.                |
+ * | `customFieldIdType`  | `string`   | ✅           | The type of the custom field identifier (e.g., `externalId`).        |
+ * | `sealedTarget`       | `boolean`  |              | Indicates whether the media should be sealed.                        |
+ * | `fileName`           | `string`   | ✅           | The name of the media file being uploaded.                           |
+ * | `fileSize`           | `number`   | ✅           | The size of the media file in bytes.                                 |
  *
- * The size of the media file in bytes.
+ * 📤 **Returns**:
+ * A `Promise<string>` containing the URL where the media can be uploaded.
  *
- * @returns {Promise<string>} - A promise that resolves to the url where post the media.
- *
- * @example
- * #### input
+ * 🛠 **Example Usage**:
  * ```typescript
- * const mediaId = await postMediaCustomField(
- *  {
- *    id: 'field1',
- *    customFieldIdType: 'externalId',
- *    sealedTarget: true,
- *    fileName: 'image.jpg',
- *    fileSize: 2048
- *  }
- * );
+ * const mediaUrl = await postMediaCustomField({
+ *   id: 'field1',
+ *   customFieldIdType: 'externalId',
+ *   sealedTarget: true,
+ *   fileName: 'image.jpg',
+ *   fileSize: 2048,
+ * });
  * ```
+ *
+ * @param {PostMediaCustomFieldParameters} params - The parameters for uploading a media custom field:
+ *   - `id` - The ID of the custom field.
+ *   - `customFieldIdType` - The type of the custom field identifier.
+ *   - `sealedTarget` (optional) - Whether the media should be sealed.
+ *   - `fileName` - The name of the media file.
+ *   - `fileSize` - The size of the media file in bytes.
+ *
+ * @returns {Promise<string>} - The URL for uploading the media file.
  */
 async function postMediaCustomField(params) {
     const { id, customFieldIdType, sealedTarget, fileName, fileSize } = params;