@djust-b2b/djust-front-sdk 3.0.0-beta.8 → 3.0.0

package/lib/services/customer-account/customer-account.service.d.ts

@@ -0,0 +1,387 @@
+/**
+ * # Customer Account Service
+ *
+ * B2B customer account and organization management.
+ *
+ * ## Features
+ * - Customer account CRUD operations
+ * - Address book management
+ * - Organization hierarchy support
+ * - User management within accounts
+ * - Order history by account
+ *
+ * @module services/customer-account
+ * @since 2.17.0
+ */
+import { BaseService } from "../base.service";
+import type { RequestContext } from "../../client/transport";
+import type { GetCustomerAccountParams, GetCustomerAccountV2Params, CreateCustomerAccountParams, UpdateCustomerAccountParams, GetCustomerAccountAddressesParams, CreateCustomerAccountAddressParams, DeleteCustomerAccountAddressParams, UpdateCustomerAccountAddressParams, GetCustomerAccountCustomFieldsParams, GetCustomerAccountOrdersParams, GetCustomerAccountUsersParams, CreateOrganisationParams, UpdateOrganisationParams, GetOrganisationsParams, GetOrganisationAddressesParams, DeleteOrganisationAddressParams, UpdateOrganisationAddressParams, GetOrganisationOrdersParams, GetOrganisationUsersParams, UpdateOrganisationUserParams, GetCustomerAccountResponse, GetCustomerAccountV2Response, CreateCustomerAccountResponse, UpdateCustomerAccountResponse, GetCustomerAccountAddressesResponse, CreateCustomerAccountAddressResponse, UpdateCustomerAccountAddressResponse, GetCustomerAccountCustomFieldsResponse, GetCustomerAccountOrdersResponse, GetCustomerAccountUsersResponse, CreateOrganisationResponse, UpdateOrganisationResponse, GetOrganisationsResponse, GetOrganisationAddressesResponse, UpdateOrganisationAddressResponse, GetOrganisationOrdersResponse, GetOrganisationUsersResponse, UpdateOrganisationUserResponse } from "./types";
+/**
+ * Service for customer account management.
+ *
+ * Handles B2B customer structures including:
+ * - Company accounts
+ * - Organizations and cost centers
+ * - Address books
+ * - User permissions
+ *
+ * @example
+ * ```typescript
+ * import { createDjustClient } from '@djust-b2b/djust-front-sdk';
+ *
+ * const client = createDjustClient({ baseUrl, clientId, apiKey });
+ *
+ * // Get current account
+ * const account = await client.customerAccount.getCustomerAccount();
+ *
+ * // Get addresses
+ * const addresses = await client.customerAccount.getCustomerAccountAddresses();
+ *
+ * // Create new address
+ * await client.customerAccount.createCustomerAccountAddress({
+ *   label: 'Warehouse',
+ *   street: '123 Industrial Blvd',
+ *   city: 'Chicago',
+ *   country: 'US',
+ *   postalCode: '60601',
+ * });
+ * ```
+ */
+export declare class CustomerAccountService extends BaseService {
+    readonly serviceName = "customer-account";
+    /**
+     * Get the current user's customer account.
+     *
+     * Returns account details for the authenticated user.
+     *
+     * **Endpoint**: `GET /v1/shop/customer-accounts [ACC-100]`
+     *
+     * @example
+     * ```typescript
+     * const account = await client.customerAccount.getCustomerAccount();
+     * console.log(`Account: ${account.name}`);
+     * console.log(`External ID: ${account.externalId}`);
+     * ```
+     *
+     * @param params - Optional query parameters
+     * @param context - Optional SSR request context
+     * @returns Customer account details
+     */
+    getCustomerAccount(params?: GetCustomerAccountParams, context?: RequestContext): Promise<GetCustomerAccountResponse>;
+    /**
+     * Get customer accounts with pagination (v2).
+     *
+     * For users with access to multiple accounts.
+     *
+     * **Endpoint**: `GET /v2/shop/customer-accounts [ACC-101]`
+     *
+     * | Parameter  | Type             | Required | Description              |
+     * |------------|------------------|----------|--------------------------|
+     * | `pageable` | `PageableParams` | No       | Pagination settings      |
+     *
+     * @example
+     * ```typescript
+     * const { content: accounts } = await client.customerAccount.getCustomerAccountV2({
+     *   pageable: { page: 0, size: 10 },
+     * });
+     *
+     * accounts.forEach(acc => console.log(acc.name));
+     * ```
+     *
+     * @param params - Pagination parameters
+     * @param context - Optional SSR request context
+     * @returns Paginated list of accounts
+     */
+    getCustomerAccountV2(params?: GetCustomerAccountV2Params, context?: RequestContext): Promise<GetCustomerAccountV2Response>;
+    /**
+     * Create a new customer account.
+     *
+     * **Endpoint**: `POST /v1/shop/customer-accounts [ACC-102]`
+     *
+     * @example
+     * ```typescript
+     * const account = await client.customerAccount.createCustomerAccount({
+     *   name: 'Acme Corporation',
+     *   externalId: 'ACME-001',
+     *   email: 'contact@acme.com',
+     * });
+     * ```
+     *
+     * @param params - Account creation data
+     * @param context - Optional SSR request context
+     * @returns Created account details
+     */
+    createCustomerAccount(params: CreateCustomerAccountParams, context?: RequestContext): Promise<CreateCustomerAccountResponse>;
+    /**
+     * Update customer account information.
+     *
+     * **Endpoint**: `PUT /v1/shop/customer-accounts [ACC-103]`
+     *
+     * @example
+     * ```typescript
+     * await client.customerAccount.updateCustomerAccount({
+     *   name: 'Acme Corporation Updated',
+     *   phone: '+1-555-123-4567',
+     * });
+     * ```
+     *
+     * @param params - Account update data
+     * @param context - Optional SSR request context
+     * @returns Updated account details
+     */
+    updateCustomerAccount(params: UpdateCustomerAccountParams, context?: RequestContext): Promise<UpdateCustomerAccountResponse>;
+    /**
+     * Get addresses for the customer account.
+     *
+     * Returns the address book for shipping and billing.
+     *
+     * **Endpoint**: `GET /v1/shop/customer-accounts/addresses [ADDR-100]`
+     *
+     * @example
+     * ```typescript
+     * const addresses = await client.customerAccount.getCustomerAccountAddresses();
+     *
+     * const shippingAddresses = addresses.filter(a => a.isShipping);
+     * const billingAddresses = addresses.filter(a => a.isBilling);
+     * ```
+     *
+     * @param params - Optional query parameters
+     * @param context - Optional SSR request context
+     * @returns List of addresses
+     */
+    getCustomerAccountAddresses(params?: GetCustomerAccountAddressesParams, context?: RequestContext): Promise<GetCustomerAccountAddressesResponse>;
+    /**
+     * Create a new address for the account.
+     *
+     * **Endpoint**: `POST /v1/shop/customer-accounts/addresses [ADDR-101]`
+     *
+     * @example
+     * ```typescript
+     * const address = await client.customerAccount.createCustomerAccountAddress({
+     *   label: 'Main Office',
+     *   street: '123 Business Ave',
+     *   city: 'New York',
+     *   country: 'US',
+     *   postalCode: '10001',
+     *   isShipping: true,
+     *   isBilling: true,
+     *   isDefault: true,
+     * });
+     * ```
+     *
+     * @param params - Address creation data
+     * @param context - Optional SSR request context
+     * @returns Created address
+     */
+    createCustomerAccountAddress(params: CreateCustomerAccountAddressParams, context?: RequestContext): Promise<CreateCustomerAccountAddressResponse>;
+    /**
+     * Delete an address from the account.
+     *
+     * **Endpoint**: `DELETE /v1/shop/customer-accounts/addresses/{addressId} [ADDR-102]`
+     *
+     * | Parameter   | Type     | Required | Description              |
+     * |-------------|----------|----------|--------------------------|
+     * | `addressId` | `string` | Yes      | Address ID to delete     |
+     *
+     * @param params - Address identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If addressId is missing
+     * @throws {NotFoundError} If address doesn't exist
+     */
+    deleteCustomerAccountAddress(params: DeleteCustomerAccountAddressParams, context?: RequestContext): Promise<void>;
+    /**
+     * Update an existing address.
+     *
+     * **Endpoint**: `PUT /v1/shop/customer-accounts/addresses/{addressId} [ADDR-103]`
+     *
+     * | Parameter   | Type     | Required | Description              |
+     * |-------------|----------|----------|--------------------------|
+     * | `addressId` | `string` | Yes      | Address ID to update     |
+     * | ...fields   | various  | No       | Fields to update         |
+     *
+     * @example
+     * ```typescript
+     * await client.customerAccount.updateCustomerAccountAddress({
+     *   addressId: 'addr-123',
+     *   street: '456 New Street',
+     *   isDefault: true,
+     * });
+     * ```
+     *
+     * @param params - Address update data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If addressId is missing
+     * @returns Updated address
+     */
+    updateCustomerAccountAddress(params: UpdateCustomerAccountAddressParams, context?: RequestContext): Promise<UpdateCustomerAccountAddressResponse>;
+    /**
+     * Get custom fields for the account.
+     *
+     * **Endpoint**: `GET /v1/shop/customer-accounts/custom-fields [ACC-104]`
+     *
+     * @param params - Query parameters
+     * @param context - Optional SSR request context
+     * @returns Custom field values
+     */
+    getCustomerAccountCustomFields(params?: GetCustomerAccountCustomFieldsParams, context?: RequestContext): Promise<GetCustomerAccountCustomFieldsResponse>;
+    /**
+     * Get order history for the account.
+     *
+     * **Endpoint**: `GET /v1/shop/customer-accounts/orders [ACC-105]`
+     *
+     * @example
+     * ```typescript
+     * const { content: orders } = await client.customerAccount.getCustomerAccountOrders({
+     *   pageable: { page: 0, size: 20 },
+     *   locale: 'en-US',
+     * });
+     *
+     * orders.forEach(order => {
+     *   console.log(`${order.businessId}: ${order.status}`);
+     * });
+     * ```
+     *
+     * @param params - Query parameters
+     * @param context - Optional SSR request context
+     * @returns Paginated order history
+     */
+    getCustomerAccountOrders(params: GetCustomerAccountOrdersParams, context?: RequestContext): Promise<GetCustomerAccountOrdersResponse>;
+    /**
+     * Get users associated with the account.
+     *
+     * **Endpoint**: `GET /v1/shop/customer-accounts/users [ACC-106]`
+     *
+     * | Parameter       | Type             | Required | Description              |
+     * |-----------------|------------------|----------|--------------------------|
+     * | `pageable`      | `PageableParams` | Yes      | Pagination settings      |
+     * | `forAllAccounts`| `boolean`        | No       | Include all accounts     |
+     * | `query`         | `string`         | No       | Search query             |
+     *
+     * @example
+     * ```typescript
+     * const { content: users } = await client.customerAccount.getCustomerAccountUsers({
+     *   pageable: { page: 0, size: 50 },
+     *   query: 'john',
+     * });
+     * ```
+     *
+     * @param params - Query parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If pageable is missing
+     * @returns Paginated user list
+     */
+    getCustomerAccountUsers(params: GetCustomerAccountUsersParams, context?: RequestContext): Promise<GetCustomerAccountUsersResponse>;
+    /**
+     * Create an organisation (cost center/department).
+     *
+     * **Endpoint**: `POST /v1/shop/customer-accounts/organisations [ORG-100]`
+     *
+     * | Parameter    | Type     | Required | Description              |
+     * |--------------|----------|----------|--------------------------|
+     * | `externalId` | `string` | Yes      | External identifier      |
+     * | `name`       | `string` | Yes      | Organisation name        |
+     *
+     * @example
+     * ```typescript
+     * const org = await client.customerAccount.createCustomerAccountOrganisation({
+     *   externalId: 'DEPT-SALES',
+     *   name: 'Sales Department',
+     * });
+     * ```
+     *
+     * @param params - Organisation creation data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Created organisation
+     */
+    createCustomerAccountOrganisation(params: CreateOrganisationParams, context?: RequestContext): Promise<CreateOrganisationResponse>;
+    /**
+     * Update an organisation.
+     *
+     * **Endpoint**: `PUT /v1/shop/customer-accounts/organisations/{organisationId} [ORG-101]`
+     *
+     * @param params - Organisation update data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If organisationId is missing
+     * @returns Updated organisation
+     */
+    updateCustomerAccountOrganisation(params: UpdateOrganisationParams, context?: RequestContext): Promise<UpdateOrganisationResponse>;
+    /**
+     * Get all organisations for the account.
+     *
+     * @deprecated Use getCustomerAccountV2 with organisation filter
+     *
+     * **Endpoint**: `GET /v1/shop/customer-accounts/organisations [ORG-102]`
+     *
+     * @param params - Pagination parameters
+     * @param context - Optional SSR request context
+     * @returns List of organisations
+     */
+    getCustomerAccountOrganisations(params?: GetOrganisationsParams, context?: RequestContext): Promise<GetOrganisationsResponse>;
+    /**
+     * Get addresses for a specific organisation.
+     *
+     * **Endpoint**: `GET /v1/shop/customer-accounts/organisations/{organisationId}/addresses [ORG-103]`
+     *
+     * @param params - Organisation identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If organisationId is missing
+     * @returns Organisation addresses
+     */
+    getCustomerAccountOrganisationAddresses(params: GetOrganisationAddressesParams, context?: RequestContext): Promise<GetOrganisationAddressesResponse>;
+    /**
+     * Delete an organisation address.
+     *
+     * **Endpoint**: `DELETE /v1/shop/customer-accounts/organisations/{organisationId}/addresses/{addressId} [ORG-104]`
+     *
+     * @param params - Organisation and address identification
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     */
+    deleteCustomerAccountOrganisationAddress(params: DeleteOrganisationAddressParams, context?: RequestContext): Promise<void>;
+    /**
+     * Update an organisation address.
+     *
+     * **Endpoint**: `PUT /v1/shop/customer-accounts/organisations/{organisationId}/addresses/{addressId} [ORG-105]`
+     *
+     * @param params - Address update data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Updated address
+     */
+    updateCustomerAccountOrganisationAddress(params: UpdateOrganisationAddressParams, context?: RequestContext): Promise<UpdateOrganisationAddressResponse>;
+    /**
+     * Get orders for a specific organisation.
+     *
+     * **Endpoint**: `GET /v1/shop/customer-accounts/organisations/{organisationId}/orders [ORG-106]`
+     *
+     * @param params - Query parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Paginated order history
+     */
+    getCustomerAccountOrganisationOrders(params: GetOrganisationOrdersParams, context?: RequestContext): Promise<GetOrganisationOrdersResponse>;
+    /**
+     * Get users for a specific organisation.
+     *
+     * **Endpoint**: `GET /v1/shop/customer-accounts/organisations/{organisationId}/users [ORG-107]`
+     *
+     * @param params - Query parameters
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Paginated user list
+     */
+    getCustomerAccountOrganisationUsers(params: GetOrganisationUsersParams, context?: RequestContext): Promise<GetOrganisationUsersResponse>;
+    /**
+     * Update user permissions within an organisation.
+     *
+     * **Endpoint**: `PUT /v1/shop/customer-accounts/organisations/{organisationId}/users/{userId} [ORG-108]`
+     *
+     * @param params - User update data
+     * @param context - Optional SSR request context
+     * @throws {ValidationError} If required parameters are missing
+     * @returns Updated user
+     */
+    updateCustomerAccountOrganisationUser(params: UpdateOrganisationUserParams, context?: RequestContext): Promise<UpdateOrganisationUserResponse>;
+}
+//# sourceMappingURL=customer-account.service.d.ts.map

