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

package/lib/index.d.ts

@@ -30,14 +30,15 @@ export declare const DjustSDK: {
     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>;
+    createCommercialOrderCardRegistration({ orderId, paymentProvider, currency, }: import("./interfaces").CreateCommercialOrderCardRegistrationParameters): Promise<import("./interfaces").CreateCommercialOrderCardRegistrationResponse>;
     updateCommercialOrderBillingInformation({ orderId, billingAddressId, }: import("./interfaces").UpdateCommercialOrderBillingInformationParameters): Promise<void>;
     setCommercialOrderStatusAsCreated({ orderId, paymentInfo, }: import("./interfaces").SetCommercialOrderStatusAsCreatedParameters): Promise<void>;
     setCommercialOrderStatusAsOnHold({ orderId, }: import("./interfaces").SetCommercialOrderStatusAsOnHoldParameters): Promise<void>;
     getCommercialOrderPaymentPageUrl({ orderId, paymentOption, paymentProvider, }: import("./interfaces").GetCommercialOrderPaymentPageUrlParameters): Promise<string>;
+    createCommercialOrderPreauthorization({ orderId, paymentProvider, authorId, browserInfo, ipAddress, paymentCardInfo, }: import("./interfaces").CreateCommercialOrderPreauthorizationParameters): Promise<import("./interfaces").CreateCommercialOrderPreauthorizationResponse>;
     updateCommercialOrderShippingAddress({ orderId, shippingAddressId, }: import("./interfaces").UpdateCommercialOrderShippingAddressParameters): Promise<void>;
     updateCommercialOrderShippingInformation({ orderId, shippingAddressId, shippingType, }: import("./interfaces").UpdateCommercialOrderShippingInformationParameters): Promise<void>;
     updateCommercialOrderShippingType({ orderId, shippingType, }: import("./interfaces").UpdateCommercialOrderShippingTypeParameters): Promise<void>;
-    updateLogisticOrderCustomFieldsValue({ orderLogisticId, customFieldsValues, }: import("./interfaces").UpdateOrderLogisticCustomFieldParameters): Promise<import("./interfaces").UpdateOrderLogisticCustomFieldResponse>;
     getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, nbPreviewLines, page, size, sort, }: import("./interfaces").GetLogisticOrdersParameters): Promise<import("./interfaces").GetLogisticOrdersResponse>;
     getLogisticOrderCustomFields({ customFieldIds, page, size, sort, }: import("./interfaces").GetLogisticOrderCustomFieldsParameters): Promise<import("./interfaces").GetLogisticOrderCustomFieldsResponse>;
     getLogisticOrderLineCustomFields({ customFieldIds, page, size, sort, }: import("./interfaces").GetLogisticOrderLineCustomFieldsParameters): Promise<import("./interfaces").GetLogisticOrderLineCustomFieldsResponse>;
