@djust-b2b/djust-front-sdk 1.14.0 → 1.15.1

package/lib/index.d.ts

@@ -21,12 +21,10 @@ export declare const DjustSDK: {
         storeId?: string;
         storeViewId?: string;
     }>) => void;
-    getOrderLogisticIncidents({ logisticOrderId, status, idType, page, size, sort, }: import("./services/incident/definitions").getOrderLogisticIncidentsParameters): Promise<import("./services/incident/definitions").getOrderLogisticIncidentsResponse>;
-    getOrderLogisticIncident({ logisticOrderId, incidentId, idType, }: import("./services/incident/definitions").getOrderLogisticIncidentParameters): Promise<import("./services/incident/definitions").getOrderLogisticIncidentResponse>;
-    getOrderLogisticLineIncidents({ logisticOrderId, lineId, status, idType, page, size, sort, }: import("./services/incident/definitions").getOrderLogisticLineIncidentsParameters): Promise<import("./services/incident/definitions").getOrderLogisticLineIncidentsResponse>;
+    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>;
     createOrderLogisticLineIncident({ logisticOrderId, idType, customFieldIdType, orderLines, reasonCode, }: import("./services/incident/definitions").createOrderLogisticLineIncidentParameters): Promise<import("./services/incident/definitions").createOrderLogisticLineIncidentResponse>;
-    getCustomerAccountIncidents({ customerAccountId, status, page, size, sort, }: import("./services/incident/definitions").getCustomerAccountIncidentsParameters): Promise<import("./services/incident/definitions").getCustomerAccountIncidentsResponse>;
     getCommercialOrders({ locale, nbPreviewLines, }: import("./interfaces").GetCommercialOrdersParameters): Promise<import("./interfaces").GetCommercialOrdersResponse>;
     createCommercialOrder({ nbPreviewLines, channel, customFields, locale, originId, paymentInfo, }: import("./interfaces").CreateCommercialOrderParameters): Promise<import("./interfaces").CreateCommercialOrderResponse>;
     getCommercialOrder({ orderId, idType, locale, nbPreviewLines, }: import("./interfaces").GetCommercialOrderParameters): Promise<import("./interfaces").GetCommercialOrderResponse>;
@@ -144,11 +142,11 @@ export declare const DjustSDK: {
     deleteBuyingList({ buyingListId, }: import("./interfaces").DeleteBuyingListParameters): Promise<void>;
     deleteBuyingListItems({ buyingListId, itemIds, }: import("./interfaces").DeleteBuyingListItemsParameters): Promise<void>;
     updateBuyingListOwner({ buyingListId, newOwnerEmail, }: import("./interfaces").UpdateBuyingListOwnerParameters): Promise<void>;
-    isTokenValid({ token, }: import("./interfaces").IsTokenValidParameters): Promise<boolean>;
-    refreshToken({ refreshToken, }: import("./interfaces").RefreshTokenParameters): Promise<import("./interfaces").RefreshTokenResponse>;
-    resetPassword({ newPassword, resetPasswordToken, }: import("./interfaces").ResetPasswordParameters): Promise<void>;
-    sendResetPasswordEmail({ email, }: import("./interfaces").SendResetPasswordEmailParameters): Promise<void>;
-    login({ username, password, }: import("./interfaces").LoginParameters): Promise<import("./interfaces").LoginResponse>;
+    isTokenValid({ token, }: import("./services/auth/definitions.requests").IsTokenValidParameters): Promise<boolean>;
+    refreshToken({ refreshToken, }: import("./services/auth/definitions.requests").RefreshTokenParameters): Promise<import("./interfaces").RefreshTokenResponse>;
+    resetPassword({ newPassword, resetPasswordToken, }: import("./services/auth/definitions.requests").ResetPasswordParameters): Promise<void>;
+    sendResetPasswordEmail({ email, }: import("./services/auth/definitions.requests").SendResetPasswordEmailParameters): Promise<void>;
+    login({ username, password, }: import("./services/auth/definitions.requests").LoginParameters): Promise<import("./interfaces").LoginResponse>;
     logout(): Promise<void>;
 };
 export * from "./interfaces";

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

