@djust-b2b/djust-front-sdk 3.0.0-beta.9 → 3.0.1

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

@@ -0,0 +1,346 @@
+/**
+ * # Quote Service
+ *
+ * B2B quote request and negotiation management.
+ *
+ * ## Features
+ * - Master quote creation and management
+ * - Supplier quote workflows
+ * - Quote acceptance/decline process
+ * - Quote-to-order conversion
+ * - Quote messaging
+ *
+ * @module services/quote
+ * @since 2.17.0
+ */
+import { BaseService } from "../base.service";
+import type { RequestContext } from "../../client/transport";
+import type { GetMasterQuotesParams, CreateMasterQuoteParams, DeleteMasterQuoteParams, GetMasterQuoteParams, UpdateMasterQuoteParams, CreateSupplierQuotesParams, GetSupplierQuoteParams, AcceptSupplierQuoteParams, DeclineSupplierQuoteParams, UpdateSupplierQuoteCustomFieldsParams, PostMessageToSupplierQuoteParams, InitializeOrderFromSupplierQuoteParams, GetMasterQuotesResponse, CreateMasterQuoteResponse, GetMasterQuoteResponse, UpdateMasterQuoteResponse, CreateSupplierQuotesResponse, GetSupplierQuoteResponse, AcceptSupplierQuoteResponse, DeclineSupplierQuoteResponse, UpdateSupplierQuoteCustomFieldsResponse, PostMessageToSupplierQuoteResponse, InitializeOrderFromSupplierQuoteResponse } from "./types";
+/**
+ * Service for B2B quote management.
+ *
+ * Enables full quote workflow:
+ * - Create quote requests with multiple products
+ * - Send to suppliers for pricing
+ * - Review, accept or decline quotes
+ * - Convert accepted quotes to orders
+ *
+ * @example
+ * ```typescript
+ * import { createDjustClient } from '@djust-b2b/djust-front-sdk';
+ *
+ * const client = createDjustClient({ baseUrl, clientId, apiKey });
+ *
+ * // Create a master quote
+ * const masterQuote = await client.quote.createMasterQuote({
+ *   name: 'Q-2024-001',
+ *   description: 'Office supplies for Q1',
+ * });
+ *
+ * // Send to suppliers
+ * await client.quote.createSupplierQuotes({
+ *   masterQuoteId: masterQuote.id,
+ *   createSupplierQuoteRequests: [...],
+ *   supplierQuoteUrl: 'https://myapp.com/quotes',
+ * });
+ * ```
+ */
+export declare class QuoteService extends BaseService {
+    readonly serviceName = "quote";
+    /**
+     * Get paginated list of master quotes.
+     *
+     * **Endpoint**: `GET /v1/shop/quotes [QUO-100]`
+     *
+     * | Parameter             | Type             | Required | Description              |
+     * |-----------------------|------------------|----------|--------------------------|
+     * | `fromCustomerAccount` | `boolean`        | No       | Filter to current account|
+     * | `pageable`            | `PageableParams` | No       | Pagination settings      |
+     *
+     * @example
+     * ```typescript
+     * const { content: quotes } = await client.quote.getMasterQuotes({
+     *   pageable: { page: 0, size: 10 },
+     * });
+     *
+     * quotes.forEach(q => console.log(`${q.name}: ${q.status}`));
+     * ```
+     *
+     * @param params - Query parameters
+     * @param context - Optional SSR request context
+     * @returns Paginated quote list
+     */
+    getMasterQuotes(params?: GetMasterQuotesParams, context?: RequestContext): Promise<GetMasterQuotesResponse>;
+    /**
+     * Create a new master quote.
+     *
+     * A master quote is the main quote request that can be sent to multiple suppliers.
+     *
+     * **Endpoint**: `POST /v1/shop/quotes [QUO-101]`
+     *
+     * | Parameter     | Type     | Required | Description              |
+     * |---------------|----------|----------|--------------------------|
+     * | `name`        | `string` | Yes      | Quote reference name     |
+     * | `description` | `string` | Yes      | Quote description        |
+     *
+     * @example
+     * ```typescript
+     * const quote = await client.quote.createMasterQuote({
+     *   name: 'Q-2024-001',
+     *   description: 'Request for office furniture',
+     * });
+     *
+     * console.log(`Quote created: ${quote.id}`);
+     * ```
+     *
+     * @param params - Quote creation data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Created master quote
+     */
+    createMasterQuote(params: CreateMasterQuoteParams, context?: RequestContext): Promise<CreateMasterQuoteResponse>;
+    /**
+     * Delete a master quote.
+     *
+     * **Endpoint**: `DELETE /v1/shop/quotes/{quoteId} [QUO-102]`
+     *
+     * | Parameter       | Type     | Required | Description              |
+     * |-----------------|----------|----------|--------------------------|
+     * | `masterQuoteId` | `string` | Yes      | Quote ID to delete       |
+     *
+     * @param params - Quote identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If masterQuoteId is missing
+     * @throws {NotFoundError} If quote doesn't exist
+     */
+    deleteMasterQuote(params: DeleteMasterQuoteParams, context?: RequestContext): Promise<void>;
+    /**
+     * Get master quote details.
+     *
+     * **Endpoint**: `GET /v1/shop/quotes/{quoteId} [QUO-103]`
+     *
+     * | Parameter       | Type     | Required | Description              |
+     * |-----------------|----------|----------|--------------------------|
+     * | `masterQuoteId` | `string` | Yes      | Quote ID                 |
+     *
+     * @example
+     * ```typescript
+     * const quote = await client.quote.getMasterQuote({
+     *   masterQuoteId: 'quote-123',
+     * });
+     *
+     * console.log(`${quote.name}: ${quote.status}`);
+     * console.log(`Items: ${quote.details.length}`);
+     * ```
+     *
+     * @param params - Quote identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If masterQuoteId is missing
+     * @throws {NotFoundError} If quote doesn't exist
+     * @returns Master quote with details
+     */
+    getMasterQuote(params: GetMasterQuoteParams, context?: RequestContext): Promise<GetMasterQuoteResponse>;
+    /**
+     * Update a master quote (add/remove items, custom fields).
+     *
+     * **Endpoint**: `PUT /v1/shop/quotes/{quoteId} [QUO-104]`
+     *
+     * | Parameter                    | Type     | Required | Description              |
+     * |------------------------------|----------|----------|--------------------------|
+     * | `masterQuoteId`              | `string` | Yes      | Quote ID                 |
+     * | `masterQuoteDetailsToAdd`    | `array`  | No       | Items to add             |
+     * | `masterQuoteDetailsToRemove` | `array`  | No       | Item IDs to remove       |
+     * | `customFieldValues`          | `object` | No       | Custom field updates     |
+     * | `idType`                     | `string` | No       | Query: type for productVariantId (DJUST_ID \| EXTERNAL_ID). Default DJUST_ID. |
+     *
+     * @example
+     * ```typescript
+     * await client.quote.updateMasterQuote({
+     *   masterQuoteId: 'quote-123',
+     *   masterQuoteDetailsToAdd: [
+     *     { productVariantId: 'variant-1', quantity: 10 },
+     *   ],
+     * });
+     * ```
+     *
+     * @param params - Update data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If masterQuoteId is missing
+     * @returns Updated master quote
+     */
+    updateMasterQuote(params: UpdateMasterQuoteParams, context?: RequestContext): Promise<UpdateMasterQuoteResponse>;
+    /**
+     * Send quote requests to suppliers.
+     *
+     * Creates supplier quote requests from a master quote or ad-hoc.
+     *
+     * **Endpoint**: `POST /v1/shop/supplier-quotes [QUO-200]`
+     *
+     * | Parameter                   | Type     | Required | Description              |
+     * |-----------------------------|----------|----------|--------------------------|
+     * | `createSupplierQuoteRequests`| `array` | Yes      | Quote requests per supplier |
+     * | `supplierQuoteUrl`          | `string` | Yes      | Callback URL for suppliers |
+     * | `masterQuoteId`             | `string` | No       | Link to master quote     |
+     * | `billingAddressId`          | `string` | No       | Billing address          |
+     *
+     * @example
+     * ```typescript
+     * const supplierQuotes = await client.quote.createSupplierQuotes({
+     *   masterQuoteId: 'quote-123',
+     *   supplierQuoteUrl: 'https://myapp.com/supplier-quotes',
+     *   createSupplierQuoteRequests: [
+     *     {
+     *       supplierId: 'supplier-1',
+     *       shippingAddressId: 'addr-1',
+     *       lines: [{ productVariantId: 'var-1', quantity: 100 }],
+     *     },
+     *   ],
+     * });
+     * ```
+     *
+     * @param params - Supplier quote creation data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Created supplier quotes
+     */
+    createSupplierQuotes(params: CreateSupplierQuotesParams, context?: RequestContext): Promise<CreateSupplierQuotesResponse>;
+    /**
+     * Get supplier quote details.
+     *
+     * **Endpoint**: `GET /v1/shop/supplier-quotes/{quoteId} [QUO-201]`
+     *
+     * | Parameter         | Type     | Required | Description              |
+     * |-------------------|----------|----------|--------------------------|
+     * | `supplierQuoteId` | `string` | Yes      | Supplier quote ID        |
+     *
+     * @example
+     * ```typescript
+     * const quote = await client.quote.getSupplierQuote({
+     *   supplierQuoteId: 'sq-123',
+     * });
+     *
+     * console.log(`Supplier: ${quote.supplierName}`);
+     * console.log(`Status: ${quote.status}`);
+     * console.log(`Total: ${quote.totalAmount}`);
+     * ```
+     *
+     * @param params - Quote identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If supplierQuoteId is missing
+     * @returns Supplier quote details
+     */
+    getSupplierQuote(params: GetSupplierQuoteParams, context?: RequestContext): Promise<GetSupplierQuoteResponse>;
+    /**
+     * Accept a supplier quote.
+     *
+     * Marks the quote as accepted, ready for order creation.
+     *
+     * **Endpoint**: `PUT /v1/shop/supplier-quotes/{quoteId}/accept [QUO-202]`
+     *
+     * | Parameter         | Type     | Required | Description              |
+     * |-------------------|----------|----------|--------------------------|
+     * | `supplierQuoteId` | `string` | Yes      | Supplier quote ID        |
+     *
+     * @example
+     * ```typescript
+     * const accepted = await client.quote.acceptSupplierQuote({
+     *   supplierQuoteId: 'sq-123',
+     * });
+     *
+     * console.log(`Quote accepted: ${accepted.status}`);
+     * ```
+     *
+     * @param params - Quote identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If supplierQuoteId is missing
+     * @returns Accepted quote
+     */
+    acceptSupplierQuote(params: AcceptSupplierQuoteParams, context?: RequestContext): Promise<AcceptSupplierQuoteResponse>;
+    /**
+     * Decline a supplier quote.
+     *
+     * **Endpoint**: `PUT /v1/shop/supplier-quotes/{quoteId}/decline [QUO-203]`
+     *
+     * | Parameter         | Type     | Required | Description              |
+     * |-------------------|----------|----------|--------------------------|
+     * | `supplierQuoteId` | `string` | Yes      | Supplier quote ID        |
+     *
+     * @param params - Quote identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If supplierQuoteId is missing
+     * @returns Declined quote
+     */
+    declineSupplierQuote(params: DeclineSupplierQuoteParams, context?: RequestContext): Promise<DeclineSupplierQuoteResponse>;
+    /**
+     * Update custom fields on a supplier quote.
+     *
+     * **Endpoint**: `PATCH /v1/shop/supplier-quotes/{quoteId}/custom-fields [QUO-204]`
+     *
+     * @param params - Custom field update data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If supplierQuoteId is missing
+     * @returns Updated quote
+     */
+    updateSupplierQuoteCustomFields(params: UpdateSupplierQuoteCustomFieldsParams, context?: RequestContext): Promise<UpdateSupplierQuoteCustomFieldsResponse>;
+    /**
+     * Post a message to a supplier quote thread.
+     *
+     * Enables communication between buyer and supplier.
+     *
+     * **Endpoint**: `POST /v1/shop/supplier-quotes/{quoteId}/messages [QUO-205]`
+     *
+     * | Parameter         | Type     | Required | Description              |
+     * |-------------------|----------|----------|--------------------------|
+     * | `supplierQuoteId` | `string` | Yes      | Supplier quote ID        |
+     * | `message`         | `string` | Yes      | Message content          |
+     * | `username`        | `string` | Yes      | Sender's name            |
+     *
+     * @example
+     * ```typescript
+     * await client.quote.postMessageToSupplierQuote({
+     *   supplierQuoteId: 'sq-123',
+     *   message: 'Can you provide faster delivery options?',
+     *   username: 'John Doe',
+     * });
+     * ```
+     *
+     * @param params - Message data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Message confirmation
+     */
+    postMessageToSupplierQuote(params: PostMessageToSupplierQuoteParams, context?: RequestContext): Promise<PostMessageToSupplierQuoteResponse>;
+    /**
+     * Convert an accepted supplier quote to an order.
+     *
+     * Creates a commercial order from the accepted quote.
+     *
+     * **Endpoint**: `POST /v1/shop/supplier-quotes/{quoteId}/initialize-orders [QUO-206]`
+     *
+     * | Parameter                  | Type     | Required | Description              |
+     * |---------------------------|----------|----------|--------------------------|
+     * | `supplierQuoteId`         | `string` | Yes      | Supplier quote ID        |
+     * | `quoteLineIdsAndQuantities`| `array` | Yes      | Lines to convert         |
+     * | `nbPreviewLines`          | `number` | No       | Preview lines in response|
+     *
+     * @example
+     * ```typescript
+     * const order = await client.quote.initializeOrderFromSupplierQuote({
+     *   supplierQuoteId: 'sq-123',
+     *   quoteLineIdsAndQuantities: [
+     *     { quoteLineId: 'line-1', quantity: 50 },
+     *     { quoteLineId: 'line-2', quantity: 100 },
+     *   ],
+     * });
+     *
+     * console.log(`Order created: ${order.commercialOrderId}`);
+     * ```
+     *
+     * @param params - Order initialization data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Created order reference
+     */
+    initializeOrderFromSupplierQuote(params: InitializeOrderFromSupplierQuoteParams, context?: RequestContext): Promise<InitializeOrderFromSupplierQuoteResponse>;
+}
+//# sourceMappingURL=quote.service.d.ts.map

