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

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

@@ -1,37 +1,376 @@
-import { CreateMasterQuoteParameters, CreateMasterQuoteResponse, CreateSupplierQuotesParameters, CreateSupplierQuotesResponse, DeclineSupplierQuoteParameters, DeclineSupplierQuoteResponse, DeleteMasterQuoteParameters, GetMasterQuoteParameters, GetMasterQuoteResponse, GetMasterQuotesParameters, GetMasterQuotesResponse, GetSupplierQuoteParameters, GetSupplierQuoteResponse, PostMessageToSupplierQuoteParameters, PostMessageToSupplierQuoteResponse, UpdateMasterQuoteParameters, UpdateMasterQuoteResponse } from "./definitions";
+import { AcceptSupplierQuoteParameters, AcceptSupplierQuoteResponse, CreateMasterQuoteParameters, CreateMasterQuoteResponse, CreateSupplierQuotesParameters, CreateSupplierQuotesResponse, DeclineSupplierQuoteParameters, DeclineSupplierQuoteResponse, DeleteMasterQuoteParameters, GetMasterQuoteParameters, GetMasterQuoteResponse, GetMasterQuotesParameters, GetMasterQuotesResponse, GetSupplierQuoteParameters, GetSupplierQuoteResponse, PostMessageToSupplierQuoteParameters, PostMessageToSupplierQuoteResponse, UpdateMasterQuoteParameters, UpdateMasterQuoteResponse, UpdateSupplierQuoteCustomFieldsParameters, UpdateSupplierQuoteCustomFieldsResponse, InitializeOrderFromSupplierQuoteParameters, InitializeOrderFromSupplierQuoteResponse } from "./definitions";
 /**
- * Get master quotes
+ * 📄 Fetches a paginated list of master quotes.
+ *
+ * This function retrieves master quotes with optional filters for customer accounts and pagination parameters.
+ * If no parameters are provided, it fetches the default paginated list of master quotes.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/master-quotes`
+ *
+ * | Parameter            | Type                          | Required   | Description                                                   |
+ * |----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `fromCustomerAccount`| `boolean`                    | ❌         | If `true`, filters quotes originating from customer accounts. |
+ * | `pageable.page`      | `number`                     | ❌         | The page number to fetch (0-based index).                     |
+ * | `pageable.size`      | `number`                     | ❌         | The number of items per page.                                 |
+ * | `pageable.sort`      | `string[]`                   | ❌         | Sorting criteria (e.g., `["createdAt,desc"]`).                |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetMasterQuotesResponse` object,
+ * containing the paginated list of master quotes with metadata such as total pages, size, and current page.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const quotes = await getMasterQuotes({
+ *   fromCustomerAccount: true,
+ *   pageable: { page: 1, size: 10, sort: ["createdAt,desc"] },
+ * });
+ *
+ * console.log(quotes);
+ * ```
+ *
+ * @param {GetMasterQuotesParameters} params - Optional filters and pagination parameters.
+ * @returns {Promise<GetMasterQuotesResponse>} A promise resolving to the paginated master quotes response.
  */
 export declare function getMasterQuotes({ fromCustomerAccount, pageable, }?: GetMasterQuotesParameters): Promise<GetMasterQuotesResponse>;
 /**
- * Create a master quote
+ * ✏️ Creates a new master quote.
+ *
+ * This function allows the creation of a new master quote by providing a description and a name.
+ * Both parameters are mandatory and validated before sending the request.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/master-quotes`
+ *
+ * | Parameter      | Type       | Required   | Description                                 |
+ * |----------------|------------|------------|---------------------------------------------|
+ * | `description`  | `string`   | ✅         | The description of the master quote.        |
+ * | `name`         | `string`   | ✅         | The name of the master quote.               |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `CreateMasterQuoteResponse` object,
+ * representing the created master quote with its details.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const newQuote = await createMasterQuote({
+ *   description: "This is a test quote.",
+ *   name: "Test Quote",
+ * });
+ *
+ * console.log(newQuote);
+ * ```
+ *
+ * @param {CreateMasterQuoteParameters} params - The parameters for creating the master quote.
+ * @throws {Error} If `description` or `name` is missing.
+ * @returns {Promise<CreateMasterQuoteResponse>} A promise resolving to the created master quote response.
  */
 export declare function createMasterQuote({ description, name, }: CreateMasterQuoteParameters): Promise<CreateMasterQuoteResponse>;
 /**
- * Delete a master quote
+ * 📝 Deletes a master quote by its ID.
+ *
+ * This function allows you to delete an existing master quote by providing the `masterQuoteId`. Once the quote is deleted, it can no longer be retrieved or used in other operations.
+ *
+ * 🛠 **Endpoint**: `DELETE /v1/shop/master-quotes/{masterQuoteId}`
+ *
+ * | Parameter         | Type    | Required   | Description                                                   |
+ * |-------------------|---------|------------|---------------------------------------------------------------|
+ * | `masterQuoteId`   | `string`| ✅         | The unique identifier of the master quote to be deleted.       |
+ *
+ * 📤 **Returns**:
+ * A `Promise<void>` indicating the operation was successful. No data is returned as the master quote is simply deleted.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await deleteMasterQuote({
+ *   masterQuoteId: "quote123",
+ * });
+ * ```
+ *
+ * @param {DeleteMasterQuoteParameters} params - The parameters required to delete the master quote.
+ * @throws {Error} If the required `masterQuoteId` is missing.
+ * @returns {Promise<void>} A promise that resolves when the master quote is successfully deleted.
  */
 export declare function deleteMasterQuote({ masterQuoteId, }: DeleteMasterQuoteParameters): Promise<void>;
 /**
- * Get a master quote by id
+ * 📄 Fetches the details of a specific master quote.
+ *
+ * This function retrieves a master quote identified by its unique `masterQuoteId`.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/master-quotes/{masterQuoteId}`
+ *
+ * | Parameter         | Type       | Required   | Description                                      |
+ * |-------------------|------------|------------|--------------------------------------------------|
+ * | `masterQuoteId`   | `string`   | ✅         | The unique identifier of the master quote to fetch. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetMasterQuoteResponse` object, containing the details of the requested master quote.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const masterQuote = await getMasterQuote({ masterQuoteId: "12345" });
+ *
+ * console.log(masterQuote);
+ * ```
+ *
+ * @param {GetMasterQuoteParameters} params - The parameters required to fetch the master quote.
+ * @throws {Error} If `masterQuoteId` is missing.
+ * @returns {Promise<GetMasterQuoteResponse>} A promise resolving to the details of the master quote.
  */
 export declare function getMasterQuote({ masterQuoteId, }: GetMasterQuoteParameters): Promise<GetMasterQuoteResponse>;
 /**
- * Update a master quote
+ * ✏️ Updates an existing master quote.
+ *
+ * This function modifies the specified master quote by updating custom field values, adding new details, or removing existing ones.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/master-quotes/{masterQuoteId}`
+ *
+ * | Parameter                    | Type                                       | Required   | Description                                          |
+ * |------------------------------|--------------------------------------------|------------|------------------------------------------------------|
+ * | `masterQuoteId`              | `string`                                  | ✅         | The unique identifier of the master quote to update. |
+ * | `customFieldValues`          | `{ customFieldId: string; customFieldValue?: string; }[]` | ❌         | Custom field values to update for the master quote.  |
+ * | `masterQuoteDetailsToAdd`    | `{ productVariantId: string; quantity: number; }[]` | ❌         | Details to add to the master quote.                 |
+ * | `masterQuoteDetailsToRemove` | `string[]`                                | ❌         | IDs of details to remove from the master quote.      |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an `UpdateMasterQuoteResponse` object, which contains the updated details of the master quote.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const updatedQuote = await updateMasterQuote({
+ *   masterQuoteId: "12345",
+ *   customFieldValues: [{ customFieldId: "field1", customFieldValue: "value1" }],
+ *   masterQuoteDetailsToAdd: [{ productVariantId: "variant1", quantity: 5 }],
+ *   masterQuoteDetailsToRemove: ["detail1", "detail2"],
+ * });
+ *
+ * console.log(updatedQuote);
+ * ```
+ *
+ * @param {UpdateMasterQuoteParameters} params - The parameters required to update the master quote.
+ * @throws {Error} If `masterQuoteId` is missing.
+ * @returns {Promise<UpdateMasterQuoteResponse>} A promise resolving to the updated details of the master quote.
  */
 export declare function updateMasterQuote({ masterQuoteId, customFieldValues, masterQuoteDetailsToAdd, masterQuoteDetailsToRemove, }: UpdateMasterQuoteParameters): Promise<UpdateMasterQuoteResponse>;
 /**
- * Create supplier quotes
+ * ✏️ Creates supplier quotes.
+ *
+ * This function generates supplier quotes based on the provided parameters, including billing and shipping information, quantities, and supplier details.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/supplier-quotes`
+ *
+ * | Parameter                      | Type                                                                                   | Required   | Description                                                                 |
+ * |--------------------------------|----------------------------------------------------------------------------------------|------------|-----------------------------------------------------------------------------|
+ * | `billingAddressId`             | `string`                                                                              | ❌         | The ID of the billing address for the supplier quotes.                     |
+ * | `createSupplierQuoteRequests`  | `{ createQuoteDeliveryLineRequests: { quantity: number; shippingAddressId: string; }[]; masterQuoteDetailId: string; quantity: number; supplierIds: string[]; }[]` | ✅         | Array of supplier quote request objects, including delivery and supplier details. |
+ * | `masterQuoteId`                | `string`                                                                              | ❌         | The ID of the master quote associated with the supplier quotes.            |
+ * | `supplierQuoteUrl`             | `string`                                                                              | ✅         | The URL for the supplier quote.                                            |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `CreateSupplierQuotesResponse` object, containing the newly created supplier quotes.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await createSupplierQuotes({
+ *   billingAddressId: "address123",
+ *   createSupplierQuoteRequests: [
+ *     {
+ *       createQuoteDeliveryLineRequests: [
+ *         { quantity: 10, shippingAddressId: "ship123" },
+ *       ],
+ *       masterQuoteDetailId: "detail123",
+ *       quantity: 20,
+ *       supplierIds: ["supplier1", "supplier2"],
+ *     },
+ *   ],
+ *   masterQuoteId: "master123",
+ *   supplierQuoteUrl: "https://example.com/supplier-quote",
+ * });
+ *
+ * console.log(response);
+ * ```
+ *
+ * @param {CreateSupplierQuotesParameters} params - The parameters required to create supplier quotes.
+ * @throws {Error} If `createSupplierQuoteRequests` or `supplierQuoteUrl` is missing.
+ * @returns {Promise<CreateSupplierQuotesResponse>} A promise resolving to the created supplier quotes.
  */
 export declare function createSupplierQuotes({ billingAddressId, createSupplierQuoteRequests, masterQuoteId, supplierQuoteUrl, }: CreateSupplierQuotesParameters): Promise<CreateSupplierQuotesResponse>;
 /**
- * Get supplier quote
+ * ✏️ Retrieves a supplier quote by ID.
+ *
+ * This function fetches detailed information about a specific supplier quote, including customer details, billing address, quote lines, and status.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/supplier-quotes/{supplierQuoteId}`
+ *
+ * | Parameter         | Type      | Required   | Description                                          |
+ * |--------------------|-----------|------------|------------------------------------------------------|
+ * | `supplierQuoteId`  | `string` | ✅         | The unique identifier of the supplier quote to retrieve. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetSupplierQuoteResponse` object, containing the details of the requested supplier quote.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await getSupplierQuote({
+ *   supplierQuoteId: "quote123",
+ * });
+ *
+ * console.log(response);
+ * ```
+ *
+ * @param {GetSupplierQuoteParameters} params - The parameters required to retrieve a supplier quote.
+ * @throws {Error} If `supplierQuoteId` is missing.
+ * @returns {Promise<GetSupplierQuoteResponse>} A promise resolving to the supplier quote details.
  */
 export declare function getSupplierQuote({ supplierQuoteId, }: GetSupplierQuoteParameters): Promise<GetSupplierQuoteResponse>;
 /**
- * Decline supplier quote
+ * ✅ Accepts a supplier quote.
+ *
+ * This function allows the user to accept a specific supplier quote, which may trigger further actions in the purchasing or negotiation process.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/supplier-quotes/{supplierQuoteId}/accept`
+ *
+ * | Parameter          | Type      | Required   | Description                                                         |
+ * |---------------------|-----------|------------|---------------------------------------------------------------------|
+ * | `supplierQuoteId`   | `string`  | ✅         | The unique identifier of the supplier quote to be accepted.          |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an `AcceptSupplierQuoteResponse` object, confirming that the supplier quote has been accepted.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await acceptSupplierQuote({
+ *   supplierQuoteId: "quote123",
+ * });
+ *
+ * console.log(response);
+ * ```
+ *
+ * @param {AcceptSupplierQuoteParameters} params - The parameters required to accept a supplier quote.
+ * @throws {Error} If the required `supplierQuoteId` is missing.
+ * @returns {Promise<AcceptSupplierQuoteResponse>} A promise resolving to the result of the supplier quote acceptance operation.
+ */
+export declare function acceptSupplierQuote({ supplierQuoteId, }: AcceptSupplierQuoteParameters): Promise<AcceptSupplierQuoteResponse>;
+/**
+ * 📝 Updates custom fields of a supplier quote.
+ *
+ * This function allows you to update custom fields associated with a specific supplier quote.
+ * You can modify the values of the custom fields, providing a flexible way to manage additional information for the quote.
+ *
+ * 🛠 **Endpoint**: `PATCH /v1/shop/supplier-quotes/{supplierQuoteId}/custom-fields`
+ *
+ * | Parameter           | Type    | Required   | Description                                                          |
+ * |---------------------|---------|------------|----------------------------------------------------------------------|
+ * | `supplierQuoteId`    | `string`| ✅         | The unique identifier of the supplier quote to be updated.            |
+ * | `customFieldValues`   | `array` | ✅         | An array of custom field values to be updated for the supplier quote. |
+ * | `idType`             | `string`| ✅         | The ID type used for the custom fields.                               |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an `UpdateSupplierQuoteCustomFieldsResponse` object, which confirms that the custom fields have been updated successfully.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await updateSupplierQuoteCustomFields({
+ *   supplierQuoteId: "quote123",
+ *   customFieldValues: [{ customFieldId: "field1", customFieldValue: "value1" }],
+ *   idType: "EXTERNAL_ID",
+ * });
+ *
+ * console.log(response);
+ * ```
+ *
+ * @param {UpdateSupplierQuoteCustomFieldsParameters} params - The parameters required to update custom fields for a supplier quote.
+ * @throws {Error} If the required `supplierQuoteId` is missing.
+ * @returns {Promise<UpdateSupplierQuoteCustomFieldsResponse>} A promise resolving to the result of the custom fields update operation.
+ */
+export declare function updateSupplierQuoteCustomFields({ supplierQuoteId, customFieldValues, idType, }: UpdateSupplierQuoteCustomFieldsParameters): Promise<UpdateSupplierQuoteCustomFieldsResponse>;
+/**
+ * ❌ Declines a supplier quote.
+ *
+ * This function allows the user to decline a specific supplier quote by its unique identifier.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/supplier-quotes/{supplierQuoteId}/decline`
+ *
+ * | Parameter         | Type      | Required   | Description                                          |
+ * |--------------------|-----------|------------|------------------------------------------------------|
+ * | `supplierQuoteId`  | `string` | ✅         | The unique identifier of the supplier quote to decline. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `DeclineSupplierQuoteResponse` object, indicating the result of the decline operation.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await declineSupplierQuote({
+ *   supplierQuoteId: "quote123",
+ * });
+ *
+ * console.log(response);
+ * ```
+ *
+ * @param {DeclineSupplierQuoteParameters} params - The parameters required to decline a supplier quote.
+ * @throws {Error} If `supplierQuoteId` is missing.
+ * @returns {Promise<DeclineSupplierQuoteResponse>} A promise resolving to the result of the decline operation.
  */
 export declare function declineSupplierQuote({ supplierQuoteId, }: DeclineSupplierQuoteParameters): Promise<DeclineSupplierQuoteResponse>;
 /**
- * Post message to supplier quote
+ * 💬 Posts a message to a supplier quote.
+ *
+ * This function allows the user to send a message to a specific supplier quote, useful for communication regarding the quote's details.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/supplier-quotes/{supplierQuoteId}/messages`
+ *
+ * | Parameter          | Type      | Required   | Description                                                  |
+ * |---------------------|-----------|------------|--------------------------------------------------------------|
+ * | `supplierQuoteId`   | `string`  | ✅         | The unique identifier of the supplier quote to which the message will be sent. |
+ * | `message`           | `string`  | ✅         | The content of the message to be sent to the supplier quote.   |
+ * | `username`          | `string`  | ✅         | The username of the person sending the message.               |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `PostMessageToSupplierQuoteResponse` object, confirming that the message was successfully posted.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await postMessageToSupplierQuote({
+ *   supplierQuoteId: "quote123",
+ *   message: "Please review the updated pricing.",
+ *   username: "admin_user",
+ * });
+ *
+ * console.log(response);
+ * ```
+ *
+ * @param {PostMessageToSupplierQuoteParameters} params - The parameters required to send a message to a supplier quote.
+ * @throws {Error} If any of the required parameters (`supplierQuoteId`, `message`, `username`) are missing.
+ * @returns {Promise<PostMessageToSupplierQuoteResponse>} A promise resolving to the result of the message posting operation.
  */
 export declare function postMessageToSupplierQuote({ supplierQuoteId, message, username, }: PostMessageToSupplierQuoteParameters): Promise<PostMessageToSupplierQuoteResponse>;