@@ -50,21 +51,24 @@ export declare const DjustSDK: {
     updateLogisticOrderBillingInformation({ orderId, billingAddressId, }: import("./interfaces").UpdateLogisticOrderBillingInformationParameters): Promise<void>;
     cancelLogisticOrder({ orderId, locale, nbPreviewLines, }: import("./interfaces").CancelLogisticOrderParameters): Promise<import("./interfaces").CancelLogisticOrderResponse>;
     confirmLogisticOrderReception({ orderId, locale, nbPreviewLines, }: import("./interfaces").ConfirmLogisticOrderReceptionParameters): Promise<import("./interfaces").ConfirmLogisticOrderReceptionResponse>;
+    createLogisticOrder({ orderId, }: import("./interfaces").CreateLogisticOrderParameters): Promise<void>;
     disapproveLogisticOrder({ orderId, locale, nbPreviewLines, }: import("./interfaces").DisapproveLogisticOrderParameters): Promise<import("./interfaces").DisapproveLogisticOrderResponse>;
     getLogisticOrderDocuments({ orderId, idType, }: import("./interfaces").GetLogisticOrderDocumentsParameters): Promise<import("./interfaces").GetLogisticOrderDocumentsResponse>;
     getLogisticOrderDocumentUrl({ orderId, documentId, }: import("./interfaces").GetLogisticOrderDocumentUrlParameters): Promise<string[]>;
     getLogisticOrderLines({ orderId, page, size, sort, locale, }: import("./interfaces").GetLogisticOrderLinesParameters): Promise<import("./interfaces").GetLogisticOrderLinesResponse>;
+    updateOnHoldLogisticOrderLines({ orderId, lines, }: import("./interfaces").UpdateOnHoldLogisticOrderLinesParameters): Promise<import("./interfaces").UpdateOnHoldLogisticOrderLinesResponse>;
     updateLogisticOrderLineCustomFields({ orderId, lineId, locale, customFields, }: import("./interfaces").UpdateLogisticOrderLineCustomFieldsParameters): Promise<import("./interfaces").UpdateLogisticOrderLineCustomFieldsResponse>;
+    updateOnHoldLogisticOrderLine({ orderId, orderLineId, quantity, }: import("./interfaces").UpdateOnHoldLogisticOrderLineParameters): Promise<void>;
     updateLogisticOrderShippingAddress({ orderId, shippingAddressId, }: import("./interfaces").UpdateLogisticOrderShippingAddressParameters): Promise<void>;
     getLogisticOrderShippingInformation({ orderId, }: import("./interfaces").GetLogisticOrderShippingAddressParameters): Promise<import("./interfaces").GetLogisticOrderShippingAddressResponse>;
     updateLogisticOrderShippingInformation({ orderId, shippingAddressId, shippingType, }: import("./interfaces").UpdateLogisticOrderShippingInformationParameters): Promise<void>;
     updateLogisticOrderShippingType({ orderId, shippingType, }: import("./interfaces").UpdateLogisticOrderShippingTypeParameters): Promise<void>;
     createLogisticOrderThread({ orderId, lineId, message, reasonCode, }: import("./interfaces").CreateLogisticOrderThreadParameters): Promise<void>;
     getLogisticOrderReview({ orderId, }: import("./interfaces").GetLogisticOrderReviewParameters): Promise<import("./interfaces").GetLogisticOrderReviewResponse>;
-    addLogisitcOrderReview({ orderId, comment, grade, }: import("./interfaces").AddLogisticOrderReviewParameters): Promise<import("./interfaces").AddLogisticOrderReviewResponse>;
+    addLogisticOrderReview({ orderId, comment, grade, }: import("./interfaces").AddLogisticOrderReviewParameters): Promise<import("./interfaces").AddLogisticOrderReviewResponse>;
     getThreadReasonTypes(): Promise<import("./interfaces").GetThreadReasonTypesResponse>;
     getThreadSubReasons({ reasonType, }: import("./interfaces").GetThreadSubReasonsParameters): Promise<import("./interfaces").GetThreadSubReasonsResponse>;
-    getSuppliers({ pageable, }: import("./interfaces").GetSuppliersParameters): Promise<import("./interfaces").GetSuppliersResponse>;
+    getSuppliers({ pageable, supplierStatus, supplierIds, idType, }: import("./interfaces").GetSuppliersParameters): Promise<import("./interfaces").GetSuppliersResponse>;
     getSupplier({ supplierId, idType, }: import("./interfaces").GetSupplierParameters): Promise<import("./interfaces").GetSupplierResponse>;
     getSupplierEvaluations({ supplierId, idType, pageable, }: import("./interfaces").GetSupplierEvaluationsParameters): Promise<import("./interfaces").GetSupplierEvaluationsResponse>;
     getMasterQuotes({ fromCustomerAccount, pageable, }?: import("./interfaces").GetMasterQuotesParameters): Promise<import("./interfaces").GetMasterQuotesResponse>;
@@ -74,8 +78,11 @@ export declare const DjustSDK: {
     updateMasterQuote({ masterQuoteId, customFieldValues, masterQuoteDetailsToAdd, masterQuoteDetailsToRemove, }: import("./interfaces").UpdateMasterQuoteParameters): Promise<import("./interfaces").UpdateMasterQuoteResponse>;
     createSupplierQuotes({ billingAddressId, createSupplierQuoteRequests, masterQuoteId, supplierQuoteUrl, }: import("./interfaces").CreateSupplierQuotesParameters): Promise<import("./interfaces").CreateSupplierQuotesResponse>;
     getSupplierQuote({ supplierQuoteId, }: import("./interfaces").GetSupplierQuoteParameters): Promise<import("./interfaces").GetSupplierQuoteResponse>;
+    acceptSupplierQuote({ supplierQuoteId, }: import("./interfaces").AcceptSupplierQuoteParameters): Promise<import("./interfaces").AcceptSupplierQuoteResponse>;
+    updateSupplierQuoteCustomFields({ supplierQuoteId, customFieldValues, idType, }: import("./interfaces").UpdateSupplierQuoteCustomFieldsParameters): Promise<import("./interfaces").UpdateSupplierQuoteCustomFieldsResponse>;
     declineSupplierQuote({ supplierQuoteId, }: import("./interfaces").DeclineSupplierQuoteParameters): Promise<import("./interfaces").DeclineSupplierQuoteResponse>;
     postMessageToSupplierQuote({ supplierQuoteId, message, username, }: import("./interfaces").PostMessageToSupplierQuoteParameters): Promise<import("./interfaces").PostMessageToSupplierQuoteResponse>;
+    initializeOrderFromSupplierQuote({ supplierQuoteId, nbPreviewLines, quoteLineIdsAndQuantities, }: import("./interfaces").InitializeOrderFromSupplierQuoteParameters): Promise<import("./interfaces").InitializeOrderFromSupplierQuoteResponse>;
     autoCompleteSearchProducts({ input, locale, currency, pageable, aggregation, productTags, }: import("./interfaces").AutoCompleteSearchProductsParameters): Promise<import("./interfaces").SearchProductsResponse>;
     getProductsList({ locale, filters, pageable, }: import("./interfaces").GetProductsListParameters): Promise<import("./interfaces").GetProductsListResponse>;
     getProductVariantsList({ productSku, locale, pageable, }: import("./interfaces").GetProductVariantsListParameters): Promise<import("./interfaces").GetProductVariantsListResponse>;
@@ -93,11 +100,10 @@ export declare const DjustSDK: {
     getNavigationCategories({ locale, }: import("./interfaces").GetNavigationCategoriesParameters): Promise<import("./interfaces").GetNavigationCategoriesResponse>;
     getNavigationCategory({ locale, idType, navigationCategoryId, }: import("./interfaces").GetNavigationCategoryParameters): Promise<import("./interfaces").GetNavigationCategoryResponse>;
     getNavigationCategoryBreadcrumbs({ locale, idType, navigationCategoryId, }: import("./interfaces").GetNavigationCategoryBreadcrumbsParameters): Promise<import("./interfaces").GetNavigationCategoryBreadcrumbsResponse>;
-    getAuthenticatedUser(): Promise<any>;
-    createCustomerUser({ activationUrl, civility, customFieldValues, email, externalId, firstName, lastName, password, groups, status, mainOrganisationId, organisations, phone, }: import("./interfaces").CreateCustomerUserParameters): Promise<import("./interfaces").CreateCustomerUserResponse>;
+    getAuthenticatedUser(): Promise<import("./interfaces").GetAuthenticatedUserResponse>;
+    createCustomerUser(params: import("./interfaces").CreateCustomerUserParameters): Promise<import("./interfaces").CreateCustomerUserResponse>;
     updateCustomerUser({ civility, firstName, lastName, phone, customFieldValues, }: import("./interfaces").UpdateCustomerUserParameters): Promise<import("./interfaces").UpdateCustomerUserResponse>;
-    removeCustomerUserFromAccount({ userId, }: import("./interfaces").RemoveCustomerUserParameters): Promise<void>;
-    activateCustomerUser({ token, }: import("./interfaces").ActivateCustomerUserParameters): Promise<void>;
+    activateCustomerUser(params: import("./interfaces").ActivateCustomerUserParameters): Promise<void>;
     getCustomerUserAddresses({ shipping, billing, account, organisationIds, }: import("./interfaces").GetCustomerUserAddressesParameters): Promise<void>;
     getCustomerUserOrganisations(): Promise<import("./interfaces").GetCustomerUserOrganisationsResponse>;
     sendCustomerUserActivationRequest({ redirectUrl, token, }: import("./interfaces").SendCustomerUserActivationRequestParameters): Promise<void>;
@@ -110,7 +116,6 @@ export declare const DjustSDK: {
     updateCustomerAccountAddress({ addressId, additionalAddress, address, billing, city, company, country, fullName, label, phone, shipping, state, zipcode, }: import("./interfaces").UpdateCustomerAccountAddressParameters): Promise<import("./interfaces").UpdateCustomerAccountAddressResponse>;
     getCustomerAccountOrders({ pageable, locale, }: import("./interfaces").GetCustomerAccountOrdersParameters): Promise<import("./interfaces").GetCustomerAccountOrdersResponse>;
     getCustomerAccountUsers({ pageable, }: import("./interfaces").GetCustomerAccountUsersParameters): Promise<import("./interfaces").GetCustomerAccountUsersResponse>;
-    createCustomerAccountUser({ accountId, civility, firstName, lastName, email, password, groups, }: import("./interfaces").CreateCustomerAccountUsersParameters): Promise<void>;
     createCustomerAccountOrganisation({ externalId, name, parentId, }: import("./interfaces").CreateCustomerAccountOrganisationParameters): Promise<import("./interfaces").CreateCustomerAccountOrganisationResponse>;
     updateCustomerAccountOrganisation({ organisationId, name, parentId, status, }: import("./interfaces").UpdateCustomerAccountOrganisationParameters): Promise<import("./interfaces").UpdateCustomerAccountOrganisationResponse>;
     getCustomerAccountOrganisations(): Promise<import("./interfaces").GetCustomerAccountOrganisationResponse>;

package/lib/interfaces/models/customer-user.d.ts

@@ -1,5 +1,6 @@
 import { CustomFieldValueObject, CustomFieldValueRequest } from "./custom-field";
 import { Order, PageableObject } from "./common";
+import { CustomerAccountDto } from "./customer-account";
 export type CivilityType = "MR" | "MRS" | "MISS";
 export type UserStatus = "ACTIVE" | "INACTIVE" | "NEW" | "WAITING_ACTIVATION" | "APPROBATION_REFUSED";
 export interface CustomerUserWithoutAccountDto {
@@ -100,4 +101,9 @@ export interface SimpleUserView {
     firstName: string;
     lastName: string;
 }
+export interface UserInfoDto {
+    account: CustomerAccountDto;
+    accounts: CustomerAccountDto[];
+    user: CustomerUserDto;
+}
 export {};

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

@@ -62,7 +62,7 @@ export interface OfferInventory {
     minShippingPrice: number;
     minShippingPriceAdditional: number;
     minShippingType: number;
-    minShippingZone: String;
+    minShippingZone: string;
     leadTimeToShip: number;
     customFieldValues: CustomFieldValueDto[];
 }

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

@@ -77,6 +77,12 @@ export interface OrderLogisticLineDto {
     quantity: number;
     status: OrderLineStatus;
 }
+export interface OrderLogisticLineUpdate {
+    customFieldValues: CustomFieldValueObject[];
+    id: string;
+    quantity: number;
+    updateAction: string;
+}
 interface OfferCustomFieldSnapshot {
     externalId: string;
     externalSource: string;
@@ -303,4 +309,94 @@ export interface RequestGetOrderLogisticDocumentbyID {
     orderLogisticId: string;
     documentId: string;
 }
+export interface CardInformationDto {
+    AccessKey: string;
+    CardId: string;
+    CardRegistrationURL: string;
+    CardType: string;
+    CreationDate: string;
+    Currency: string;
+    Id: string;
+    PreregistrationData: string;
+    RegistrationData: string;
+    ResultCode: string;
+    Status: string;
+    Tag: string;
+    UserId: string;
+}
+export interface BrowserInfo {
+    AcceptHeader: string;
+    ColorDepth: number;
+    JavaEnabled: boolean;
+    JavascriptEnabled: boolean;
+    Language: string;
+    ScreenHeight: number;
+    ScreenWidth: number;
+    TimeZoneOffset: string;
+    UserAgent: string;
+}
+export interface PaymentCardInfo {
+    amount: number;
+    cardId: string;
+    currency: string;
+}
+export interface PreauthorizationDto {
+    Applied3DSVersion: string;
+    AuthorId: string;
+    Billing: {
+        Address: {
+            AddressLine1: string;
+            AddressLine2: string;
+            City: string;
+            Country: string;
+            PostalCode: string;
+            Region: string;
+        };
+        FirstName: string;
+        LastName: string;
+    };
+    BrowserInfo: BrowserInfo;
+    CardId: string;
+    CreationDate: number;
+    Culture: string;
+    DebitedFunds: {
+        Amount: number;
+        Currency: Currency;
+    };
+    ExecutionType: string;
+    ExpirationDate: number;
+    Id: string;
+    IpAddress: string;
+    MultiCapture: true;
+    PaymentStatus: string;
+    RemainingFunds: {
+        Amount: number;
+        Currency: Currency;
+    };
+    Requested3DSVersion: string;
+    ResultCode: string;
+    ResultMessage: string;
+    SecureMode: string;
+    SecureModeNeeded: true;
+    SecureModeRedirectURL: string;
+    SecureModeReturnURL: string;
+    SecurityInfo: {
+        AVSResult: string;
+    };
+    Shipping: {
+        Address: {
+            AddressLine1: string;
+            AddressLine2: string;
+            City: string;
+            Country: string;
+            PostalCode: string;
+            Region: string;
+        };
+        FirstName: string;
+        LastName: string;
+    };
+    StatementDescriptor: string;
+    Status: string;
+    Tag: string;
+}
 export {};

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

@@ -2,7 +2,10 @@ import { SupplierSimpleView } from "./supplier";
 import { AddressDto } from "./address";
 import { Order, PageableObject } from "./common";
 import { ProductVariantResponse } from "./product";
-export type SupplierQuoteStatus = "STAGING" | "NEW" | "WAITING_FOR_CUSTOMER" | "WAITING_FOR_SUPPLIER_INFOS" | "WAITING_FOR_OPERATOR" | "DECLINED_BY_OPERATOR" | "DECLINED_BY_SUPPLIER" | "DECLINED_BY_CUSTOMER" | "VALIDATED" | "CLOSED";
+import { CustomFieldValueObject } from "./custom-field";
+export type SupplierQuoteStatus = "STAGING" | "NEW" | "WAITING_FOR_CUSTOMER" | "WAITING_FOR_SUPPLIER_INFOS" | "WAITING_FOR_OPERATOR" | "DECLINED_BY_OPERATOR" | "DECLINED_BY_SUPPLIER" | "DECLINED_BY_CUSTOMER" | "VALIDATED" | "CLOSED" | "EXPIRED";
+export type SupplierQuoteOrderingState = "TO_ORDER" | "PARTIALLY_ORDERED" | "FULLY_ORDERED";
+export type SupplierQuoteIdType = "DJUST_ID" | "EXTERNAL_ID";
 export interface PageMasterQuote {
     content: MasterQuote[];
     empty: boolean;
@@ -17,6 +20,7 @@ export interface PageMasterQuote {
     totalPages: number;
 }
 export interface MasterQuote {
+    customFieldValues: CustomFieldValueObject[];
     description: string;
     id: string;
     masterQuoteDetails: MasterQuoteDetail[];
@@ -31,17 +35,24 @@ export interface MasterQuoteDetail {
 export interface SupplierQuoteDto {
     billingAddress: AddressDto;
     createdAt: string;
+    customFieldValue: CustomFieldValueObject[];
     customerName: string;
     customerThread: ThreadMessage[];
     customerUserId: string;
+    externalId: string;
+    globalDiscount: number;
     id: string;
+    orderingState: SupplierQuoteOrderingState;
     quoteLines: QuoteLine[];
+    quoteWithMultipleOrders: boolean;
     status: SupplierQuoteStatus;
     supplier: SupplierSimpleView;
     updatedAt: string;
     validityDate: string;
 }
 interface QuoteLine {
+    customFieldValues: CustomFieldValueObject[];
+    externalId: string;
     id: string;
     offerInventoryId: string;
     price: number;
@@ -53,6 +64,7 @@ interface QuoteLine {
         quantity: number;
         shippingAddress: AddressDto;
     }[];
+    remainingQuantity: number;
     shippingPrice: number;
     shippingTaxAmount: number;
     shippingTaxRate: number;

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

@@ -1,36 +1,150 @@
+/**
+ * @packageDocumentation
+ *
+ * @document documents/auth.md
+ */
 import { IsTokenValidParameters, LoginParameters, LoginResponse, RefreshTokenParameters, RefreshTokenResponse, ResetPasswordParameters, SendResetPasswordEmailParameters } from "./definitions";
 /**
- * Returns true if the token is valid and not expired, false otherwise
+ * CART ENDPOINT
+ */
+/**
+ * ##R eturns true if the token is valid and not expired, false otherwise
+ * ### APICODE(TOK-200)
  * @param {IsTokenValidParameters} params - The parameters for the function
+ * #### token - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The token to validate.
+ *
  * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the token is valid or not
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const isValidToken = await isTokenValid({
+ *  token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+ * });
+ * ```
+ * #### output
+ * ```json
+ * true
+ * ```
  */
 export declare function isTokenValid({ token, }: IsTokenValidParameters): Promise<boolean>;
 /**
- * Ask for a new token from a refresh token
- * @param {RefreshTokenParameters} params - The parameters for the function
+ * ## Ask for a new token from a refresh token
+ * ### APICODE(AUTH-102)
+ * @param {RefreshTokenParameters} params - The parameters for the function, including:
+ * #### refreshToken - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The refresh token to request a new access token (required)
+ *
  * @returns {Promise<RefreshTokenResponse>} - A promise that resolves to the response containing the new token
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const response = await refreshToken({ refreshToken: 'string' });
+ * ```
+ * #### output
+ * ```json
+ *   {
+ *     "token": {
+ *       "accessToken": "string",
+ *       "expireAt": 0,
+ *       "refreshToken": "string"
+ *     },
+ *     "user": {
+ *       "id": "userID"
+ *     }
+ *   }
+ * ```
  */
 export declare function refreshToken({ refreshToken, }: RefreshTokenParameters): Promise<RefreshTokenResponse>;
 /**
- * Reset the password of a user
+ * ## Reset the password of a user
+ * ### APICODE(PWD-102)
  * @param {ResetPasswordParameters} params - The parameters for the function
- * @returns {Promise<void>} - A promise that resolves when the password is reset
+ * #### newPassword - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The new password to set for the user.
+ * #### resetPasswordToken - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The token required to authenticate the password reset process.
+ *
+ * @returns {Promise<void>} - Resolves to a success message `"OK"` when the password is successfully reset
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *    await resetPassword({ newPassword: 'string', resetPasswordToken: 'string' });
+ * ```
+ * #### output
+ * ```json
+ *    "OK" (No output, resolves on success)
+ * ```
  */
 export declare function resetPassword({ newPassword, resetPasswordToken, }: ResetPasswordParameters): Promise<void>;
 /**
- * Send an email to the user with a reset password link
- * @param {SendResetPasswordEmailParameters} params - The parameters for the function
+ * ## Send an email to the user with a reset password link
+ * ### APICODE(PWD-101)
+ * @param {SendResetPasswordEmailParameters} params - The parameters for the function, including:
+ * #### email - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The email address to send the reset link to.
+ *
  * @returns {Promise<void>} - A promise that resolves when the email is sent
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *    await sendResetPasswordEmail({ email: 'user@example.com' });
+ * ```
+ * #### output
+ * ```json
+ *    "OK" (No output, resolves on success)
+ * ```
  */
 export declare function sendResetPasswordEmail({ email, }: SendResetPasswordEmailParameters): Promise<void>;
 /**
- * Login a user
- * @param {LoginParameters} params - The parameters for the function
+ * ##Login a user
+ * ### APICODE(AUTH-101)
+ * @param {LoginParameters} params - The parameters for the function, including:
+ * #### username - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The username of the user to log in.
+ * #### password - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The password of the user to log in.
+ *
  * @returns {Promise<LoginResponse>} - A promise that resolves to the response containing the user's login information
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *    const loginResponse = await login({ username: 'user@example.com', password: 'password123' });
+ * ```
+ * #### output
+ * ```json
+ *    {
+ *      "token": {
+ *        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+ *        "expireAt": 1679022000,
+ *        "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+ *      },
+ *      "user": {
+ *        "id": "userID"
+ *      }
+ *    }
+ * ```
  */
 export declare function login({ username, password, }: LoginParameters): Promise<LoginResponse>;
 /**
- * Logout the user
+ * ### Logout the user
+ * ### APICODE(AUTH-103)
+ *
  * @returns {Promise<void>} - A promise that resolves when the user is logged out
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *    await logout();
+ * ```
+ * #### output
+ * ```json
+ *    "OK" (No output, resolves on success)
+ * ```
  */
 export declare function logout(): Promise<void>;

package/lib/services/auth/index.js

@@ -1,4 +1,9 @@
 "use strict";
+/**
+ * @packageDocumentation
+ *
+ * @document documents/auth.md
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isTokenValid = isTokenValid;
 exports.refreshToken = refreshToken;
@@ -9,9 +14,28 @@ exports.logout = logout;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * Returns true if the token is valid and not expired, false otherwise
+ * CART ENDPOINT
+ */
+/**
+ * ##R eturns true if the token is valid and not expired, false otherwise
+ * ### APICODE(TOK-200)
  * @param {IsTokenValidParameters} params - The parameters for the function
+ * #### token - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The token to validate.
+ *
  * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the token is valid or not
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const isValidToken = await isTokenValid({
+ *  token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+ * });
+ * ```
+ * #### output
+ * ```json
+ * true
+ * ```
  */
 async function isTokenValid({ token, }) {
     (0, parameters_validation_1.required)({ token });
@@ -25,9 +49,32 @@ async function isTokenValid({ token, }) {
     return response === null || response === void 0 ? void 0 : response.data;
 }
 /**
- * Ask for a new token from a refresh token
- * @param {RefreshTokenParameters} params - The parameters for the function
+ * ## Ask for a new token from a refresh token
+ * ### APICODE(AUTH-102)
+ * @param {RefreshTokenParameters} params - The parameters for the function, including:
+ * #### refreshToken - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The refresh token to request a new access token (required)
+ *
  * @returns {Promise<RefreshTokenResponse>} - A promise that resolves to the response containing the new token
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const response = await refreshToken({ refreshToken: 'string' });
+ * ```
+ * #### output
+ * ```json
+ *   {
+ *     "token": {
+ *       "accessToken": "string",
+ *       "expireAt": 0,
+ *       "refreshToken": "string"
+ *     },
+ *     "user": {
+ *       "id": "userID"
+ *     }
+ *   }
+ * ```
  */
 async function refreshToken({ refreshToken, }) {
     (0, parameters_validation_1.required)({ refreshToken });
@@ -41,9 +88,25 @@ async function refreshToken({ refreshToken, }) {
     return data;
 }
 /**
- * Reset the password of a user
+ * ## Reset the password of a user
+ * ### APICODE(PWD-102)
  * @param {ResetPasswordParameters} params - The parameters for the function
- * @returns {Promise<void>} - A promise that resolves when the password is reset
+ * #### newPassword - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The new password to set for the user.
+ * #### resetPasswordToken - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The token required to authenticate the password reset process.
+ *
+ * @returns {Promise<void>} - Resolves to a success message `"OK"` when the password is successfully reset
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *    await resetPassword({ newPassword: 'string', resetPasswordToken: 'string' });
+ * ```
+ * #### output
+ * ```json
+ *    "OK" (No output, resolves on success)
+ * ```
  */
 async function resetPassword({ newPassword, resetPasswordToken, }) {
     (0, parameters_validation_1.required)({ newPassword, resetPasswordToken });
@@ -57,9 +120,23 @@ async function resetPassword({ newPassword, resetPasswordToken, }) {
     });
 }
 /**
- * Send an email to the user with a reset password link
- * @param {SendResetPasswordEmailParameters} params - The parameters for the function
+ * ## Send an email to the user with a reset password link
+ * ### APICODE(PWD-101)
+ * @param {SendResetPasswordEmailParameters} params - The parameters for the function, including:
+ * #### email - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The email address to send the reset link to.
+ *
  * @returns {Promise<void>} - A promise that resolves when the email is sent
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *    await sendResetPasswordEmail({ email: 'user@example.com' });
+ * ```
+ * #### output
+ * ```json
+ *    "OK" (No output, resolves on success)
+ * ```
  */
 async function sendResetPasswordEmail({ email, }) {
     (0, parameters_validation_1.required)({ email });
@@ -72,9 +149,34 @@ async function sendResetPasswordEmail({ email, }) {
     });
 }
 /**
- * Login a user
- * @param {LoginParameters} params - The parameters for the function
+ * ##Login a user
+ * ### APICODE(AUTH-101)
+ * @param {LoginParameters} params - The parameters for the function, including:
+ * #### username - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The username of the user to log in.
+ * #### password - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The password of the user to log in.
+ *
  * @returns {Promise<LoginResponse>} - A promise that resolves to the response containing the user's login information
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *    const loginResponse = await login({ username: 'user@example.com', password: 'password123' });
+ * ```
+ * #### output
+ * ```json
+ *    {
+ *      "token": {
+ *        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+ *        "expireAt": 1679022000,
+ *        "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+ *      },
+ *      "user": {
+ *        "id": "userID"
+ *      }
+ *    }
+ * ```
  */
 async function login({ username, password, }) {
     (0, parameters_validation_1.required)({ username, password });
@@ -89,8 +191,20 @@ async function login({ username, password, }) {
     return data;
 }
 /**
- * Logout the user
+ * ### Logout the user
+ * ### APICODE(AUTH-103)
+ *
  * @returns {Promise<void>} - A promise that resolves when the user is logged out
+ *
+ * @example
+ * #### input
+ * ```typescript
+ *    await logout();
+ * ```
+ * #### output
+ * ```json
+ *    "OK" (No output, resolves on success)
+ * ```
  */
 async function logout() {
     await (0, fetch_instance_1.enhancedFetch)({