package/lib/services/customer-account/customer-account.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customer-account.service.d.ts","sourceRoot":"","sources":["../../../src/services/customer-account/customer-account.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,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,EAC3B,2BAA2B,EAC3B,iCAAiC,EACjC,kCAAkC,EAClC,kCAAkC,EAClC,kCAAkC,EAClC,oCAAoC,EACpC,8BAA8B,EAC9B,6BAA6B,EAC7B,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,8BAA8B,EAC9B,+BAA+B,EAC/B,+BAA+B,EAC/B,2BAA2B,EAC3B,0BAA0B,EAC1B,4BAA4B,EAC5B,0BAA0B,EAC1B,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,mCAAmC,EACnC,oCAAoC,EACpC,oCAAoC,EACpC,sCAAsC,EACtC,gCAAgC,EAChC,+BAA+B,EAC/B,0BAA0B,EAC1B,0BAA0B,EAC1B,wBAAwB,EACxB,gCAAgC,EAChC,iCAAiC,EACjC,6BAA6B,EAC7B,4BAA4B,EAC5B,8BAA8B,EAC/B,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD,QAAQ,CAAC,WAAW,sBAAsB;IAE1C;;;;;;;;;;;;;;;;;OAiBG;IACG,kBAAkB,CACtB,MAAM,GAAE,wBAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,0BAA0B,CAAC;IAWtC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,oBAAoB,CACxB,MAAM,GAAE,0BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,4BAA4B,CAAC;IAexC;;;;;;;;;;;;;;;;;OAiBG;IACG,qBAAqB,CACzB,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,6BAA6B,CAAC;IAWzC;;;;;;;;;;;;;;;;OAgBG;IACG,qBAAqB,CACzB,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,6BAA6B,CAAC;IAWzC;;;;;;;;;;;;;;;;;;OAkBG;IACG,2BAA2B,CAC/B,MAAM,GAAE,iCAAsC,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mCAAmC,CAAC;IAW/C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,4BAA4B,CAChC,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oCAAoC,CAAC;IAWhD;;;;;;;;;;;;;OAaG;IACG,4BAA4B,CAChC,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,4BAA4B,CAChC,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oCAAoC,CAAC;IAchD;;;;;;;;OAQG;IACG,8BAA8B,CAClC,MAAM,GAAE,oCAAyC,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,sCAAsC,CAAC;IAiBlD;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,wBAAwB,CAC5B,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gCAAgC,CAAC;IAmB5C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,uBAAuB,CAC3B,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,+BAA+B,CAAC;IAmB3C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,iCAAiC,CACrC,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,0BAA0B,CAAC;IAatC;;;;;;;;;OASG;IACG,iCAAiC,CACrC,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,0BAA0B,CAAC;IAgBtC;;;;;;;;;;OAUG;IACG,+BAA+B,CACnC,MAAM,GAAE,sBAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,wBAAwB,CAAC;IAepC;;;;;;;;;OASG;IACG,uCAAuC,CAC3C,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gCAAgC,CAAC;IAc5C;;;;;;;;OAQG;IACG,wCAAwC,CAC5C,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;;OASG;IACG,wCAAwC,CAC5C,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,iCAAiC,CAAC;IAiB7C;;;;;;;;;OASG;IACG,oCAAoC,CACxC,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,6BAA6B,CAAC;IAqBzC;;;;;;;;;OASG;IACG,mCAAmC,CACvC,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,4BAA4B,CAAC;IAmBxC;;;;;;;;;OASG;IACG,qCAAqC,CACzC,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,8BAA8B,CAAC;CAgB3C"}