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

package/lib/services/customer-user/index.d.ts

@@ -1,33 +1,282 @@
-import { ActivateCustomerUserParameters, CreateCustomerUserParameters, CreateCustomerUserResponse, GetCustomerUserAddressesParameters, GetCustomerUserOrganisationsResponse, RemoveCustomerUserParameters, SendCustomerUserActivationRequestParameters, UpdateCustomerUserParameters, UpdateCustomerUserResponse } from "./definitions";
 /**
- * Get authenticated user
+ * @packageDocumentation
+ *
+ * @document documents/customer-user.md
  */
-export declare function getAuthenticatedUser(): Promise<any>;
+import { ActivateCustomerUserParameters, CreateCustomerUserParameters, CreateCustomerUserResponse, GetCustomerUserAddressesParameters, GetCustomerUserOrganisationsResponse, SendCustomerUserActivationRequestParameters, UpdateCustomerUserParameters, UpdateCustomerUserResponse } from "./definitions";
 /**
- * Create a customer user
+ * APICODE(USER-500)
+ * Retrieves the authenticated user.
+ *
+ * This function sends a request to obtain the details of the currently authenticated user.
+ *
+ * @returns {Promise<any>} - The data of the authenticated user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const user = await getAuthenticatedUser();
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "id": "user1",
+ *   "name": "John Doe"
+ * }
+ * ```
  */
-export declare function createCustomerUser({ activationUrl, civility, customFieldValues, email, externalId, firstName, lastName, password, groups, status, mainOrganisationId, organisations, phone, }: CreateCustomerUserParameters): Promise<CreateCustomerUserResponse>;
+export declare function getAuthenticatedUser(): Promise<any>;
 /**
- * Update a customer user
+ * APICODE(USER-100)
+ * Creates a customer user.
+ *
+ * This function sends a request to create a new customer user with the specified parameters.
+ *
+ * @param {CreateCustomerUserParameters} params - The parameters for creating the user, including:
+ * #### email - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The email address of the user.
+ * #### password - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The password of the user.
+ * #### firstName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The first name of the user.
+ * #### lastName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The last name of the user.
+ * #### groups - `string[]` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The groups to which the user belongs.
+ * #### activationUrl - `string`
+ *
+ * The URL for user activation.
+ * #### civility - `string`
+ *
+ * The civility of the user (e.g., Mr., Ms.).
+ * #### customFieldValues - `object`
+ *
+ * Custom fields for additional user information.
+ * #### externalId - `string`
+ *
+ * An external identifier for the user.
+ * #### status - `string`
+ *
+ * The status of the user (e.g., active, inactive).
+ * #### mainOrganisationId - `string`
+ *
+ * The ID of the main organization associated with the user.
+ * #### organisations - `string[]`
+ *
+ * The list of organizations associated with the user.
+ * #### phone - `string`
+ *
+ * The phone number of the user.
+ *
+ * @returns {Promise<CreateCustomerUserResponse>} - The data of the created user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const newUser = await createCustomerUser({
+ *   email: 'user@example.com',
+ *   password: 'securePassword',
+ *   firstName: 'John',
+ *   lastName: 'Doe',
+ *   activationUrl: 'http://example.com/activate',
+ *   civility: 'Mr.',
+ *   customFieldValues: {},
+ *   externalId: 'external123',
+ *   groups: ['group1'],
+ *   status: 'active',
+ *   mainOrganisationId: 'org1',
+ *   organisations: ['org1', 'org2'],
+ *   phone: '123-456-7890'
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "id": "user1",
+ *   "detail": "User created successfully"
+ * }
+ * ```
  */
-export declare function updateCustomerUser({ civility, firstName, lastName, phone, customFieldValues, }: UpdateCustomerUserParameters): Promise<UpdateCustomerUserResponse>;
+export declare function createCustomerUser(params: CreateCustomerUserParameters): Promise<CreateCustomerUserResponse>;
 /**
- * Remove a customer user's access to an account
+ * APICODE(USER-201)
+ * Updates a customer user.
+ *
+ * This function sends a request to update the details of an existing customer user.
+ *
+ * @param {UpdateCustomerUserParameters} params - The parameters for updating the user, including:
+ * #### firstName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The first name of the user.
+ * #### lastName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The last name of the user.
+ * #### civility - `string`
+ *
+ * The civility of the user (e.g., Mr., Ms.).
+ * #### phone - `string`
+ *
+ * The phone number of the user.
+ * #### customFieldValues - `object`
+ *
+ * Custom fields for additional user information.
+ *
+ * @returns {Promise<UpdateCustomerUserResponse>} - The data of the updated user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const updatedUser = await updateCustomerUser({
+ *   firstName: 'John',
+ *   lastName: 'Doe',
+ *   civility: 'Mr.',
+ *   phone: '123-456-7890',
+ *   customFieldValues: {}
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "detail": "User updated successfully"
+ * }
+ * ```
  */
