@djust-b2b/djust-front-sdk 1.22.2 → 1.23.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 (112) hide show
  1. package/README.md +41 -10
  2. package/lib/{src/helpers → helpers}/parameters-validation.js +2 -2
  3. package/lib/{src/index.d.ts → index.d.ts} +18 -31
  4. package/lib/{src/index.js → index.js} +1 -2
  5. package/lib/{src/interfaces → interfaces}/models/common.d.ts +2 -2
  6. package/lib/{src/interfaces → interfaces}/models/customer-user.d.ts +1 -1
  7. package/lib/{src/interfaces → interfaces}/models/order.d.ts +90 -3
  8. package/lib/{src/services → services}/auth/definitions.requests.js +3 -0
  9. package/lib/{src/services → services}/cart/index.d.ts +2 -2
  10. package/lib/{src/services → services}/cart/index.js +2 -2
  11. package/lib/{src/services → services}/commercial-order/definitions.d.ts +33 -2
  12. package/lib/{src/services → services}/commercial-order/index.d.ts +167 -1
  13. package/lib/{src/services → services}/commercial-order/index.js +225 -4
  14. package/lib/{src/services → services}/customer-account/definitions.d.ts +14 -1
  15. package/lib/{src/services → services}/customer-account/index.d.ts +28 -2
  16. package/lib/{src/services → services}/customer-account/index.js +38 -0
  17. package/lib/{src/services → services}/customer-user/definitions.d.ts +1 -1
  18. package/lib/{src/services → services}/logistic-order/definitions.d.ts +94 -4
  19. package/lib/{src/services → services}/logistic-order/index.d.ts +423 -9
  20. package/lib/{src/services → services}/logistic-order/index.js +534 -8
  21. package/lib/{src/services → services}/navigation-category/definitions.d.ts +0 -3
  22. package/lib/{src/services → services}/product/definitions.d.ts +1 -2
  23. package/lib/{src/services → services}/product-variant/definitions.d.ts +1 -2
  24. package/lib/{src/settings → settings}/fetch-instance.d.ts +2 -3
  25. package/lib/{src/settings → settings}/fetch-instance.js +67 -30
  26. package/package.json +5 -6
  27. package/lib/instrument.d.ts +0 -2
  28. package/lib/instrument.js +0 -33
  29. /package/lib/{src/helpers → helpers}/parameters-validation.d.ts +0 -0
  30. /package/lib/{src/helpers → helpers}/utils.d.ts +0 -0
  31. /package/lib/{src/helpers → helpers}/utils.js +0 -0
  32. /package/lib/{src/interfaces → interfaces}/index.d.ts +0 -0
  33. /package/lib/{src/interfaces → interfaces}/index.js +0 -0
  34. /package/lib/{src/interfaces → interfaces}/models/address.d.ts +0 -0
  35. /package/lib/{src/interfaces → interfaces}/models/address.js +0 -0
  36. /package/lib/{src/interfaces → interfaces}/models/attribute.d.ts +0 -0
  37. /package/lib/{src/interfaces → interfaces}/models/attribute.js +0 -0
  38. /package/lib/{src/interfaces → interfaces}/models/auth.d.ts +0 -0
  39. /package/lib/{src/interfaces → interfaces}/models/auth.js +0 -0
  40. /package/lib/{src/interfaces → interfaces}/models/buying-list.d.ts +0 -0
  41. /package/lib/{src/interfaces → interfaces}/models/buying-list.js +0 -0
  42. /package/lib/{src/interfaces → interfaces}/models/cart.d.ts +0 -0
  43. /package/lib/{src/interfaces → interfaces}/models/cart.js +0 -0
  44. /package/lib/{src/interfaces → interfaces}/models/common.js +0 -0
  45. /package/lib/{src/interfaces → interfaces}/models/custom-field.d.ts +0 -0
  46. /package/lib/{src/interfaces → interfaces}/models/custom-field.js +0 -0
  47. /package/lib/{src/interfaces → interfaces}/models/customer-account.d.ts +0 -0
  48. /package/lib/{src/interfaces → interfaces}/models/customer-account.js +0 -0
  49. /package/lib/{src/interfaces → interfaces}/models/customer-organisation.d.ts +0 -0
  50. /package/lib/{src/interfaces → interfaces}/models/customer-organisation.js +0 -0
  51. /package/lib/{src/interfaces → interfaces}/models/customer-user.js +0 -0
  52. /package/lib/{src/interfaces → interfaces}/models/incident.d.ts +0 -0
  53. /package/lib/{src/interfaces → interfaces}/models/incident.js +0 -0
  54. /package/lib/{src/interfaces → interfaces}/models/navigation-category.d.ts +0 -0
  55. /package/lib/{src/interfaces → interfaces}/models/navigation-category.js +0 -0
  56. /package/lib/{src/interfaces → interfaces}/models/offer.d.ts +0 -0
  57. /package/lib/{src/interfaces → interfaces}/models/offer.js +0 -0
  58. /package/lib/{src/interfaces → interfaces}/models/order.js +0 -0
  59. /package/lib/{src/interfaces → interfaces}/models/payment.d.ts +0 -0
  60. /package/lib/{src/interfaces → interfaces}/models/payment.js +0 -0
  61. /package/lib/{src/interfaces → interfaces}/models/price.d.ts +0 -0
  62. /package/lib/{src/interfaces → interfaces}/models/price.js +0 -0
  63. /package/lib/{src/interfaces → interfaces}/models/product.d.ts +0 -0
  64. /package/lib/{src/interfaces → interfaces}/models/product.js +0 -0
  65. /package/lib/{src/interfaces → interfaces}/models/quote.d.ts +0 -0
  66. /package/lib/{src/interfaces → interfaces}/models/quote.js +0 -0
  67. /package/lib/{src/interfaces → interfaces}/models/searchProduct.d.ts +0 -0
  68. /package/lib/{src/interfaces → interfaces}/models/searchProduct.js +0 -0
  69. /package/lib/{src/interfaces → interfaces}/models/supplier.d.ts +0 -0
  70. /package/lib/{src/interfaces → interfaces}/models/supplier.js +0 -0
  71. /package/lib/{src/services → services}/auth/definitions.d.ts +0 -0
  72. /package/lib/{src/services → services}/auth/definitions.js +0 -0
  73. /package/lib/{src/services → services}/auth/definitions.requests.d.ts +0 -0
  74. /package/lib/{src/services → services}/auth/index.d.ts +0 -0
  75. /package/lib/{src/services → services}/auth/index.js +0 -0
  76. /package/lib/{src/services → services}/buying-list/definitions.d.ts +0 -0
  77. /package/lib/{src/services → services}/buying-list/definitions.js +0 -0
  78. /package/lib/{src/services → services}/buying-list/index.d.ts +0 -0
  79. /package/lib/{src/services → services}/buying-list/index.js +0 -0
  80. /package/lib/{src/services → services}/cart/definitions.d.ts +0 -0
  81. /package/lib/{src/services → services}/cart/definitions.js +0 -0
  82. /package/lib/{src/services → services}/commercial-order/definitions.js +0 -0
  83. /package/lib/{src/services → services}/custom-field/definitions.d.ts +0 -0
  84. /package/lib/{src/services → services}/custom-field/definitions.js +0 -0
  85. /package/lib/{src/services → services}/custom-field/index.d.ts +0 -0
  86. /package/lib/{src/services → services}/custom-field/index.js +0 -0
  87. /package/lib/{src/services → services}/customer-account/definitions.js +0 -0
  88. /package/lib/{src/services → services}/customer-user/definitions.js +0 -0
  89. /package/lib/{src/services → services}/customer-user/index.d.ts +0 -0
  90. /package/lib/{src/services → services}/customer-user/index.js +0 -0
  91. /package/lib/{src/services → services}/incident/definitions.d.ts +0 -0
  92. /package/lib/{src/services → services}/incident/definitions.js +0 -0
  93. /package/lib/{src/services → services}/incident/index.d.ts +0 -0
  94. /package/lib/{src/services → services}/incident/index.js +0 -0
  95. /package/lib/{src/services → services}/logistic-order/definitions.js +0 -0
  96. /package/lib/{src/services → services}/navigation-category/definitions.js +0 -0
  97. /package/lib/{src/services → services}/navigation-category/index.d.ts +0 -0
  98. /package/lib/{src/services → services}/navigation-category/index.js +0 -0
  99. /package/lib/{src/services → services}/product/definitions.js +0 -0
  100. /package/lib/{src/services → services}/product/index.d.ts +0 -0
  101. /package/lib/{src/services → services}/product/index.js +0 -0
  102. /package/lib/{src/services → services}/product-variant/definitions.js +0 -0
  103. /package/lib/{src/services → services}/product-variant/index.d.ts +0 -0
  104. /package/lib/{src/services → services}/product-variant/index.js +0 -0
  105. /package/lib/{src/services → services}/quote/definitions.d.ts +0 -0
  106. /package/lib/{src/services → services}/quote/definitions.js +0 -0
  107. /package/lib/{src/services → services}/quote/index.d.ts +0 -0
  108. /package/lib/{src/services → services}/quote/index.js +0 -0
  109. /package/lib/{src/services → services}/supplier/definitions.d.ts +0 -0
  110. /package/lib/{src/services → services}/supplier/definitions.js +0 -0
  111. /package/lib/{src/services → services}/supplier/index.d.ts +0 -0
  112. /package/lib/{src/services → services}/supplier/index.js +0 -0
