@djust-b2b/djust-front-sdk 3.0.0-beta.2 → 3.0.0-beta.20

package/dist/services/commercial-order/commercial-order.service.d.ts

@@ -0,0 +1,435 @@
+/**
+ * # Commercial Order Service
+ *
+ * Complete order management for B2B commerce workflows.
+ *
+ * ## Features
+ * - Order creation and lifecycle management
+ * - Payment processing and card registration
+ * - Shipping and billing configuration
+ * - Order line management
+ * - Punchout/OCI integration
+ *
+ * @module services/commercial-order
+ * @since 2.17.0
+ */
+import { BaseService } from "../base.service";
+import type { RequestContext } from "../../client/transport";
+import type { GetCommercialOrdersParams, GetCommercialOrdersV2Params, CreateCommercialOrderParams, CreateCommercialOrderV2Params, GetCommercialOrderParams, UpdateCommercialOrderParams, CreateCardRegistrationParams, UpdateBillingInformationParams, SetStatusAsCreatedParams, SetStatusAsOnHoldParams, SyncCommercialOrderParams, GetPaymentPageUrlParams, CreatePreauthorizationParams, UpdateShippingAddressParams, UpdateShippingInformationParams, UpdateShippingTypeParams, DeleteCommercialOrderParams, GetCommercialOrderLinesParams, UpdateCommercialOrderLinesParams, DeleteCommercialOrderLinesParams, PunchoutOciParams, GetCommercialOrdersResponse, GetCommercialOrdersV2Response, CreateCommercialOrderResponse, CreateCommercialOrderV2Response, GetCommercialOrderResponse, CreateCardRegistrationResponse, CreatePreauthorizationResponse, GetCommercialOrderLinesResponse, UpdateCommercialOrderLinesResponse, DeleteCommercialOrderLinesResponse, SyncCommercialOrderResponse } from "./types";
+/**
+ * Service for commercial order management.
+ *
+ * Handles the complete order lifecycle from creation to fulfillment:
+ * - Order creation from carts or quotes
+ * - Payment processing
+ * - Shipping and billing configuration
+ * - Order status management
+ *
+ * @example
+ * ```typescript
+ * import { createDjustClient } from '@djust-b2b/djust-front-sdk';
+ *
+ * const client = createDjustClient({ baseUrl, clientId, apiKey });
+ *
+ * // Get orders
+ * const { content: orders } = await client.commercialOrder.getCommercialOrdersV2({
+ *   locale: 'en-US',
+ *   page: 0,
+ *   size: 10,
+ * });
+ *
+ * // Get single order details
+ * const order = await client.commercialOrder.getCommercialOrder({
+ *   orderId: 'ORD-12345',
+ *   locale: 'en-US',
+ * });
+ * ```
+ */
+export declare class CommercialOrderService extends BaseService {
+    readonly serviceName = "commercial-order";
+    /**
+     * Get paginated list of commercial orders (v1).
+     *
+     * **Endpoint**: `GET /v1/shop/commercial-orders [ORD-100]`
+     *
+     * | Parameter            | Type       | Required | Description                    |
+     * |----------------------|------------|----------|--------------------------------|
+     * | `locale`             | `string`   | Yes      | Locale for translations        |
+     * | `page`               | `number`   | No       | Page number (0-based)          |
+     * | `size`               | `number`   | No       | Items per page                 |
+     * | `sort`               | `string`   | No       | Sort criteria                  |
+     * | `connectedUserOnly`  | `boolean`  | No       | Filter to current user's orders|
+     * | `customerAccountIds` | `string[]` | No       | Filter by customer accounts    |
+     * | `sourceTypes`        | `string[]` | No       | Filter by order source         |
+     * | `isValidated`        | `boolean`  | No       | Filter by validation status    |
+     *
+     * @param params - Query parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If locale is missing
+     * @returns Paginated order list
+     */
+    getCommercialOrders(params: GetCommercialOrdersParams, context?: RequestContext): Promise<GetCommercialOrdersResponse>;
+    /**
+     * Get paginated list of commercial orders (v2).
+     *
+     * Enhanced version with additional filtering capabilities.
+     *
+     * **Endpoint**: `GET /v2/shop/commercial-orders [ORD-101]`
+     *
+     * | Parameter            | Type       | Required | Description                    |
+     * |----------------------|------------|----------|--------------------------------|
+     * | `locale`             | `string`   | Yes      | Locale for translations        |
+     * | `page`               | `number`   | No       | Page number (0-based)          |
+     * | `size`               | `number`   | No       | Items per page                 |
+     * | `sort`               | `string`   | No       | Sort criteria                  |
+     * | `sourceIds`          | `string[]` | No       | Filter by source IDs           |
+     * | `sourceTypes`        | `string[]` | No       | Filter by source types         |
+     *
+     * @example
+     * ```typescript
+     * const { content: orders, totalElements } = await client.commercialOrder.getCommercialOrdersV2({
+     *   locale: 'fr-FR',
+     *   page: 0,
+     *   size: 20,
+     *   sort: 'createdAt,desc',
+     * });
+     *
+     * orders.forEach(order => {
+     *   console.log(`${order.businessId}: ${order.status} - ${order.total}`);
+     * });
+     * ```
+     *
+     * @param params - Query parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If locale is missing
+     * @returns Paginated order list
+     */
+    getCommercialOrdersV2(params: GetCommercialOrdersV2Params, context?: RequestContext): Promise<GetCommercialOrdersV2Response>;
+    /**
+     * Create a new commercial order from a cart or quote.
+     *
+     * **Endpoint**: `POST /v1/shop/commercial-orders [ORD-102]`
+     *
+     * | Parameter      | Type     | Required | Description                    |
+     * |----------------|----------|----------|--------------------------------|
+     * | `locale`       | `string` | Yes      | Locale for the order           |
+     * | `origin`       | `string` | Yes      | Origin type (CART, QUOTE)      |
+     * | `originId`     | `string` | Yes      | ID of the cart or quote        |
+     * | `channel`      | `string` | No       | Sales channel                  |
+     * | `customFields` | `object` | No       | Custom field values            |
+     * | `paymentInfo`  | `object` | No       | Payment configuration          |
+     *
+     * @example
+     * ```typescript
+     * const order = await client.commercialOrder.createCommercialOrder({
+     *   locale: 'en-US',
+     *   origin: 'CART',
+     *   originId: 'cart-123',
+     *   paymentInfo: { method: 'INVOICE' },
+     * });
+     *
+     * console.log(`Order created: ${order.businessId}`);
+     * ```
+     *
+     * @param params - Order creation parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Created order details
+     */
+    createCommercialOrder(params: CreateCommercialOrderParams, context?: RequestContext): Promise<CreateCommercialOrderResponse>;
+    /**
+     * Create a commercial order (v2).
+     *
+     * Enhanced creation endpoint with more flexibility.
+     *
+     * **Endpoint**: `POST /v2/shop/commercial-orders [ORD-103]`
+     *
+     * | Parameter           | Type     | Required | Description                    |
+     * |---------------------|----------|----------|--------------------------------|
+     * | `sourceType`        | `string` | No       | Source type (CART, QUOTE)      |
+     * | `sourceId`          | `string` | No       | Source ID                      |
+     * | `customFields`      | `object` | No       | Custom field values            |
+     * | `customFieldIdType` | `string` | No       | ID type for custom fields      |
+     * | `isFull`            | `boolean`| No       | Include full order details     |
+     *
+     * @param params - Order creation parameters
+     * @param context - Optional SSR request context
+     * @returns Created order details
+     */
+    createCommercialOrderV2(params: CreateCommercialOrderV2Params, context?: RequestContext): Promise<CreateCommercialOrderV2Response>;
+    /**
+     * Get detailed information about a specific order.
+     *
+     * **Endpoint**: `GET /v1/shop/commercial-orders/{orderId} [ORD-104]`
+     *
+     * | Parameter  | Type     | Required | Description                    |
+     * |------------|----------|----------|--------------------------------|
+     * | `orderId`  | `string` | Yes      | Order ID or business ID        |
+     * | `locale`   | `string` | Yes      | Locale for translations        |
+     * | `idType`   | `string` | No       | ID type (id, businessId)       |
+     *
+     * @example
+     * ```typescript
+     * const order = await client.commercialOrder.getCommercialOrder({
+     *   orderId: 'ORD-2024-001234',
+     *   locale: 'en-US',
+     *   idType: 'businessId',
+     * });
+     *
+     * console.log(`Order: ${order.businessId}`);
+     * console.log(`Status: ${order.status}`);
+     * console.log(`Total: ${order.totalAmount} ${order.currency}`);
+     * ```
+     *
+     * @param params - Order identification parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @throws {NotFoundError} If order doesn't exist
+     * @returns Full order details
+     */
+    getCommercialOrder(params: GetCommercialOrderParams, context?: RequestContext): Promise<GetCommercialOrderResponse>;
+    /**
+     * Update commercial order custom fields.
+     *
+     * **Endpoint**: `PUT /v2/shop/commercial-orders/{orderId} [ORD-105]`
+     *
+     * @param params - Update parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If commercialOrderId is missing
+     */
+    updateCommercialOrder(params: UpdateCommercialOrderParams, context?: RequestContext): Promise<void>;
+    /**
+     * Create a card registration for payment.
+     *
+     * Initiates the card registration process with the payment provider.
+     *
+     * **Endpoint**: `POST /v1/shop/commercial-orders/{orderId}/card-registration [PAY-100]`
+     *
+     * | Parameter         | Type     | Required | Description              |
+     * |-------------------|----------|----------|--------------------------|
+     * | `orderId`         | `string` | Yes      | Order ID                 |
+     * | `paymentProvider` | `string` | Yes      | Provider (MANGOPAY, etc) |
+     * | `currency`        | `string` | Yes      | Currency code            |
+     *
+     * @example
+     * ```typescript
+     * const registration = await client.commercialOrder.createCardRegistration({
+     *   orderId: 'order-123',
+     *   paymentProvider: 'MANGOPAY',
+     *   currency: 'EUR',
+     * });
+     *
+     * // Use registration data to tokenize card
+     * console.log(registration.cardRegistrationUrl);
+     * ```
+     *
+     * @param params - Card registration parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Card registration details
+     */
+    createCardRegistration(params: CreateCardRegistrationParams, context?: RequestContext): Promise<CreateCardRegistrationResponse>;
+    /**
+     * Update billing information for an order.
+     *
+     * **Endpoint**: `PUT /v1/shop/commercial-orders/{orderId}/billing-information [ORD-106]`
+     *
+     * | Parameter          | Type     | Required | Description              |
+     * |--------------------|----------|----------|--------------------------|
+     * | `orderId`          | `string` | Yes      | Order ID                 |
+     * | `billingAddressId` | `string` | Yes      | Billing address ID       |
+     *
+     * @param params - Billing update parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     */
+    updateBillingInformation(params: UpdateBillingInformationParams, context?: RequestContext): Promise<void>;
+    /**
+     * Set order status to CREATED (finalize order).
+     *
+     * **Endpoint**: `PUT /v1/shop/commercial-orders/{orderId}/set-status-as-created [ORD-107]`
+     *
+     * @example
+     * ```typescript
+     * await client.commercialOrder.setStatusAsCreated({
+     *   orderId: 'order-123',
+     *   paymentInfo: { method: 'CARD', transactionId: 'txn-456' },
+     * });
+     * ```
+     *
+     * @param params - Status update parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If orderId is missing
+     */
+    setStatusAsCreated(params: SetStatusAsCreatedParams, context?: RequestContext): Promise<void>;
+    /**
+     * Set order status to ON_HOLD.
+     *
+     * **Endpoint**: `PUT /v1/shop/commercial-orders/{orderId}/set-status-as-hold [ORD-108]`
+     *
+     * @param params - Order identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If orderId is missing
+     */
+    setStatusAsOnHold(params: SetStatusAsOnHoldParams, context?: RequestContext): Promise<void>;
+    /**
+     * Synchronize order with external systems (ORDER-223).
+     *
+     * **Endpoint**: `PUT /v1/shop/commercial-orders/{orderId}/sync`
+     *
+     * Returns the set of synchronisation warnings. Empty array if no warning.
+     *
+     * @param params - Order identification (REFERENCE only; business/external IDs not supported)
+     * @param context - Optional SSR request context
+     * @returns Synchronisation warnings; empty array if none
+     * @throws {ValidationError} If orderId is missing
+     */
+    syncCommercialOrder(params: SyncCommercialOrderParams, context?: RequestContext): Promise<SyncCommercialOrderResponse>;
+    /**
+     * Get payment page URL for online payment.
+     *
+     * **Endpoint**: `GET /v1/shop/commercial-orders/{orderId}/payment-page [PAY-101]`
+     *
+     * | Parameter         | Type     | Required | Description              |
+     * |-------------------|----------|----------|--------------------------|
+     * | `orderId`         | `string` | Yes      | Order ID                 |
+     * | `paymentOption`   | `string` | Yes      | Payment option selected  |
+     * | `paymentProvider` | `string` | No       | Specific provider        |
+     *
+     * @example
+     * ```typescript
+     * const paymentUrl = await client.commercialOrder.getPaymentPageUrl({
+     *   orderId: 'order-123',
+     *   paymentOption: 'CARD',
+     * });
+     *
+     * // Redirect user to payment page
+     * window.location.href = paymentUrl;
+     * ```
+     *
+     * @param params - Payment page parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Payment page URL
+     */
+    getPaymentPageUrl(params: GetPaymentPageUrlParams, context?: RequestContext): Promise<string>;
+    /**
+     * Create a payment preauthorization.
+     *
+     * **Endpoint**: `POST /v1/shop/commercial-orders/{orderId}/preauthorization [PAY-102]`
+     *
+     * @param params - Preauthorization parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Preauthorization result
+     */
+    createPreauthorization(params: CreatePreauthorizationParams, context?: RequestContext): Promise<CreatePreauthorizationResponse>;
+    /**
+     * Update shipping address for an order.
+     *
+     * **Endpoint**: `PUT /v1/shop/commercial-orders/{orderId}/shipping-address [ORD-110]`
+     *
+     * @param params - Shipping address update parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     */
+    updateShippingAddress(params: UpdateShippingAddressParams, context?: RequestContext): Promise<void>;
+    /**
+     * Update complete shipping information.
+     *
+     * **Endpoint**: `PUT /v1/shop/commercial-orders/{orderId}/shipping-information [ORD-111]`
+     *
+     * @param params - Shipping information parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     */
+    updateShippingInformation(params: UpdateShippingInformationParams, context?: RequestContext): Promise<void>;
+    /**
+     * Update shipping type only.
+     *
+     * **Endpoint**: `PUT /v1/shop/commercial-orders/{orderId}/shipping-type [ORD-112]`
+     *
+     * @param params - Shipping type parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     */
+    updateShippingType(params: UpdateShippingTypeParams, context?: RequestContext): Promise<void>;
+    /**
+     * Delete a commercial order.
+     *
+     * **Endpoint**: `DELETE /v2/shop/commercial-orders/{orderId} [ORD-113]`
+     *
+     * @param params - Order identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If commercialOrderId is missing
+     * @throws {NotFoundError} If order doesn't exist
+     */
+    deleteCommercialOrder(params: DeleteCommercialOrderParams, context?: RequestContext): Promise<void>;
+    /**
+     * Get order lines with pagination.
+     *
+     * **Endpoint**: `GET /v1/shop/commercial-orders/{orderId}/lines [ORD-114]`
+     *
+     * @example
+     * ```typescript
+     * const { content: lines } = await client.commercialOrder.getCommercialOrderLines({
+     *   commercialOrderId: 'order-123',
+     *   page: 0,
+     *   size: 50,
+     *   locale: 'en-US',
+     * });
+     *
+     * lines.forEach(line => {
+     *   console.log(`${line.productName}: ${line.quantity} x ${line.unitPrice}`);
+     * });
+     * ```
+     *
+     * @param params - Query parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If commercialOrderId is missing
+     * @returns Paginated order lines
+     */
+    getCommercialOrderLines(params: GetCommercialOrderLinesParams, context?: RequestContext): Promise<GetCommercialOrderLinesResponse>;
+    /**
+     * Update order lines (quantities, custom fields).
+     *
+     * **Endpoint**: `PUT /v2/shop/commercial-orders/{orderId}/lines [ORD-115]`
+     *
+     * @param params - Update parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If commercialOrderId is missing
+     * @returns Updated lines information
+     */
+    updateCommercialOrderLines(params: UpdateCommercialOrderLinesParams, context?: RequestContext): Promise<UpdateCommercialOrderLinesResponse>;
+    /**
+     * Delete order lines.
+     *
+     * **Endpoint**: `DELETE /v2/shop/commercial-orders/{orderId}/lines [ORD-116]`
+     *
+     * @param params - Deletion parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If commercialOrderId is missing
+     * @returns Deletion result
+     */
+    deleteCommercialOrderLines(params: DeleteCommercialOrderLinesParams, context?: RequestContext): Promise<DeleteCommercialOrderLinesResponse>;
+    /**
+     * Get OCI punchout data for procurement integration.
+     *
+     * Returns order data in OCI format for SAP Ariba, Coupa, etc.
+     *
+     * **Endpoint**: `GET /cxml/punchout/oci/{configKey}/commercial-orders/{orderId} [PUNCHOUT-100]`
+     *
+     * | Parameter                  | Type     | Required | Description              |
+     * |---------------------------|----------|----------|--------------------------|
+     * | `commercialOrderId`       | `string` | Yes      | Order ID                 |
+     * | `tenantConfigurationKey`  | `string` | Yes      | OCI configuration key    |
+     * | `locale`                  | `string` | No       | Locale for data          |
+     *
+     * @param params - Punchout parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns OCI field mapping for the order
+     */
+    punchoutOci(params: PunchoutOciParams, context?: RequestContext): Promise<Record<string, string>>;
+}
+//# sourceMappingURL=commercial-order.service.d.ts.map

