@djust-b2b/djust-front-sdk 2.2.0 → 2.4.0

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.
Files changed (8) hide show
  1. package/lib/index.d.ts +1 -1
  2. package/lib/interfaces/models/order.d.ts +4 -1
  3. package/lib/services/commercial-order/definitions.d.ts +6 -7
  4. package/lib/services/commercial-order/index.d.ts +5 -5
  5. package/lib/services/commercial-order/index.js +6 -7
  6. package/lib/services/customer-account/index.d.ts +46 -69
  7. package/lib/services/customer-account/index.js +46 -69
  8. package/package.json +1 -1
package/lib/index.d.ts CHANGED
@@ -30,7 +30,7 @@ export declare const DjustSDK: {
30
30
  updateCommercialOrderShippingType({ orderId, shippingType, }: import("./interfaces").UpdateCommercialOrderShippingTypeParameters): Promise<void>;
31
31
  deleteCommercialOrder(commercialOrderId: string): Promise<void>;
32
32
  getCommercialOrderLines({ commercialOrderId, page, size, sort, supplierIds, productVariantIds, offerPriceIds, idType, locale, }: import("./interfaces").GetOrderCommercialLinesParameters): Promise<import("./interfaces").GetOrderCommercialLinesResponse>;
33
- updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, updateOrderLineIdType, updateOrderLineType, }: import("./interfaces").UpdateCommercialOrderLinesParameters): Promise<import("./interfaces").UpdateCommercialOrderLinesResponse>;
33
+ updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, metadata, }: import("./interfaces").UpdateCommercialOrderLinesParameters): Promise<import("./interfaces").UpdateCommercialOrderLinesResponse>;
34
34
  deleteCommercialOrderLines({ commercialOrderId, body, }: import("./interfaces").DeleteCommercialOrderLinesParameters): Promise<import("./interfaces").DeleteCommercialOrderLinesResponse>;
35
35
  punchoutOciCommercialOrder({ tenantConfigurationKey, commercialOrderId, locale, }: import("./interfaces").PunchoutOciCommercialOrderParameters): Promise<any>;
36
36
  getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, connectedUserOnly, nbPreviewLines, page, size, sort, suppliersIds, creationDateFrom, creationDateTo, updateDateFrom, updateDateTo, }: import("./interfaces").GetLogisticOrdersParameters): Promise<import("./interfaces").GetLogisticOrdersResponse>;
package/lib/interfaces/models/order.d.ts CHANGED
@@ -80,10 +80,13 @@ export interface OrderLogisticLineDto {
80
80
  status: OrderLineStatus;
81
81
  }
82
82
  export interface OrderLogisticLineUpdate {
83
- customFieldValues: CustomFieldValueObject[];
83
+ customFieldValues: CustomFieldValueRequest[];
84
84
  id: string;
85
85
  quantity: number;
86
86
  updateAction: UpdateCartLineType;
87
+ metadata?: {
88
+ [key: string]: any;
89
+ };
87
90
  }
