@djust-b2b/djust-front-sdk 2.0.0 → 2.1.1

package/lib/index.d.ts

@@ -9,6 +9,7 @@ export declare const DjustSDK: {
     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>;
     createOrderLogisticIncidentThread({ logisticOrderId, incidentId, idType, customField, message, name, reasonCode, }: import("./services/incident/definitions").createOrderLogisticIncidentThreadParameters): Promise<import("./services/incident/definitions").createOrderLogisticIncidentThreadResponse>;
+    createIncident({ customField, externalId, logisticOrderId, reasonCodes, idType, }: import("./services/incident/definitions").createIncidentParameters): Promise<import("./services/incident/definitions").createIncidentResponse>;
     getCommercialOrders({ locale, nbPreviewLines, page, size, sort, connectedUserOnly, customerAccountIds, isValidated, }: import("./interfaces").GetCommercialOrdersParameters): Promise<import("./interfaces").GetCommercialOrdersResponse>;
     createCommercialOrder({ nbPreviewLines, channel, customFields, locale, origin, originId, paymentInfo, }: import("./interfaces").CreateCommercialOrderParameters): Promise<import("./interfaces").CreateCommercialOrderResponse>;
     createCommercialOrderV2({ customFieldIdType, customFields, }: import("./interfaces").CreateCommercialOrderV2Parameters): Promise<import("./interfaces").CreateCommercialOrderV2Response>;
@@ -28,10 +29,10 @@ export declare const DjustSDK: {
     updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, updateOrderLineIdType, updateOrderLineType, }: import("./interfaces").UpdateCommercialOrderLinesParameters): Promise<import("./interfaces").UpdateCommercialOrderLinesResponse>;
     deleteCommercialOrderLines({ commercialOrderId, body, }: import("./interfaces").DeleteCommercialOrderLinesParameters): Promise<import("./interfaces").DeleteCommercialOrderLinesResponse>;
     punchoutOciCommercialOrder({ tenantConfigurationKey, commercialOrderId, locale, }: import("./interfaces").PunchoutOciCommercialOrderParameters): Promise<any>;
-    getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, connectedUserOnly, nbPreviewLines, page, size, sort, }: import("./interfaces").GetLogisticOrdersParameters): Promise<import("./interfaces").GetLogisticOrdersResponse>;
+    getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, connectedUserOnly, nbPreviewLines, page, size, sort, suppliersIds, creationDateFrom, creationDateTo, updateDateFrom, updateDateTo, }: import("./interfaces").GetLogisticOrdersParameters): Promise<import("./interfaces").GetLogisticOrdersResponse>;
     logisticOrdersPaginatedList({ page, size, sort, nbPreviewLines, accountCustomFieldValueCriteria, approvalIds, connectedUserOnly, creationDateFrom, creationDateTo, customerAccountIds, incident, locale, logisticStatus, offerCustomFieldValueCriteria, orderLogisticCustomFieldValueCriteria, paymentOptions, supplierIds, updateDateFrom, updateDateTo, }: import("./interfaces").GetPaginatedLogisticOrdersParameters): Promise<import("./interfaces").GetPaginatedLogisticOrdersResponse>;
-    getLogisticOrderCustomFields({ customFieldIds, page, size, sort, }: import("./interfaces").GetLogisticOrderCustomFieldsParameters): Promise<import("./interfaces").GetLogisticOrderCustomFieldsResponse>;
-    getLogisticOrderLineCustomFields({ customFieldIds, page, size, sort, }: import("./interfaces").GetLogisticOrderLineCustomFieldsParameters): Promise<import("./interfaces").GetLogisticOrderLineCustomFieldsResponse>;
+    getLogisticOrderCustomFields({ customFieldIds, page, size, sort, idType, }: import("./interfaces").GetLogisticOrderCustomFieldsParameters): Promise<import("./interfaces").GetLogisticOrderCustomFieldsResponse>;
+    getLogisticOrderLineCustomFields({ customFieldIds, page, size, sort, idType, }: import("./interfaces").GetLogisticOrderLineCustomFieldsParameters): Promise<import("./interfaces").GetLogisticOrderLineCustomFieldsResponse>;
     getLogisticOrder({ orderId, locale, nbPreviewLines, }: import("./interfaces").GetLogisticOrderParameters): Promise<import("./interfaces").GetLogisticOrderResponse>;
     updateLogisticOrderCustomFields({ orderId, locale, nbPreviewLines, customFields, }: import("./interfaces").UpdateLogisticOrderCustomFieldsParameters): Promise<import("./interfaces").UpdateLogisticOrderCustomFieldsResponse>;
     getLogisticOrderAccountingDocuments({ orderId, }: import("./interfaces").GetLogisticOrderAccountingDocumentsParameters): Promise<import("./interfaces").GetLogisticOrderAccountingDocumentsResponse>;