package/dist/services/commercial-order/commercial-order.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commercial-order.service.d.ts","sourceRoot":"","sources":["../../../src/services/commercial-order/commercial-order.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,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,2BAA2B,EAC3B,4BAA4B,EAC5B,8BAA8B,EAC9B,wBAAwB,EACxB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,4BAA4B,EAC5B,2BAA2B,EAC3B,+BAA+B,EAC/B,wBAAwB,EACxB,2BAA2B,EAC3B,6BAA6B,EAC7B,gCAAgC,EAChC,gCAAgC,EAChC,iBAAiB,EACjB,2BAA2B,EAC3B,6BAA6B,EAC7B,6BAA6B,EAC7B,+BAA+B,EAC/B,0BAA0B,EAC1B,8BAA8B,EAC9B,8BAA8B,EAC9B,+BAA+B,EAC/B,kCAAkC,EAClC,kCAAkC,EAClC,2BAA2B,EAC5B,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD,QAAQ,CAAC,WAAW,sBAAsB;IAE1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,2BAA2B,CAAC;IAuBvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,qBAAqB,CACzB,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,6BAA6B,CAAC;IAwBzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,qBAAqB,CACzB,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,6BAA6B,CAAC;IAqBzC;;;;;;;;;;;;;;;;;;OAkBG;IACG,uBAAuB,CAC3B,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,+BAA+B,CAAC;IAiB3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,kBAAkB,CACtB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,0BAA0B,CAAC;IAmBtC;;;;;;;;OAQG;IACG,qBAAqB,CACzB,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,sBAAsB,CAC1B,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,8BAA8B,CAAC;IAkB1C;;;;;;;;;;;;;OAaG;IACG,wBAAwB,CAC5B,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;;;;;;;;;OAgBG;IACG,kBAAkB,CACtB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;OAQG;IACG,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;;;;;;OAWG;IACG,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,2BAA2B,CAAC;IAevC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;IAoBlB;;;;;;;;;OASG;IACG,sBAAsB,CAC1B,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,8BAA8B,CAAC;IAqB1C;;;;;;;;OAQG;IACG,qBAAqB,CACzB,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;OAQG;IACG,yBAAyB,CAC7B,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;;;OAQG;IACG,kBAAkB,CACtB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;;OASG;IACG,qBAAqB,CACzB,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,uBAAuB,CAC3B,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,+BAA+B,CAAC;IAwB3C;;;;;;;;;OASG;IACG,0BAA0B,CAC9B,MAAM,EAAE,gCAAgC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,kCAAkC,CAAC;IAqB9C;;;;;;;;;OASG;IACG,0BAA0B,CAC9B,MAAM,EAAE,gCAAgC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,kCAAkC,CAAC;IAe9C;;;;;;;;;;;;;;;;;OAiBG;IACG,WAAW,CACf,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAYnC"}