-export declare function removeCustomerUserFromAccount({ userId, }: RemoveCustomerUserParameters): Promise<void>;
+export declare function updateCustomerUser({ civility, firstName, lastName, phone, customFieldValues, }: UpdateCustomerUserParameters): Promise<UpdateCustomerUserResponse>;
 /**
- * Activate a customer user
+ * APICODE(USER-200)
+ * Activates a customer user.
+ *
+ * This function sends a request to activate a customer user with a specified token.
+ *
+ * @param {ActivateCustomerUserParameters} params - The parameters for activating the user, including:
+ * #### token - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The activation token of the user.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the user is activated.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await activateCustomerUser({ token: 'activationToken' });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "detail": "User activated successfully"
+ * }
+ * ```
  */
-export declare function activateCustomerUser({ token, }: ActivateCustomerUserParameters): Promise<void>;
+export declare function activateCustomerUser(params: ActivateCustomerUserParameters): Promise<void>;
 /**
- * Get customer user addresses
+ * APICODE(USER-501)
+ * Retrieves customer user addresses.
+ *
+ * This function sends a request to obtain the addresses associated with a customer user.
+ *
+ * @param {GetCustomerUserAddressesParameters} params - The parameters for retrieving the addresses, including:
+ * #### shipping - `boolean`
+ *
+ * Indicates whether to retrieve shipping addresses.
+ * #### billing - `boolean`
+ *
+ * Indicates whether to retrieve billing addresses.
+ * #### account - `string`
+ *
+ * The ID of the account for which to retrieve addresses.
+ * #### organisationIds - `string[]`
+ *
+ * An array of organization IDs to filter the addresses.
+ *
+ * @returns {Promise<void>} - The addresses of the customer user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const addresses = await getCustomerUserAddresses({
+ *   shipping: true,
+ *   billing: false,
+ *   account: 'account1',
+ *   organisationIds: ['org1', 'org2']
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "addresses": [
+ *     {
+ *       "id": "address1",
+ *       "detail": "Address retrieved successfully"
+ *     }
+ *   ]
+ * }
+ * ```
  */
 export declare function getCustomerUserAddresses({ shipping, billing, account, organisationIds, }: GetCustomerUserAddressesParameters): Promise<void>;
 /**
- * Get customer user organisations
+ * APICODE(USER-502)
+ * Retrieves customer user organisations.
+ *
+ * This function sends a request to obtain the organisations associated with a customer user.
+ *
+ * @returns {Promise<GetCustomerUserOrganisationsResponse>} - The organisations of the customer user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const organisations = await getCustomerUserOrganisations();
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "organisations": [
+ *     {
+ *       "id": "org1",
+ *       "name": "Organisation 1"
+ *     },
+ *     {
+ *       "id": "org2",
+ *       "name": "Organisation 2"
+ *     }
+ *   ]
+ * }
+ * ```
  */
 export declare function getCustomerUserOrganisations(): Promise<GetCustomerUserOrganisationsResponse>;
 /**
- * Send customer user activation request
+ * APICODE(USER-203)
+ * Sends a customer user activation request.
+ *
+ * This function sends a request to resend an activation request to a customer user.
+ *
+ * @param {SendCustomerUserActivationRequestParameters} params - The parameters for sending the request, including:
+ * #### token - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The activation token of the user.
+ * #### redirectUrl - `string`
+ *
+ * The URL to redirect the user after activation.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the request is sent.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await sendCustomerUserActivationRequest({
+ *   token: 'activationToken',
+ *   redirectUrl: 'http://example.com/redirect'
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "detail": "Activation request sent successfully"
+ * }
+ * ```
  */
 export declare function sendCustomerUserActivationRequest({ redirectUrl, token, }: SendCustomerUserActivationRequestParameters): Promise<void>;

package/lib/services/customer-user/index.js

@@ -1,9 +1,13 @@
 "use strict";
