@gofynd/fdk-client-javascript 1.4.2-beta.6 → 1.4.3

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 (187) hide show
  1. package/README.md +1 -1
  2. package/package.json +5 -3
  3. package/sdk/application/ApplicationAPIClient.d.ts +1 -1
  4. package/sdk/application/ApplicationAPIClient.js +0 -1
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
  6. package/sdk/application/Cart/CartApplicationClient.js +25 -25
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  10. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
  16. package/sdk/application/Content/ContentApplicationClient.js +10 -10
  17. package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
  18. package/sdk/application/Content/ContentApplicationModel.js +26 -26
  19. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
  20. package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +7 -7
  23. package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
  24. package/sdk/application/Lead/LeadApplicationModel.js +42 -52
  25. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
  26. package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
  27. package/sdk/application/Order/OrderApplicationClient.d.ts +13 -13
  28. package/sdk/application/Order/OrderApplicationClient.js +16 -12
  29. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -0
  30. package/sdk/application/Order/OrderApplicationValidator.js +3 -0
  31. package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
  32. package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
  33. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
  34. package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
  35. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  36. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  37. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
  38. package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
  39. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
  40. package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
  41. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  42. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  43. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  44. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  45. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  46. package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
  47. package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
  48. package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
  49. package/sdk/application/User/UserApplicationClient.d.ts +28 -28
  50. package/sdk/application/User/UserApplicationClient.js +28 -28
  51. package/sdk/application/User/UserApplicationModel.d.ts +44 -13
  52. package/sdk/application/User/UserApplicationModel.js +17 -13
  53. package/sdk/common/AxiosHelper.d.ts +1 -1
  54. package/sdk/common/AxiosHelper.js +38 -17
  55. package/sdk/common/Clickstream.js +33 -19
  56. package/sdk/common/curlHelper.js +1 -3
  57. package/sdk/common/utils.d.ts +15 -0
  58. package/sdk/common/utils.js +30 -0
  59. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
  60. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
  61. package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
  62. package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
  63. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
  64. package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
  65. package/sdk/partner/OAuthClient.d.ts +3 -3
  66. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  67. package/sdk/partner/PartnerAPIClient.js +0 -1
  68. package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
  69. package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
  70. package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
  71. package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
  72. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
  73. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  74. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
  75. package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -2
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
  78. package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
  79. package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
  80. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
  81. package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
  82. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
  83. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
  84. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
  85. package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
  86. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
  87. package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
  88. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  89. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  90. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
  91. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
  92. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  93. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  94. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
  95. package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
  96. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
  97. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
  98. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  99. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  100. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
  101. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
  102. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
  103. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
  104. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
  105. package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
  106. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  107. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  108. package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
  109. package/sdk/platform/Content/ContentPlatformClient.js +9 -9
  110. package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
  111. package/sdk/platform/Content/ContentPlatformModel.js +26 -26
  112. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  113. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  114. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
  115. package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
  116. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
  117. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
  118. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  119. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
  120. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
  121. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
  122. package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
  123. package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
  124. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
  125. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
  126. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  127. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  128. package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
  129. package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
  130. package/sdk/platform/OAuthClient.d.ts +3 -3
  131. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
  132. package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
  133. package/sdk/platform/Order/OrderPlatformClient.d.ts +43 -43
  134. package/sdk/platform/Order/OrderPlatformClient.js +55 -44
  135. package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
  136. package/sdk/platform/Order/OrderPlatformModel.js +8 -2
  137. package/sdk/platform/Order/OrderPlatformValidator.d.ts +14 -0
  138. package/sdk/platform/Order/OrderPlatformValidator.js +6 -0
  139. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
  140. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
  141. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
  142. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
  143. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
  144. package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
  145. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  146. package/sdk/platform/PlatformAPIClient.js +0 -1
  147. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
  148. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
  149. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
  150. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
  151. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
  152. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
  153. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
  154. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
  155. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  156. package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
  157. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  158. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  159. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
  160. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
  161. package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
  162. package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
  163. package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
  164. package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
  165. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
  166. package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
  167. package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
  168. package/sdk/platform/User/UserPlatformModel.js +21 -13
  169. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
  170. package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
  171. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -45
  172. package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -50
  173. package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
  174. package/sdk/public/Billing/BillingPublicClient.js +4 -4
  175. package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
  176. package/sdk/public/Billing/BillingPublicValidator.js +2 -2
  177. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
  178. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
  179. package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
  180. package/sdk/public/Content/ContentPublicValidator.js +3 -3
  181. package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
  182. package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
  183. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  184. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  185. package/sdk/public/PublicAPIClient.d.ts +1 -1
  186. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  187. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