@@ -55,13 +56,13 @@ export declare const DjustSDK: {
     updateLogisticOrderShippingType({ orderId, shippingType, }: import("./interfaces").UpdateLogisticOrderShippingTypeParameters): Promise<void>;
     createLogisticOrderThread({ orderId, lineId, message, reasonCode, }: import("./interfaces").CreateLogisticOrderThreadParameters): Promise<import("./interfaces").CreateLogisticOrderThreadResponse>;
     createLogisticOrderThreadV2({ logisticOrderId, idType, message, reasonCode, }: import("./interfaces").CreateLogisticOrderThreadParametersV2): Promise<import("./interfaces").CreateLogisticOrderThreadResponseV2>;
-    getLogisticOrderThreads({ logisticOrderId, pageable, }: import("./interfaces").GetLogisticOrderThreadsParams): Promise<import("./interfaces").GetLogisticOrderThreadsResponse>;
-    getLogisticOrderThread({ logisticOrderId, threadId, }: import("./interfaces").GetLogisticOrderThreadParams): Promise<import("./interfaces").GetLogisticOrderThreadResponse>;
-    createOrderLogisticThreadMessages({ logisticOrderId, threadId, body, customField, }: import("./interfaces").CreateLogisticOrderThreadMessagesParams): Promise<import("./interfaces").CreateLogisticOrderThreadMessagesResponse>;
+    getLogisticOrderThreads({ logisticOrderId, pageable, idType, }: import("./interfaces").GetLogisticOrderThreadsParams): Promise<import("./interfaces").GetLogisticOrderThreadsResponse>;
+    getLogisticOrderThread({ logisticOrderId, threadId, idType, }: import("./interfaces").GetLogisticOrderThreadParams): Promise<import("./interfaces").GetLogisticOrderThreadResponse>;
+    createOrderLogisticThreadMessages({ logisticOrderId, threadId, body, customField, idType, }: import("./interfaces").CreateLogisticOrderThreadMessagesParams): Promise<import("./interfaces").CreateLogisticOrderThreadMessagesResponse>;
     updateOrderLogisticThreadMessage({ logisticOrderId, threadId, messageId, customFieldValues, idType, }: import("./interfaces").UpdateLogisticOrderThreadMessageParams): Promise<void>;
-    createLogisticOrderIncidentThreads({ logisticOrderId, incidentId, customField, message, name, reasonCode, }: import("./interfaces").CreateLogisticOrderIncidentThreadsParams): Promise<import("./interfaces").CreateLogisticOrderIncidentThreadsResponse>;
-    getLogisticOrderIncidentThread({ logisticOrderId, incidentId, threadId, }: import("./interfaces").GetLogisticOrderIncidentThreadParams): Promise<import("./interfaces").GetLogisticOrderIncidentThreadResponse>;
-    createLogisticOrderIncidentThreadMessages({ logisticOrderId, incidentId, threadId, body, customField, }: import("./interfaces").CreateLogisticOrderIncidentThreadMessagesParams): Promise<import("./interfaces").CreateLogisticOrderIncidentThreadMessagesResponse>;
+    createLogisticOrderIncidentThreads({ logisticOrderId, incidentId, customField, message, name, reasonCode, idType, }: import("./interfaces").CreateLogisticOrderIncidentThreadsParams): Promise<import("./interfaces").CreateLogisticOrderIncidentThreadsResponse>;
+    getLogisticOrderIncidentThread({ logisticOrderId, incidentId, threadId, idType, }: import("./interfaces").GetLogisticOrderIncidentThreadParams): Promise<import("./interfaces").GetLogisticOrderIncidentThreadResponse>;
+    createLogisticOrderIncidentThreadMessages({ logisticOrderId, incidentId, threadId, body, customField, idType, }: import("./interfaces").CreateLogisticOrderIncidentThreadMessagesParams): Promise<import("./interfaces").CreateLogisticOrderIncidentThreadMessagesResponse>;
     updateLogisticOrderIncidentThreadMessage({ logisticOrderId, incidentId, threadId, messageId, customFieldValues, idType, }: import("./interfaces").UpdateLogisticOrderIncidentThreadMessageParams): Promise<void>;
     getLogisticOrderReview({ orderId, }: import("./interfaces").GetLogisticOrderReviewParameters): Promise<import("./interfaces").GetLogisticOrderReviewResponse>;
     addLogisticOrderReview({ orderId, comment, grade, }: import("./interfaces").AddLogisticOrderReviewParameters): Promise<import("./interfaces").AddLogisticOrderReviewResponse>;
@@ -84,11 +85,10 @@ export declare const DjustSDK: {
     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>;
-    getProductVariantOffers({ productIdentifier, productIdType, currency, }: import("./interfaces").GetProductVariantOffersParameters): Promise<import("./interfaces").GetProductVariantOffersResponse>;
+    getProductVariantOffers({ productIdentifier, productIdType, currency, withoutPrice, }: import("./interfaces").GetProductVariantOffersParameters): Promise<import("./interfaces").GetProductVariantOffersResponse>;
     getProductVariantSuppliers({ productVariantId, }: import("./interfaces").GetProductVariantSuppliersParameters): Promise<import("./interfaces").GetProductVariantSuppliersResponse>;
     getProduct({ productIdentifier, productIdType, locale, }: import("./interfaces").GetProductParameters): Promise<import("./interfaces").GetProductsListResponse>;
-    getProductOffers({ productIdentifier, productIdType, locale, currency, }: import("./interfaces").GetProductOffersParameters): Promise<import("./interfaces").GetProductOffersResponse>;
+    getProductOffers({ productIdentifier, productIdType, locale, currency, withoutPrice, }: import("./interfaces").GetProductOffersParameters): Promise<import("./interfaces").GetProductOffersResponse>;
     getRelatedProducts({ productIdentifier, productIdType, locale, currency, pageable, }: import("./interfaces").GetRelatedProductsParameters): Promise<import("./interfaces").GetRelatedProductsResponse>;
     getProductReviews({ productIdentifier, productIdType, }: import("./interfaces").GetProductReviewsParameters): Promise<import("./interfaces").GetProductReviewsResponse>;
     getProductStatReviews({ productIdentifier, productIdType, }: import("./interfaces").GetProductStatReviewsParameters): Promise<import("./interfaces").GetProductStatReviewsResponse>;
@@ -99,6 +99,7 @@ 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>;
+    getNavigationCategoryByOptions(params?: import("./interfaces").GetNavigationCategoryByOptionsParameters): Promise<import("./interfaces").GetNavigationCategoriesResponse>;
     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>;
@@ -106,7 +107,7 @@ export declare const DjustSDK: {
     getCustomerUserAddresses({ shipping, billing, account, organisationIds, }: import("./interfaces").GetCustomerUserAddressesParameters): Promise<void>;
     getCustomerUserOrganisations(): Promise<import("./interfaces").GetCustomerUserOrganisationsResponse>;
     sendCustomerUserActivationRequest({ redirectUrl, token, }: import("./interfaces").SendCustomerUserActivationRequestParameters): Promise<void>;
-    updateSpecificCustomerUser({ userToUpdateId, civility, firstName, lastName, phone, groups, customFieldValues, }: import("./interfaces").UpdateSpecificCustomerUserParameters): Promise<void>;
+    updateSpecificCustomerUser({ userToUpdateId, civility, firstName, lastName, phone, groups, customFieldValues, idType, }: import("./interfaces").UpdateSpecificCustomerUserParameters): Promise<void>;
     removeAccountsFromCustomerUser({ userToUpdateId, idType, accountIds, }: import("./interfaces").RemoveAccountsFromCustomerUserParameters): Promise<void>;
     addCustomerUserToAccounts({ userToUpdateId, idType, accountIds, }: import("./interfaces").AddCustomerUserToAccountsParameters): Promise<void>;
     getCustomerAccount(config?: import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").GetCustomerAccountResponse>;
@@ -117,11 +118,14 @@ export declare const DjustSDK: {
     createCustomerAccountAddress(params: import("./interfaces").CreateCustomerAccountAddressParameters & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").CreateCustomerAccountAddressResponse>;
     deleteCustomerAccountAddress({ addressId, ...config }: import("./interfaces").DeleteCustomerAccountAddressParameters & import("./interfaces/models/common").DjustConfig): Promise<void>;
     updateCustomerAccountAddress({ addressId, additionalAddress, address, billing, city, company, country, fullName, label, phone, shipping, state, zipcode, ...config }: import("./interfaces").UpdateCustomerAccountAddressParameters & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").UpdateCustomerAccountAddressResponse>;
+    getCustomerAccountCustomFields({ customFieldIds, idType, pageable, }: import("./interfaces").GetCustomerAccountCustomFieldsParameters): Promise<import("./interfaces").GetCustomerAccountCustomFieldsResponse>;
     getCustomerAccountOrders(params: import("./interfaces").GetCustomerAccountOrdersParameters & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").GetCustomerAccountOrdersResponse>;
     getCustomerAccountUsers(params: import("./interfaces").GetCustomerAccountUsersParameters & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").GetCustomerAccountUsersResponse>;
     createCustomerAccountOrganisation(params: import("./interfaces").CreateCustomerAccountOrganisationParameters & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").CreateCustomerAccountOrganisationResponse>;
     updateCustomerAccountOrganisation(params: import("./interfaces").UpdateCustomerAccountOrganisationParameters & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").UpdateCustomerAccountOrganisationResponse>;
-    getCustomerAccountOrganisations(config?: import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").GetCustomerAccountOrganisationResponse>;
+    getCustomerAccountOrganisations(params?: {
+        pageable?: import("./interfaces/models/common").PageableParameters;
+    } & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").GetCustomerAccountOrganisationResponse>;
     getCustomerAccountOrganisationAddresses(params: import("./interfaces").GetCustomerAccountOrganisationAddressesParameters & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").GetCustomerAccountOrganisationAddressesResponse>;
     deleteCustomerAccountOrganisationAddress(params: import("./interfaces").DeleteCustomerAccountOrganisationAddressParameters & import("./interfaces/models/common").DjustConfig): Promise<void>;
     updateCustomerAccountOrganisationAddress(params: import("./interfaces").UpdateCustomerAccountOrganisationAddressParameters & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").UpdateCustomerAccountOrganisationAddressResponse>;
@@ -151,7 +155,9 @@ export declare const DjustSDK: {
     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>;
+    login({ username, password, withUser, }: import("./services/auth/definitions.requests").LoginParameters): Promise<import("./interfaces").LoginResponse>;
     logout(): Promise<void>;
+    getSettings(): Promise<import("./interfaces").SettingsResponse>;
+    getStore({ storeId, }: import("./services/auth/definitions.requests").GetStoreParameters): Promise<import("./interfaces").Store>;
 };
 export * from "./interfaces";

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

@@ -7,9 +7,19 @@ export interface AttributeValue {
 export interface Attribute {
     id: string;
     externalId: string;
-    name: string;
-    status: string;
+    externalSource: string;
+    names: {
+        additionalProp1: string;
+        additionalProp2: string;
+        additionalProp3: string;
+    };
+}
+export interface AttributeObject {
+    externalId: string;
+    id: string;
+    name: Record<string, string>;
     type: AttributeType;
+    values: string[];
 }
 export interface AttributeObject {
     externalId: string;

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

@@ -54,3 +54,14 @@ export interface DjustConfig {
     storeId?: string;
     storeViewId?: string;
 }
+export interface BrowserInfo {
+    acceptHeader: string;
+    colorDepth: number;
+    javaEnabled: boolean;
+    javaScriptEnabled: boolean;
+    language: string;
+    screenHeight: number;
+    screenWidth: number;
+    timeZoneOffset: number;
+    userAgent: string;
+}

package/lib/interfaces/models/custom-field.d.ts

@@ -23,11 +23,15 @@ export interface CustomFieldTeaserSearch {
 export interface CustomFieldSearch {
     externalId: string;
     externalSource: string;
+    facetable?: boolean;
     id: string;
+    indexable?: boolean;
     mandatory: boolean;
     name: string;
     role?: string;
     sealedTarget: SealedTarget;
+    searchable?: boolean;
+    sortable?: boolean;
     status?: string;
     type: string;
 }

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

@@ -5,6 +5,7 @@ import { CustomerUserWithoutAccountDto } from "./customer-user";
 import { PaymentType } from "./payment";
 export type CustomerAccountStatus = "ACTIVE" | "INACTIVE" | "WAITING_APPROBATION" | "APPROBATION_REFUSED";
 export type AccountIdType = "DJUST_ID" | "EXTERNAL_ID";
+export type AccountCustomFieldsIdType = "DJUST_ID" | "EXTERNAL_ID";
 interface CustomerTagNameableDto {
     id: string;
     name: string;

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

@@ -36,6 +36,15 @@ export interface OfferPriceResponse {
     customerTagId: string;
     priceRanges: PriceRange[];
 }
+export interface OfferPrice {
+    customerAccountExternalId: string;
+    customerTagExternalId: string;
+    externalId: string;
+    id: string;
+    itemPerPack: number;
+    priceRanges: PriceRange[];
+    type: string;
+}
 export interface PriceRange {
     discountPrice: ProductPrice;
     quantity: number;

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

@@ -1,6 +1,7 @@
 export type PaymentType = "ON_ACCEPTANCE" | "DUE_DATE";
 export type PaymentOption = "BANK_WIRE" | "BANK_WIRE_ON_DUE_DATE" | "CREDIT_CARD" | "DIRECT_PAYMENT" | "BANK_WIRE_ON_ACCEPTANCE";
 export type PaymentStatus = "AUTHORIZED" | "WAITING_AUTHORIZATION" | "WAITING_PAYMENT" | "PAID" | "PARTIALLY_PAID" | "OVER_PAID" | "REFUSED" | "WAITING_REFUND" | "PARTIALLY_REFUNDED" | "REFUNDED";
+export type PaymentReferenceType = "LOGISTIC" | "COMMERCIAL";
 type PaymentDueDateMode = "SIMPLE" | "END_OF_MONTH";
 export type PaymentProvider = "MANGOPAY" | "THUNES" | "LEMONWAY";
 export interface PaymentDueDate {
@@ -13,5 +14,6 @@ export interface PaymentInfoRequest {
     };
     paymentOption: PaymentOption;
     paymentProvider: PaymentProvider;
+    referenceType?: string;
 }
 export {};

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

@@ -0,0 +1,27 @@
+import { Attribute } from "../../interfaces/models/attribute";
+import { PageableObject, PageableParameters, Order } from "../../interfaces/models/common";
+/**
+ * Request parameters type definitions
+ */
+export interface GetAttributesParameters {
+    searchCriteria?: string;
+    pageable?: PageableParameters;
+    searchable?: boolean;
+    sortable?: boolean;
+}
+/**
+ * Response type definitions
+ */
+export interface GetAttributesResponse {
+    content: Attribute[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+    totalPages: number;
+}

package/lib/services/attributes/definitions.js

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

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

@@ -0,0 +1,32 @@
+import { GetAttributesParameters, GetAttributesResponse } from "./definitions";
+/**
+ * 🛒 Retrieves all attributes.
+ *
+ * This function allows fetching the list of attributes.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/attributes [listAttribute]`
+ *
+ * | Parameter        | Type                 | Required   | Description                                                |
+ * |------------------|----------------------|------------|------------------------------------------------------------|                |
+ * | `searchCriteria` | `string`             | ❌         | The search term.                                 |
+ * | `searchable`     | `boolean`            | ❌         | If appears in search response.                                 |
+ * | `sortable`       | `boolean`            | ❌         | If is sortable.                                 |
+ * | `pageable`       | `object`             | ❌         | The pagination parameters.                , `BUYING_LIST`).                             |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetAttributesResponse` object, containing the list of attributes and pagination information.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const attributes = await getAttributes({ pageable: { page: 1, size: 10 } });
+ * ```
+ *
+ * @param {GetAttributesParameters} params - The parameters for retrieving the attributes, including:
+ *   - `searchCriteria` - The search term.
+ *   - `searchable` - The boolean if attributes appears in search response.
+ *   - `sortable` - The boolean if can sort by this attribute.
+ *   - `pageable` - The pagination parameters.
+ *
+ * @returns {Promise<GetAttributesResponse>} - An object containing the list of attributes and pagination information.
+ */
+export declare function getAttributes({ searchCriteria, searchable, sortable, pageable, }: GetAttributesParameters): Promise<GetAttributesResponse>;

package/lib/services/attributes/index.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAttributes = getAttributes;
+const fetch_instance_1 = require("../../settings/fetch-instance");
+/**
+ * 🛒 Retrieves all attributes.
+ *
+ * This function allows fetching the list of attributes.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/attributes [listAttribute]`
+ *
+ * | Parameter        | Type                 | Required   | Description                                                |
+ * |------------------|----------------------|------------|------------------------------------------------------------|                |
+ * | `searchCriteria` | `string`             | ❌         | The search term.                                 |
+ * | `searchable`     | `boolean`            | ❌         | If appears in search response.                                 |
+ * | `sortable`       | `boolean`            | ❌         | If is sortable.                                 |
+ * | `pageable`       | `object`             | ❌         | The pagination parameters.                , `BUYING_LIST`).                             |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetAttributesResponse` object, containing the list of attributes and pagination information.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const attributes = await getAttributes({ pageable: { page: 1, size: 10 } });
+ * ```
+ *
+ * @param {GetAttributesParameters} params - The parameters for retrieving the attributes, including:
+ *   - `searchCriteria` - The search term.
+ *   - `searchable` - The boolean if attributes appears in search response.
+ *   - `sortable` - The boolean if can sort by this attribute.
+ *   - `pageable` - The pagination parameters.
+ *
+ * @returns {Promise<GetAttributesResponse>} - An object containing the list of attributes and pagination information.
+ */
+async function getAttributes({ searchCriteria, searchable, sortable, pageable, }) {
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/attributes`,
+        params: {
+            searchCriteria,
+            searchable,
+            sortable,
+            page: pageable === null || pageable === void 0 ? void 0 : pageable.page,
+            size: pageable === null || pageable === void 0 ? void 0 : pageable.size,
+            sort: pageable === null || pageable === void 0 ? void 0 : pageable.sort,
+        },
+    });
+    return data;
+}

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

@@ -20,6 +20,9 @@ export interface LoginParameters {
     username: string;
     password: string;
 }
+export interface SettingsResponse {
+    manualAccountCheck: boolean;
+}
 /**
  * Response type definitions
  */
@@ -27,3 +30,39 @@ export interface RefreshTokenResponse extends AuthenticationResponseDto {
 }
 export interface LoginResponse extends AuthenticationResponseDto {
 }
+export interface StoreLocale {
+    active: boolean;
+    code: string;
+    id: string;
+    label: string;
+    main: boolean;
+}
+export interface CustomField {
+    externalId: string;
+    externalSource: string;
+    faceted: boolean;
+    id: string;
+    indexable: boolean;
+    mandatory: boolean;
+    name: {
+        [key: string]: string;
+    };
+    role: string;
+    sealedTarget: string;
+    searchable: boolean;
+    sortable: boolean;
+    status: string;
+}
+export interface CustomFieldValue {
+    customField: CustomField;
+    value: Record<string, unknown>;
+}
+export interface Store {
+    active: boolean;
+    customFieldValues: CustomFieldValue[];
+    description: string;
+    externalId: string;
+    id: string;
+    name: string;
+    storeLocales: StoreLocale[];
+}

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

@@ -17,4 +17,8 @@ export interface SendResetPasswordEmailParameters {
 export interface LoginParameters {
     username: string;
     password: string;
+    withUser?: boolean;
+}
+export interface GetStoreParameters {
+    storeId: string;
 }

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

@@ -12,8 +12,8 @@
  *
  * Each function is described with its input parameters, output responses, and example usages.
  */
-import { LoginResponse, RefreshTokenResponse } from "./definitions";
-import { IsTokenValidParameters, LoginParameters, RefreshTokenParameters, ResetPasswordParameters, SendResetPasswordEmailParameters } from "./definitions.requests";
+import { LoginResponse, RefreshTokenResponse, SettingsResponse, Store } from "./definitions";
+import { IsTokenValidParameters, LoginParameters, RefreshTokenParameters, ResetPasswordParameters, SendResetPasswordEmailParameters, GetStoreParameters } from "./definitions.requests";
 /**
  * 🔐 Validates if a token is still active and unexpired.
  *
@@ -132,6 +132,7 @@ export declare function sendResetPasswordEmail({ email, }: SendResetPasswordEmai
  * |-------------|----------|----------|--------------------------------------|
  * | `username`  | `string` | ✅       | The username of the user to log in.  |
  * | `password`  | `string` | ✅       | The password of the user to log in.  |
+ * | `withUser`  | `boolean`| ❌       | Whether to include user details in the response. Default: `true` |
  *
  * 📤 **Returns**:
  * A `Promise<LoginResponse>` that resolves to the user's login information, including:
@@ -150,7 +151,7 @@ export declare function sendResetPasswordEmail({ email, }: SendResetPasswordEmai
  * @throws {Error} If the required parameters `username` or `password` are missing.
  * @returns {Promise<LoginResponse>} Resolves to an object containing the user's login information.
  */
-export declare function login({ username, password, }: LoginParameters): Promise<LoginResponse>;
+export declare function login({ username, password, withUser, }: LoginParameters): Promise<LoginResponse>;
 /**
  * 🚪 Logs out the user.
  *
@@ -174,3 +175,57 @@ export declare function login({ username, password, }: LoginParameters): Promise
  * @returns {Promise<void>} Resolves when the logout is successful.
  */
 export declare function logout(): Promise<void>;
+/**
+ * ⚙️ Récupère les paramètres globaux du shop.
+ *
+ * Cette fonction permet d'obtenir les paramètres de configuration du shop.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/settings`
+ *
+ * 📤 **Returns**:
+ * A `Promise<SettingsResponse>` contenant les paramètres du shop, notamment:
+ * - `manualAccountCheck` (boolean): Indique si la vérification manuelle des comptes est activée.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const settings = await getSettings();
+ * console.log(settings.manualAccountCheck); // true
+ * ```
+ *
+ * @returns {Promise<SettingsResponse>} Une promesse qui résout avec les paramètres du shop.
+ */
+export declare function getSettings(): Promise<SettingsResponse>;
+/**
+ * 🏪 Récupère les informations d'un magasin spécifique.
+ *
+ * Cette fonction permet d'obtenir les détails d'un magasin à partir de son identifiant.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/stores/{storeId}`
+ *
+ * | Parameter  | Type     | Required | Description                          |
+ * |------------|----------|----------|--------------------------------------|
+ * | `storeId`  | `string` | ✅       | L'identifiant unique du magasin.     |
+ *
+ * 📤 **Returns**:
+ * A `Promise<Store>` contenant les informations détaillées du magasin, notamment:
+ * - `active`: État d'activation du magasin
+ * - `customFieldValues`: Valeurs des champs personnalisés
+ * - `description`: Description du magasin
+ * - `externalId`: Identifiant externe
+ * - `id`: Identifiant interne
+ * - `name`: Nom du magasin
+ * - `storeLocales`: Informations de localisation
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const store = await getStore({
+ *   storeId: "123e4567-e89b-12d3-a456-426614174000"
+ * });
+ * console.log(store.name); // "Mon Magasin"
+ * ```
+ *
+ * @param {GetStoreParameters} params - Les paramètres pour récupérer le magasin.
+ * @throws {Error} Si le paramètre `storeId` est manquant.
+ * @returns {Promise<Store>} Une promesse qui résout avec les informations du magasin.
+ */
+export declare function getStore({ storeId, }: GetStoreParameters): Promise<Store>;

package/lib/services/auth/index.js

@@ -20,6 +20,8 @@ exports.resetPassword = resetPassword;
 exports.sendResetPasswordEmail = sendResetPasswordEmail;
 exports.login = login;
 exports.logout = logout;
+exports.getSettings = getSettings;
+exports.getStore = getStore;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
@@ -179,6 +181,7 @@ async function sendResetPasswordEmail({ email, }) {
  * |-------------|----------|----------|--------------------------------------|
  * | `username`  | `string` | ✅       | The username of the user to log in.  |
  * | `password`  | `string` | ✅       | The password of the user to log in.  |
+ * | `withUser`  | `boolean`| ❌       | Whether to include user details in the response. Default: `true` |
  *
  * 📤 **Returns**:
  * A `Promise<LoginResponse>` that resolves to the user's login information, including:
@@ -197,11 +200,11 @@ async function sendResetPasswordEmail({ email, }) {
  * @throws {Error} If the required parameters `username` or `password` are missing.
  * @returns {Promise<LoginResponse>} Resolves to an object containing the user's login information.
  */
-async function login({ username, password, }) {
+async function login({ username, password, withUser = true, }) {
     (0, parameters_validation_1.required)({ username, password });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "POST",
-        path: `/auth/token?withUser=true`,
+        path: `/auth/token?withUser=${withUser}`,
         body: JSON.stringify({
             username,
             password,
@@ -237,3 +240,70 @@ async function logout() {
         path: `/auth/revoke-token`,
     });
 }
+/**
+ * ⚙️ Récupère les paramètres globaux du shop.
+ *
+ * Cette fonction permet d'obtenir les paramètres de configuration du shop.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/settings`
+ *
+ * 📤 **Returns**:
+ * A `Promise<SettingsResponse>` contenant les paramètres du shop, notamment:
+ * - `manualAccountCheck` (boolean): Indique si la vérification manuelle des comptes est activée.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const settings = await getSettings();
+ * console.log(settings.manualAccountCheck); // true
+ * ```
+ *
+ * @returns {Promise<SettingsResponse>} Une promesse qui résout avec les paramètres du shop.
+ */
+async function getSettings() {
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/settings`,
+    });
+    return data;
+}
+/**
+ * 🏪 Récupère les informations d'un magasin spécifique.
+ *
+ * Cette fonction permet d'obtenir les détails d'un magasin à partir de son identifiant.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/stores/{storeId}`
+ *
+ * | Parameter  | Type     | Required | Description                          |
+ * |------------|----------|----------|--------------------------------------|
+ * | `storeId`  | `string` | ✅       | L'identifiant unique du magasin.     |
+ *
+ * 📤 **Returns**:
+ * A `Promise<Store>` contenant les informations détaillées du magasin, notamment:
+ * - `active`: État d'activation du magasin
+ * - `customFieldValues`: Valeurs des champs personnalisés
+ * - `description`: Description du magasin
+ * - `externalId`: Identifiant externe
+ * - `id`: Identifiant interne
+ * - `name`: Nom du magasin
+ * - `storeLocales`: Informations de localisation
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const store = await getStore({
+ *   storeId: "123e4567-e89b-12d3-a456-426614174000"
+ * });
+ * console.log(store.name); // "Mon Magasin"
+ * ```
+ *
+ * @param {GetStoreParameters} params - Les paramètres pour récupérer le magasin.
+ * @throws {Error} Si le paramètre `storeId` est manquant.
+ * @returns {Promise<Store>} Une promesse qui résout avec les informations du magasin.
+ */
+async function getStore({ storeId, }) {
+    (0, parameters_validation_1.required)({ storeId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/stores/${storeId}`,
+    });
+    return data;
+}

package/lib/services/cart/index.js

@@ -80,6 +80,7 @@ async function getCarts(params) {
             currency,
             page: pageable === null || pageable === void 0 ? void 0 : pageable.page,
             size: pageable === null || pageable === void 0 ? void 0 : pageable.size,
+            sort: pageable === null || pageable === void 0 ? void 0 : pageable.sort,
             status: Array.isArray(status) ? status.join(",") : status,
             type: Array.isArray(type) ? type.join(",") : type,
         },

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

@@ -97,4 +97,10 @@ export interface PostMediaCustomFieldParameters {
     fileName: string;
     fileSize: number;
 }
+export interface GetMediaUrlParameters {
+    id: string;
+    customFieldIdType?: CustomFieldIdType;
+    sealedTarget?: SealedTarget;
+    fileUrl: string;
+}
 export {};

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

@@ -1,4 +1,4 @@
-import type { GetCustomFieldParameters, GetCustomFieldResponse, PostMediaCustomFieldParameters } from "./definitions";
+import type { GetCustomFieldParameters, GetCustomFieldResponse, PostMediaCustomFieldParameters, GetMediaUrlParameters } from "./definitions";
 /**
  * 📋 Retrieves custom fields.
  *
@@ -74,3 +74,40 @@ export declare function getCustomFields(params: GetCustomFieldParameters): Promi
  * @returns {Promise<string>} - The URL for uploading the media file.
  */
 export declare function postMediaCustomField(params: PostMediaCustomFieldParameters): Promise<string>;
+/**
+ * 🎥 Gets the media URL for a custom field.
+ *
+ * @deprecated This endpoint is deprecated in the API and should not be used for new implementations.
+ *
+ * This function retrieves the media URL associated with a specific custom field.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/custom-fields/{id}/media`
+ *
+ * | **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 (BUSINESS_ID, EXTERNAL_ID).  |
+ * | `sealedTarget`        | `string`   |              | The sealed target type.                                              |
+ * | `fileUrl`             | `string`   | ✅           | The URL of the file to retrieve.                                     |
+ *
+ * 📤 **Returns**:
+ * A `Promise<string>` containing the media URL.
+ *
+ * 🛠 **Example Usage**:
+ * ```typescript
+ * const mediaUrl = await getMediaUrl({
+ *   id: 'field1',
+ *   customFieldIdType: 'EXTERNAL_ID',
+ *   fileUrl: 'https://example.com/image.jpg',
+ * });
+ * ```
+ *
+ * @param {GetMediaUrlParameters} params - The parameters for retrieving a media URL:
+ *   - `id` - The ID of the custom field.
+ *   - `customFieldIdType` (optional) - The type of the custom field identifier.
+ *   - `sealedTarget` (optional) - The sealed target type.
+ *   - `fileUrl` - The URL of the file to retrieve.
+ *
+ * @returns {Promise<string>} - The media URL.
+ */
+export declare function getMediaUrl(params: GetMediaUrlParameters): Promise<string>;