+/**
+ * @packageDocumentation
+ *
+ * @document documents/customer-user.md
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAuthenticatedUser = getAuthenticatedUser;
 exports.createCustomerUser = createCustomerUser;
 exports.updateCustomerUser = updateCustomerUser;
-exports.removeCustomerUserFromAccount = removeCustomerUserFromAccount;
 exports.activateCustomerUser = activateCustomerUser;
 exports.getCustomerUserAddresses = getCustomerUserAddresses;
 exports.getCustomerUserOrganisations = getCustomerUserOrganisations;
@@ -11,7 +15,25 @@ exports.sendCustomerUserActivationRequest = sendCustomerUserActivationRequest;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * Get authenticated user
+ * APICODE(USER-500)
+ * Retrieves the authenticated user.
+ *
+ * This function sends a request to obtain the details of the currently authenticated user.
+ *
+ * @returns {Promise<any>} - The data of the authenticated user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const user = await getAuthenticatedUser();
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "id": "user1",
+ *   "name": "John Doe"
+ * }
+ * ```
  */
 async function getAuthenticatedUser() {
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
@@ -21,9 +43,83 @@ async function getAuthenticatedUser() {
     return data;
 }
 /**
- * Create a customer user
+ * APICODE(USER-100)
+ * Creates a customer user.
+ *
+ * This function sends a request to create a new customer user with the specified parameters.
+ *
+ * @param {CreateCustomerUserParameters} params - The parameters for creating the user, including:
+ * #### email - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The email address of the user.
+ * #### password - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The password of the user.
+ * #### firstName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The first name of the user.
+ * #### lastName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The last name of the user.
+ * #### groups - `string[]` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The groups to which the user belongs.
+ * #### activationUrl - `string`
+ *
+ * The URL for user activation.
+ * #### civility - `string`
+ *
+ * The civility of the user (e.g., Mr., Ms.).
+ * #### customFieldValues - `object`
+ *
+ * Custom fields for additional user information.
+ * #### externalId - `string`
+ *
+ * An external identifier for the user.
+ * #### status - `string`
+ *
+ * The status of the user (e.g., active, inactive).
+ * #### mainOrganisationId - `string`
+ *
+ * The ID of the main organization associated with the user.
+ * #### organisations - `string[]`
+ *
+ * The list of organizations associated with the user.
+ * #### phone - `string`
+ *
+ * The phone number of the user.
+ *
+ * @returns {Promise<CreateCustomerUserResponse>} - The data of the created user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const newUser = await createCustomerUser({
+ *   email: 'user@example.com',
+ *   password: 'securePassword',
+ *   firstName: 'John',
+ *   lastName: 'Doe',
+ *   activationUrl: 'http://example.com/activate',
+ *   civility: 'Mr.',
+ *   customFieldValues: {},
+ *   externalId: 'external123',
+ *   groups: ['group1'],
+ *   status: 'active',
+ *   mainOrganisationId: 'org1',
+ *   organisations: ['org1', 'org2'],
+ *   phone: '123-456-7890'
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "id": "user1",
+ *   "detail": "User created successfully"
+ * }
+ * ```
  */
-async function createCustomerUser({ activationUrl, civility, customFieldValues, email, externalId, firstName, lastName, password, groups, status, mainOrganisationId, organisations, phone, }) {
+async function createCustomerUser(params) {
+    const { activationUrl, civility, customFieldValues, email, externalId, firstName, lastName, password, groups, status, mainOrganisationId, organisations, phone, } = params;
     (0, parameters_validation_1.required)({ civility, firstName, lastName, email, password, groups });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "POST",
@@ -47,7 +143,47 @@ async function createCustomerUser({ activationUrl, civility, customFieldValues,
     return data;
 }
 /**
- * Update a customer user
+ * APICODE(USER-201)
+ * Updates a customer user.
+ *
+ * This function sends a request to update the details of an existing customer user.
+ *
+ * @param {UpdateCustomerUserParameters} params - The parameters for updating the user, including:
+ * #### firstName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The first name of the user.
+ * #### lastName - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The last name of the user.
+ * #### civility - `string`
+ *
+ * The civility of the user (e.g., Mr., Ms.).
+ * #### phone - `string`
+ *
+ * The phone number of the user.
+ * #### customFieldValues - `object`
+ *
+ * Custom fields for additional user information.
+ *
+ * @returns {Promise<UpdateCustomerUserResponse>} - The data of the updated user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const updatedUser = await updateCustomerUser({
+ *   firstName: 'John',
+ *   lastName: 'Doe',
+ *   civility: 'Mr.',
+ *   phone: '123-456-7890',
+ *   customFieldValues: {}
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "detail": "User updated successfully"
+ * }
+ * ```
  */
 async function updateCustomerUser({ civility, firstName, lastName, phone, customFieldValues, }) {
     (0, parameters_validation_1.required)({ civility, firstName, lastName });
@@ -65,19 +201,32 @@ async function updateCustomerUser({ civility, firstName, lastName, phone, custom
     return data;
 }
 /**
- * Remove a customer user's access to an account
- */
-async function removeCustomerUserFromAccount({ userId, }) {
-    (0, parameters_validation_1.required)({ userId });
-    await (0, fetch_instance_1.enhancedFetch)({
-        method: "PUT",
-        path: `/v1/shop/customer-users/${userId}/accounts`,
-    });
-}
-/**
- * Activate a customer user
+ * APICODE(USER-200)
+ * Activates a customer user.
+ *
+ * This function sends a request to activate a customer user with a specified token.
+ *
+ * @param {ActivateCustomerUserParameters} params - The parameters for activating the user, including:
+ * #### token - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The activation token of the user.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the user is activated.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await activateCustomerUser({ token: 'activationToken' });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "detail": "User activated successfully"
+ * }
+ * ```
  */
-async function activateCustomerUser({ token, }) {
+async function activateCustomerUser(params) {
+    const { token } = params;
     (0, parameters_validation_1.required)({ token });
     await (0, fetch_instance_1.enhancedFetch)({
         method: "POST",
@@ -88,7 +237,48 @@ async function activateCustomerUser({ token, }) {
     });
 }
 /**
- * Get customer user addresses
+ * APICODE(USER-501)
+ * Retrieves customer user addresses.
+ *
+ * This function sends a request to obtain the addresses associated with a customer user.
+ *
+ * @param {GetCustomerUserAddressesParameters} params - The parameters for retrieving the addresses, including:
+ * #### shipping - `boolean`
+ *
+ * Indicates whether to retrieve shipping addresses.
+ * #### billing - `boolean`
+ *
+ * Indicates whether to retrieve billing addresses.
+ * #### account - `string`
+ *
+ * The ID of the account for which to retrieve addresses.
+ * #### organisationIds - `string[]`
+ *
+ * An array of organization IDs to filter the addresses.
+ *
+ * @returns {Promise<void>} - The addresses of the customer user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const addresses = await getCustomerUserAddresses({
+ *   shipping: true,
+ *   billing: false,
+ *   account: 'account1',
+ *   organisationIds: ['org1', 'org2']
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "addresses": [
+ *     {
+ *       "id": "address1",
+ *       "detail": "Address retrieved successfully"
+ *     }
+ *   ]
+ * }
+ * ```
  */
 async function getCustomerUserAddresses({ shipping, billing, account, organisationIds, }) {
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
@@ -104,7 +294,33 @@ async function getCustomerUserAddresses({ shipping, billing, account, organisati
     return data;
 }
 /**
- * Get customer user organisations
+ * APICODE(USER-502)
+ * Retrieves customer user organisations.
+ *
+ * This function sends a request to obtain the organisations associated with a customer user.
+ *
+ * @returns {Promise<GetCustomerUserOrganisationsResponse>} - The organisations of the customer user.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const organisations = await getCustomerUserOrganisations();
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "organisations": [
+ *     {
+ *       "id": "org1",
+ *       "name": "Organisation 1"
+ *     },
+ *     {
+ *       "id": "org2",
+ *       "name": "Organisation 2"
+ *     }
+ *   ]
+ * }
+ * ```
  */
 async function getCustomerUserOrganisations() {
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
@@ -114,7 +330,35 @@ async function getCustomerUserOrganisations() {
     return data;
 }
 /**
- * Send customer user activation request
+ * APICODE(USER-203)
+ * Sends a customer user activation request.
+ *
+ * This function sends a request to resend an activation request to a customer user.
+ *
+ * @param {SendCustomerUserActivationRequestParameters} params - The parameters for sending the request, including:
+ * #### token - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The activation token of the user.
+ * #### redirectUrl - `string`
+ *
+ * The URL to redirect the user after activation.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the request is sent.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await sendCustomerUserActivationRequest({
+ *   token: 'activationToken',
+ *   redirectUrl: 'http://example.com/redirect'
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "detail": "Activation request sent successfully"
+ * }
+ * ```
  */
 async function sendCustomerUserActivationRequest({ redirectUrl, token, }) {
     (0, parameters_validation_1.required)({ token });

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 {
+}