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

package/lib/services/navigation-category/index.d.ts

@@ -1,13 +1,132 @@
 import { GetNavigationCategoriesParameters, GetNavigationCategoriesResponse, GetNavigationCategoryBreadcrumbsParameters, GetNavigationCategoryBreadcrumbsResponse, GetNavigationCategoryParameters, GetNavigationCategoryResponse } from "./definitions";
 /**
- * Get all navigation categories
+ * ## Get all navigation categories
+ * ### APICODE(NAVCAT-550)
+ * @returns {Promise<GetNavigationCategoriesResponse>} - The response with the navigation categories
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getNavigationCategories({ locale: 'string' });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * [
+ *   {
+ *      "active": true,
+ *      "childrenCategories": [
+ *        string
+ *      ],
+ *      "customFieldValues": [
+ *        {
+ *          "customField": {
+ *            "externalId": "string",
+ *            "id": "string",
+ *            "name": {
+ *              "additionalProp1": "string",
+ *              "additionalProp2": "string",
+ *              "additionalProp3": "string"
+ *            },
+ *            "type": "LONG_TEXT"
+ *          },
+ *          "value": {}
+ *        }
+ *      ],
+ *      "externalId": "string",
+ *      "id": "string",
+ *      "name": "string"
+ *    }
+ * ]
  */
 export declare function getNavigationCategories({ locale, }: GetNavigationCategoriesParameters): Promise<GetNavigationCategoriesResponse>;
 /**
- * Get navigation category
+ * ## Get navigation category
+ * ### APICODE(NAVCAT-501)
+ * @param {GetNavigationCategoryParameters} params - The parameters for the function
+ * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### idType - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### navigationCategoryId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<GetNavigationCategoryResponse>} - The response with the navigation category
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getNavigationCategory({ locale: 'string', idType: 'string', navigationCategoryId: 'string' });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "active": true,
+ *   "childrenCategories": [
+ *     string
+ *   ],
+ *   "customFieldValues": [
+ *     {
+ *       "customField": {
+ *         "externalId": "string",
+ *         "id": "string",
+ *         "name": {
+ *           "additionalProp1": "string",
+ *           "additionalProp2": "string",
+ *           "additionalProp3": "string"
+ *         },
+ *         "type": "LONG_TEXT"
+ *       },
+ *       "value": {}
+ *     }
+ *   ],
+ *   "externalId": "string",
+ *   "id": "string",
+ *   "name": "string",
+ * }
  */
 export declare function getNavigationCategory({ locale, idType, navigationCategoryId, }: GetNavigationCategoryParameters): Promise<GetNavigationCategoryResponse>;
 /**
- * Get navigation category breadcrumbs
+ * ## Get navigation category breadcrumbs
+ * ### APICODE(NAVCAT-502)
+ * @param {GetNavigationCategoryBreadcrumbsParameters} params - The parameters for the function
+ * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### idType - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### navigationCategoryId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<GetNavigationCategoryBreadcrumbsResponse>} - The response with the navigation category breadcrumbs
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getNavigationCategoryBreadcrumbs({ locale: 'string', idType: 'string', navigationCategoryId: 'string' });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * [
+ *   {
+ *     "active": true,
+ *     "childrenCategories": [
+ *       string
+ *     ],
+ *     "customFieldValues": [
+ *       {
+ *         "customField": {
+ *           "externalId": "string",
+ *           "id": "string",
+ *           "name": {
+ *             "additionalProp1": "string",
+ *             "additionalProp2": "string",
+ *             "additionalProp3": "string"
+ *           },
+ *           "type": "LONG_TEXT"
+ *         },
+ *         "value": {}
+ *       }
+ *     ],
+ *     "externalId": "string",
+ *     "id": "string",
+ *     "name": "string",
+ *     "parent": "string"
+ *   }
  */
 export declare function getNavigationCategoryBreadcrumbs({ locale, idType, navigationCategoryId, }: GetNavigationCategoryBreadcrumbsParameters): Promise<GetNavigationCategoryBreadcrumbsResponse>;

package/lib/services/navigation-category/index.js