@@ -8,7 +8,7 @@ declare class Order {
8
8
  * @param {import("../PlatformAPIClient").Options} - Options
9
9
  * @returns {Promise<OrderPlatformModel.AttachOrderUserResponse>} - Success response
10
10
  * @name attachOrderUser
11
- * @summary: Attach order user.
11
+ * @summary: Attach order user
12
12
  * @description: Attach order User - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
13
13
  */
14
14
  attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponse>;
@@ -40,7 +40,7 @@ declare class Order {
40
40
  * @param {import("../PlatformAPIClient").Options} - Options
41
41
  * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
42
42
  * @name checkOrderStatus
43
- * @summary: Check order status.
43
+ * @summary: Check order status
44
44
  * @description: Verify the current status of an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
45
45
  */
46
46
  checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
@@ -50,7 +50,7 @@ declare class Order {
50
50
  * @param {import("../PlatformAPIClient").Options} - Options
51
51
  * @returns {Promise<OrderPlatformModel.Click2CallResponse>} - Success response
52
52
  * @name click2Call
53
- * @summary: Click to call.
53
+ * @summary: Click to call
54
54
  * @description: Click to call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/click2Call/).
55
55
  */
56
56
  click2Call({ caller, receiver, bagId, callerId, method, requestHeaders }?: OrderPlatformValidator.Click2CallParam, { responseHeaders }?: object): Promise<OrderPlatformModel.Click2CallResponse>;
@@ -61,7 +61,7 @@ declare class Order {
61
61
  * @returns {Promise<OrderPlatformModel.CreateChannelConfigResponse>} -
62
62
  * Success response
63
63
  * @name createChannelConfig
64
- * @summary: Create channel configuration.
64
+ * @summary: Create channel configuration
65
65
  * @description: Set up configuration for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
66
66
  */
67
67
  createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponse>;
@@ -71,7 +71,7 @@ declare class Order {
71
71
  * @param {import("../PlatformAPIClient").Options} - Options
72
72
  * @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
73
73
  * @name createOrder
74
- * @summary: Create order.
74
+ * @summary: Create order
75
75
  * @description: Create order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
76
76
  */
77
77
  createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
@@ -91,7 +91,7 @@ declare class Order {
91
91
  * @param {import("../PlatformAPIClient").Options} - Options
92
92
  * @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
93
93
  * @name downloadBulkActionTemplate
94
- * @summary: Download bulk action template.
94
+ * @summary: Download bulk action template
95
95
  * @description: Download bulk actions seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
96
96
  */
97
97
  downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
@@ -102,7 +102,7 @@ declare class Order {
102
102
  * @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponse>} -
103
103
  * Success response
104
104
  * @name downloadLanesReport
105
- * @summary: Download lanes report.
105
+ * @summary: Download lanes report
106
106
  * @description: Downloads lanes shipment/orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
107
107
  */
108
108
  downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponse>;
@@ -112,7 +112,7 @@ declare class Order {
112
112
  * @param {import("../PlatformAPIClient").Options} - Options
113
113
  * @returns {Promise<OrderPlatformModel.EInvoiceRetryResponse>} - Success response
114
114
  * @name eInvoiceRetry
115
- * @summary: E-invoice retry.
115
+ * @summary: E-invoice retry
116
116
  * @description: Retry e-invoice after failure - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
117
117
  */
118
118
  eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponse>;
@@ -134,7 +134,7 @@ declare class Order {
134
134
  * - Success response
135
135
  *
136
136
  * @name fetchCreditBalanceDetail
137
- * @summary: Fetch credit balance detail.
137
+ * @summary: Fetch credit balance detail
138
138
  * @description: Retrieve details about credit balance. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
139
139
  */
140
140
  fetchCreditBalanceDetail({ body, requestHeaders }?: OrderPlatformValidator.FetchCreditBalanceDetailParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>;
@@ -145,7 +145,7 @@ declare class Order {
145
145
  * @returns {Promise<OrderPlatformModel.RefundModeConfigResponsePayload>} -
146
146
  * Success response
147
147
  * @name fetchRefundModeConfig
148
- * @summary: Fetch refund mode config.
148
+ * @summary: Fetch refund mode config
149
149
  * @description: Retrieve configuration for refund modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
150
150
  */
151
151
  fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
@@ -166,7 +166,7 @@ declare class Order {
166
166
  * @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
167
167
  * Success response
168
168
  * @name generatePOSReceiptByOrderId
169
- * @summary: Generate POS receipt by order ID.
169
+ * @summary: Generate POS receipt by order ID
170
170
  * @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/).
171
171
  */
172
172
  generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
@@ -177,7 +177,7 @@ declare class Order {
177
177
  * @returns {Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>} -
178
178
  * Success response
179
179
  * @name getAllowedStateTransition
180
- * @summary: Get allowed state transition.
180
+ * @summary: Get allowed state transition
181
181
  * @description: Retrieve next possible states based on logged in user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
182
182
  */
183
183
  getAllowedStateTransition({ orderingChannel, status, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
@@ -197,7 +197,7 @@ declare class Order {
197
197
  * @param {import("../PlatformAPIClient").Options} - Options
198
198
  * @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
199
199
  * @name getAnnouncements
200
- * @summary: Get announcements.
200
+ * @summary: Get announcements
201
201
  * @description: Retrieve announcements related to orders or shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
202
202
  */
203
203
  getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponse>;
@@ -208,7 +208,7 @@ declare class Order {
208
208
  * @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
209
209
  * Success response
210
210
  * @name getBagById
211
- * @summary: Get bag by ID.
211
+ * @summary: Get bag by ID
212
212
  * @description: Retrieve detailed information about a specific bag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
213
213
  */
214
214
  getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponse>;
@@ -218,7 +218,7 @@ declare class Order {
218
218
  * @param {import("../PlatformAPIClient").Options} - Options
219
219
  * @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
220
220
  * @name getBags
221
- * @summary: Get bags.
221
+ * @summary: Get bags
222
222
  * @description: Retrieve Bags for the order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
223
223
  */
224
224
  getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponse>;
@@ -229,7 +229,7 @@ declare class Order {
229
229
  * @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
230
230
  * Success response
231
231
  * @name getBulkActionTemplate
232
- * @summary: Get bulk action template.
232
+ * @summary: Get bulk action template
233
233
  * @description: Retrieve bulk action seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
234
234
  */
235
235
  getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
@@ -239,7 +239,7 @@ declare class Order {
239
239
  * @param {import("../PlatformAPIClient").Options} - Options
240
240
  * @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
241
241
  * @name getBulkShipmentExcelFile
242
- * @summary: Get bulk shipment Excel file.
242
+ * @summary: Get bulk shipment Excel file
243
243
  * @description: Retrieve a bulk shipment Excel report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
244
244
  */
245
245
  getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
@@ -249,7 +249,7 @@ declare class Order {
249
249
  * @param {import("../PlatformAPIClient").Options} - Options
250
250
  * @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
251
251
  * @name getChannelConfig
252
- * @summary: Get channel configuration.
252
+ * @summary: Get channel configuration
253
253
  * @description: Retrieve configuration settings for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
254
254
  */
255
255
  getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
@@ -269,7 +269,7 @@ declare class Order {
269
269
  * @param {import("../PlatformAPIClient").Options} - Options
270
270
  * @returns {Promise<OrderPlatformModel.LaneConfigResponse>} - Success response
271
271
  * @name getLaneConfig
272
- * @summary: Get lane configuration.
272
+ * @summary: Get lane configuration
273
273
  * @description: Retrieve configuration settings for lanes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
274
274
  */
275
275
  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.LaneConfigResponse>;
@@ -319,7 +319,7 @@ declare class Order {
319
319
  * @param {import("../PlatformAPIClient").Options} - Options
320
320
  * @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
321
321
  * @name getOrderById
322
- * @summary: Get order by ID.
322
+ * @summary: Get order by ID
323
323
  * @description: Retrieve detailed information about a specific order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
324
324
  */
325
325
  getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
@@ -329,17 +329,17 @@ declare class Order {
329
329
  * @param {import("../PlatformAPIClient").Options} - Options
330
330
  * @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
331
331
  * @name getOrders
332
- * @summary: Get orders.
332
+ * @summary: Get orders
333
333
  * @description: Retrieve a list of available orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
334
334
  */
335
- getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
335
+ getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
336
336
  /**
337
337
  * @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
338
338
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
339
339
  * @param {import("../PlatformAPIClient").Options} - Options
340
340
  * @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
341
341
  * @name getRoleBasedActions
342
- * @summary: Get role-based actions.
342
+ * @summary: Get role-based actions
343
343
  * @description: Retrieve role based actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
344
344
  */
345
345
  getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
@@ -349,17 +349,17 @@ declare class Order {
349
349
  * @param {import("../PlatformAPIClient").Options} - Options
350
350
  * @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
351
351
  * @name getShipmentById
352
- * @summary: Get shipment by ID.
352
+ * @summary: Get shipment by ID
353
353
  * @description: Retrieve detailed information about a specific shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
354
354
  */
355
- getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, requestHeaders }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
355
+ getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
356
356
  /**
357
357
  * @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
358
358
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
359
359
  * @param {import("../PlatformAPIClient").Options} - Options
360
360
  * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
361
361
  * @name getShipmentHistory
362
- * @summary: Get shipment history.
362
+ * @summary: Get shipment history
363
363
  * @description: Retrieve the shipment history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
364
364
  */
365
365
  getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
@@ -370,7 +370,7 @@ declare class Order {
370
370
  * @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
371
371
  * Success response
372
372
  * @name getShipmentReasons
373
- * @summary: Get shipment reasons.
373
+ * @summary: Get shipment reasons
374
374
  * @description: Retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
375
375
  */
376
376
  getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>;
@@ -382,7 +382,7 @@ declare class Order {
382
382
  * - Success response
383
383
  *
384
384
  * @name getShipments
385
- * @summary: Get shipments.
385
+ * @summary: Get shipments
386
386
  * @description: Retrieve a list of available shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
387
387
  */
388
388
  getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
@@ -392,7 +392,7 @@ declare class Order {
392
392
  * @param {import("../PlatformAPIClient").Options} - Options
393
393
  * @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
394
394
  * @name getStateTransitionMap
395
- * @summary: Get state transition map.
395
+ * @summary: Get state transition map
396
396
  * @description: Retrieve a map of state transitions for orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
397
397
  */
398
398
  getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
@@ -412,7 +412,7 @@ declare class Order {
412
412
  * @param {import("../PlatformAPIClient").Options} - Options
413
413
  * @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
414
414
  * @name getfilters
415
- * @summary: Get filters.
415
+ * @summary: Get filters
416
416
  * @description: Retrieve listing filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
417
417
  */
418
418
  getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponse>;
@@ -423,7 +423,7 @@ declare class Order {
423
423
  * @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
424
424
  * Success response
425
425
  * @name invalidateShipmentCache
426
- * @summary: Invalidate shipment cache.
426
+ * @summary: Invalidate shipment cache
427
427
  * @description: Invalidate shipment Cache. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
428
428
  */
429
429
  invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
@@ -443,7 +443,7 @@ declare class Order {
443
443
  * @param {import("../PlatformAPIClient").Options} - Options
444
444
  * @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
445
445
  * @name orderUpdate
446
- * @summary: Order update.
446
+ * @summary: Order update
447
447
  * @description: Modify the details and status of an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
448
448
  */
449
449
  orderUpdate({ body, requestHeaders }?: OrderPlatformValidator.OrderUpdateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ResponseDetail>;
@@ -453,7 +453,7 @@ declare class Order {
453
453
  * @param {import("../PlatformAPIClient").Options} - Options
454
454
  * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
455
455
  * @name postShipmentHistory
456
- * @summary: Post shipment history.
456
+ * @summary: Post shipment history
457
457
  * @description: Add history records for a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
458
458
  */
459
459
  postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
@@ -474,7 +474,7 @@ declare class Order {
474
474
  * @param {import("../PlatformAPIClient").Options} - Options
475
475
  * @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
476
476
  * @name reassignLocation
477
- * @summary: Reassign location.
477
+ * @summary: Reassign location
478
478
  * @description: Change the assigned location for an order or shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
479
479
  */
480
480
  reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponse>;
@@ -484,7 +484,7 @@ declare class Order {
484
484
  * @param {import("../PlatformAPIClient").Options} - Options
485
485
  * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
486
486
  * @name sendSmsNinja
487
- * @summary: Send SMS via Ninja.
487
+ * @summary: Send SMS via Ninja
488
488
  * @description: Send SMS Ninja Panel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
489
489
  */
490
490
  sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
@@ -494,7 +494,7 @@ declare class Order {
494
494
  * @param {import("../PlatformAPIClient").Options} - Options
495
495
  * @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
496
496
  * @name sendUserMobileOTP
497
- * @summary: Send user mobile OTP.
497
+ * @summary: Send user mobile OTP
498
498
  * @description: Send a one-time OTP to a users mobile device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
499
499
  */
500
500
  sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponse>;
@@ -505,7 +505,7 @@ declare class Order {
505
505
  * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
506
506
  * Success response
507
507
  * @name trackShipment
508
- * @summary: Track shipment.
508
+ * @summary: Track shipment
509
509
  * @description: Retrieve courier partner tracking details for a given shipment id or awb no. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
510
510
  */
511
511
  trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
@@ -515,7 +515,7 @@ declare class Order {
515
515
  * @param {import("../PlatformAPIClient").Options} - Options
516
516
  * @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
517
517
  * @name updateAddress
518
- * @summary: Update address.
518
+ * @summary: Update address
519
519
  * @description: Modify the shipping address for an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
520
520
  */
521
521
  updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, requestHeaders, }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
@@ -527,7 +527,7 @@ declare class Order {
527
527
  * - Success response
528
528
  *
529
529
  * @name updatePackagingDimensions
530
- * @summary: Update packaging dimensions.
530
+ * @summary: Update packaging dimensions
531
531
  * @description: Modify the dimensions of packaging. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
532
532
  */
533
533
  updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>;
@@ -538,7 +538,7 @@ declare class Order {
538
538
  * @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
539
539
  * Success response
540
540
  * @name updateShipmentLock
541
- * @summary: Update shipment lock.
541
+ * @summary: Update shipment lock
542
542
  * @description: Modify shipment/bag lock and check status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
543
543
  */
544
544
  updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
@@ -550,7 +550,7 @@ declare class Order {
550
550
  * - Success response
551
551
  *
552
552
  * @name updateShipmentStatus
553
- * @summary: Update shipment status.
553
+ * @summary: Update shipment status
554
554
  * @description: Shipment state transition or Shipment data update or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
555
555
  */
556
556
  updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
@@ -561,7 +561,7 @@ declare class Order {
561
561
  * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingDetails>} -
562
562
  * Success response
563
563
  * @name updateShipmentTracking
564
- * @summary: Update shipment tracking.
564
+ * @summary: Update shipment tracking
565
565
  * @description: Modify courier partner tracking details for a given shipment id or awb no. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentTracking/).
566
566
  */
567
567
  updateShipmentTracking({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentTrackingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingDetails>;
@@ -581,7 +581,7 @@ declare class Order {
581
581
  * @param {import("../PlatformAPIClient").Options} - Options
582
582
  * @returns {Promise<OrderPlatformModel.VerifyOtpResponse>} - Success response
583
583
  * @name verifyMobileOTP
584
- * @summary: Verify mobile OTP.
584
+ * @summary: Verify mobile OTP
585
585
  * @description: Verify Mobile OTP - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
586
586
  */
587
587
  verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponse>;