@@ -1,5 +1,6 @@
1
- import { AddLogisticOrderReviewParameters, AddLogisticOrderReviewResponse, ApproveLogisticOrderParameters, ApproveLogisticOrderResponse, CancelLogisticOrderParameters, CancelLogisticOrderResponse, ConfirmLogisticOrderReceptionParameters, ConfirmLogisticOrderReceptionResponse, CreateLogisticOrderParameters, CreateLogisticOrderThreadParameters, CreateLogisticOrderThreadResponse, DisapproveLogisticOrderParameters, DisapproveLogisticOrderResponse, GetLogisticOrderAccountingDocumentsParameters, GetLogisticOrderAccountingDocumentsResponse, GetLogisticOrderAccountingDocumentUrlParameters, GetLogisticOrderApproversParameters, GetLogisticOrderApproversResponse, GetLogisticOrderCustomFieldsParameters, GetLogisticOrderCustomFieldsResponse, GetLogisticOrderDocumentsParameters, GetLogisticOrderDocumentsResponse, GetLogisticOrderDocumentUrlParameters, GetLogisticOrderLineCustomFieldsParameters, GetLogisticOrderLineCustomFieldsResponse, GetLogisticOrderLinesParameters, GetLogisticOrderLinesResponse, GetLogisticOrderParameters, GetLogisticOrderResponse, GetLogisticOrderReviewParameters, GetLogisticOrderReviewResponse, GetLogisticOrderShippingAddressParameters, GetLogisticOrderShippingAddressResponse, GetLogisticOrdersParameters, GetLogisticOrdersResponse, GetThreadReasonTypesResponse, GetThreadSubReasonsParameters, GetThreadSubReasonsResponse, UpdateLogisticOrderBillingInformationParameters, UpdateLogisticOrderCustomFieldsParameters, UpdateLogisticOrderCustomFieldsResponse, UpdateLogisticOrderLineCustomFieldsParameters, UpdateLogisticOrderLineCustomFieldsResponse, UpdateLogisticOrderShippingAddressParameters, UpdateLogisticOrderShippingInformationParameters, UpdateLogisticOrderShippingTypeParameters, UpdateOnHoldLogisticOrderLineParameters, UpdateOnHoldLogisticOrderLinesParameters, UpdateOnHoldLogisticOrderLinesResponse } from "./definitions";
1
+ import { AddLogisticOrderReviewParameters, AddLogisticOrderReviewResponse, ApproveLogisticOrderParameters, ApproveLogisticOrderResponse, CancelLogisticOrderParameters, CancelLogisticOrderResponse, ConfirmLogisticOrderReceptionParameters, ConfirmLogisticOrderReceptionResponse, CreateLogisticOrderParameters, CreateLogisticOrderThreadParameters, GetPaginatedLogisticOrdersParameters, GetPaginatedLogisticOrdersResponse, CreateLogisticOrderThreadResponse, DisapproveLogisticOrderParameters, DisapproveLogisticOrderResponse, GetLogisticOrderAccountingDocumentsParameters, GetLogisticOrderAccountingDocumentsResponse, GetLogisticOrderAccountingDocumentUrlParameters, GetLogisticOrderApproversParameters, GetLogisticOrderApproversResponse, GetLogisticOrderCustomFieldsParameters, GetLogisticOrderCustomFieldsResponse, GetLogisticOrderDocumentsParameters, GetLogisticOrderDocumentsResponse, GetLogisticOrderDocumentUrlParameters, GetLogisticOrderLineCustomFieldsParameters, GetLogisticOrderLineCustomFieldsResponse, GetLogisticOrderLinesParameters, GetLogisticOrderLinesResponse, GetLogisticOrderParameters, GetLogisticOrderResponse, GetLogisticOrderReviewParameters, GetLogisticOrderReviewResponse, GetLogisticOrderShippingAddressParameters, GetLogisticOrderShippingAddressResponse, GetLogisticOrdersParameters, GetLogisticOrdersResponse, GetThreadReasonTypesResponse, GetThreadSubReasonsParameters, GetThreadSubReasonsResponse, UpdateLogisticOrderBillingInformationParameters, UpdateLogisticOrderCustomFieldsParameters, UpdateLogisticOrderCustomFieldsResponse, UpdateLogisticOrderLineCustomFieldsParameters, UpdateLogisticOrderLineCustomFieldsResponse, UpdateLogisticOrderShippingAddressParameters, UpdateLogisticOrderShippingInformationParameters, UpdateLogisticOrderShippingTypeParameters, UpdateOnHoldLogisticOrderLineParameters, UpdateOnHoldLogisticOrderLinesParameters, UpdateOnHoldLogisticOrderLinesResponse, CreateLogisticOrderIncidentThreadsParams, CreateLogisticOrderIncidentThreadsResponse, GetLogisticOrderIncidentThreadParams, GetLogisticOrderIncidentThreadResponse, CreateLogisticOrderIncidentThreadMessagesParams, CreateLogisticOrderIncidentThreadMessagesResponse, UpdateLogisticOrderIncidentThreadMessageParams, GetLogisticOrderThreadsParams, GetLogisticOrderThreadsResponse, CreateLogisticOrderThreadParametersV2, CreateLogisticOrderThreadResponseV2, GetLogisticOrderThreadParams, GetLogisticOrderThreadResponse, CreateLogisticOrderThreadMessagesParams, CreateLogisticOrderThreadMessagesResponse, UpdateLogisticOrderThreadMessageParams } from "./definitions";
2
2
  /**
3
+ * @deprecated
3
4
  * 🚚 Gets logistic orders.
4
5
  *
5
6
  * This function retrieves all logistic orders. The parameter locale is mandatory and validated
@@ -28,12 +29,88 @@ import { AddLogisticOrderReviewParameters, AddLogisticOrderReviewResponse, Appro
28
29
  * locale: "fr",
29
30
  * });
30
31
  * ```
31
- *
32
32
  * @param {GetLogisticOrdersParameters} params - The parameters for the request.
33
33
  * @throws {Error} If `locale` is missing.
34
34
  * @returns {Promise<GetLogisticOrdersResponse>} A promise resolving to the response containing page object.
35
35
  */