+/**
+ * 📝 Initializes an order from a supplier quote.
+ *
+ * This function allows you to initialize an order based on a specific supplier quote, specifying which quote lines and quantities should be included in the order. Additionally, it lets you preview a set number of lines before the final order is created.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/supplier-quotes/{supplierQuoteId}/initialize-orders`
+ *
+ * | Parameter               | Type    | Required   | Description                                                          |
+ * |-------------------------|---------|------------|----------------------------------------------------------------------|
+ * | `supplierQuoteId`        | `string`| ✅         | The unique identifier of the supplier quote from which to initialize the order. |
+ * | `nbPreviewLines`         | `number`| ❌         | The number of lines to fetch in the order response.    |
+ * | `quoteLineIdsAndQuantities` | `array` | ✅         | A list of quote line IDs along with the respective quantities to be included in the order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an `InitializeOrderFromSupplierQuoteResponse` object, confirming the successful initialization of the order.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await initializeOrderFromSupplierQuote({
+ *   supplierQuoteId: "quote123",
+ *   nbPreviewLines: 5,
+ *   quoteLineIdsAndQuantities: [{ quoteLineId: "line1", quantity: 10 }],
+ * });
+ *
+ * console.log(response);
+ * ```
+ *
+ * @param {InitializeOrderFromSupplierQuoteParameters} params - The parameters required to initialize an order from a supplier quote.
+ * @throws {Error} If the required `supplierQuoteId` or `quoteLineIdsAndQuantities` are missing.
+ * @returns {Promise<InitializeOrderFromSupplierQuoteResponse>} A promise resolving to the result of the order initialization operation.
+ */
+export declare function initializeOrderFromSupplierQuote({ supplierQuoteId, nbPreviewLines, quoteLineIdsAndQuantities, }: InitializeOrderFromSupplierQuoteParameters): Promise<InitializeOrderFromSupplierQuoteResponse>;