@@ -1,6 +1,7 @@
 import { CustomFieldValueObject } from "./custom-field";
 export type IncidentStatus = "OPEN" | "ON_GOING" | "CLOSED";
 export type IncidentIdType = "DJUST_ID" | "EXTERNAL_ID";
+export type IncidentLinkedType = "ORDER" | "ORDER_LINES";
 export interface IncidentLogisticOrder {
     id: string;
     externalId: string;

package/lib/services/auth/definitions.requests.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Request parameters type definitions
+ */
+export interface IsTokenValidParameters {
+    token: string;
+}
+export interface RefreshTokenParameters {
+    refreshToken: string;
+}
+export interface ResetPasswordParameters {
+    newPassword: string;
+    resetPasswordToken: string;
+}
+export interface SendResetPasswordEmailParameters {
+    email: string;
+    redirectUrl: string;
+}
+export interface LoginParameters {
+    username: string;
+    password: string;
+}

package/lib/services/auth/definitions.requests.js

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

package/lib/services/auth/index.d.ts

@@ -1,11 +1,21 @@
 /**
- * @packageDocumentation
+ * # Auth Service
  *
- * @document documents/auth.md
+ * This module provides all functionalities related to user authentication and authorization.
+ *
+ * ## Features:
+ * - Validate tokens
+ * - Refresh tokens
+ * - Reset user passwords
+ * - Manage user login and logout
+ * - Send password reset emails
+ *
+ * Each function is described with its input parameters, output responses, and example usages.
  */
-import { IsTokenValidParameters, LoginParameters, LoginResponse, RefreshTokenParameters, RefreshTokenResponse, ResetPasswordParameters, SendResetPasswordEmailParameters } from "./definitions";
+import { LoginResponse, RefreshTokenResponse } from "./definitions";
+import { IsTokenValidParameters, LoginParameters, RefreshTokenParameters, ResetPasswordParameters, SendResetPasswordEmailParameters } from "./definitions.requests";
 /**
- * CART ENDPOINT
+ * AUTH ENDPOINT
  */
 /**
  * ##R eturns true if the token is valid and not expired, false otherwise

package/lib/services/auth/index.js

@@ -1,8 +1,17 @@
 "use strict";
 /**
- * @packageDocumentation
+ * # Auth Service
  *
- * @document documents/auth.md
+ * This module provides all functionalities related to user authentication and authorization.
+ *
+ * ## Features:
+ * - Validate tokens
+ * - Refresh tokens
+ * - Reset user passwords
+ * - Manage user login and logout
+ * - Send password reset emails
+ *
+ * Each function is described with its input parameters, output responses, and example usages.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isTokenValid = isTokenValid;
@@ -14,7 +23,7 @@ exports.logout = logout;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * CART ENDPOINT
+ * AUTH ENDPOINT
  */
 /**
  * ##R eturns true if the token is valid and not expired, false otherwise

package/lib/services/cart/index.d.ts

@@ -1,8 +1,3 @@
-/**
- * @packageDocumentation
- *
- * @document documents/cart.md
- */
 import { CreateCartParameters, DeleteCartsResponse, DeleteCartParameters, GetCartParameters, GetCartResponse, GetCartsParameters, GetCartsResponse, UpdateCartParameters, InitializeOrdersFromCartParameters, GetCartLinesParameters, DeleteCartLinesResponse, DeleteCartLinesParameters, GetCartLinesResponse, UpdateCartLinesResponse, UpdateCartLinesParameters, UpdateCartLinesByVariantParameters, UpdateCartLinesByVariantResponse } from "./definitions";
 /**
  * CART ENDPOINT

package/lib/services/cart/index.js

@@ -1,9 +1,4 @@
 "use strict";
-/**
- * @packageDocumentation
- *
- * @document documents/cart.md
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteCarts = deleteCarts;
 exports.getCarts = getCarts;

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

@@ -0,0 +1,100 @@
+import { Order, PageableObject } from "../../interfaces/models/common";
+declare enum SealedTarget {
+    OFFER = 0,
+    ACCOUNT = 1,
+    NAVIGATION_CATEGORY = 2,
+    SUPPLIER = 3,
+    CUSTOMER_USER = 4,
+    CUSTOMER_ORGANISATION = 5,
+    ORDER_LOGISTIC = 6,
+    ORDER_COMMERCIAL = 7,
+    ORDER_LOGISTIC_LINE = 8,
+    QUOTE = 9,
+    QUOTE_LINE = 10,
+    ORDER_INCIDENT = 11,
+    THREAD_MESSAGE = 12
+}
+declare enum ExternalSource {
+    MIRAKL = 0,
+    CLIENT = 1,
+    NOT_DEFINED = 2,
+    EXTERN = 3,
+    SYSTEM = 4
+}
+declare enum CustomFieldRole {
+    PRODUCT_TAX_RATE = 0,
+    SHIPPING_TAX_RATE = 1,
+    SHIPPING_TAX_CODE = 2,
+    PRODUCT_TAX_CODE = 3,
+    ORDERS_MANAGED_INTERNALLY = 4,
+    OFFER_VALIDITY_START_DATE = 5,
+    OFFER_VALIDITY_END_DATE = 6,
+    AUTOMATIC_ORDER_VALIDATION = 7
+}
+declare enum CustomFieldStatus {
+    ACTIVE = 0,
+    INACTIVE = 1
+}
+declare enum CustomFieldType {
+    LONG_TEXT = 0,
+    TEXT = 1,
+    NUMBER = 2,
+    METRIC = 3,
+    DATE = 4,
+    LIST_TEXT = 5,
+    LIST_METRIC = 6,
+    LIST_NUMBER = 7,
+    BOOLEAN = 8,
+    MEDIA = 9
+}
+declare enum CustomFieldIdType {
+    BUSINESS_ID = 0,
+    EXTERNAL_ID = 1
+}
+interface CustomFieldDto {
+    externalId: string;
+    externalSource: ExternalSource;
+    faceted?: boolean;
+    id?: string;
+    indexable?: boolean;
+    mandatory: boolean;
+    name: string;
+    role?: CustomFieldRole;
+    sealedTarget: boolean;
+    searchable?: boolean;
+    sortable?: boolean;
+    status: CustomFieldStatus;
+    type?: CustomFieldType;
+}
+export interface GetCustomFieldParameters {
+    sealedTarget: SealedTarget;
+    status?: CustomFieldStatus;
+    type?: CustomFieldType;
+    searchCriteria?: string;
+    searchable?: boolean;
+    sortable?: boolean;
+    page?: number;
+    size?: number;
+    sort?: string[];
+}
+export interface GetCustomFieldResponse {
+    content: CustomFieldDto[];
+    empty?: boolean;
+    first?: boolean;
+    last?: boolean;
+    number?: number;
+    numberOfElements?: number;
+    pageable?: PageableObject;
+    size?: number;
+    sort?: Order[];
+    totalElemets?: number;
+    totalPages?: number;
+}
+export interface PostMediaCustomFieldParameters {
+    id: string;
+    customFieldIdType?: CustomFieldIdType;
+    sealedTarget?: SealedTarget;
+    fileName: string;
+    fileSize: number;
+}
+export {};

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,116 @@
+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` | **required**
+ * The identifier of the custom field to which the media is associated.
+ * #### customFieldIdType - `string` | **required**
+ * The type of the custom field identifier (e.g., 'externalId').
+ * #### sealedTarget - `boolean`
+ * Indicates whether the media should be sealed.
+ * #### fileName - `string` | **required**
+ * The name of the media file being uploaded.
+ * #### fileSize - `number` | **required**
+ * The size of the media file in bytes.
+ *
+ * @returns {Promise<string>} - A promise that resolves to the URL where the media can be posted.
+ *
+ * @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,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCustomFields = getCustomFields;
+exports.postMediaCustomField = postMediaCustomField;
+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` | **required**
+ * The identifier of the custom field to which the media is associated.
+ * #### customFieldIdType - `string` | **required**
+ * The type of the custom field identifier (e.g., 'externalId').
+ * #### sealedTarget - `boolean`
+ * Indicates whether the media should be sealed.
+ * #### fileName - `string` | **required**
+ * The name of the media file being uploaded.
+ * #### fileSize - `number` | **required**
+ * The size of the media file in bytes.
+ *
+ * @returns {Promise<string>} - A promise that resolves to the URL where the media can be posted.
+ *
+ * @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;
+}