88
91
  export interface updateCommercialOrderLinesRequest {
89
92
  customFieldIdType?: IdType;
package/lib/services/commercial-order/definitions.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { Channel, Currency, IdType } from "../../interfaces/models/common";
2
2
  import { CustomFieldValueRequest } from "../../interfaces/models/custom-field";
3
- import { BrowserInfo, CardInformationDto, OrderCommercialDto, OrderIdType, OrderLogisticDto, OrderOrigin, PageOrderCommercialDto, PaymentCardInfo, PreauthorizationDto, OfferToDelete, OrderLogisticLineUpdate, OrderLineType, PageOrderCommercialLinesDto } from "../../interfaces/models/order";
3
+ import { BrowserInfo, CardInformationDto, OrderCommercialDto, OrderIdType, OrderLogisticDto, OrderOrigin, PageOrderCommercialDto, PaymentCardInfo, PreauthorizationDto, OfferToDelete, OrderLogisticLineUpdate, PageOrderCommercialLinesDto } from "../../interfaces/models/order";
4
4
  import { SingleWarningReportDto } from "../../interfaces/models/common";
5
5
  import { PaymentInfoRequest, PaymentOption, PaymentProvider } from "../../interfaces/models/payment";
6
6
  /**
@@ -121,8 +121,9 @@ export interface UpdateCommercialOrderLinesParameters {
121
121
  lineIdType?: IdType;
122
122
  lineType?: string;
123
123
  updateOrderCommercialLines?: OrderLogisticLineUpdate[];
124
- updateOrderLineIdType?: IdType;
125
- updateOrderLineType?: OrderLineType;
124
+ metadata?: {
125
+ [key: string]: any;
126
+ };
126
127
  }
127
128
  export interface GetCommercialOrderResponse extends OrderCommercialDto {
128
129
  }
@@ -134,9 +135,7 @@ export interface CreateCommercialOrderPreauthorizationResponse extends Preauthor
134
135
  }
135
136
  export interface UpdateOrderLogisticCustomFieldResponse extends OrderLogisticDto {
136
137
  }
137
- export interface DeleteCommercialOrderLinesResponse {
138
- singleWarningReportDtos: SingleWarningReportDto[];
138
+ export interface DeleteCommercialOrderLinesResponse extends Array<SingleWarningReportDto> {
139
139
  }
140
- export interface UpdateCommercialOrderLinesResponse {
141
- singleWarningReportDtos: SingleWarningReportDto[];
140
+ export interface UpdateCommercialOrderLinesResponse extends Array<SingleWarningReportDto> {
142
141
  }
package/lib/services/commercial-order/index.d.ts CHANGED
@@ -543,8 +543,7 @@ export declare function getCommercialOrderLines({ commercialOrderId, page, size,
543
543
  * | `lineIdType` | `string` | ❌ | The line id type to use. |
544
544
  * | `lineType` | `string` | ❌ | The line type to use. |
545
545
  * | `updateOrderCommercialLines` | `OrderLogisticLineUpdate[]` | ❌ | Attributes to update. Can be empty object. |
546
- * | `updateOrderLineIdType` | `IdType` | ❌ | The line id type to use. |
547
- * | `updateOrderLineType` | `OrderLineType` | ❌ | The line type to use. |
546
+ * | `metadata` | `{ [key: string]: any }` | ❌ | Metadata to update. Can be empty object. |
548
547
  *
549
548
  * 📤 **Returns**:
550
549
  * A `Promise` resolving when the commercial order lines are successfully updated.
@@ -568,8 +567,9 @@ export declare function getCommercialOrderLines({ commercialOrderId, page, size,
568
567
  * updateAction: "ADD_QUANTITY"
569
568
  * }
570
569
  * ],
571
- * updateOrderLineIdType: "EXTERNAL_ID",
572
- * updateOrderLineType: "PRODUCT_VARIANT"
570
+ * metadata: {
571
+ * "key": "value"
572
+ * }
573
573
  * });
574
574
  * ```
575
575
  *
@@ -577,7 +577,7 @@ export declare function getCommercialOrderLines({ commercialOrderId, page, size,
577
577
  * @throws {Error} If `commercialOrderId` is missing.
578
578
  * @returns {Promise<UpdateCommercialOrderLinesResponse>} A promise resolving when the commercial order lines are successfully updated.
579
579
  */
580
- export declare function updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, updateOrderLineIdType, updateOrderLineType, }: UpdateCommercialOrderLinesParameters): Promise<UpdateCommercialOrderLinesResponse>;
580
+ export declare function updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, metadata, }: UpdateCommercialOrderLinesParameters): Promise<UpdateCommercialOrderLinesResponse>;
581
581
  /**
582
582
  * ❌ Deletes specific commercial order lines.
583
583
  *
package/lib/services/commercial-order/index.js CHANGED
@@ -742,8 +742,7 @@ async function getCommercialOrderLines({ commercialOrderId, page, size, sort, su
742
742
  * | `lineIdType` | `string` | ❌ | The line id type to use. |
743
743
  * | `lineType` | `string` | ❌ | The line type to use. |
744
744
  * | `updateOrderCommercialLines` | `OrderLogisticLineUpdate[]` | ❌ | Attributes to update. Can be empty object. |
745
- * | `updateOrderLineIdType` | `IdType` | ❌ | The line id type to use. |
746
- * | `updateOrderLineType` | `OrderLineType` | ❌ | The line type to use. |
745
+ * | `metadata` | `{ [key: string]: any }` | ❌ | Metadata to update. Can be empty object. |
747
746
  *
748
747
  * 📤 **Returns**:
749
748
  * A `Promise` resolving when the commercial order lines are successfully updated.
@@ -767,8 +766,9 @@ async function getCommercialOrderLines({ commercialOrderId, page, size, sort, su
767
766
  * updateAction: "ADD_QUANTITY"
768
767
  * }
769
768
  * ],
770
- * updateOrderLineIdType: "EXTERNAL_ID",
771
- * updateOrderLineType: "PRODUCT_VARIANT"
769
+ * metadata: {
770
+ * "key": "value"
771
+ * }
772
772
  * });
773
773
  * ```
774
774
  *
@@ -776,7 +776,7 @@ async function getCommercialOrderLines({ commercialOrderId, page, size, sort, su
776
776
  * @throws {Error} If `commercialOrderId` is missing.
777
777
  * @returns {Promise<UpdateCommercialOrderLinesResponse>} A promise resolving when the commercial order lines are successfully updated.
778
778
  */
