@gofynd/fdk-client-javascript 3.3.5 → 3.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 (166) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
  4. package/sdk/application/Cart/CartApplicationClient.js +30 -30
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
  7. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  8. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  9. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  10. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
  14. package/sdk/application/Content/ContentApplicationClient.js +24 -24
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  17. package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
  18. package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
  20. package/sdk/application/Lead/LeadApplicationClient.js +5 -5
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +53 -9
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
  24. package/sdk/application/Order/OrderApplicationClient.js +12 -12
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
  26. package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  32. package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
  33. package/sdk/application/User/UserApplicationClient.d.ts +47 -47
  34. package/sdk/application/User/UserApplicationClient.js +47 -47
  35. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  36. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  37. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
  38. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
  39. package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
  40. package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
  41. package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
  42. package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
  43. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
  44. package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
  45. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
  46. package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
  47. package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
  48. package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
  49. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
  50. package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
  51. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
  52. package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
  53. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
  54. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
  55. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
  56. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
  57. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
  58. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
  59. package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
  60. package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
  61. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
  62. package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
  63. package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
  64. package/sdk/platform/Cart/CartPlatformModel.js +147 -1
  65. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
  66. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
  67. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
  68. package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
  69. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
  70. package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
  71. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
  72. package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
  73. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  74. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  75. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
  76. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
  77. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  78. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  79. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
  80. package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
  81. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
  82. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
  83. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
  84. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
  85. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
  86. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
  87. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
  88. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
  89. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
  90. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
  91. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
  92. package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
  93. package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
  94. package/sdk/platform/Content/ContentPlatformClient.js +40 -40
  95. package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
  96. package/sdk/platform/Content/ContentPlatformModel.js +1 -1
  97. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
  98. package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
  99. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
  100. package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
  101. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
  102. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
  103. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
  104. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  105. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  106. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  107. package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
  108. package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
  109. package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
  110. package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
  111. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
  112. package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
  113. package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
  114. package/sdk/platform/Order/OrderPlatformClient.js +58 -58
  115. package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
  116. package/sdk/platform/Order/OrderPlatformModel.js +28 -6
  117. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
  118. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
  119. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
  120. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
  121. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
  122. package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
  123. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
  124. package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
  125. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
  126. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
  127. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
  128. package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
  129. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
  130. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
  131. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
  132. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
  133. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
  134. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
  135. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
  136. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
  137. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
  138. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
  139. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  140. package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
  141. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
  142. package/sdk/platform/Share/SharePlatformModel.js +1 -1
  143. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
  144. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
  145. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  146. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  147. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
  148. package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
  149. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
  150. package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
  151. package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
  152. package/sdk/platform/User/UserPlatformModel.js +276 -7
  153. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
  154. package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
  155. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
  156. package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
  157. package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
  158. package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
  159. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  160. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  161. package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
  162. package/sdk/public/Content/ContentPublicClient.js +14 -14
  163. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  164. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  165. package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
  166. package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
@@ -26,7 +26,7 @@ class Order {
26
26
  *
27
27
  * @name getApplicationShipments
28
28
  * @summary: List sales channel shipments
29
- * @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
29
+ * @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getApplicationShipments/).
30
30
  */