package/dist/services/commercial-order/definitions.d.ts

@@ -0,0 +1,181 @@
+import { Channel, Currency, IdType, PageableObject, Order } from "../../interfaces/models/common";
+import { CustomFieldValueRequest } from "../../interfaces/models/custom-field";
+import { BrowserInfo, CardInformationDto, OrderCommercialDto, OrderIdType, OrderLogisticDto, OrderOrigin, PageOrderCommercialDto, PaymentCardInfo, PreauthorizationDto, OfferToDelete, OrderLogisticLineUpdate, PageOrderCommercialLinesDto } from "../../interfaces/models/order";
+import { SingleWarningReportDto } from "../../interfaces/models/common";
+import { PaymentInfoRequest, PaymentOption, PaymentProvider } from "../../interfaces/models/payment";
+/**
+ * Request parameters type definitions
+ */
+export interface GetCommercialOrdersParameters {
+    locale: string;
+    nbPreviewLines?: number;
+    page?: number;
+    size?: number;
+    sort?: string[];
+    connectedUserOnly?: boolean;
+    customerAccountIds?: string[];
+    sourceTypes?: string[];
+    isValidated?: boolean;
+}
+export interface GetCommercialOrdersV2Parameters {
+    page?: number;
+    size?: number;
+    sort?: string[];
+    locale: string;
+    connectedUserOnly?: boolean;
+    customerAccountIds?: string[];
+    sourceTypes?: string[];
+    sourceIds?: string[];
+    isValidated?: boolean;
+    nbPreviewLines?: number;
+}
+export interface GetOrderCommercialLinesParameters {
+    commercialOrderId: string;
+    page?: number;
+    size?: number;
+    sort?: string;
+    supplierIds?: string[];
+    productVariantIds?: string[];
+    offerPriceIds: string[];
+    idType?: IdType;
+    locale?: string;
+}
+export interface CreateCommercialOrderParameters {
+    nbPreviewLines?: number;
+    channel?: Channel;
+    customFields?: CustomFieldValueRequest[];
+    locale: string;
+    origin: OrderOrigin;
+    originId: string;
+    paymentInfo?: PaymentInfoRequest;
+}
+export interface CreateCommercialOrderV2Parameters {
+    customFieldIdType?: IdType;
+    customFields?: CustomFieldValueRequest[];
+    isFull?: boolean;
+    sourceId?: string;
+    sourceType?: string;
+}
+export interface UpdateCommercialOrderParameters extends CreateCommercialOrderV2Parameters {
+    commercialOrderId: string;
+}
+export interface DeleteCommercialOrderLinesParameters {
+    commercialOrderId: string;
+    body: OfferToDelete[];
+}
+export interface GetCommercialOrderParameters {
+    orderId: string;
+    locale: string;
+    idType?: OrderIdType;
+    nbPreviewLines?: number;
+}
+export interface CreateCommercialOrderCardRegistrationParameters {
+    orderId: string;
+    paymentProvider: PaymentProvider;
+    currency: Currency;
+}
+export interface UpdateCommercialOrderBillingInformationParameters {
+    orderId: string;
+    billingAddressId: string;
+}
+export interface SetCommercialOrderStatusAsCreatedParameters {
+    orderId: string;
+    paymentInfo?: PaymentInfoRequest;
+}
+export interface SetCommercialOrderStatusAsOnHoldParameters {
+    orderId: string;
+}
+export interface GetCommercialOrderPaymentPageUrlParameters {
+    orderId: string;
+    paymentOption: PaymentOption;
+    paymentProvider?: PaymentProvider;
+}
+export interface CreateCommercialOrderPreauthorizationParameters {
+    orderId: string;
+    paymentProvider: PaymentProvider;
+    authorId: string;
+    browserInfo: BrowserInfo;
+    ipAddress: string;
+    paymentCardInfo: PaymentCardInfo;
+}
+export interface UpdateCommercialOrderShippingAddressParameters {
+    orderId: string;
+    shippingAddressId: string;
+}
+export interface UpdateCommercialOrderShippingInformationParameters {
+    orderId: string;
+    shippingAddressId: string;
+    shippingType: string;
+}
+export interface UpdateCommercialOrderShippingTypeParameters {
+    orderId: string;
+    shippingType: string;
+}
+export interface UpdateOrderLogisticCustomFieldParameters {
+    orderLogisticId: string;
+    customFieldsValues: CustomFieldValueRequest[];
+}
+export interface PunchoutOciCommercialOrderParameters {
+    tenantConfigurationKey: string;
+    commercialOrderId: string;
+    locale: string;
+}
+/**
+ * Response type definitions
+ */
+export interface GetCommercialOrdersResponse extends PageOrderCommercialDto {
+}
+export interface GetCommercialOrdersV2Response {
+    content: OrderCommercialDto[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+}
+export interface CreateCommercialOrderResponse extends OrderCommercialDto {
+}
+export interface CreateCommercialOrderV2Response {
+    id: string;
+    reference: string;
+}
+export interface UpdateCommercialOrderLinesParameters {
+    commercialOrderId: string;
+    customFieldIdType?: IdType;
+    lineIdType?: IdType;
+    lineType?: string;
+    updateOrderCommercialLines?: OrderLogisticLineUpdate[];
+    metadata?: {
+        [key: string]: any;
+    };
+}
+export interface GetCommercialOrderResponse extends OrderCommercialDto {
+}
+export interface GetOrderCommercialLinesResponse extends PageOrderCommercialLinesDto {
+}
+export interface CreateCommercialOrderCardRegistrationResponse extends CardInformationDto {
+}
+export interface CreateCommercialOrderPreauthorizationResponse extends PreauthorizationDto {
+}
+export interface UpdateOrderLogisticCustomFieldResponse extends OrderLogisticDto {
+}
+export interface DeleteCommercialOrderLinesResponse extends Array<SingleWarningReportDto> {
+}
+export interface UpdateCommercialOrderLinesResponse extends Array<SingleWarningReportDto> {
+}
+/**
+ * Single synchronisation warning returned by PUT .../sync (ORDER-223).
+ * If no warning is detected, the API returns an empty array.
+ */
+export interface SyncCommercialOrderWarningItem {
+    id: string;
+    code: string;
+    blocked: boolean;
+    detail: string;
+}
+/** Response of PUT /v1/shop/commercial-orders/{orderCommercialReference}/sync */
+export type SyncCommercialOrderResponse = SyncCommercialOrderWarningItem[];
+//# sourceMappingURL=definitions.d.ts.map

package/dist/services/commercial-order/definitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../../src/services/commercial-order/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,QAAQ,EACR,MAAM,EACN,cAAc,EACd,KAAK,EACN,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,aAAa,EACb,uBAAuB,EAEvB,2BAA2B,EAC5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,eAAe,EAChB,MAAM,iCAAiC,CAAC;AAEzC;;GAEG;AAEH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iCAAiC;IAChD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,+BAA+B;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,uBAAuB,EAAE,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,WAAW,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AACD,MAAM,WAAW,iCAAiC;IAChD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,uBAAuB,EAAE,CAAC;IACzC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,+BACf,SAAQ,iCAAiC;IACzC,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,oCAAoC;IACnD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,IAAI,EAAE,aAAa,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,+CAA+C;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,eAAe,CAAC;IACjC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,iDAAiD;IAChE,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,2CAA2C;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,WAAW,0CAA0C;IACzD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0CAA0C;IACzD,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,aAAa,CAAC;IAC7B,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED,MAAM,WAAW,+CAA+C;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,eAAe,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,eAAe,CAAC;CAClC;AAED,MAAM,WAAW,8CAA8C;IAC7D,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,kDAAkD;IACjE,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,2CAA2C;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wCAAwC;IACvD,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;CAC/C;AAED,MAAM,WAAW,oCAAoC;IACnD,sBAAsB,EAAE,MAAM,CAAC;IAC/B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AAEH,MAAM,WAAW,2BAA4B,SAAQ,sBAAsB;CAAG;AAE9E,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,cAAc,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,EAAE,CAAC;CACf;AAED,MAAM,WAAW,6BAA8B,SAAQ,kBAAkB;CAAG;AAE5E,MAAM,WAAW,+BAA+B;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oCAAoC;IACnD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0BAA0B,CAAC,EAAE,uBAAuB,EAAE,CAAC;IACvD,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACnC;AAED,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;CAAG;AAEzE,MAAM,WAAW,+BACf,SAAQ,2BAA2B;CAAG;AACxC,MAAM,WAAW,6CACf,SAAQ,kBAAkB;CAAG;AAE/B,MAAM,WAAW,6CACf,SAAQ,mBAAmB;CAAG;AAEhC,MAAM,WAAW,sCACf,SAAQ,gBAAgB;CAAG;AAE7B,MAAM,WAAW,kCACf,SAAQ,KAAK,CAAC,sBAAsB,CAAC;CAAG;AAE1C,MAAM,WAAW,kCACf,SAAQ,KAAK,CAAC,sBAAsB,CAAC;CAAG;AAE1C;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,iFAAiF;AACjF,MAAM,MAAM,2BAA2B,GAAG,8BAA8B,EAAE,CAAC"}

package/dist/services/commercial-order/endpoints.d.ts

@@ -0,0 +1,28 @@
+/**
+ * DJUST SDK Commercial Order Service - Endpoints
+ * API endpoint constants for commercial order operations.
+ *
+ * @module services/commercial-order/endpoints
+ * @since 2.17.0
+ */
+export declare const CommercialOrderEndpoints: {
+    readonly ORDERS_V1: "/v1/shop/commercial-orders";
+    readonly ORDER_V1: "/v1/shop/commercial-orders/{orderId}";
+    readonly CARD_REGISTRATION: "/v1/shop/commercial-orders/{orderId}/card-registration";
+    readonly BILLING_INFORMATION: "/v1/shop/commercial-orders/{orderId}/billing-information";
+    readonly STATUS_CREATED: "/v1/shop/commercial-orders/{orderId}/created";
+    readonly STATUS_HOLD: "/v1/shop/commercial-orders/{orderId}/hold";
+    readonly SYNC: "/v1/shop/commercial-orders/{orderId}/sync";
+    readonly PAYMENT_PAGE: "/v1/shop/commercial-orders/{orderId}/payment-page";
+    readonly PREAUTHORIZATION: "/v1/shop/commercial-orders/{orderId}/preauthorization";
+    readonly SHIPPING_ADDRESS: "/v1/shop/commercial-orders/{orderId}/shipping-address";
+    readonly SHIPPING_INFORMATION: "/v1/shop/commercial-orders/{orderId}/shipping-information";
+    readonly SHIPPING_TYPE: "/v1/shop/commercial-orders/{orderId}/shipping-type";
+    readonly LINES_V1: "/v1/shop/commercial-orders/{commercialOrderId}/lines";
+    readonly ORDERS_V2: "/v2/shop/commercial-orders";
+    readonly ORDER_V2: "/v2/shop/commercial-orders/{commercialOrderId}";
+    readonly LINES_V2: "/v2/shop/commercial-orders/{commercialOrderId}/lines";
+    readonly PUNCHOUT_OCI: "/cxml/punchout/oci/{tenantConfigurationKey}/commercial-orders/{commercialOrderId}";
+};
+export type CommercialOrderEndpoint = (typeof CommercialOrderEndpoints)[keyof typeof CommercialOrderEndpoints];
+//# sourceMappingURL=endpoints.d.ts.map

package/dist/services/commercial-order/endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../../src/services/commercial-order/endpoints.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;CA0B3B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GACjC,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,OAAO,wBAAwB,CAAC,CAAC"}