779
- async function updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, updateOrderLineIdType, updateOrderLineType, }) {
779
+ async function updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, metadata, }) {
780
780
  (0, parameters_validation_1.required)({ commercialOrderId });
781
781
  const { data } = await (0, fetch_instance_1.enhancedFetch)({
782
782
  method: "PUT",
@@ -786,8 +786,7 @@ async function updateCommercialOrderLines({ commercialOrderId, customFieldIdType
786
786
  lineIdType,
787
787
  lineType,
788
788
  updateOrderCommercialLines,
789
- updateOrderLineIdType,
790
- updateOrderLineType,
789
+ metadata,
791
790
  }),
792
791
  });
793
792
  return data;
package/lib/services/customer-account/index.d.ts CHANGED
@@ -48,7 +48,7 @@ export declare function getCustomerAccountV2(pageable: PageableParameters): Prom
48
48
  *
49
49
  * This function allows the creation of a new customer account with relevant details including addresses, user information, and custom fields.
50
50
  *
51
- * 🛠 **Endpoint**: `POST /v1/shop/customer-accounts`
51
+ * 🛠 **Endpoint**: `POST /v1/shop/customer-accounts` [ACCOUNT-100]
52
52
  *
53
53
  * | Parameter | Type | Required | Description |
54
54
  * |-----------------------------------|--------------------------------|----------|-------------|
@@ -58,82 +58,59 @@ export declare function getCustomerAccountV2(pageable: PageableParameters): Prom
58
58
  * | `customFieldValues` | `object[]` | ✅ | List of custom fields with their `customFieldId` and `customFieldValue`. |
59
59
  * | `customerTagList` | `string[]` | ✅ | List of customer tags. |
60
60
  * | `fromFO` | `boolean` | ✅ | Flag indicating if the account is created from the front-office (FO). |
61
- * | `legalUser` | `object[]` | ✅ | Information about the legal user including `birthday`, `countryOfResidence`, `email`, `firstName`, `lastName`, and `nationality`. |
62
-
61
+ * | `legalUser` | `object` | ✅ | Information about the legal user including `birthday`, `countryOfResidence`, `email`, `firstName`, `lastName`, and `nationality`. |
62
+ *
63
63
  * 📤 **Returns**:
64
64
  * A `Promise<CreateCustomerAccountResponse>` containing the details of the created customer account.
65
65
  *
66
66
  * 🛠 **Example usage**:
67
67
  * ```ts
68
68
  * const response = await createCustomerAccount({
69
- * createAddressRequests: [
70
- * {
71
- * additionalAddress: "string",
72
- * address: "string",
73
- * billing: true,
74
- * city: "string",
75
- * company: "string",
76
- * country: "string",
77
- * externalId: "string",
78
- * fullName: "string",
79
- * id: "string",
80
- * label: "string",
81
- * phone: "string",
82
- * shipping: true,
83
- * state: "string",
84
- * zipcode: "string"
85
- * }
86
- * ],
87
- * createCustomerUserRequest: {
88
- * civility: "MR",
89
- * email: "string",
90
- * customFieldValues: [
91
- * {
92
- * customFieldId: 'string',
93
- * customFieldValue: 'string'
94
- * }
95
- * ],
96
- * externalId: "string",
97
- * firstName: "string",
98
- * groups: ["group1", "group2"],
99
- * lastName: "string",
100
- * mainOrganisationsId: "orgId",
101
- * mainSubOrganisationsId: "subOrgId",
102
- * organisationsIds: ['orgId1', 'orgId2'],
103
- * password: "password123",
104
- * phone: "123456789",
105
- * subOrganisationsIds: ['subOrgId1', 'subOrgId2']
106
- * },
107
- * createObjectCustomerAccountRequest: {
108
- * accountManager: "string",
109
- * businessRegistrationNumber: "string",
110
- * companyRegistrationName: "string",
111
- * externalId: "string",
112
- * name: "string",
113
- * vatNumber: "string",
114
- * website: "string"
115
- * },
116
- * customFieldValues: [
117
- * {
118
- * customFieldId: "string",
119
- * customFieldValue: "value"
120
- * }
121
- * ],
122
- * customerTagList: ["tag1", "tag2"],
123
- * fromFO: true,
124
- * legalUser: [
125
- * {
126
- * birthday: "2024-12-11T09:46:27.656Z",
127
- * countryOfResidence: "FR",
128
- * email: "user@example.com",
129
- * firstName: "John",
130
- * id: "userId",
131
- * lastName: "Doe",
132
- * nationality: "FR"
133
- * }
134
- * ],
69
+ * createAddressRequests: [
70
+ * {
71
+ * address: "123 Main Street",
72
+ * city: "Paris",
73
+ * country: "FR",
74
+ * billing: true,
75
+ * shipping: true,
76
+ * fullName: "John Doe",
77
+ * zipcode: "75001"
78
+ * }
79
+ * ],
80
+ * createCustomerUserRequest: {
81
+ * email: "john.doe@example.com",
82
+ * firstName: "John",
83
+ * lastName: "Doe",
84
+ * password: "securePassword123",
85
+ * phone: "+33123456789"
86
+ * },
87
+ * createObjectCustomerAccountRequest: {
88
+ * name: "Acme Corporation",
89
+ * externalId: "acme-corp-001",
90
+ * vatNumber: "FR12345678901"
91
+ * },
92
+ * customFieldValues: [
93
+ * {
94
+ * customFieldId: "industry",
95
+ * customFieldValue: "technology"
96
+ * }
97
+ * ],
98
+ * customerTagList: ["premium", "enterprise"],
99
+ * fromFO: true,
100
+ * legalUser: {
101
+ * birthday: "1990-01-01T00:00:00.000Z",
102
+ * countryOfResidence: "FR",
103
+ * email: "john.doe@example.com",
104
+ * firstName: "John",
105
+ * lastName: "Doe",
106
+ * nationality: "FR"
107
+ * }
135
108
  * });
136
109
  * ```
110
+ *
111
+ * @param {CreateCustomerAccountParameters} params - The parameters for creating a customer account
112
+ * @throws {Error} If required parameters are missing
113
+ * @returns {Promise<CreateCustomerAccountResponse>} A promise resolving to the response containing the created customer account
137
114
  */
138
115
  export declare function createCustomerAccount({ createAddressRequests, createCustomerUserRequest, createObjectCustomerAccountRequest, customFieldValues, customerTagList, fromFO, legalUser, ...config }: CreateCustomerAccountParameters & DjustConfig): Promise<CreateCustomerAccountResponse>;
139
116
  /**
package/lib/services/customer-account/index.js CHANGED
@@ -88,7 +88,7 @@ async function getCustomerAccountV2(pageable) {
88
88
  *
89
89
  * This function allows the creation of a new customer account with relevant details including addresses, user information, and custom fields.
90
90
  *
91
- * 🛠 **Endpoint**: `POST /v1/shop/customer-accounts`
91
+ * 🛠 **Endpoint**: `POST /v1/shop/customer-accounts` [ACCOUNT-100]
92
92
  *
93
93
  * | Parameter | Type | Required | Description |
94
94
  * |-----------------------------------|--------------------------------|----------|-------------|
@@ -98,82 +98,59 @@ async function getCustomerAccountV2(pageable) {
98
98
  * | `customFieldValues` | `object[]` | ✅ | List of custom fields with their `customFieldId` and `customFieldValue`. |
99
99
  * | `customerTagList` | `string[]` | ✅ | List of customer tags. |
100
100
  * | `fromFO` | `boolean` | ✅ | Flag indicating if the account is created from the front-office (FO). |
101
- * | `legalUser` | `object[]` | ✅ | Information about the legal user including `birthday`, `countryOfResidence`, `email`, `firstName`, `lastName`, and `nationality`. |
102
-
101
+ * | `legalUser` | `object` | ✅ | Information about the legal user including `birthday`, `countryOfResidence`, `email`, `firstName`, `lastName`, and `nationality`. |
102
+ *
103
103
  * 📤 **Returns**:
104
104
  * A `Promise<CreateCustomerAccountResponse>` containing the details of the created customer account.
105
105
  *
106
106
  * 🛠 **Example usage**:
107
107
  * ```ts
108
108
  * const response = await createCustomerAccount({
109
- * createAddressRequests: [
110
- * {
111
- * additionalAddress: "string",
112
- * address: "string",
113
- * billing: true,
114
- * city: "string",
115
- * company: "string",
116
- * country: "string",
117
- * externalId: "string",
118
- * fullName: "string",
119
- * id: "string",
120
- * label: "string",
121
- * phone: "string",
122
- * shipping: true,
123
- * state: "string",
124
- * zipcode: "string"
125
- * }
126
- * ],
127
- * createCustomerUserRequest: {
128
- * civility: "MR",
129
- * email: "string",
130
- * customFieldValues: [
131
- * {
132
- * customFieldId: 'string',
133
- * customFieldValue: 'string'
134
- * }
135
- * ],
136
- * externalId: "string",
137
- * firstName: "string",
138
- * groups: ["group1", "group2"],
139
- * lastName: "string",
140
- * mainOrganisationsId: "orgId",
141
- * mainSubOrganisationsId: "subOrgId",
142
- * organisationsIds: ['orgId1', 'orgId2'],
143
- * password: "password123",
144
- * phone: "123456789",
145
- * subOrganisationsIds: ['subOrgId1', 'subOrgId2']
146
- * },
147
- * createObjectCustomerAccountRequest: {
148
- * accountManager: "string",
149
- * businessRegistrationNumber: "string",
150
- * companyRegistrationName: "string",
151
- * externalId: "string",
152
- * name: "string",
153
- * vatNumber: "string",
154
- * website: "string"
155
- * },
156
- * customFieldValues: [
157
- * {
158
- * customFieldId: "string",
159
- * customFieldValue: "value"
160
- * }
161
- * ],
162
- * customerTagList: ["tag1", "tag2"],
163
- * fromFO: true,
164
- * legalUser: [
165
- * {
166
- * birthday: "2024-12-11T09:46:27.656Z",
167
- * countryOfResidence: "FR",
168
- * email: "user@example.com",
169
- * firstName: "John",
170
- * id: "userId",
171
- * lastName: "Doe",
172
- * nationality: "FR"
173
- * }
174
- * ],
109
+ * createAddressRequests: [
110
+ * {
111
+ * address: "123 Main Street",
112
+ * city: "Paris",
113
+ * country: "FR",
114
+ * billing: true,
115
+ * shipping: true,
116
+ * fullName: "John Doe",
117
+ * zipcode: "75001"
118
+ * }
119
+ * ],
120
+ * createCustomerUserRequest: {
121
+ * email: "john.doe@example.com",
122
+ * firstName: "John",
123
+ * lastName: "Doe",
124
+ * password: "securePassword123",
125
+ * phone: "+33123456789"
126
+ * },
127
+ * createObjectCustomerAccountRequest: {
128
+ * name: "Acme Corporation",
129
+ * externalId: "acme-corp-001",
130
+ * vatNumber: "FR12345678901"
131
+ * },
132
+ * customFieldValues: [
133
+ * {
134
+ * customFieldId: "industry",
135
+ * customFieldValue: "technology"
136
+ * }
137
+ * ],
138
+ * customerTagList: ["premium", "enterprise"],
139
+ * fromFO: true,
140
+ * legalUser: {
141
+ * birthday: "1990-01-01T00:00:00.000Z",
142
+ * countryOfResidence: "FR",
143
+ * email: "john.doe@example.com",
144
+ * firstName: "John",
145
+ * lastName: "Doe",
146
+ * nationality: "FR"
147
+ * }
175
148
  * });
176
149
  * ```
150
+ *
151
+ * @param {CreateCustomerAccountParameters} params - The parameters for creating a customer account
152
+ * @throws {Error} If required parameters are missing
153
+ * @returns {Promise<CreateCustomerAccountResponse>} A promise resolving to the response containing the created customer account
177
154
  */
178
155
  async function createCustomerAccount({ createAddressRequests, createCustomerUserRequest, createObjectCustomerAccountRequest, customFieldValues, customerTagList, fromFO, legalUser, ...config }) {
179
156
  (0, parameters_validation_1.required)({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@djust-b2b/djust-front-sdk",
3
- "version": "2.2.0",
3
+ "version": "2.4.0",
4
4
  "description": "DJUST Front SDK is a versatile JavaScript Software Development Kit (SDK)",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",