package/lib/services/quote/quote.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"quote.service.d.ts","sourceRoot":"","sources":["../../../src/services/quote/quote.service.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,KAAK,EACV,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,EAC1B,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,qCAAqC,EACrC,gCAAgC,EAChC,sCAAsC,EACtC,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,EACtB,yBAAyB,EACzB,4BAA4B,EAC5B,wBAAwB,EACxB,2BAA2B,EAC3B,4BAA4B,EAC5B,uCAAuC,EACvC,kCAAkC,EAClC,wCAAwC,EACzC,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C,QAAQ,CAAC,WAAW,WAAW;IAM/B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,eAAe,CACnB,MAAM,GAAE,qBAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,uBAAuB,CAAC;IAgBnC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,yBAAyB,CAAC;IAgBrC;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,cAAc,CAClB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAclC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,yBAAyB,CAAC;IAwBrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,oBAAoB,CACxB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,4BAA4B,CAAC;IAkBxC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,gBAAgB,CACpB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,wBAAwB,CAAC;IAcpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,2BAA2B,CAAC;IAcvC;;;;;;;;;;;;;OAaG;IACG,oBAAoB,CACxB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,4BAA4B,CAAC;IAcxC;;;;;;;;;OASG;IACG,+BAA+B,CACnC,MAAM,EAAE,qCAAqC,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,uCAAuC,CAAC;IAkBnD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,0BAA0B,CAC9B,MAAM,EAAE,gCAAgC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,kCAAkC,CAAC;IAkB9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,gCAAgC,CACpC,MAAM,EAAE,sCAAsC,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,wCAAwC,CAAC;CAerD"}