@@ -6,7 +6,44 @@ exports.getNavigationCategoryBreadcrumbs = getNavigationCategoryBreadcrumbs;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * Get all navigation categories
+ * ## Get all navigation categories
+ * ### APICODE(NAVCAT-550)
+ * @returns {Promise<GetNavigationCategoriesResponse>} - The response with the navigation categories
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getNavigationCategories({ locale: 'string' });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * [
+ *   {
+ *      "active": true,
+ *      "childrenCategories": [
+ *        string
+ *      ],
+ *      "customFieldValues": [
+ *        {
+ *          "customField": {
+ *            "externalId": "string",
+ *            "id": "string",
+ *            "name": {
+ *              "additionalProp1": "string",
+ *              "additionalProp2": "string",
+ *              "additionalProp3": "string"
+ *            },
+ *            "type": "LONG_TEXT"
+ *          },
+ *          "value": {}
+ *        }
+ *      ],
+ *      "externalId": "string",
+ *      "id": "string",
+ *      "name": "string"
+ *    }
+ * ]
  */
 async function getNavigationCategories({ locale, }) {
     (0, parameters_validation_1.required)({ locale });
@@ -20,7 +57,47 @@ async function getNavigationCategories({ locale, }) {
     return data;
 }
 /**
- * Get navigation category
+ * ## Get navigation category
+ * ### APICODE(NAVCAT-501)
+ * @param {GetNavigationCategoryParameters} params - The parameters for the function
+ * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### idType - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### navigationCategoryId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<GetNavigationCategoryResponse>} - The response with the navigation category
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getNavigationCategory({ locale: 'string', idType: 'string', navigationCategoryId: 'string' });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * {
+ *   "active": true,
+ *   "childrenCategories": [
+ *     string
+ *   ],
+ *   "customFieldValues": [
+ *     {
+ *       "customField": {
+ *         "externalId": "string",
+ *         "id": "string",
+ *         "name": {
+ *           "additionalProp1": "string",
+ *           "additionalProp2": "string",
+ *           "additionalProp3": "string"
+ *         },
+ *         "type": "LONG_TEXT"
+ *       },
+ *       "value": {}
+ *     }
+ *   ],
+ *   "externalId": "string",
+ *   "id": "string",
+ *   "name": "string",
+ * }
  */
 async function getNavigationCategory({ locale, idType, navigationCategoryId, }) {
     (0, parameters_validation_1.required)({ idType, navigationCategoryId });
@@ -35,7 +112,49 @@ async function getNavigationCategory({ locale, idType, navigationCategoryId, })
     return data;
 }
 /**
- * Get navigation category breadcrumbs
+ * ## Get navigation category breadcrumbs
+ * ### APICODE(NAVCAT-502)
+ * @param {GetNavigationCategoryBreadcrumbsParameters} params - The parameters for the function
+ * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### idType - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * #### navigationCategoryId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * @returns {Promise<GetNavigationCategoryBreadcrumbsResponse>} - The response with the navigation category breadcrumbs
+ *
+ * @example
+ * ### input
+ * ```typescript
+ * const response = await getNavigationCategoryBreadcrumbs({ locale: 'string', idType: 'string', navigationCategoryId: 'string' });
+ * ```
+ * ### output
+ * Response - <strong style={{ color: 'green' }}>200</strong> - OK
+ * ```json
+ * [
+ *   {
+ *     "active": true,
+ *     "childrenCategories": [
+ *       string
+ *     ],
+ *     "customFieldValues": [
+ *       {
+ *         "customField": {
+ *           "externalId": "string",
+ *           "id": "string",
+ *           "name": {
+ *             "additionalProp1": "string",
+ *             "additionalProp2": "string",
+ *             "additionalProp3": "string"
+ *           },
+ *           "type": "LONG_TEXT"
+ *         },
+ *         "value": {}
+ *       }
+ *     ],
+ *     "externalId": "string",
+ *     "id": "string",
+ *     "name": "string",
+ *     "parent": "string"
+ *   }
  */
 async function getNavigationCategoryBreadcrumbs({ locale, idType, navigationCategoryId, }) {
     (0, parameters_validation_1.required)({ idType, navigationCategoryId });

package/lib/services/quote/definitions.d.ts

@@ -1,5 +1,7 @@
-import { MasterQuote, PageMasterQuote, SupplierQuoteDto } from "../../interfaces/models/quote";
+import { MasterQuote, PageMasterQuote, SupplierQuoteDto, SupplierQuoteIdType } from "../../interfaces/models/quote";
+import { OrderCommercialDto } from "../../interfaces/models/order";
 import { PageableParameters } from "../../interfaces/models/common";
+import { CustomFieldValueRequest } from "../../interfaces/models/custom-field";
 /**
  * Request parameters type definitions
  */
@@ -46,6 +48,9 @@ export interface CreateSupplierQuotesParameters {
 export interface GetSupplierQuoteParameters {
     supplierQuoteId: string;
 }
+export interface AcceptSupplierQuoteParameters {
+    supplierQuoteId: string;
+}
 export interface DeclineSupplierQuoteParameters {
     supplierQuoteId: string;
 }
@@ -54,6 +59,19 @@ export interface PostMessageToSupplierQuoteParameters {
     message: string;
     username: string;
 }
+export interface UpdateSupplierQuoteCustomFieldsParameters {
+    supplierQuoteId: string;
+    customFieldValues: CustomFieldValueRequest[];
+    idType: SupplierQuoteIdType;
+}
+export interface InitializeOrderFromSupplierQuoteParameters {
+    supplierQuoteId: string;
+    nbPreviewLines: number;
+    quoteLineIdsAndQuantities: {
+        quantity: number;
+        quoteLineId: string;
+    };
+}
 /**
  * Response type definitions
  */
@@ -71,5 +89,11 @@ export interface GetSupplierQuoteResponse extends SupplierQuoteDto {
 }
 export interface DeclineSupplierQuoteResponse extends SupplierQuoteDto {
 }
+export interface AcceptSupplierQuoteResponse extends SupplierQuoteDto {
+}
 export interface PostMessageToSupplierQuoteResponse extends SupplierQuoteDto {
 }
+export interface UpdateSupplierQuoteCustomFieldsResponse extends SupplierQuoteDto {
+}
+export interface InitializeOrderFromSupplierQuoteResponse extends OrderCommercialDto {
+}