36
36
  export declare function getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, nbPreviewLines, page, size, sort, }: GetLogisticOrdersParameters): Promise<GetLogisticOrdersResponse>;
37
+ /**
38
+ * 🚚 Get paginated and filtered Order logistics.
39
+ *
40
+ * 🛠 **Endpoint**: `POST /v1/shop/logistic-orders` [ORDER-550]
41
+ *
42
+ * | Parameter | Type | Required | Description |
43
+ * |-----------------------------------------|----------------------------|-----------|--------------------------------------------------------|
44
+ * | `page` | `number` | ❌ | Current Page |
45
+ * | `size` | `number` | ❌ | The size of the page to be returned |
46
+ * | `sort` | `string` | ❌ | Sorting criteria in the format: property,(asc|desc) |
47
+ * | `nbPreviewLines` | `number` | ❌ | The number of lines to display in the logistic order. |
48
+ * | `accountCustomFieldValueCriteria` | `CustomFieldValueObject[]` | ❌ | Account custom field value criteria |
49
+ * | `approvalIds` | `string[]` | ❌ | Approval IDs |
50
+ * | `connectedUserOnly` | `boolean` | ❌ | Connected user only |
51
+ * | `creationDateFrom` | `string` | ❌ | Creation date from |
52
+ * | `creationDateTo` | `string` | ❌ | Creation date to |
53
+ * | `customerAccountIds` | `string[]` | ❌ | Customer account IDs |
54
+ * | `incident` | `boolean` | ❌ | Incident |
55
+ * | `locale` | `string` | ✅ | Locale |
56
+ * | `logisticStatus` | `string[]` | ❌ | Logistic status |
57
+ * | `offerCustomFieldValueCriteria` | `CustomFieldValueObject[]` | ❌ | Offer custom field value criteria |
58
+ * | `orderLogisticCustomFieldValueCriteria` | `CustomFieldValueObject[]` | ❌ | Order logistic custom field value criteria |
59
+ * | `paymentOptions` | `string[]` | ❌ | Payment options |
60
+ * | `supplierIds` | `string[]` | ❌ | Supplier IDs |
61
+ * | `updateDateFrom` | `string` | ❌ | Update date from |
62
+ * | `updateDateTo` | `string` | ❌ | Update date to |
63
+ *
64
+ * 📤 **Returns**:
65
+ * A `Promise` resolving to a `GetPaginatedLogisticOrdersResponse`.
66
+ *
67
+ * 🛠 **Example usage**:
68
+ * ```ts
69
+ * await logisticOrdersPaginatedList({
70
+ * 1,
71
+ * 10,
72
+ * 'asc|desc',
73
+ * 20,
74
+ * {
75
+ * "accountCustomFieldValueCriteria": [
76
+ * {
77
+ * "customFieldId": "string",
78
+ * "customFieldValue": "string"
79
+ * }
80
+ * ],
81
+ * "approvalIds": [ "string" ],
82
+ * "connectedUserOnly": true,
83
+ * "creationDateFrom": "2025-03-26T15:38:31.964Z",
84
+ * "creationDateTo": "2025-03-26T15:38:31.964Z",
85
+ * "incident": true,
86
+ * "locale": "string",
87
+ * "logisticStatus": [ "CREATING" ],
88
+ * "offerCustomFieldValueCriteria": [
89
+ * {
90
+ * "customFieldId": "string",
91
+ * "customFieldValue": "string"
92
+ * }
93
+ * ],
94
+ * "customerAccountIds": [ "string" ],
95
+ * "orderLogisticCustomFieldValueCriteria": [
96
+ * {
97
+ * "customFieldId": "string",
98
+ * "customFieldValue": "string"
99
+ * }
100
+ * ],
101
+ * "paymentOptions": [ "BANK_WIRE" ],
102
+ * "supplierIds": [ "string" ],
103
+ * "updateDateFrom": "2025-03-26T15:38:31.964Z",
104
+ * "updateDateTo": "2025-03-26T15:38:31.964Z"
105
+ * }
106
+ * });
107
+ * ```
108
+ *
109
+ * @param {GetPaginatedLogisticOrdersParameters} params - The parameters for the request.
110
+ * @throws {Error} If `locale` is missing.
111
+ * @returns {Promise<GetPaginatedLogisticOrdersResponse>}
112
+ */
113
+ export declare function logisticOrdersPaginatedList({ page, size, sort, nbPreviewLines, accountCustomFieldValueCriteria, approvalIds, connectedUserOnly, creationDateFrom, creationDateTo, customerAccountIds, incident, locale, logisticStatus, offerCustomFieldValueCriteria, orderLogisticCustomFieldValueCriteria, paymentOptions, supplierIds, updateDateFrom, updateDateTo, }: GetPaginatedLogisticOrdersParameters): Promise<GetPaginatedLogisticOrdersResponse>;
37
114
  /**
38
115
  * 🚚 Get logistic order's custom fields.
39
116
  *
@@ -741,14 +818,14 @@ export declare function updateLogisticOrderShippingType({ orderId, shippingType,
741
818
  * the `orderId`. This parameter, as well as the `lineId`, the `message` and the `reasonCode`, is mandatory and validated
742
819
  * before the request is executed.
743
820
  *
744
- * 🛠 **Endpoint**: `POST /v1/shop/logistic-orders/${orderId}/threads [THREAD-101]`
821
+ * 🛠 **Endpoint**: `POST /v1/shop/logistic-orders/${orderId}/threads [THREAD-100]`
745
822
  *
746
823
  * | Parameter | Type | Required | Description |
747
824
  * |-------------------|---------------------------------|------------|------------------------------------------|
748
825
  * | `orderId` | `string` | ✅ | The ID of the logistic order for which you want to create a thread. |
749
- * | `lineId` | `string` | | The ID of the logistic order line involved in the thread. |
750
- * | `message` | `string` | | A message to add comments on the thread. |
751
- * | `reasonCode` | `string` | | The code indentifying the type of thread. |
826
+ * | `lineId` | `string` | | The ID of the logistic order line involved in the thread. |
827
+ * | `message` | `string` | | A message to add comments on the thread. |
828
+ * | `reasonCode` | `string` | | The code indentifying the type of thread. |
752
829
  *
753
830
  * 📤 **Returns**:
754
831
  * A `Promise` resolving to a `CreateLogisticOrderThreadResponse` object when the thread is created.
@@ -764,10 +841,347 @@ export declare function updateLogisticOrderShippingType({ orderId, shippingType,
764
841
  * ```
765
842
  *
766
843
  * @param {CreateLogisticOrderThreadParameters} params - The parameters for the request.
767
- * @throws {Error} If `orderId`, `lineId`, `message` or `reasonCode` is missing.
844
+ * @throws {Error} If `orderId` is missing.
768
845
  * @returns {Promise<CreateLogisticOrderThreadResponse>} A promise resolving when the thread is created.
769
846
  */
