@djust-b2b/djust-front-sdk 3.0.0-beta.4 → 3.0.0-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -7
- package/dist/.tsbuildinfo +1 -0
- package/dist/.tsbuildinfo-esm +1 -0
- package/dist/client/create-client.d.ts +233 -0
- package/dist/client/create-client.d.ts.map +1 -0
- package/dist/client/index.d.ts +14 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/performance.d.ts +203 -0
- package/dist/client/performance.d.ts.map +1 -0
- package/dist/client/transport.d.ts +367 -0
- package/dist/client/transport.d.ts.map +1 -0
- package/dist/errors/base.d.ts +101 -0
- package/dist/errors/base.d.ts.map +1 -0
- package/dist/errors/classes/auth.error.d.ts +64 -0
- package/dist/errors/classes/auth.error.d.ts.map +1 -0
- package/dist/errors/classes/forbidden.error.d.ts +52 -0
- package/dist/errors/classes/forbidden.error.d.ts.map +1 -0
- package/dist/errors/classes/index.d.ts +17 -0
- package/dist/errors/classes/index.d.ts.map +1 -0
- package/dist/errors/classes/network.error.d.ts +63 -0
- package/dist/errors/classes/network.error.d.ts.map +1 -0
- package/dist/errors/classes/not-found.error.d.ts +58 -0
- package/dist/errors/classes/not-found.error.d.ts.map +1 -0
- package/dist/errors/classes/rate-limit.error.d.ts +49 -0
- package/dist/errors/classes/rate-limit.error.d.ts.map +1 -0
- package/dist/errors/classes/server.error.d.ts +63 -0
- package/dist/errors/classes/server.error.d.ts.map +1 -0
- package/dist/errors/classes/timeout.error.d.ts +64 -0
- package/dist/errors/classes/timeout.error.d.ts.map +1 -0
- package/dist/errors/classes/unexpected.error.d.ts +70 -0
- package/dist/errors/classes/unexpected.error.d.ts.map +1 -0
- package/dist/errors/classes/validation.error.d.ts +68 -0
- package/dist/errors/classes/validation.error.d.ts.map +1 -0
- package/dist/errors/codes.d.ts +111 -0
- package/dist/errors/codes.d.ts.map +1 -0
- package/dist/errors/compat.d.ts +99 -0
- package/dist/errors/compat.d.ts.map +1 -0
- package/dist/errors/factory.d.ts +33 -0
- package/dist/errors/factory.d.ts.map +1 -0
- package/dist/errors/guards.d.ts +142 -0
- package/dist/errors/guards.d.ts.map +1 -0
- package/dist/errors/index.d.ts +25 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/types.d.ts +100 -0
- package/dist/errors/types.d.ts.map +1 -0
- package/dist/helpers/index.d.ts +42 -0
- package/dist/helpers/index.d.ts.map +1 -0
- package/dist/helpers/parameters-validation.d.ts +3 -0
- package/dist/helpers/parameters-validation.d.ts.map +1 -0
- package/dist/helpers/utils.d.ts +5 -0
- package/dist/helpers/utils.d.ts.map +1 -0
- package/dist/index.cjs +182 -0
- package/dist/index.d.ts +265 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.mjs +11515 -0
- package/dist/interfaces/index.d.ts +31 -0
- package/dist/interfaces/index.d.ts.map +1 -0
- package/dist/interfaces/models/address.d.ts +61 -0
- package/dist/interfaces/models/address.d.ts.map +1 -0
- package/dist/interfaces/models/attribute.d.ts +31 -0
- package/dist/interfaces/models/attribute.d.ts.map +1 -0
- package/dist/interfaces/models/auth.d.ts +37 -0
- package/dist/interfaces/models/auth.d.ts.map +1 -0
- package/dist/interfaces/models/cart.d.ts +64 -0
- package/dist/interfaces/models/cart.d.ts.map +1 -0
- package/dist/interfaces/models/common.d.ts +68 -0
- package/dist/interfaces/models/common.d.ts.map +1 -0
- package/dist/interfaces/models/custom-field.d.ts +57 -0
- package/dist/interfaces/models/custom-field.d.ts.map +1 -0
- package/dist/interfaces/models/customer-account.d.ts +52 -0
- package/dist/interfaces/models/customer-account.d.ts.map +1 -0
- package/dist/interfaces/models/customer-organisation.d.ts +14 -0
- package/dist/interfaces/models/customer-organisation.d.ts.map +1 -0
- package/dist/interfaces/models/customer-user.d.ts +114 -0
- package/dist/interfaces/models/customer-user.d.ts.map +1 -0
- package/dist/interfaces/models/incident.d.ts +37 -0
- package/dist/interfaces/models/incident.d.ts.map +1 -0
- package/dist/interfaces/models/navigation-category.d.ts +22 -0
- package/dist/interfaces/models/navigation-category.d.ts.map +1 -0
- package/dist/interfaces/models/offer.d.ts +151 -0
- package/dist/interfaces/models/offer.d.ts.map +1 -0
- package/dist/interfaces/models/order.d.ts +701 -0
- package/dist/interfaces/models/order.d.ts.map +1 -0
- package/dist/interfaces/models/payment.d.ts +20 -0
- package/dist/interfaces/models/payment.d.ts.map +1 -0
- package/dist/interfaces/models/price.d.ts +6 -0
- package/dist/interfaces/models/price.d.ts.map +1 -0
- package/dist/interfaces/models/product.d.ts +243 -0
- package/dist/interfaces/models/product.d.ts.map +1 -0
- package/dist/interfaces/models/quote.d.ts +77 -0
- package/dist/interfaces/models/quote.d.ts.map +1 -0
- package/dist/interfaces/models/searchProduct.d.ts +128 -0
- package/dist/interfaces/models/searchProduct.d.ts.map +1 -0
- package/dist/interfaces/models/supplier.d.ts +72 -0
- package/dist/interfaces/models/supplier.d.ts.map +1 -0
- package/dist/services/attributes/attributes.service.d.ts +18 -0
- package/dist/services/attributes/attributes.service.d.ts.map +1 -0
- package/dist/services/attributes/definitions.d.ts +28 -0
- package/dist/services/attributes/definitions.d.ts.map +1 -0
- package/dist/services/attributes/endpoints.d.ts +12 -0
- package/dist/services/attributes/endpoints.d.ts.map +1 -0
- package/dist/services/attributes/index.d.ts +33 -0
- package/dist/services/attributes/index.d.ts.map +1 -0
- package/dist/services/attributes/module.d.ts +11 -0
- package/dist/services/attributes/module.d.ts.map +1 -0
- package/dist/services/attributes/types.d.ts +35 -0
- package/dist/services/attributes/types.d.ts.map +1 -0
- package/dist/services/auth/__mocks__/auth.mocks.d.ts +249 -0
- package/dist/services/auth/__mocks__/auth.mocks.d.ts.map +1 -0
- package/dist/services/auth/auth.service.d.ts +286 -0
- package/dist/services/auth/auth.service.d.ts.map +1 -0
- package/dist/services/auth/definitions.d.ts +69 -0
- package/dist/services/auth/definitions.d.ts.map +1 -0
- package/dist/services/auth/definitions.requests.d.ts +25 -0
- package/dist/services/auth/definitions.requests.d.ts.map +1 -0
- package/dist/services/auth/endpoints.d.ts +30 -0
- package/dist/services/auth/endpoints.d.ts.map +1 -0
- package/dist/services/auth/index.d.ts +232 -0
- package/dist/services/auth/index.d.ts.map +1 -0
- package/dist/services/auth/module.d.ts +11 -0
- package/dist/services/auth/module.d.ts.map +1 -0
- package/dist/services/auth/types.d.ts +124 -0
- package/dist/services/auth/types.d.ts.map +1 -0
- package/dist/services/base.service.d.ts +81 -0
- package/dist/services/base.service.d.ts.map +1 -0
- package/dist/services/cart/cart.service.d.ts +443 -0
- package/dist/services/cart/cart.service.d.ts.map +1 -0
- package/dist/services/cart/definitions.d.ts +84 -0
- package/dist/services/cart/definitions.d.ts.map +1 -0
- package/dist/services/cart/endpoints.d.ts +24 -0
- package/dist/services/cart/endpoints.d.ts.map +1 -0
- package/dist/services/cart/index.d.ts +330 -0
- package/dist/services/cart/index.d.ts.map +1 -0
- package/dist/services/cart/module.d.ts +11 -0
- package/dist/services/cart/module.d.ts.map +1 -0
- package/dist/services/cart/types.d.ts +236 -0
- package/dist/services/cart/types.d.ts.map +1 -0
- package/dist/services/commercial-order/commercial-order.service.d.ts +432 -0
- package/dist/services/commercial-order/commercial-order.service.d.ts.map +1 -0
- package/dist/services/commercial-order/definitions.d.ts +169 -0
- package/dist/services/commercial-order/definitions.d.ts.map +1 -0
- package/dist/services/commercial-order/endpoints.d.ts +28 -0
- package/dist/services/commercial-order/endpoints.d.ts.map +1 -0
- package/dist/services/commercial-order/index.d.ts +710 -0
- package/dist/services/commercial-order/index.d.ts.map +1 -0
- package/dist/services/commercial-order/module.d.ts +11 -0
- package/dist/services/commercial-order/module.d.ts.map +1 -0
- package/dist/services/commercial-order/types.d.ts +243 -0
- package/dist/services/commercial-order/types.d.ts.map +1 -0
- package/dist/services/custom-field/custom-field.service.d.ts +23 -0
- package/dist/services/custom-field/custom-field.service.d.ts.map +1 -0
- package/dist/services/custom-field/definitions.d.ts +107 -0
- package/dist/services/custom-field/definitions.d.ts.map +1 -0
- package/dist/services/custom-field/endpoints.d.ts +13 -0
- package/dist/services/custom-field/endpoints.d.ts.map +1 -0
- package/dist/services/custom-field/index.d.ts +115 -0
- package/dist/services/custom-field/index.d.ts.map +1 -0
- package/dist/services/custom-field/module.d.ts +11 -0
- package/dist/services/custom-field/module.d.ts.map +1 -0
- package/dist/services/custom-field/types.d.ts +51 -0
- package/dist/services/custom-field/types.d.ts.map +1 -0
- package/dist/services/customer-account/customer-account.service.d.ts +387 -0
- package/dist/services/customer-account/customer-account.service.d.ts.map +1 -0
- package/dist/services/customer-account/definitions.d.ts +164 -0
- package/dist/services/customer-account/definitions.d.ts.map +1 -0
- package/dist/services/customer-account/endpoints.d.ts +25 -0
- package/dist/services/customer-account/endpoints.d.ts.map +1 -0
- package/dist/services/customer-account/index.d.ts +656 -0
- package/dist/services/customer-account/index.d.ts.map +1 -0
- package/dist/services/customer-account/module.d.ts +11 -0
- package/dist/services/customer-account/module.d.ts.map +1 -0
- package/dist/services/customer-account/types.d.ts +253 -0
- package/dist/services/customer-account/types.d.ts.map +1 -0
- package/dist/services/customer-user/customer-user.service.d.ts +280 -0
- package/dist/services/customer-user/customer-user.service.d.ts.map +1 -0
- package/dist/services/customer-user/definitions.d.ts +84 -0
- package/dist/services/customer-user/definitions.d.ts.map +1 -0
- package/dist/services/customer-user/endpoints.d.ts +19 -0
- package/dist/services/customer-user/endpoints.d.ts.map +1 -0
- package/dist/services/customer-user/index.d.ts +394 -0
- package/dist/services/customer-user/index.d.ts.map +1 -0
- package/dist/services/customer-user/module.d.ts +11 -0
- package/dist/services/customer-user/module.d.ts.map +1 -0
- package/dist/services/customer-user/types.d.ts +118 -0
- package/dist/services/customer-user/types.d.ts.map +1 -0
- package/dist/services/factory.d.ts +104 -0
- package/dist/services/factory.d.ts.map +1 -0
- package/dist/services/incident/definitions.d.ts +85 -0
- package/dist/services/incident/definitions.d.ts.map +1 -0
- package/dist/services/incident/endpoints.d.ts +17 -0
- package/dist/services/incident/endpoints.d.ts.map +1 -0
- package/dist/services/incident/incident.service.d.ts +24 -0
- package/dist/services/incident/incident.service.d.ts.map +1 -0
- package/dist/services/incident/index.d.ts +270 -0
- package/dist/services/incident/index.d.ts.map +1 -0
- package/dist/services/incident/module.d.ts +11 -0
- package/dist/services/incident/module.d.ts.map +1 -0
- package/dist/services/incident/types.d.ts +116 -0
- package/dist/services/incident/types.d.ts.map +1 -0
- package/dist/services/logistic-order/definitions.d.ts +293 -0
- package/dist/services/logistic-order/definitions.d.ts.map +1 -0
- package/dist/services/logistic-order/endpoints.d.ts +43 -0
- package/dist/services/logistic-order/endpoints.d.ts.map +1 -0
- package/dist/services/logistic-order/index.d.ts +1300 -0
- package/dist/services/logistic-order/index.d.ts.map +1 -0
- package/dist/services/logistic-order/logistic-order.service.d.ts +57 -0
- package/dist/services/logistic-order/logistic-order.service.d.ts.map +1 -0
- package/dist/services/logistic-order/module.d.ts +11 -0
- package/dist/services/logistic-order/module.d.ts.map +1 -0
- package/dist/services/logistic-order/types.d.ts +402 -0
- package/dist/services/logistic-order/types.d.ts.map +1 -0
- package/dist/services/module.d.ts +64 -0
- package/dist/services/module.d.ts.map +1 -0
- package/dist/services/navigation-category/definitions.d.ts +31 -0
- package/dist/services/navigation-category/definitions.d.ts.map +1 -0
- package/dist/services/navigation-category/endpoints.d.ts +15 -0
- package/dist/services/navigation-category/endpoints.d.ts.map +1 -0
- package/dist/services/navigation-category/index.d.ts +114 -0
- package/dist/services/navigation-category/index.d.ts.map +1 -0
- package/dist/services/navigation-category/module.d.ts +11 -0
- package/dist/services/navigation-category/module.d.ts.map +1 -0
- package/dist/services/navigation-category/navigation-category.service.d.ts +148 -0
- package/dist/services/navigation-category/navigation-category.service.d.ts.map +1 -0
- package/dist/services/navigation-category/types.d.ts +51 -0
- package/dist/services/navigation-category/types.d.ts.map +1 -0
- package/dist/services/offer-inventories/definitions.d.ts +73 -0
- package/dist/services/offer-inventories/definitions.d.ts.map +1 -0
- package/dist/services/offer-inventories/endpoints.d.ts +16 -0
- package/dist/services/offer-inventories/endpoints.d.ts.map +1 -0
- package/dist/services/offer-inventories/index.d.ts +120 -0
- package/dist/services/offer-inventories/index.d.ts.map +1 -0
- package/dist/services/offer-inventories/module.d.ts +11 -0
- package/dist/services/offer-inventories/module.d.ts.map +1 -0
- package/dist/services/offer-inventories/offer-inventories.service.d.ts +26 -0
- package/dist/services/offer-inventories/offer-inventories.service.d.ts.map +1 -0
- package/dist/services/offer-inventories/types.d.ts +85 -0
- package/dist/services/offer-inventories/types.d.ts.map +1 -0
- package/dist/services/offer-prices/__mocks__/offer-prices.mocks.d.ts +109 -0
- package/dist/services/offer-prices/__mocks__/offer-prices.mocks.d.ts.map +1 -0
- package/dist/services/offer-prices/definitions.d.ts +24 -0
- package/dist/services/offer-prices/definitions.d.ts.map +1 -0
- package/dist/services/offer-prices/endpoints.d.ts +12 -0
- package/dist/services/offer-prices/endpoints.d.ts.map +1 -0
- package/dist/services/offer-prices/index.d.ts +36 -0
- package/dist/services/offer-prices/index.d.ts.map +1 -0
- package/dist/services/offer-prices/module.d.ts +11 -0
- package/dist/services/offer-prices/module.d.ts.map +1 -0
- package/dist/services/offer-prices/offer-prices.service.d.ts +18 -0
- package/dist/services/offer-prices/offer-prices.service.d.ts.map +1 -0
- package/dist/services/offer-prices/types.d.ts +33 -0
- package/dist/services/offer-prices/types.d.ts.map +1 -0
- package/dist/services/operation/definitions.d.ts +280 -0
- package/dist/services/operation/definitions.d.ts.map +1 -0
- package/dist/services/operation/endpoints.d.ts +18 -0
- package/dist/services/operation/endpoints.d.ts.map +1 -0
- package/dist/services/operation/index.d.ts +520 -0
- package/dist/services/operation/index.d.ts.map +1 -0
- package/dist/services/operation/module.d.ts +11 -0
- package/dist/services/operation/module.d.ts.map +1 -0
- package/dist/services/operation/operation.service.d.ts +32 -0
- package/dist/services/operation/operation.service.d.ts.map +1 -0
- package/dist/services/operation/types.d.ts +174 -0
- package/dist/services/operation/types.d.ts.map +1 -0
- package/dist/services/payment/definitions.d.ts +79 -0
- package/dist/services/payment/definitions.d.ts.map +1 -0
- package/dist/services/payment/endpoints.d.ts +16 -0
- package/dist/services/payment/endpoints.d.ts.map +1 -0
- package/dist/services/payment/index.d.ts +150 -0
- package/dist/services/payment/index.d.ts.map +1 -0
- package/dist/services/payment/module.d.ts +11 -0
- package/dist/services/payment/module.d.ts.map +1 -0
- package/dist/services/payment/payment.service.d.ts +224 -0
- package/dist/services/payment/payment.service.d.ts.map +1 -0
- package/dist/services/payment/types.d.ts +93 -0
- package/dist/services/payment/types.d.ts.map +1 -0
- package/dist/services/product/definitions.d.ts +149 -0
- package/dist/services/product/definitions.d.ts.map +1 -0
- package/dist/services/product/endpoints.d.ts +40 -0
- package/dist/services/product/endpoints.d.ts.map +1 -0
- package/dist/services/product/index.d.ts +387 -0
- package/dist/services/product/index.d.ts.map +1 -0
- package/dist/services/product/module.d.ts +11 -0
- package/dist/services/product/module.d.ts.map +1 -0
- package/dist/services/product/product.service.d.ts +452 -0
- package/dist/services/product/product.service.d.ts.map +1 -0
- package/dist/services/product/types.d.ts +344 -0
- package/dist/services/product/types.d.ts.map +1 -0
- package/dist/services/product-variant/definitions.d.ts +172 -0
- package/dist/services/product-variant/definitions.d.ts.map +1 -0
- package/dist/services/product-variant/endpoints.d.ts +15 -0
- package/dist/services/product-variant/endpoints.d.ts.map +1 -0
- package/dist/services/product-variant/index.d.ts +123 -0
- package/dist/services/product-variant/index.d.ts.map +1 -0
- package/dist/services/product-variant/module.d.ts +11 -0
- package/dist/services/product-variant/module.d.ts.map +1 -0
- package/dist/services/product-variant/product-variant.service.d.ts +21 -0
- package/dist/services/product-variant/product-variant.service.d.ts.map +1 -0
- package/dist/services/product-variant/types.d.ts +73 -0
- package/dist/services/product-variant/types.d.ts.map +1 -0
- package/dist/services/quote/definitions.d.ts +100 -0
- package/dist/services/quote/definitions.d.ts.map +1 -0
- package/dist/services/quote/endpoints.d.ts +20 -0
- package/dist/services/quote/endpoints.d.ts.map +1 -0
- package/dist/services/quote/index.d.ts +377 -0
- package/dist/services/quote/index.d.ts.map +1 -0
- package/dist/services/quote/module.d.ts +11 -0
- package/dist/services/quote/module.d.ts.map +1 -0
- package/dist/services/quote/quote.service.d.ts +345 -0
- package/dist/services/quote/quote.service.d.ts.map +1 -0
- package/dist/services/quote/types.d.ts +158 -0
- package/dist/services/quote/types.d.ts.map +1 -0
- package/dist/services/supplier/__mocks__/supplier-mocks.d.ts +49 -0
- package/dist/services/supplier/__mocks__/supplier-mocks.d.ts.map +1 -0
- package/dist/services/supplier/definitions.d.ts +30 -0
- package/dist/services/supplier/definitions.d.ts.map +1 -0
- package/dist/services/supplier/endpoints.d.ts +14 -0
- package/dist/services/supplier/endpoints.d.ts.map +1 -0
- package/dist/services/supplier/index.d.ts +102 -0
- package/dist/services/supplier/index.d.ts.map +1 -0
- package/dist/services/supplier/module.d.ts +11 -0
- package/dist/services/supplier/module.d.ts.map +1 -0
- package/dist/services/supplier/supplier.service.d.ts +20 -0
- package/dist/services/supplier/supplier.service.d.ts.map +1 -0
- package/dist/services/supplier/types.d.ts +58 -0
- package/dist/services/supplier/types.d.ts.map +1 -0
- package/dist/services/types.d.ts +81 -0
- package/dist/services/types.d.ts.map +1 -0
- package/dist/settings/fetch-instance.d.ts +30 -0
- package/dist/settings/fetch-instance.d.ts.map +1 -0
- package/package.json +8 -6
- package/dist/djust-b2b-djust-front-sdk-3.0.0-beta.4.tgz +0 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../../src/services/customer-user/endpoints.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;CASxB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAC9B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC"}
|
|
@@ -0,0 +1,394 @@
|
|
|
1
|
+
import { ActivateCustomerUserParameters, AddCustomerUserToAccountsParameters, CreateCustomerUserParameters, CreateCustomerUserResponse, GetAuthenticatedUserResponse, GetCustomerUserAddressesParameters, GetCustomerUserOrganisationsResponse, RemoveAccountsFromCustomerUserParameters, SendCustomerUserActivationRequestParameters, UpdateCustomerUserParameters, UpdateCustomerUserResponse, UpdateSpecificCustomerUserParameters } from "./definitions";
|
|
2
|
+
/**
|
|
3
|
+
* 🚚 **Retrieve Authenticated User**
|
|
4
|
+
*
|
|
5
|
+
* **APICODE(USER-500)**
|
|
6
|
+
* Retrieves the authenticated user.
|
|
7
|
+
*
|
|
8
|
+
* This function sends a request to obtain the details of the currently authenticated user.
|
|
9
|
+
*
|
|
10
|
+
* 🛠 **Endpoint**: `GET /v1/authenticated-user`
|
|
11
|
+
*
|
|
12
|
+
* | Parameter | Type | Required | Description |
|
|
13
|
+
* |-----------|--------|----------|---------------------------|
|
|
14
|
+
* | N/A | N/A | N/A | This function does not require any parameters. |
|
|
15
|
+
*
|
|
16
|
+
* 📤 **Returns**:
|
|
17
|
+
* A `Promise` resolving to an object containing the authenticated user's data.
|
|
18
|
+
*
|
|
19
|
+
* 🛠 **Example usage**:
|
|
20
|
+
* ```ts
|
|
21
|
+
* const user = await getAuthenticatedUser();
|
|
22
|
+
* ```
|
|
23
|
+
* #### Output
|
|
24
|
+
* ```json
|
|
25
|
+
* {
|
|
26
|
+
* "id": "user1",
|
|
27
|
+
* "name": "John Doe"
|
|
28
|
+
* }
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
export declare function getAuthenticatedUser(): Promise<GetAuthenticatedUserResponse>;
|
|
32
|
+
/**
|
|
33
|
+
* 🚚 **Create Customer User**
|
|
34
|
+
*
|
|
35
|
+
* **APICODE(USER-100)**
|
|
36
|
+
* Creates a customer user.
|
|
37
|
+
*
|
|
38
|
+
* This function sends a request to create a new customer user with the specified parameters.
|
|
39
|
+
*
|
|
40
|
+
* 🛠 **Endpoint**: `POST /v1/shop/customer-users`
|
|
41
|
+
*
|
|
42
|
+
* | Parameter | Type | Required | Description |
|
|
43
|
+
* |--------------------|--------|----------|--------------------------------------------------|
|
|
44
|
+
* | `email` | string | ✅ | The email address of the user. |
|
|
45
|
+
* | `password` | string | ✅ | The password of the user. |
|
|
46
|
+
* | `firstName` | string | ✅ | The first name of the user. |
|
|
47
|
+
* | `lastName` | string | ✅ | The last name of the user. |
|
|
48
|
+
* | `groups` | string[] | ✅ | The groups to which the user belongs. |
|
|
49
|
+
* | `activationUrl` | string | ❌ | The URL for user activation. |
|
|
50
|
+
* | `civility` | string | ❌ | The civility of the user (e.g., Mr., Ms.). |
|
|
51
|
+
* | `customFieldValues`| object | ❌ | Custom fields for additional user information. |
|
|
52
|
+
* | `externalId` | string | ❌ | An external identifier for the user. |
|
|
53
|
+
* | `status` | string | ❌ | The status of the user (e.g., active, inactive). |
|
|
54
|
+
* | `mainOrganisationId`| string | ❌ | The ID of the main organization associated with the user. |
|
|
55
|
+
* | `organisations` | string[] | ❌ | The list of organizations associated with the user. |
|
|
56
|
+
* | `phone` | string | ❌ | The phone number of the user. |
|
|
57
|
+
*
|
|
58
|
+
* 📤 **Returns**:
|
|
59
|
+
* A `Promise` resolving to an object containing the created user's data.
|
|
60
|
+
*
|
|
61
|
+
* 🛠 **Example usage**:
|
|
62
|
+
* ```ts
|
|
63
|
+
* const newUser = await createCustomerUser({
|
|
64
|
+
* email: 'user@example.com',
|
|
65
|
+
* password: 'securePassword',
|
|
66
|
+
* firstName: 'John',
|
|
67
|
+
* lastName: 'Doe',
|
|
68
|
+
* activationUrl: 'http://example.com/activate',
|
|
69
|
+
* civility: 'Mr.',
|
|
70
|
+
* customFieldValues: {},
|
|
71
|
+
* externalId: 'external123',
|
|
72
|
+
* groups: ['group1'],
|
|
73
|
+
* status: 'active',
|
|
74
|
+
* mainOrganisationId: 'org1',
|
|
75
|
+
* organisations: ['org1', 'org2'],
|
|
76
|
+
* phone: '123-456-7890'
|
|
77
|
+
* });
|
|
78
|
+
* ```
|
|
79
|
+
* #### Output
|
|
80
|
+
* ```json
|
|
81
|
+
* {
|
|
82
|
+
* "id": "user1",
|
|
83
|
+
* "detail": "User created successfully"
|
|
84
|
+
* }
|
|
85
|
+
* ```
|
|
86
|
+
*/
|
|
87
|
+
export declare function createCustomerUser(params: CreateCustomerUserParameters): Promise<CreateCustomerUserResponse>;
|
|
88
|
+
/**
|
|
89
|
+
* 🚚 **Update Customer User**
|
|
90
|
+
*
|
|
91
|
+
* **APICODE(USER-201)**
|
|
92
|
+
* Updates your customer user.
|
|
93
|
+
*
|
|
94
|
+
* This function sends a request to update the details of the current customer user.
|
|
95
|
+
*
|
|
96
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/customer-users`
|
|
97
|
+
*
|
|
98
|
+
* | Parameter | Type | Required | Description |
|
|
99
|
+
* |--------------------|--------|----------|--------------------------------------------------|
|
|
100
|
+
* | `firstName` | string | ✅ | The first name of the user. |
|
|
101
|
+
* | `lastName` | string | ✅ | The last name of the user. |
|
|
102
|
+
* | `civility` | string | ❌ | The civility of the user (e.g., Mr., Ms.). |
|
|
103
|
+
* | `phone` | string | ❌ | The phone number of the user. |
|
|
104
|
+
* | `customFieldValues`| object | ❌ | Custom fields for additional user information. |
|
|
105
|
+
*
|
|
106
|
+
* 📤 **Returns**:
|
|
107
|
+
* A `Promise` resolving to an object containing the updated user's data.
|
|
108
|
+
*
|
|
109
|
+
* 🛠 **Example usage**:
|
|
110
|
+
* ```ts
|
|
111
|
+
* const updatedUser = await updateCustomerUser({
|
|
112
|
+
* firstName: 'John',
|
|
113
|
+
* lastName: 'Doe',
|
|
114
|
+
* civility: 'Mr.',
|
|
115
|
+
* phone: '123-456-7890',
|
|
116
|
+
* customFieldValues: {}
|
|
117
|
+
* });
|
|
118
|
+
* ```
|
|
119
|
+
* #### Output
|
|
120
|
+
* ```json
|
|
121
|
+
* {
|
|
122
|
+
* "detail": "User updated successfully"
|
|
123
|
+
* }
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
export declare function updateCustomerUser({ civility, firstName, lastName, phone, customFieldValues, }: UpdateCustomerUserParameters): Promise<UpdateCustomerUserResponse>;
|
|
127
|
+
/**
|
|
128
|
+
* 🚚 **Activate Customer User**
|
|
129
|
+
*
|
|
130
|
+
* **APICODE(USER-200)**
|
|
131
|
+
* Activates a customer user.
|
|
132
|
+
*
|
|
133
|
+
* This function sends a request to activate a customer user with a specified token.
|
|
134
|
+
*
|
|
135
|
+
* 🛠 **Endpoint**: `POST /v1/shop/customer-users/activate`
|
|
136
|
+
*
|
|
137
|
+
* | Parameter | Type | Required | Description |
|
|
138
|
+
* |-----------|--------|----------|--------------------------------------------------|
|
|
139
|
+
* | `token` | string | ✅ | The activation token of the user. |
|
|
140
|
+
*
|
|
141
|
+
* 📤 **Returns**:
|
|
142
|
+
* A `Promise` resolving when the user is activated.
|
|
143
|
+
*
|
|
144
|
+
* 🛠 **Example usage**:
|
|
145
|
+
* ```ts
|
|
146
|
+
* await activateCustomerUser({ token: 'activationToken' });
|
|
147
|
+
* ```
|
|
148
|
+
* #### Output
|
|
149
|
+
* ```json
|
|
150
|
+
* {
|
|
151
|
+
* "detail": "User activated successfully"
|
|
152
|
+
* }
|
|
153
|
+
* ```
|
|
154
|
+
*/
|
|
155
|
+
export declare function activateCustomerUser(params: ActivateCustomerUserParameters): Promise<void>;
|
|
156
|
+
/**
|
|
157
|
+
* 🚚 **Retrieve Customer User Addresses**
|
|
158
|
+
*
|
|
159
|
+
* **APICODE(USER-501)**
|
|
160
|
+
* Retrieves customer user addresses.
|
|
161
|
+
*
|
|
162
|
+
* This function sends a request to obtain the addresses associated with a customer user.
|
|
163
|
+
*
|
|
164
|
+
* 🛠 **Endpoint**: `GET /v1/shop/customer-users/addresses`
|
|
165
|
+
*
|
|
166
|
+
* | Parameter | Type | Required | Description |
|
|
167
|
+
* |------------------|---------|----------|-----------------------------------------------|
|
|
168
|
+
* | `shipping` | boolean | ✅ | Indicates whether to retrieve shipping addresses. |
|
|
169
|
+
* | `billing` | boolean | ✅ | Indicates whether to retrieve billing addresses. |
|
|
170
|
+
* | `account` | string | ✅ | The ID of the account for which to retrieve addresses. |
|
|
171
|
+
* | `organisationIds`| string[]| ❌ | An array of organization IDs to filter the addresses. |
|
|
172
|
+
*
|
|
173
|
+
* 📤 **Returns**:
|
|
174
|
+
* A `Promise` resolving to the list of addresses associated with the customer user.
|
|
175
|
+
*
|
|
176
|
+
* 🛠 **Example usage**:
|
|
177
|
+
* ```ts
|
|
178
|
+
* const addresses = await getCustomerUserAddresses({
|
|
179
|
+
* shipping: true,
|
|
180
|
+
* billing: false,
|
|
181
|
+
* account: 'account1',
|
|
182
|
+
* organisationIds: ['org1', 'org2']
|
|
183
|
+
* });
|
|
184
|
+
* ```
|
|
185
|
+
* #### Output
|
|
186
|
+
* ```json
|
|
187
|
+
* {
|
|
188
|
+
* "addresses": [
|
|
189
|
+
* {
|
|
190
|
+
* "id": "address1",
|
|
191
|
+
* "detail": "Address retrieved successfully"
|
|
192
|
+
* }
|
|
193
|
+
* ]
|
|
194
|
+
* }
|
|
195
|
+
* ```
|
|
196
|
+
*/
|
|
197
|
+
export declare function getCustomerUserAddresses({ shipping, billing, account, organisationIds, }: GetCustomerUserAddressesParameters): Promise<void>;
|
|
198
|
+
/**
|
|
199
|
+
* 🚚 **Retrieve Customer User Organisations**
|
|
200
|
+
*
|
|
201
|
+
* **APICODE(USER-502)**
|
|
202
|
+
* Retrieves customer user organisations.
|
|
203
|
+
*
|
|
204
|
+
* This function sends a request to obtain the organisations associated with a customer user.
|
|
205
|
+
*
|
|
206
|
+
* 🛠 **Endpoint**: `GET /v1/shop/customer-users/organisations`
|
|
207
|
+
*
|
|
208
|
+
* 📤 **Returns**:
|
|
209
|
+
* A `Promise` resolving to the list of organisations associated with the customer user.
|
|
210
|
+
*
|
|
211
|
+
* 🛠 **Example usage**:
|
|
212
|
+
* ```ts
|
|
213
|
+
* const organisations = await getCustomerUserOrganisations();
|
|
214
|
+
* ```
|
|
215
|
+
* #### Output
|
|
216
|
+
* ```json
|
|
217
|
+
* {
|
|
218
|
+
* "organisations": [
|
|
219
|
+
* {
|
|
220
|
+
* "id": "org1",
|
|
221
|
+
* "name": "Organisation 1"
|
|
222
|
+
* },
|
|
223
|
+
* {
|
|
224
|
+
* "id": "org2",
|
|
225
|
+
* "name": "Organisation 2"
|
|
226
|
+
* }
|
|
227
|
+
* ]
|
|
228
|
+
* }
|
|
229
|
+
* ```
|
|
230
|
+
*/
|
|
231
|
+
export declare function getCustomerUserOrganisations(): Promise<GetCustomerUserOrganisationsResponse>;
|
|
232
|
+
/**
|
|
233
|
+
* 🚚 **Send Customer User Activation Request**
|
|
234
|
+
*
|
|
235
|
+
* **APICODE(USER-203)**
|
|
236
|
+
* Sends a customer user activation request.
|
|
237
|
+
*
|
|
238
|
+
* This function sends a request to resend an activation request to a customer user.
|
|
239
|
+
*
|
|
240
|
+
* 🛠 **Endpoint**: `POST /v1/shop/customer-users/resend-activation-request`
|
|
241
|
+
*
|
|
242
|
+
* | Parameter | Type | Required | Description |
|
|
243
|
+
* |-------------|--------|----------|--------------------------------------------------|
|
|
244
|
+
* | `token` | string | ✅ | The activation token of the user. |
|
|
245
|
+
* | `redirectUrl`| string | ❌ | The URL to redirect the user after activation. |
|
|
246
|
+
*
|
|
247
|
+
* 📤 **Returns**:
|
|
248
|
+
* A `Promise` resolving when the request is sent.
|
|
249
|
+
*
|
|
250
|
+
* 🛠 **Example usage**:
|
|
251
|
+
* ```ts
|
|
252
|
+
* await sendCustomerUserActivationRequest({
|
|
253
|
+
* token: 'activationToken',
|
|
254
|
+
* redirectUrl: 'http://example.com/redirect'
|
|
255
|
+
* });
|
|
256
|
+
* ```
|
|
257
|
+
* #### Output
|
|
258
|
+
* ```json
|
|
259
|
+
* {
|
|
260
|
+
* "detail": "Activation request sent successfully"
|
|
261
|
+
* }
|
|
262
|
+
* ```
|
|
263
|
+
*/
|
|
264
|
+
export declare function sendCustomerUserActivationRequest({ redirectUrl, token, }: SendCustomerUserActivationRequestParameters): Promise<void>;
|
|
265
|
+
/**
|
|
266
|
+
* 🚚 **Update Specific Customer User**
|
|
267
|
+
*
|
|
268
|
+
* **APICODE(USER-202)**
|
|
269
|
+
* Updates a specific customer user.
|
|
270
|
+
*
|
|
271
|
+
* This function updates the details of a specific user, identified by
|
|
272
|
+
* the `userToUpdateId`. This parameter is mandatory and validated
|
|
273
|
+
* before the request is executed.
|
|
274
|
+
*
|
|
275
|
+
* 🛠 **Endpoint**: `PUT /v1/shop/customer-users/{userToUpdateId}`
|
|
276
|
+
*
|
|
277
|
+
* | Parameter | Type | Required | Description |
|
|
278
|
+
* |--------------------|--------|----------|--------------------------------------------------|
|
|
279
|
+
* | `userToUpdateId` | string | ✅ | The ID of the user you want to update. |
|
|
280
|
+
* | `firstName` | string | ✅ | The first name of the user. |
|
|
281
|
+
* | `lastName` | string | ✅ | The last name of the user. |
|
|
282
|
+
* | `civility` | string | ❌ | The civility of the user (e.g., Mr., Ms.). |
|
|
283
|
+
* | `phone` | string | ❌ | The phone number of the user. |
|
|
284
|
+
* | `customFieldValues`| object | ❌ | Custom fields for additional user information. |
|
|
285
|
+
* | `groups` | string[] | ❌ | The groups to which the user belongs. |
|
|
286
|
+
|
|
287
|
+
*
|
|
288
|
+
* 📤 **Returns**:
|
|
289
|
+
* A `Promise` resolving when the request is sent.
|
|
290
|
+
*
|
|
291
|
+
* 🛠 **Example usage**:
|
|
292
|
+
* ```ts
|
|
293
|
+
* const updatedUser = await updateCustomerUser({
|
|
294
|
+
* "userToUpdateId": "user1"
|
|
295
|
+
"civility": "MR",
|
|
296
|
+
"customFieldValues": [
|
|
297
|
+
{
|
|
298
|
+
"customFieldId": "string",
|
|
299
|
+
"customFieldValue": "string"
|
|
300
|
+
}
|
|
301
|
+
],
|
|
302
|
+
"firstName": "string",
|
|
303
|
+
"groups": [
|
|
304
|
+
"string"
|
|
305
|
+
],
|
|
306
|
+
"lastName": "string",
|
|
307
|
+
"phone": "+1 6884-2243 27"
|
|
308
|
+
});
|
|
309
|
+
* ```
|
|
310
|
+
* #### Output
|
|
311
|
+
* ```json
|
|
312
|
+
* {
|
|
313
|
+
* "detail": "User updated successfully"
|
|
314
|
+
* }
|
|
315
|
+
* ```
|
|
316
|
+
*/
|
|
317
|
+
export declare function updateSpecificCustomerUser({ userToUpdateId, civility, firstName, lastName, phone, groups, customFieldValues, idType, }: UpdateSpecificCustomerUserParameters): Promise<void>;
|
|
318
|
+
/**
|
|
319
|
+
* 🚚 **Remove Accounts from User**
|
|
320
|
+
*
|
|
321
|
+
* **APICODE(USER-350)**
|
|
322
|
+
* Removes accounts from a specific customer user.
|
|
323
|
+
*
|
|
324
|
+
* This function removes accounts of a specific user, identified by
|
|
325
|
+
* the `userToUpdateId`. The parameters `userToUpdateId` and `accountIds` are mandatory and validated
|
|
326
|
+
* before the request is executed.
|
|
327
|
+
*
|
|
328
|
+
* 🛠 **Endpoint**: `DELETE /v1/shop/customer-users/{userToUpdateId}/customer-accounts`
|
|
329
|
+
*
|
|
330
|
+
* | Parameter | Type | Required | Description |
|
|
331
|
+
* |--------------------|--------|----------|--------------------------------------------------|
|
|
332
|
+
* | `userToUpdateId` | string | ✅ | The ID of the user you want to update. |
|
|
333
|
+
* | `idType` | `AccountIdType`| ❌ | The type of account ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
|
|
334
|
+
* | `accountIds` | string[] | ✅ | The first name of the user. |
|
|
335
|
+
|
|
336
|
+
*
|
|
337
|
+
* 📤 **Returns**:
|
|
338
|
+
* A `Promise` resolving when the request is sent.
|
|
339
|
+
*
|
|
340
|
+
* 🛠 **Example usage**:
|
|
341
|
+
* ```ts
|
|
342
|
+
* const updatedUser = await updateCustomerUser({
|
|
343
|
+
* "userToUpdateId": "user1",
|
|
344
|
+
* "idType": "EXTERNAL_ID",
|
|
345
|
+
"accountIds": ["account1", "account2", ...],
|
|
346
|
+
});
|
|
347
|
+
* ```
|
|
348
|
+
* #### Output
|
|
349
|
+
* ```json
|
|
350
|
+
* {
|
|
351
|
+
* "detail": "User successfully removed from accounts"
|
|
352
|
+
* }
|
|
353
|
+
* ```
|
|
354
|
+
*/
|
|
355
|
+
export declare function removeAccountsFromCustomerUser({ userToUpdateId, idType, accountIds, }: RemoveAccountsFromCustomerUserParameters): Promise<void>;
|
|
356
|
+
/**
|
|
357
|
+
* 🚚 **Add User to Accounts**
|
|
358
|
+
*
|
|
359
|
+
* **APICODE(USER-250)**
|
|
360
|
+
* Add specific user to accounts.
|
|
361
|
+
*
|
|
362
|
+
* This function removes accounts of a specific user, identified by
|
|
363
|
+
* the `userToUpdateId`. The parameters `userToUpdateId` and `accountIds` are mandatory and validated
|
|
364
|
+
* before the request is executed.
|
|
365
|
+
*
|
|
366
|
+
* 🛠 **Endpoint**: `PATCH /v1/shop/customer-users/{userToUpdateId}/customer-accounts`
|
|
367
|
+
*
|
|
368
|
+
* | Parameter | Type | Required | Description |
|
|
369
|
+
* |--------------------|--------|----------|--------------------------------------------------|
|
|
370
|
+
* | `userToUpdateId` | string | ✅ | The ID of the user you want to update. |
|
|
371
|
+
* | `idType` | `AccountIdType`| ❌ | The type of account ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
|
|
372
|
+
* | `accountIds` | string[] | ✅ | The first name of the user. |
|
|
373
|
+
|
|
374
|
+
*
|
|
375
|
+
* 📤 **Returns**:
|
|
376
|
+
* A `Promise` resolving when the request is sent.
|
|
377
|
+
*
|
|
378
|
+
* 🛠 **Example usage**:
|
|
379
|
+
* ```ts
|
|
380
|
+
* const updatedUser = await updateCustomerUser({
|
|
381
|
+
* "userToUpdateId": "user1",
|
|
382
|
+
* "idType": "EXTERNAL_ID",
|
|
383
|
+
"accountIds": ["account1", "account2", ...],
|
|
384
|
+
});
|
|
385
|
+
* ```
|
|
386
|
+
* #### Output
|
|
387
|
+
* ```json
|
|
388
|
+
* {
|
|
389
|
+
* "detail": "User successfully added to accounts"
|
|
390
|
+
* }
|
|
391
|
+
* ```
|
|
392
|
+
*/
|
|
393
|
+
export declare function addCustomerUserToAccounts({ userToUpdateId, idType, accountIds, }: AddCustomerUserToAccountsParameters): Promise<void>;
|
|
394
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/customer-user/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,8BAA8B,EAC9B,mCAAmC,EACnC,4BAA4B,EAC5B,0BAA0B,EAC1B,4BAA4B,EAC5B,kCAAkC,EAClC,oCAAoC,EACpC,wCAAwC,EACxC,2CAA2C,EAC3C,4BAA4B,EAC5B,0BAA0B,EAC1B,oCAAoC,EACrC,MAAM,eAAe,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAOlF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,0BAA0B,CAAC,CAuCrC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,KAAK,EACL,iBAAiB,GAClB,EAAE,4BAA4B,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAgBpE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,8BAA8B,GACrC,OAAO,CAAC,IAAI,CAAC,CAWf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAsB,wBAAwB,CAAC,EAC7C,QAAQ,EACR,OAAO,EACP,OAAO,EACP,eAAe,GAChB,EAAE,kCAAkC,GAAG,OAAO,CAAC,IAAI,CAAC,CAapD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAsB,4BAA4B,IAAI,OAAO,CAAC,oCAAoC,CAAC,CAOlG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,iCAAiC,CAAC,EACtD,WAAW,EACX,KAAK,GACN,EAAE,2CAA2C,GAAG,OAAO,CAAC,IAAI,CAAC,CAW7D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,wBAAsB,0BAA0B,CAAC,EAC/C,cAAc,EACd,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,KAAK,EACL,MAAM,EACN,iBAAiB,EACjB,MAAM,GACP,EAAE,oCAAoC,GAAG,OAAO,CAAC,IAAI,CAAC,CAoBtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAsB,8BAA8B,CAAC,EACnD,cAAc,EACd,MAAM,EACN,UAAU,GACX,EAAE,wCAAwC,GAAG,OAAO,CAAC,IAAI,CAAC,CAa1D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAsB,yBAAyB,CAAC,EAC9C,cAAc,EACd,MAAM,EACN,UAAU,GACX,EAAE,mCAAmC,GAAG,OAAO,CAAC,IAAI,CAAC,CAarD"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DJUST SDK Customer User Module
|
|
3
|
+
* Re-exports all customer user-related types and service.
|
|
4
|
+
*
|
|
5
|
+
* @module services/customer-user
|
|
6
|
+
* @since 2.17.0
|
|
7
|
+
*/
|
|
8
|
+
export type { Civility, UserStatus, IdType, CustomFieldValueRequest, CreateCustomerUserParams, UpdateCustomerUserParams, ActivateCustomerUserParams, GetCustomerUserAddressesParams, SendActivationRequestParams, UpdateSpecificCustomerUserParams, RemoveAccountsFromUserParams, AddUserToAccountsParams, AuthenticatedUser, UserAddress, UserOrganisation, GetAuthenticatedUserResponse, CreateCustomerUserResponse, UpdateCustomerUserResponse, GetCustomerUserAddressesResponse, GetCustomerUserOrganisationsResponse, } from "./types";
|
|
9
|
+
export { CustomerUserEndpoints, type CustomerUserEndpoint } from "./endpoints";
|
|
10
|
+
export { CustomerUserService } from "./customer-user.service";
|
|
11
|
+
//# sourceMappingURL=module.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../src/services/customer-user/module.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,YAAY,EACV,QAAQ,EACR,UAAU,EACV,MAAM,EACN,uBAAuB,EACvB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,8BAA8B,EAC9B,2BAA2B,EAC3B,gCAAgC,EAChC,4BAA4B,EAC5B,uBAAuB,EACvB,iBAAiB,EACjB,WAAW,EACX,gBAAgB,EAChB,4BAA4B,EAC5B,0BAA0B,EAC1B,0BAA0B,EAC1B,gCAAgC,EAChC,oCAAoC,GACrC,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,qBAAqB,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC"}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DJUST SDK Customer User Service - Types
|
|
3
|
+
* Type definitions for customer user operations.
|
|
4
|
+
*
|
|
5
|
+
* @module services/customer-user/types
|
|
6
|
+
* @since 2.17.0
|
|
7
|
+
*/
|
|
8
|
+
export type Civility = "MR" | "MRS" | "MS";
|
|
9
|
+
export type UserStatus = "ACTIVE" | "INACTIVE" | "PENDING";
|
|
10
|
+
export type IdType = "DJUST_ID" | "EXTERNAL_ID";
|
|
11
|
+
export interface CustomFieldValueRequest {
|
|
12
|
+
customFieldId: string;
|
|
13
|
+
customFieldValue?: string;
|
|
14
|
+
}
|
|
15
|
+
export interface CreateCustomerUserParams {
|
|
16
|
+
email: string;
|
|
17
|
+
password: string;
|
|
18
|
+
firstName: string;
|
|
19
|
+
lastName: string;
|
|
20
|
+
groups: string[];
|
|
21
|
+
civility: Civility;
|
|
22
|
+
activationUrl?: string;
|
|
23
|
+
customFieldValues?: CustomFieldValueRequest[];
|
|
24
|
+
externalId?: string;
|
|
25
|
+
status?: UserStatus;
|
|
26
|
+
mainOrganisationId?: string;
|
|
27
|
+
organisations?: string[];
|
|
28
|
+
phone?: string;
|
|
29
|
+
}
|
|
30
|
+
export interface UpdateCustomerUserParams {
|
|
31
|
+
firstName: string;
|
|
32
|
+
lastName: string;
|
|
33
|
+
civility: Civility;
|
|
34
|
+
phone?: string;
|
|
35
|
+
customFieldValues?: CustomFieldValueRequest[];
|
|
36
|
+
}
|
|
37
|
+
export interface ActivateCustomerUserParams {
|
|
38
|
+
token: string;
|
|
39
|
+
}
|
|
40
|
+
export interface GetCustomerUserAddressesParams {
|
|
41
|
+
shipping?: boolean;
|
|
42
|
+
billing?: boolean;
|
|
43
|
+
account?: string;
|
|
44
|
+
organisationIds?: string[];
|
|
45
|
+
}
|
|
46
|
+
export interface SendActivationRequestParams {
|
|
47
|
+
token: string;
|
|
48
|
+
redirectUrl?: string;
|
|
49
|
+
}
|
|
50
|
+
export interface UpdateSpecificCustomerUserParams {
|
|
51
|
+
userToUpdateId: string;
|
|
52
|
+
firstName: string;
|
|
53
|
+
lastName: string;
|
|
54
|
+
civility: Civility;
|
|
55
|
+
phone?: string;
|
|
56
|
+
groups?: string[];
|
|
57
|
+
customFieldValues?: CustomFieldValueRequest[];
|
|
58
|
+
idType?: IdType;
|
|
59
|
+
}
|
|
60
|
+
export interface RemoveAccountsFromUserParams {
|
|
61
|
+
userToUpdateId: string;
|
|
62
|
+
accountIds: string[];
|
|
63
|
+
idType?: IdType;
|
|
64
|
+
}
|
|
65
|
+
export interface AddUserToAccountsParams {
|
|
66
|
+
userToUpdateId: string;
|
|
67
|
+
accountIds: string[];
|
|
68
|
+
idType?: IdType;
|
|
69
|
+
}
|
|
70
|
+
export interface AuthenticatedUser {
|
|
71
|
+
id: string;
|
|
72
|
+
email: string;
|
|
73
|
+
firstName: string;
|
|
74
|
+
lastName: string;
|
|
75
|
+
civility?: Civility;
|
|
76
|
+
phone?: string;
|
|
77
|
+
status: UserStatus;
|
|
78
|
+
groups: string[];
|
|
79
|
+
customFieldValues?: CustomFieldValueRequest[];
|
|
80
|
+
mainOrganisationId?: string;
|
|
81
|
+
customerAccountId?: string;
|
|
82
|
+
}
|
|
83
|
+
export interface UserAddress {
|
|
84
|
+
id: string;
|
|
85
|
+
address: string;
|
|
86
|
+
additionalAddress?: string;
|
|
87
|
+
city: string;
|
|
88
|
+
country: string;
|
|
89
|
+
zipcode: string;
|
|
90
|
+
state?: string;
|
|
91
|
+
fullName: string;
|
|
92
|
+
phone?: string;
|
|
93
|
+
company?: string;
|
|
94
|
+
billing: boolean;
|
|
95
|
+
shipping: boolean;
|
|
96
|
+
}
|
|
97
|
+
export interface UserOrganisation {
|
|
98
|
+
id: string;
|
|
99
|
+
name: string;
|
|
100
|
+
externalId?: string;
|
|
101
|
+
parentId?: string;
|
|
102
|
+
}
|
|
103
|
+
export interface GetAuthenticatedUserResponse extends AuthenticatedUser {
|
|
104
|
+
}
|
|
105
|
+
export interface CreateCustomerUserResponse {
|
|
106
|
+
id: string;
|
|
107
|
+
detail?: string;
|
|
108
|
+
}
|
|
109
|
+
export interface UpdateCustomerUserResponse {
|
|
110
|
+
detail?: string;
|
|
111
|
+
}
|
|
112
|
+
export interface GetCustomerUserAddressesResponse {
|
|
113
|
+
addresses: UserAddress[];
|
|
114
|
+
}
|
|
115
|
+
export interface GetCustomerUserOrganisationsResponse {
|
|
116
|
+
organisations: UserOrganisation[];
|
|
117
|
+
}
|
|
118
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/customer-user/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,MAAM,MAAM,QAAQ,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC;AAC3C,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;AAC3D,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,aAAa,CAAC;AAEhD,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAMD,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,uBAAuB,EAAE,CAAC;CAC/C;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gCAAgC;IAC/C,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,iBAAiB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,4BAA4B;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAMD,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,UAAU,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,iBAAiB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC9C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,4BAA6B,SAAQ,iBAAiB;CAAG;AAC1E,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,MAAM,WAAW,gCAAgC;IAC/C,SAAS,EAAE,WAAW,EAAE,CAAC;CAC1B;AACD,MAAM,WAAW,oCAAoC;IACnD,aAAa,EAAE,gBAAgB,EAAE,CAAC;CACnC"}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DJUST SDK Service Factory
|
|
3
|
+
* Factory for creating service instances.
|
|
4
|
+
*
|
|
5
|
+
* @module services/factory
|
|
6
|
+
* @since 2.17.0
|
|
7
|
+
*/
|
|
8
|
+
import type { Transport } from "../client/transport";
|
|
9
|
+
import { AuthService } from "./auth/auth.service";
|
|
10
|
+
import { CartService } from "./cart/cart.service";
|
|
11
|
+
import { ProductService } from "./product/product.service";
|
|
12
|
+
import { QuoteService } from "./quote/quote.service";
|
|
13
|
+
import { CommercialOrderService } from "./commercial-order/commercial-order.service";
|
|
14
|
+
import { LogisticOrderService } from "./logistic-order/logistic-order.service";
|
|
15
|
+
import { CustomerAccountService } from "./customer-account/customer-account.service";
|
|
16
|
+
import { CustomerUserService } from "./customer-user/customer-user.service";
|
|
17
|
+
import { SupplierService } from "./supplier/supplier.service";
|
|
18
|
+
import { PaymentService } from "./payment/payment.service";
|
|
19
|
+
import { NavigationCategoryService } from "./navigation-category/navigation-category.service";
|
|
20
|
+
import { OperationService } from "./operation/operation.service";
|
|
21
|
+
import { AttributesService } from "./attributes/attributes.service";
|
|
22
|
+
import { IncidentService } from "./incident/incident.service";
|
|
23
|
+
import { OfferInventoriesService } from "./offer-inventories/offer-inventories.service";
|
|
24
|
+
import { OfferPricesService } from "./offer-prices/offer-prices.service";
|
|
25
|
+
import { ProductVariantService } from "./product-variant/product-variant.service";
|
|
26
|
+
import { CustomFieldService } from "./custom-field/custom-field.service";
|
|
27
|
+
/**
|
|
28
|
+
* All available SDK services.
|
|
29
|
+
*/
|
|
30
|
+
export interface SDKServices {
|
|
31
|
+
/** Authentication service */
|
|
32
|
+
auth: AuthService;
|
|
33
|
+
/** Shopping cart service */
|
|
34
|
+
cart: CartService;
|
|
35
|
+
/** Product catalog service */
|
|
36
|
+
product: ProductService;
|
|
37
|
+
/** Quote management service */
|
|
38
|
+
quote: QuoteService;
|
|
39
|
+
/** Commercial order service */
|
|
40
|
+
commercialOrder: CommercialOrderService;
|
|
41
|
+
/** Logistic order service */
|
|
42
|
+
logisticOrder: LogisticOrderService;
|
|
43
|
+
/** Customer account service */
|
|
44
|
+
customerAccount: CustomerAccountService;
|
|
45
|
+
/** Customer user service */
|
|
46
|
+
customerUser: CustomerUserService;
|
|
47
|
+
/** Supplier service */
|
|
48
|
+
supplier: SupplierService;
|
|
49
|
+
/** Payment service */
|
|
50
|
+
payment: PaymentService;
|
|
51
|
+
/** Navigation category service */
|
|
52
|
+
navigationCategory: NavigationCategoryService;
|
|
53
|
+
/** Operation management service */
|
|
54
|
+
operation: OperationService;
|
|
55
|
+
/** Attributes service */
|
|
56
|
+
attributes: AttributesService;
|
|
57
|
+
/** Incident service */
|
|
58
|
+
incident: IncidentService;
|
|
59
|
+
/** Offer inventories service */
|
|
60
|
+
offerInventories: OfferInventoriesService;
|
|
61
|
+
/** Offer prices service */
|
|
62
|
+
offerPrices: OfferPricesService;
|
|
63
|
+
/** Product variant service */
|
|
64
|
+
productVariant: ProductVariantService;
|
|
65
|
+
/** Custom field service */
|
|
66
|
+
customField: CustomFieldService;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Creates all SDK service instances.
|
|
70
|
+
*
|
|
71
|
+
* This factory creates instances of all services using the provided
|
|
72
|
+
* transport layer, ensuring consistent configuration across all services.
|
|
73
|
+
*
|
|
74
|
+
* @param transport - The transport instance to use for HTTP requests
|
|
75
|
+
* @returns Object containing all service instances
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```typescript
|
|
79
|
+
* import { createDjustClient } from '@djust-b2b/djust-front-sdk';
|
|
80
|
+
* import { createServices } from '@djust-b2b/djust-front-sdk/services';
|
|
81
|
+
*
|
|
82
|
+
* const client = createDjustClient({ baseUrl, clientId, apiKey });
|
|
83
|
+
* const services = createServices(client.transport);
|
|
84
|
+
*
|
|
85
|
+
* // Use services
|
|
86
|
+
* const cart = await services.cart.getCart({ cartId: '123', currency: 'USD' });
|
|
87
|
+
* const orders = await services.commercialOrder.getCommercialOrders({ locale: 'fr-FR' });
|
|
88
|
+
* ```
|
|
89
|
+
*/
|
|
90
|
+
export declare function createServices(transport: Transport): SDKServices;
|
|
91
|
+
/**
|
|
92
|
+
* Creates a single service instance.
|
|
93
|
+
*
|
|
94
|
+
* Use this when you only need one specific service to reduce bundle size.
|
|
95
|
+
*
|
|
96
|
+
* @example
|
|
97
|
+
* ```typescript
|
|
98
|
+
* import { createService, CartService } from '@djust-b2b/djust-front-sdk/services';
|
|
99
|
+
*
|
|
100
|
+
* const cartService = createService(CartService, transport);
|
|
101
|
+
* ```
|
|
102
|
+
*/
|
|
103
|
+
export declare function createService<T>(ServiceClass: new (transport: Transport) => T, transport: Transport): T;
|
|
104
|
+
//# sourceMappingURL=factory.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/services/factory.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AACrF,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAC5E,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mDAAmD,CAAC;AAC9F,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,6BAA6B;IAC7B,IAAI,EAAE,WAAW,CAAC;IAClB,4BAA4B;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,8BAA8B;IAC9B,OAAO,EAAE,cAAc,CAAC;IACxB,+BAA+B;IAC/B,KAAK,EAAE,YAAY,CAAC;IACpB,+BAA+B;IAC/B,eAAe,EAAE,sBAAsB,CAAC;IACxC,6BAA6B;IAC7B,aAAa,EAAE,oBAAoB,CAAC;IACpC,+BAA+B;IAC/B,eAAe,EAAE,sBAAsB,CAAC;IACxC,4BAA4B;IAC5B,YAAY,EAAE,mBAAmB,CAAC;IAClC,uBAAuB;IACvB,QAAQ,EAAE,eAAe,CAAC;IAC1B,sBAAsB;IACtB,OAAO,EAAE,cAAc,CAAC;IACxB,kCAAkC;IAClC,kBAAkB,EAAE,yBAAyB,CAAC;IAC9C,mCAAmC;IACnC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,yBAAyB;IACzB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,uBAAuB;IACvB,QAAQ,EAAE,eAAe,CAAC;IAC1B,gCAAgC;IAChC,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,2BAA2B;IAC3B,WAAW,EAAE,kBAAkB,CAAC;IAChC,8BAA8B;IAC9B,cAAc,EAAE,qBAAqB,CAAC;IACtC,2BAA2B;IAC3B,WAAW,EAAE,kBAAkB,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,WAAW,CAqBhE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,YAAY,EAAE,KAAK,SAAS,EAAE,SAAS,KAAK,CAAC,EAC7C,SAAS,EAAE,SAAS,GACnB,CAAC,CAEH"}
|