31
31
  async getApplicationShipments(
32
32
  {
@@ -168,7 +168,7 @@ class Order {
168
168
  * Success response
169
169
  * @name getPlatformShipmentReasons
170
170
  * @summary: List shipment cancellation reasons
171
- * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
171
+ * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getPlatformShipmentReasons/).
172
172
  */
173
173
  async getPlatformShipmentReasons(
174
174
  { action, requestHeaders } = { requestHeaders: {} },
@@ -247,7 +247,7 @@ class Order {
247
247
  * @returns {Promise<OrderPlatformModel.RuleListResponseSchema>} - Success response
248
248
  * @name getRules
249
249
  * @summary: List of RMA rules based on the given input conditions.
250
- * @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with a specific company and application. These rules dictate the processes for handling returns, including actions, reasons, quality control (QC) types, and associated questions. The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRules/).
250
+ * @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with a specific company and application. These rules dictate the processes for handling returns, including actions, reasons, quality control (QC) types, and associated questions. The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getRules/).
251
251
  */
252
252
  async getRules(
253
253
  { body, requestHeaders } = { requestHeaders: {} },
@@ -326,7 +326,7 @@ class Order {
326
326
  * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
327
327
  * @name getShipmentBagReasons
328
328
  * @summary: Retrieve Reasons for Cancellation and Return journey
329
- * @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
329
+ * @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentBagReasons/).
330
330
  */
331
331
  async getShipmentBagReasons(
332
332
  { shipmentId, lineNumber, requestHeaders } = { requestHeaders: {} },
@@ -409,7 +409,7 @@ class Order {
409
409
  * @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
410
410
  * @name trackShipmentPlatform
411
411
  * @summary: Track shipment
412
- * @description: Track shipment by shipment Id for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
412
+ * @description: Track shipment by shipment Id for an application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/trackShipmentPlatform/).
413
413
  */
414
414
  async trackShipmentPlatform(
415
415
  { shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -10,7 +10,7 @@ declare class Order {
10
10
  * Success response
11
11
  * @name addStateManagerConfig
12
12
  * @summary: Allows esm config updation
13
- * @description: Update ESM config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/addStateManagerConfig/).
13
+ * @description: Update ESM config - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/addStateManagerConfig/).
14
14
  */
15
15
  addStateManagerConfig({ body, requestHeaders }?: OrderPlatformValidator.AddStateManagerConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>;
16
16
  /**
@@ -21,7 +21,7 @@ declare class Order {
21
21
  * Success response
22
22
  * @name attachOrderUser
23
23
  * @summary: Attach order to a user
24
- * @description: Attach an anonymous order to a customer based on OTP verification - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
24
+ * @description: Attach an anonymous order to a customer based on OTP verification - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/attachOrderUser/).
25
25
  */
26
26
  attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponseSchema>;
27
27
  /**
@@ -31,7 +31,7 @@ declare class Order {
31
31
  * @returns {Promise<OrderPlatformModel.BulkListingResponseSchema>} - Success response
32
32
  * @name bulkListing
33
33
  * @summary: Lists bulk operations
34
- * @description: Get list of bulk operation that is initiated and completed as per the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkListing/).
34
+ * @description: Get list of bulk operation that is initiated and completed as per the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/bulkListing/).
35
35
  */
36
36
  bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkListingResponseSchema>;
37
37
  /**
@@ -43,7 +43,7 @@ declare class Order {
43
43
  *
44
44
  * @name bulkStateTransistion
45
45
  * @summary: Upload bulk state transitions file
46
- * @description: Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkStateTransistion/).
46
+ * @description: Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/bulkStateTransistion/).
47
47
  */
48
48
  bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>;
49
49
  /**
@@ -53,7 +53,7 @@ declare class Order {
53
53
  * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
54
54
  * @name checkOrderStatus
55
55
  * @summary: Debug order
56
- * @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
56
+ * @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/checkOrderStatus/).
57
57
  */
58
58
  checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
59
59
  /**
@@ -65,7 +65,7 @@ declare class Order {
65
65
  *
66
66
  * @name createChannelConfig
67
67
  * @summary: Create channel configuration
68
- * @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
68
+ * @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createChannelConfig/).
69
69
  */
70
70
  createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>;
71
71
  /**
@@ -75,7 +75,7 @@ declare class Order {
75
75
  * @returns {Promise<OrderPlatformModel.CreateOrderResponseSchema>} - Success response
76
76
  * @name createOrder
77
77
  * @summary: Create order
78
- * @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
78
+ * @description: Creates an order - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
79
79
  */
80
80
  createOrder({ body, xOrderingSource, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponseSchema>;
81
81
  /**
@@ -85,7 +85,7 @@ declare class Order {
85
85
  * @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
86
86
  * @name dispatchManifests
87
87
  * @summary: Dispatch manifest
88
- * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
88
+ * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/dispatchManifests/).
89
89
  */
90
90
  dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
91
91
  /**
@@ -95,7 +95,7 @@ declare class Order {
95
95
  * @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
96
96
  * @name downloadBulkActionTemplate
97
97
  * @summary: Download bulk template
98
- * @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
98
+ * @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/downloadBulkActionTemplate/).
99
99
  */
100
100
  downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
101
101
  /**
@@ -107,7 +107,7 @@ declare class Order {
107
107
  *
108
108
  * @name downloadLanesReport
109
109
  * @summary: Download Lane report
110
- * @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
110
+ * @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/downloadLanesReport/).
111
111
  */
112
112
  downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>;
113
113
  /**
@@ -118,7 +118,7 @@ declare class Order {
118
118
  * Success response
119
119
  * @name eInvoiceRetry
120
120
  * @summary: Retry E-invoice
121
- * @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
121
+ * @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/eInvoiceRetry/).
122
122
  */
123
123
  eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>;
124
124
  /**
@@ -128,7 +128,7 @@ declare class Order {
128
128
  * @returns {Promise<OrderPlatformModel.FailedOrderLogDetails>} - Success response
129
129
  * @name failedOrderLogDetails
130
130
  * @summary: Get failed order log
131
- * @description: Get the exact error trace from the log Id provided in the failed order list API response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
131
+ * @description: Get the exact error trace from the log Id provided in the failed order list API response - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/failedOrderLogDetails/).
132
132
  */
133
133
  failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
134
134
  /**
@@ -138,7 +138,7 @@ declare class Order {
138
138
  * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
139
139
  * @name failedOrderLogs
140
140
  * @summary: List failed order logs
141
- * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
141
+ * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/failedOrderLogs/).
142
142
  */
143
143
  failedOrderLogs({ applicationId, pageNo, pageSize, searchType, searchValue, requestHeaders, }?: OrderPlatformValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
144
144
  /**
@@ -149,7 +149,7 @@ declare class Order {
149
149
  * Success response
150
150
  * @name fetchRefundModeConfig
151
151
  * @summary: List refund modes
152
- * @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
152
+ * @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/fetchRefundModeConfig/).
153
153
  */
154
154
  fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
155
155
  /**
@@ -160,7 +160,7 @@ declare class Order {
160
160
  * Success response
161
161
  * @name generateInvoiceID
162
162
  * @summary: Generate and attach invoice Id
163
- * @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
163
+ * @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/generateInvoiceID/).
164
164
  */
165
165
  generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>;
166
166
  /**
@@ -172,7 +172,7 @@ declare class Order {
172
172
  *
173
173
  * @name generatePOSReceiptByOrderId
174
174
  * @summary: Generate POS receipt by order Id
175
- * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
175
+ * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/generatePOSReceiptByOrderId/).
176
176
  */
177
177
  generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>;
178
178
  /**
@@ -182,7 +182,7 @@ declare class Order {
182
182
  * @returns {Promise<OrderPlatformModel.ManifestResponseSchema>} - Success response
183
183
  * @name generateProcessManifest
184
184
  * @summary: Process Order Manifest
185
- * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
185
+ * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/generateProcessManifest/).
186
186
  */
187
187
  generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponseSchema>;
188
188
  /**
@@ -193,7 +193,7 @@ declare class Order {
193
193
  * Success response
194
194
  * @name getAllowedStateTransition
195
195
  * @summary: Get allowed state transition
196
- * @description: Retrieve next possible states based on logged in user's role - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
196
+ * @description: Retrieve next possible states based on logged in user's role - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAllowedStateTransition/).
197
197
  */
198
198
  getAllowedStateTransition({ status, orderingChannel, orderingSource, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
199
199
  /**
@@ -204,7 +204,7 @@ declare class Order {
204
204
  * Success response
205
205
  * @name getAllowedTemplatesForBulk
206
206
  * @summary: List bulk operation templates
207
- * @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
207
+ * @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAllowedTemplatesForBulk/).
208
208
  */
209
209
  getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>;
210
210
  /**
@@ -215,7 +215,7 @@ declare class Order {
215
215
  * Success response
216
216
  * @name getAnnouncements
217
217
  * @summary: List announcements
218
- * @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
218
+ * @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAnnouncements/).
219
219
  */
220
220
  getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponseSchema>;
221
221
  /**
@@ -227,7 +227,7 @@ declare class Order {
227
227
  *
228
228
  * @name getBagById
229
229
  * @summary: Get bag
230
- * @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
230
+ * @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBagById/).
231
231
  */
232
232
  getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>;
233
233
  /**
@@ -238,7 +238,7 @@ declare class Order {
238
238
  * Success response
239
239
  * @name getBags
240
240
  * @summary: List bags
241
- * @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
241
+ * @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBags/).
242
242
  */
243
243
  getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>;
244
244
  /**
@@ -250,7 +250,7 @@ declare class Order {
250
250
  *
251
251
  * @name getBulkActionTemplate
252
252
  * @summary: List supported templates
253
- * @description: Get list of templates so that users can download the required template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
253
+ * @description: Get list of templates so that users can download the required template - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBulkActionTemplate/).
254
254
  */
255
255
  getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>;
256
256
  /**
@@ -260,7 +260,7 @@ declare class Order {
260
260
  * @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
261
261
  * @name getBulkShipmentExcelFile
262
262
  * @summary: Generate the report
263
- * @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
263
+ * @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBulkShipmentExcelFile/).
264
264
  */
265
265
  getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
266
266
  /**
@@ -270,7 +270,7 @@ declare class Order {
270
270
  * @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
271
271
  * @name getChannelConfig
272
272
  * @summary: Get channel configuration
273
- * @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
273
+ * @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getChannelConfig/).
274
274
  */
275
275
  getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
276
276
  /**
@@ -280,7 +280,7 @@ declare class Order {
280
280
  * @returns {Promise<OrderPlatformModel.JobFailedResponseSchema>} - Success response
281
281
  * @name getFileByStatus
282
282
  * @summary: Download file used for Bulk operation
283
- * @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
283
+ * @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getFileByStatus/).
284
284
  */
285
285
  getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponseSchema>;
286
286
  /**
@@ -290,7 +290,7 @@ declare class Order {
290
290
  * @returns {Promise<OrderPlatformModel.LaneConfigResponseSchema>} - Success response
291
291
  * @name getLaneConfig
292
292
  * @summary: Get lane configuration
293
- * @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
293
+ * @description: Get configuration settings for lanes - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getLaneConfig/).
294
294
  */
295
295
  getLaneConfig({ superLane, groupEntity, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, orderType, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponseSchema>;
296
296
  /**
@@ -300,7 +300,7 @@ declare class Order {
300
300
  * @returns {Promise<OrderPlatformModel.ManifestDetails>} - Success response
301
301
  * @name getManifestDetails
302
302
  * @summary: Get a manifest
303
- * @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestDetails/).
303
+ * @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifestDetails/).
304
304
  */
305
305
  getManifestDetails({ manifestId, dpIds, endDate, startDate, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
306
306
  /**
@@ -310,7 +310,7 @@ declare class Order {
310
310
  * @returns {Promise<OrderPlatformModel.ManifestShipmentListing>} - Success response
311
311
  * @name getManifestShipments
312
312
  * @summary: List manifest shipments
313
- * @description: Get list of shipments tagged to that manifest, the user can also search the shipments on the basis of shipment Id, order Id and AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestShipments/).
313
+ * @description: Get list of shipments tagged to that manifest, the user can also search the shipments on the basis of shipment Id, order Id and AWB number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifestShipments/).
314
314
  */
315
315
  getManifestShipments({ dpIds, stores, toDate, fromDate, dpName, salesChannels, searchType, searchValue, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestShipmentListing>;
316
316
  /**
@@ -321,7 +321,7 @@ declare class Order {
321
321
  * Success response
322
322
  * @name getManifestfilters
323
323
  * @summary: List filters
324
- * @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
324
+ * @description: Get supported filter for listing manifests - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifestfilters/).
325
325
  */
326
326
  getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponseSchema>;
327
327
  /**
@@ -331,7 +331,7 @@ declare class Order {
331
331
  * @returns {Promise<OrderPlatformModel.ManifestList>} - Success response
332
332
  * @name getManifests
333
333
  * @summary: List manifests
334
- * @description: Get a list of manifest as per the filter provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifests/).
334
+ * @description: Get a list of manifest as per the filter provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifests/).
335
335
  */
336
336
  getManifests({ status, startDate, endDate, searchType, storeId, searchValue, dpIds, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestList>;
337
337
  /**
@@ -342,7 +342,7 @@ declare class Order {
342
342
  * Success response
343
343
  * @name getOrderById
344
344
  * @summary: Get order
345
- * @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
345
+ * @description: Get detailed information about a specific order - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getOrderById/).
346
346
  */
347
347
  getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponseSchema>;
348
348
  /**
@@ -353,7 +353,7 @@ declare class Order {
353
353
  * Success response
354
354
  * @name getOrders
355
355
  * @summary: List orders
356
- * @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
356
+ * @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getOrders/).
357
357
  */
358
358
  getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponseSchema>;
359
359
  /**
@@ -443,7 +443,7 @@ declare class Order {
443
443
  * @returns {Promise<OrderPlatformModel.GetActionsResponseSchema>} - Success response
444
444
  * @name getRoleBasedActions
445
445
  * @summary: Get role-based actions
446
- * @description: Retrieve permissible actions based on user roles such as company_admin, company_operation, customer_care, and read_only. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
446
+ * @description: Retrieve permissible actions based on user roles such as company_admin, company_operation, customer_care, and read_only. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getRoleBasedActions/).
447
447
  */
448
448
  getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponseSchema>;
449
449
  /**
@@ -454,7 +454,7 @@ declare class Order {
454
454
  * Success response
455
455
  * @name getShipmentById
456
456
  * @summary: Get shipment details
457
- * @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
457
+ * @description: Get detailed information about a specific shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentById/).
458
458
  */
459
459
  getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponseSchema>;
460
460
  /**
@@ -465,7 +465,7 @@ declare class Order {
465
465
  * Success response
466
466
  * @name getShipmentHistory
467
467
  * @summary: Get a shipment's history
468
- * @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
468
+ * @description: Get the history of the shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentHistory/).
469
469
  */
470
470
  getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
471
471
  /**
@@ -477,7 +477,7 @@ declare class Order {
477
477
  *
478
478
  * @name getShipmentReasons
479
479
  * @summary: List bag cancellation reasons
480
- * @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
480
+ * @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentReasons/).
481
481
  */
482
482
  getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>;
483
483
  /**
@@ -489,7 +489,7 @@ declare class Order {
489
489
  *
490
490
  * @name getShipments
491
491
  * @summary: List shipments
492
- * @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
492
+ * @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipments/).
493
493
  */
494
494
  getShipments({ lane, bagStatus, statusAssigned, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, statusAssignedStartDate, statusAssignedEndDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
495
495
  /**
@@ -622,7 +622,7 @@ declare class Order {
622
622
  * @summary: Retrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
623
623
  * @description: This endpoint retrieves the ESM (Entity State Manager) configuration for a specific application within a company. The retrieval is based on parameters such as application ID, ordering channel, and entity type.
624
624
  * The ESM config stores order processing configuration. Each document in the ESM config collection of Order Management System - OMS's database is a JSON object representing the configuration of a specific application ID. This includes filters, hooks, flags set on different state-transitions. This configuration is picked and accordingly features are enabled.
625
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerConfig/).
625
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getStateManagerConfig/).
626
626
  */
627
627
  getStateManagerConfig({ appId, orderingChannel, orderingSource, entity, requestHeaders }?: OrderPlatformValidator.GetStateManagerConfigParam, { responseHeaders }?: object): Promise<any>;
628
628
  /**
@@ -632,7 +632,7 @@ declare class Order {
632
632
  * @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
633
633
  * @name getStateTransitionMap
634
634
  * @summary: Get state transition map
635
- * @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
635
+ * @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getStateTransitionMap/).
636
636
  */
637
637
  getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
638
638
  /**
@@ -643,7 +643,7 @@ declare class Order {
643
643
  * Success response
644
644
  * @name getTemplate
645
645
  * @summary: Download bulk operation templates
646
- * @description: Get the excel or CSV file URL for the template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
646
+ * @description: Get the excel or CSV file URL for the template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getTemplate/).
647
647
  */
648
648
  getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponseSchema>;
649
649
  /**
@@ -653,7 +653,7 @@ declare class Order {
653
653
  * @returns {Promise<OrderPlatformModel.FiltersResponseSchema>} - Success response
654
654
  * @name getfilters
655
655
  * @summary: List filters
656
- * @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
656
+ * @description: Get supported filters for various listing operations - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getfilters/).
657
657
  */
658
658
  getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponseSchema>;
659
659
  /**
@@ -665,7 +665,7 @@ declare class Order {
665
665
  *
666
666
  * @name invalidateShipmentCache
667
667
  * @summary: Invalidate shipment cache
668
- * @description: Clear the existing shipment cache data stored in Redis and serialize the updated data for subsequent use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
668
+ * @description: Clear the existing shipment cache data stored in Redis and serialize the updated data for subsequent use. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/invalidateShipmentCache/).
669
669
  */
670
670
  invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>;
671
671
  /**
@@ -675,7 +675,7 @@ declare class Order {
675
675
  * @returns {Promise<OrderPlatformModel.JobDetailsResponseSchema>} - Success response
676
676
  * @name jobDetails
677
677
  * @summary: Get bulk operation details
678
- * @description: Fetches details of the job for the provided batch Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/jobDetails/).
678
+ * @description: Fetches details of the job for the provided batch Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/jobDetails/).
679
679
  */
680
680
  jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponseSchema>;
681
681
  /**
@@ -685,7 +685,7 @@ declare class Order {
685
685
  * @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
686
686
  * @name orderUpdate
687
687
  * @summary: Update an order
688
- * @description: Used to update an order's meta information. These meta information can be accessed via order or shipment details API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
688
+ * @description: Used to update an order's meta information. These meta information can be accessed via order or shipment details API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/orderUpdate/).
689
689
  */
690
690
  orderUpdate({ body, requestHeaders }?: OrderPlatformValidator.OrderUpdateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ResponseDetail>;
691
691
  /**
@@ -696,7 +696,7 @@ declare class Order {
696
696
  * Success response
697
697
  * @name postShipmentHistory
698
698
  * @summary: Create shipment history
699
- * @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
699
+ * @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/postShipmentHistory/).
700
700
  */
701
701
  postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
702
702
  /**
@@ -707,7 +707,7 @@ declare class Order {
707
707
  * Success response
708
708
  * @name reassignLocation
709
709
  * @summary: Reassign location
710
- * @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
710
+ * @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/reassignLocation/).
711
711
  */
712
712
  reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponseSchema>;
713
713
  /**
@@ -717,7 +717,7 @@ declare class Order {
717
717
  * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
718
718
  * @name sendSmsNinja
719
719
  * @summary: Send SMS
720
- * @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
720
+ * @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/sendSmsNinja/).
721
721
  */
722
722
  sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
723
723
  /**
@@ -728,7 +728,7 @@ declare class Order {
728
728
  * Success response
729
729
  * @name sendUserMobileOTP
730
730
  * @summary: Send user mobile OTP
731
- * @description: Send a one-time OTP to a customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
731
+ * @description: Send a one-time OTP to a customer mobile number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/sendUserMobileOTP/).
732
732
  */
733
733
  sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>;
734
734
  /**
@@ -740,7 +740,7 @@ declare class Order {
740
740
  *
741
741
  * @name trackShipment
742
742
  * @summary: Track shipment
743
- * @description: Retrieve courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
743
+ * @description: Retrieve courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/trackShipment/).
744
744
  */
745
745
  trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>;
746
746
  /**
@@ -750,7 +750,7 @@ declare class Order {
750
750
  * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
751
751
  * @name updateAddress
752
752
  * @summary: Update shipment address
753
- * @description: Update the address details of an existing shipment based on the provided address_category. This operation allows the modification of critical shipment details, potentially affecting delivery/billing accuracy and customer communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
753
+ * @description: Update the address details of an existing shipment based on the provided address_category. This operation allows the modification of critical shipment details, potentially affecting delivery/billing accuracy and customer communication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateAddress/).
754
754
  */
755
755
  updateAddress({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
756
756
  /**
@@ -762,7 +762,7 @@ declare class Order {
762
762
  *
763
763
  * @name updatePackagingDimensions
764
764
  * @summary: Update packaging dimensions
765
- * @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
765
+ * @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updatePackagingDimensions/).
766
766
  */
767
767
  updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>;
768
768
  /**
@@ -772,7 +772,7 @@ declare class Order {
772
772
  * @returns {Promise<Object>} - Success response
773
773
  * @name updatePaymentInfo
774
774
  * @summary: Update payment details for an order, its shipments and its bags.
775
- * @description: Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePaymentInfo/).
775
+ * @description: Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updatePaymentInfo/).
776
776
  */
777
777
  updatePaymentInfo({ body, requestHeaders }?: OrderPlatformValidator.UpdatePaymentInfoParam, { responseHeaders }?: object): Promise<any>;
778
778
  /**
@@ -784,7 +784,7 @@ declare class Order {
784
784
  *
785
785
  * @name updateShipmentLock
786
786
  * @summary: Update a shipment lock
787
- * @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
787
+ * @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentLock/).
788
788
  */
789
789
  updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>;
790
790
  /**
@@ -796,7 +796,7 @@ declare class Order {
796
796
  *
797
797
  * @name updateShipmentStatus
798
798
  * @summary: Update a shipment's status
799
- * @description: Used for updating a shipment and its status. Can also be used for updating bags present in that shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
799
+ * @description: Used for updating a shipment and its status. Can also be used for updating bags present in that shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
800
800
  */
801
801
  updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
802
802
  /**
@@ -807,7 +807,7 @@ declare class Order {
807
807
  * Success response
808
808
  * @name updateShipmentTracking
809
809
  * @summary: Update shipment tracking
810
- * @description: Modify courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentTracking/).
810
+ * @description: Modify courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentTracking/).
811
811
  */
812
812
  updateShipmentTracking({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentTrackingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingDetails>;
813
813
  /**
@@ -817,7 +817,7 @@ declare class Order {
817
817
  * @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
818
818
  * @name uploadConsents
819
819
  * @summary: Upload consent
820
- * @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsents/).
820
+ * @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/uploadConsents/).
821
821
  */
822
822
  uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
823
823
  /**
@@ -827,7 +827,7 @@ declare class Order {
827
827
  * @returns {Promise<OrderPlatformModel.VerifyOtpResponseSchema>} - Success response
828
828
  * @name verifyMobileOTP
829
829
  * @summary: Verify mobile OTP
830
- * @description: Perform OTP verification to link a user to an anonymous order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
830
+ * @description: Perform OTP verification to link a user to an anonymous order - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/verifyMobileOTP/).
831
831
  */
832
832
  verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponseSchema>;
833
833
  }