770
847
  export declare function createLogisticOrderThread({ orderId, lineId, message, reasonCode, }: CreateLogisticOrderThreadParameters): Promise<CreateLogisticOrderThreadResponse>;
848
+ /**
849
+ * 🚚 Creates a thread on a specific logistic order V2.
850
+ *
851
+ * This function creates a thread on a specific logistic order, identified by (Version 2)
852
+ * the `logisticOrderId` and `reasonCode`, are mandatory and validated
853
+ * before the request is executed.
854
+ *
855
+ * 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/threads [THREAD-101]`
856
+ *
857
+ * | Parameter | Type | Required | Description |
858
+ * |-------------------|---------------------------------|------------|------------------------------------------|
859
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order for which you want to create a thread. |
860
+ * | `idType` | `IdType` | ❌ | The type of the id. |
861
+ * | `message` | `string` | ❌ | A message to add comments on the thread. |
862
+ * | `name` | `string` | ❌ | The name of the thread. |
863
+ * | `reasonCode` | `string` | ✅ | The code indentifying the type of thread. |
864
+ *
865
+ * 📤 **Returns**:
866
+ * A `Promise` resolving to a `CreateLogisticOrderThreadResponseV2` object when the threads are created.
867
+ *
868
+ * 🛠 **Example usage**:
869
+ * ```ts
870
+ * await createLogisticOrderThreadV2({
871
+ * logisticOrderId: "logisticOrder1",
872
+ * idType: "DJUST_ID",
873
+ * name: "This is a test thread",
874
+ * message: "This is a message",
875
+ * reasonCode: "REFUND"
876
+ * });
877
+ * ```
878
+ *
879
+ * @param {CreateLogisticOrderThreadParametersV2} params - The parameters for the request.
880
+ * @throws {Error} If `logisticOrderId`, `reasonCode` is missing.
881
+ * @returns {Promise<CreateLogisticOrderThreadResponseV2>} A promise resolving when the thread is created.
882
+ */
883
+ export declare function createLogisticOrderThreadV2({ logisticOrderId, idType, message, reasonCode, }: CreateLogisticOrderThreadParametersV2): Promise<CreateLogisticOrderThreadResponseV2>;
884
+ /**
885
+ * 🚚 Get order logistic threads.
886
+ *
887
+ * This function return the list of threads related to a specific logistic order.
888
+ *
889
+ * 🛠 **Endpoint**: `GET /v2/shop/logistic-orders/${logisticOrderId}/threads [ORDER-558]`
890
+ *
891
+ * | Parameter | Type | Required | Description |
892
+ * |-------------------|-------------|----------|------------------------------------------------------------------------|
893
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
894
+ * | `pageable.page` | `number` | ❌ | The page number |
895
+ * | `pageable.size` | `number` | ❌ | The number of items per page. |
896
+ *
897
+ * 📤 **Returns**:
898
+ * A `Promise` resolving to a `GetLogisticOrderThreadsResponse`.
899
+ *
900
+ * 🛠 **Example usage**:
901
+ * ```ts
902
+ * const threads = await getLogisticOrderThreads({
903
+ * logisticOrderId: "logisticOrder1",
904
+ * pageable: { page: 1, size: 10 },
905
+ * });
906
+ * ```
907
+ *
908
+ * @param {GetLogisticOrderThreadsParams} params - The parameters for the request.
909
+ * @throws {Error} If `logisticOrderId` is missing.
910
+ * @returns {Promise<GetLogisticOrderThreadsResponse>} A promise resolving when the thread is created.
911
+ */
912
+ export declare function getLogisticOrderThreads({ logisticOrderId, pageable, }: GetLogisticOrderThreadsParams): Promise<GetLogisticOrderThreadsResponse>;
913
+ /**
914
+ * 🚚 Get a logistic order thread.
915
+ *
916
+ * This function retrieves a specific logistic order thread, identified by
917
+ * the `logisticOrderId` and `threadId`. Both parameters are mandatory and validated
918
+ * before the request is executed.
919
+ *
920
+ * 🛠 **Endpoint**: `GET /v2/shop/logistic-orders/${logisticOrderId}/threads/${threadId} [ORDER-509]`
921
+ *
922
+ * | Parameter | Type | Required | Description |
923
+ * |-------------------|-------------|----------|------------------------------------------------------------------------|
924
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
925
+ * | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
926
+ *
927
+ * 📤 **Returns**:
928
+ * A `Promise` resolving to a `GetLogisticOrderThreadResponse`.
929
+ *
930
+ * 🛠 **Example usage**:
931
+ * ```ts
932
+ * const threads = await getLogisticOrderThread({
933
+ * logisticOrderId: "logisticOrder1",
934
+ * threadId: "thread1",
935
+ * });
936
+ * ```
937
+ *
938
+ * @param {GetLogisticOrderThreadsParams} params - The parameters for the request.
939
+ * @throws {Error} If `logisticOrderId` or `threadId` is missing.
940
+ * @returns {Promise<GetLogisticOrderThreadResponse>} A promise resolving when the thread is found.
941
+ */
942
+ export declare function getLogisticOrderThread({ logisticOrderId, threadId, }: GetLogisticOrderThreadParams): Promise<GetLogisticOrderThreadResponse>;
943
+ /**
944
+ * 🚚 Create messages for a specific logistic order thread.
945
+ * This function retrieves a specific logistic order thread, identified by
946
+ * the `logisticOrderId` and `threadId`. Both parameters are mandatory and validated
947
+ * before the request is executed.
948
+ *
949
+ * 🛠 **Endpoint**: `GET /v2/shop/logistic-orders/${logisticOrderId}/threads/${threadId}/messages [ORDER-217]`
950
+ *
951
+ * | Parameter | Type | Required | Description |
952
+ * |-------------------|---------------------------------------------------------|----------|------------------------------------------------------------------------|
953
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
954
+ * | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
955
+ * | `body` | `string` | ❌ | The body of the message to be added to the thread. |
956
+ * | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads messages |
957
+ *
958
+ * 📤 **Returns**:
959
+ * A `Promise` resolving to a `CreateLogisticOrderThreadMessagesResponse`.
960
+ *
961
+ * 🛠 **Example usage**:
962
+ * ```ts
963
+ * const threads = await createOrderLogisticThreadMessages({
964
+ * logisticOrderId: "logisticOrder1",
965
+ * threadId: "thread1",
966
+ * body: "This is a message",
967
+ * customField: {
968
+ * customFieldValues: [{ customFieldId: "cf1", customFieldValue: "value1" }],
969
+ * idType: "EXTERNAL_ID",
970
+ * },
971
+ * });
972
+ * ```
973
+ *
974
+ * @param {GetLogisticOrderThreadsParams} params - The parameters for the request.
975
+ * @throws {Error} If `logisticOrderId` or `threadId` is missing.
976
+ * @returns {Promise<CreateLogisticOrderThreadMessagesResponse>} A promise resolving when the thread is found.
977
+ */
978
+ export declare function createOrderLogisticThreadMessages({ logisticOrderId, threadId, body, customField, }: CreateLogisticOrderThreadMessagesParams): Promise<CreateLogisticOrderThreadMessagesResponse>;
979
+ /**
980
+ * 🚚 Update messages for a specific logistic order thread.
981
+ *
982
+ * This function retrieves a specific logistic order thread, identified by
983
+ * the `logisticOrderId` and `threadId`. Both parameters are mandatory and validated
984
+ * before the request is executed.
985
+ *
986
+ * 🛠 **Endpoint**: `PATCH /v2/shop/logistic-orders/${logisticOrderId}/threads/${threadId}/messages/${messageId} [ORDER-216]`
987
+ *
988
+ * | Parameter | Type | Required | Description |
989
+ * |---------------------|-----------------------------|----------|------------------------------------------------------------------------|
990
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
991
+ * | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
992
+ * | `messageId` | `string` | ✅ | The ID of the message to be updated. |
993
+ * | `customFieldValues` | `CustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads messages |
994
+ * | `idType` | `IdType` | ❌ | The type of the id. |
995
+ *
996
+ * 📤 **Returns**:
997
+ * A `Promise` resolving when the message is updated.
998
+
999
+ *
1000
+ * 🛠 **Example usage**:
1001
+ * ```ts
1002
+ * const threads = await updateOrderLogisticThreadMessage({
1003
+ * logisticOrderId: "logisticOrder1",
1004
+ * threadId: "thread1",
1005
+ * body: "This is a message",
1006
+ * customField: {
1007
+ * customFieldValues: [{ customFieldId: "cf1", customFieldValue: "value1" }],
1008
+ * idType: "EXTERNAL_ID",
1009
+ * },
1010
+ * });
1011
+ * ```
1012
+ *
1013
+ * @param {GetLogisticOrderThreadsParams} params - The parameters for the request.
1014
+ * @throws {Error} If `logisticOrderId`, `threadId`, `messageId` is missing.
1015
+ * @returns {Promise<void>} A promise resolving when the message updated.
1016
+ */
1017
+ export declare function updateOrderLogisticThreadMessage({ logisticOrderId, threadId, messageId, customFieldValues, idType, }: UpdateLogisticOrderThreadMessageParams): Promise<void>;
1018
+ /**
1019
+ * 🚚 Creates a thread on a specific incident on a specific logistic order.
1020
+ *
1021
+ * This function creates a thread on a specific incident on a specific logistic order, identified by ``
1022
+ * `logisticOrderId`, incidentId, reasonCode, the parameters required and validated before the request is executed.
1023
+ *
1024
+ * 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads [ORDER-106]`
1025
+ *
1026
+ * | Parameter | Type | Required | Description |
1027
+ * |-------------------|---------------------------------------------------------|----------------------------|----------------------------------------------------------|
1028
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order |
1029
+ * | `incidentId` | `string` | ✅ | The ID of the incident |
1030
+ * | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads |
1031
+ * | `message` | `string` | ❌ | A message to add comments on the thread. |
1032
+ * | `name` | `string` | ❌ | The name of the thread |
1033
+ * | `reasonCode` | `string` | ✅ | The code indentifying the type of thread. |
1034
+ *
1035
+ * 📤 **Returns**:
1036
+ * A `Promise` resolving to a `CreateLogisticOrderIncidentThreadsResponse` object when the thread is created.
1037
+ *
1038
+ * 🛠 **Example usage**:
1039
+ * ```ts
1040
+ * await createLogisticOrderIncidentThreads({
1041
+ * logisticOrderId: "logisticOrder1",
1042
+ * incidentId: "logisticOrderLine1",
1043
+ * customField: [
1044
+ * {
1045
+ * customFieldValues: [
1046
+ * {
1047
+ * "customFieldId": "string",
1048
+ * "customFieldValue": "string",
1049
+ * }
1050
+ * ],
1051
+ * "idType": "DJUST_ID"
1052
+ * }
1053
+ * ],
1054
+ * message: "string",
1055
+ * name: "string",
1056
+ * reasonCode: "string"
1057
+ * });
1058
+ * ```
1059
+ *
1060
+ * @param {CreateLogisticOrderIncidentThreadsParams} params - The parameters for the request.
1061
+ * @throws {Error} If `logisticOrderId`, `incidentId`, `reasonCode` is missing.
1062
+ * @returns {Promise<CreateLogisticOrderIncidentThreadsResponse>} A promise resolving when the thread is created.
1063
+ */
1064
+ export declare function createLogisticOrderIncidentThreads({ logisticOrderId, incidentId, customField, message, name, reasonCode, }: CreateLogisticOrderIncidentThreadsParams): Promise<CreateLogisticOrderIncidentThreadsResponse>;
1065
+ /**
1066
+ * 🚚 Gets a specific thread of specific incident of a specific logistic order.
1067
+ *
1068
+ * This function retrieves a specific logistic order line's review, identified by
1069
+ * The `orderId`, `incidentId` and `threadId` parameters are mandatory and validated
1070
+ * before the request is executed.
1071
+ *
1072
+ * 🛠 **Endpoint**: `GET /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads/${threadId} [ORDER-510]`
1073
+ *
1074
+ * | Parameter | Type | Required | Description |
1075
+ * |-------------------|---------------------------------|------------|------------------------------------------------------------------------|
1076
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
1077
+ * | `incidentId` | `string` | ✅ | The ID of the incident of which you want to retrieve the review. |
1078
+ * | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
1079
+ *
1080
+ * 📤 **Returns**:
1081
+ * A `Promise` resolving to a single `GetLogisticOrderIncidentThreadResponse` object representing the review of the thread.
1082
+ *
1083
+ * 🛠 **Example usage**:
1084
+ * ```ts
1085
+ * const review = await getLogisticOrderIncidentThread({
1086
+ * orderId: "logisticOrder1",
1087
+ * incidentId: "logisticOrderLine1",
1088
+ * threadId: "thread1",
1089
+ * });
1090
+ * ```
1091
+ *
1092
+ * @param {GetLogisticOrderIncidentThreadParams} params - The parameters for the request.
1093
+ * @throws {Error} If `logisticOrderId`, or `incidentId`, or `threadId` is missing.
1094
+ * @returns {Promise<GetLogisticOrderIncidentThreadResponse>} A promise resolving to a response containing the review of the thread.
1095
+ */
1096
+ export declare function getLogisticOrderIncidentThread({ logisticOrderId, incidentId, threadId, }: GetLogisticOrderIncidentThreadParams): Promise<GetLogisticOrderIncidentThreadResponse>;
1097
+ /**
1098
+ * 🚚 Creates messages for a specific incident thread of a specific logistic order.
1099
+ *
1100
+ * This function creates a thread on a specific incident on a specific logistic order, identified by
1101
+ * `logisticOrderId`, incidentId, threadId parameters are required and validated before the request is executed.
1102
+ *
1103
+ * 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads/messages [ORDER-103]`
1104
+ *
1105
+ * | Parameter | Type | Required | Description |
1106
+ * |-------------------|---------------------------------------------------------|------------|------------------------------------------------------------------------|
1107
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to retrieve the review. |
1108
+ * | `incidentId` | `string` | ✅ | The ID of the incident of which you want to retrieve the review. |
1109
+ * | `threadId` | `string` | ✅ | The ID of the thread of which you want to retrieve the review. |
1110
+ * | `body` | `string` | ❌ | The body of the message to be added to the thread. |
1111
+ * | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to add to the created incident threads messages |
1112
+ *
1113
+ * 📤 **Returns**:
1114
+ * A `Promise` resolving to a `CreateLogisticOrderIncidentThreadMessagesResponse` object when the message is created.
1115
+ *
1116
+ * 🛠 **Example usage**:
1117
+ * ```ts
1118
+ * await createLogisticOrderIncidentThreadMessages({
1119
+ * logisticOrderId: "logisticOrder1",
1120
+ * incidentId: "logisticOrderLine1",
1121
+ * threadId: "thread1",
1122
+ * body: "This is a message",
1123
+ * customField: {
1124
+ * customFieldValues: [
1125
+ * {
1126
+ * "customFieldId": "string",
1127
+ * "customFieldValue": "string"
1128
+ * }
1129
+ * ],
1130
+ * idType: "EXTERNAL_ID",
1131
+ * },
1132
+ * });
1133
+ * ```
1134
+ *
1135
+ * @param {CreateLogisticOrderIncidentThreadsParams} params - The parameters for the request.
1136
+ * @throws {Error} If `logisticOrderId`, or `incidentId`, or `threadId` is missing.
1137
+ * @returns {Promise<CreateLogisticOrderIncidentThreadsResponse>} A promise resolving when the message is created for the logistic order incident thread.
1138
+ */
1139
+ export declare function createLogisticOrderIncidentThreadMessages({ logisticOrderId, incidentId, threadId, body, customField, }: CreateLogisticOrderIncidentThreadMessagesParams): Promise<CreateLogisticOrderIncidentThreadMessagesResponse>;
1140
+ /**
1141
+ * 🚚 Updadate a message for a specific incident thread of a specific logistic order.
1142
+ *
1143
+ * This function allow to update a message of a thread on a specific incident on a specific logistic order
1144
+ * `logisticOrderId`, incidentId, threadId, messageId parameters are required and validated before the request is executed.
1145
+ *
1146
+ * 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads/${threadId}/messages/${messageId} [ORDER-221]`
1147
+ *
1148
+ * | Parameter | Type | Required | Description |
1149
+ * |-------------------|---------------------------------------------------------|------------|----------------------------------------------------------------------|
1150
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order of which you want to update |
1151
+ * | `incidentId` | `string` | ✅ | The ID of the incident of which you want to update |
1152
+ * | `threadId` | `string` | ✅ | The ID of the thread of which you want to update |
1153
+ * | `messageId` | `string` | ✅ | The ID of the message of the thread to update. |
1154
+ * | `body` | `string` | ❌ | The body of the message to update |
1155
+ * | `customField` | `logisticOrderIncidentThreadsCustomFieldValueRequest[]` | ❌ | The custom fields to update to the created incident threads messages |
1156
+ *
1157
+ * 📤 **Returns**:
1158
+ * A `Promise` resolving when the message is updated.
1159
+ *
1160
+ * 🛠 **Example usage**:
1161
+ * ```ts
1162
+ * await updateLogisticOrderIncidentThreadMessage({
1163
+ * logisticOrderId: "logisticOrder1",
1164
+ * incidentId: "logisticOrderLine1",
1165
+ * threadId: "thread1",
1166
+ * messageId: "message1",
1167
+ * body: "string",
1168
+ * customField: {
1169
+ * customFieldValues: [
1170
+ * {
1171
+ * "customFieldId": "string",
1172
+ * "customFieldValue": "string"
1173
+ * }
1174
+ * ],
1175
+ * idType: "EXTERNAL_ID",
1176
+ * }
1177
+ * });
1178
+ * ```
1179
+ *
1180
+ * @param {CreateLogisticOrderIncidentThreadsParams} params - The parameters for the request.
1181
+ * @throws {Error} If `logisticOrderId`, `incidentId`, `threadId`, `messageId` is missing.
1182
+ * @returns {Promise<void>} A promise resolving when the message is updated.
1183
+ */
1184
+ export declare function updateLogisticOrderIncidentThreadMessage({ logisticOrderId, incidentId, threadId, messageId, customFieldValues, idType, }: UpdateLogisticOrderIncidentThreadMessageParams): Promise<void>;
771
1185
  /**
772
1186
  * 🚚 Gets a specific logistic order's review.
773
1187
  *
@@ -833,7 +1247,7 @@ export declare function addLogisticOrderReview({ orderId, comment, grade, }: Add
833
1247
  *
834
1248
  * This function retrieves all the thread reason types. No parameters for this request.
835
1249
  *
836
- * 🛠 **Endpoint**: `GET /v1/shop/threads/reason-types [ORDER-550]`
1250
+ * 🛠 **Endpoint**: `GET /v1/shop/threads/reason-types [THREAD-550]`
837
1251
  *
838
1252
  * 📤 **Returns**:
839
1253
  * A `Promise` resolving to a single `GetThreadReasonTypesResponse` object representing the array of reason types.
@@ -853,7 +1267,7 @@ export declare function getThreadReasonTypes(): Promise<GetThreadReasonTypesResp
853
1267
  * the `reasonType`. This parameter is mandatory and validated
854
1268
  * before the request is executed.
855
1269
  *
856
- * 🛠 **Endpoint**: `GET /v1/shop/threads/reason-types/${reasonType}/sub-reasons [ORDER-551]`
1270
+ * 🛠 **Endpoint**: `GET /v1/shop/threads/reason-types/${reasonType}/sub-reasons [THREAD-551]`
857
1271
  *
858
1272
  * | Parameter | Type | Required | Description |
859
1273
  * |-------------------|---------------------------------|------------|------------------------------------------|