@gofynd/fdk-client-javascript 1.4.2-beta.7 → 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 (181) 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 +12 -12
  28. package/sdk/application/Order/OrderApplicationClient.js +12 -12
  29. package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
  30. package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
  31. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
  32. package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
  33. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  34. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  35. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
  36. package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
  37. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
  38. package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
  39. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  40. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  41. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  42. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  43. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  44. package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
  45. package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
  46. package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
  47. package/sdk/application/User/UserApplicationClient.d.ts +28 -28
  48. package/sdk/application/User/UserApplicationClient.js +28 -28
  49. package/sdk/application/User/UserApplicationModel.d.ts +44 -13
  50. package/sdk/application/User/UserApplicationModel.js +17 -13
  51. package/sdk/common/AxiosHelper.d.ts +1 -1
  52. package/sdk/common/AxiosHelper.js +38 -17
  53. package/sdk/common/Clickstream.js +22 -16
  54. package/sdk/common/curlHelper.js +1 -3
  55. package/sdk/common/utils.d.ts +15 -0
  56. package/sdk/common/utils.js +30 -0
  57. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
  58. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
  59. package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
  60. package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
  61. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
  62. package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
  63. package/sdk/partner/OAuthClient.d.ts +3 -3
  64. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  65. package/sdk/partner/PartnerAPIClient.js +0 -1
  66. package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
  67. package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
  68. package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
  69. package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
  70. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
  71. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  72. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
  73. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
  74. package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
  75. package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
  76. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
  77. package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
  79. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
  80. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
  81. package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
  82. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
  83. package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
  84. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  85. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  86. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
  87. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
  88. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  89. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  90. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
  91. package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
  92. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
  93. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
  94. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  95. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  96. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
  97. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
  98. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
  99. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
  100. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
  101. package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
  102. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  103. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  104. package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
  105. package/sdk/platform/Content/ContentPlatformClient.js +9 -9
  106. package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
  107. package/sdk/platform/Content/ContentPlatformModel.js +26 -26
  108. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  109. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  110. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
  111. package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
  112. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
  113. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
  114. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  115. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
  116. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
  117. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
  118. package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
  119. package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
  120. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
  121. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
  122. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  123. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  124. package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
  125. package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
  126. package/sdk/platform/OAuthClient.d.ts +3 -3
  127. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
  128. package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
  129. package/sdk/platform/Order/OrderPlatformClient.d.ts +41 -41
  130. package/sdk/platform/Order/OrderPlatformClient.js +41 -41
  131. package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
  132. package/sdk/platform/Order/OrderPlatformModel.js +8 -2
  133. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
  134. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
  135. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
  136. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
  137. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
  138. package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
  139. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  140. package/sdk/platform/PlatformAPIClient.js +0 -1
  141. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
  142. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
  143. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
  144. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
  145. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
  146. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
  147. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
  148. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
  149. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  150. package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
  151. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  152. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  153. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
  154. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
  155. package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
  156. package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
  157. package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
  158. package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
  159. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
  160. package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
  161. package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
  162. package/sdk/platform/User/UserPlatformModel.js +21 -13
  163. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
  164. package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
  165. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
  166. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
  167. package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
  168. package/sdk/public/Billing/BillingPublicClient.js +4 -4
  169. package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
  170. package/sdk/public/Billing/BillingPublicValidator.js +2 -2
  171. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
  172. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
  173. package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
  174. package/sdk/public/Content/ContentPublicValidator.js +3 -3
  175. package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
  176. package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
  177. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  178. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  179. package/sdk/public/PublicAPIClient.d.ts +1 -1
  180. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  181. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
@@ -20,7 +20,7 @@ class Order {
20
20
  * @param {import("../PlatformAPIClient").Options} - Options
21
21
  * @returns {Promise<OrderPlatformModel.AttachOrderUserResponse>} - Success response
22
22
  * @name attachOrderUser
23
- * @summary: Attach order user.
23
+ * @summary: Attach order user
24
24
  * @description: Attach order User - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
25
25
  */
26
26
  async attachOrderUser(
@@ -285,7 +285,7 @@ class Order {
285
285
  * @param {import("../PlatformAPIClient").Options} - Options
286
286
  * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
287
287
  * @name checkOrderStatus
288
- * @summary: Check order status.
288
+ * @summary: Check order status
289
289
  * @description: Verify the current status of an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
290
290
  */
291
291
  async checkOrderStatus(
@@ -364,7 +364,7 @@ class Order {
364
364
  * @param {import("../PlatformAPIClient").Options} - Options
365
365
  * @returns {Promise<OrderPlatformModel.Click2CallResponse>} - Success response
366
366
  * @name click2Call
367
- * @summary: Click to call.
367
+ * @summary: Click to call
368
368
  * @description: Click to call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/click2Call/).
369
369
  */
370
370
  async click2Call(
@@ -459,7 +459,7 @@ class Order {
459
459
  * @returns {Promise<OrderPlatformModel.CreateChannelConfigResponse>} -
460
460
  * Success response
461
461
  * @name createChannelConfig
462
- * @summary: Create channel configuration.
462
+ * @summary: Create channel configuration
463
463
  * @description: Set up configuration for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
464
464
  */
465
465
  async createChannelConfig(
@@ -538,7 +538,7 @@ class Order {
538
538
  * @param {import("../PlatformAPIClient").Options} - Options
539
539
  * @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
540
540
  * @name createOrder
541
- * @summary: Create order.
541
+ * @summary: Create order
542
542
  * @description: Create order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
543
543
  */
544
544
  async createOrder(
@@ -696,7 +696,7 @@ class Order {
696
696
  * @param {import("../PlatformAPIClient").Options} - Options
697
697
  * @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
698
698
  * @name downloadBulkActionTemplate
699
- * @summary: Download bulk action template.
699
+ * @summary: Download bulk action template
700
700
  * @description: Download bulk actions seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
701
701
  */
702
702
  async downloadBulkActionTemplate(
@@ -779,7 +779,7 @@ class Order {
779
779
  * @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponse>} -
780
780
  * Success response
781
781
  * @name downloadLanesReport
782
- * @summary: Download lanes report.
782
+ * @summary: Download lanes report
783
783
  * @description: Downloads lanes shipment/orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
784
784
  */
785
785
  async downloadLanesReport(
@@ -858,7 +858,7 @@ class Order {
858
858
  * @param {import("../PlatformAPIClient").Options} - Options
859
859
  * @returns {Promise<OrderPlatformModel.EInvoiceRetryResponse>} - Success response
860
860
  * @name eInvoiceRetry
861
- * @summary: E-invoice retry.
861
+ * @summary: E-invoice retry
862
862
  * @description: Retry e-invoice after failure - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
863
863
  */
864
864
  async eInvoiceRetry(
@@ -1016,7 +1016,7 @@ class Order {
1016
1016
  * - Success response
1017
1017
  *
1018
1018
  * @name fetchCreditBalanceDetail
1019
- * @summary: Fetch credit balance detail.
1019
+ * @summary: Fetch credit balance detail
1020
1020
  * @description: Retrieve details about credit balance. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
1021
1021
  */
1022
1022
  async fetchCreditBalanceDetail(
@@ -1098,7 +1098,7 @@ class Order {
1098
1098
  * @returns {Promise<OrderPlatformModel.RefundModeConfigResponsePayload>} -
1099
1099
  * Success response
1100
1100
  * @name fetchRefundModeConfig
1101
- * @summary: Fetch refund mode config.
1101
+ * @summary: Fetch refund mode config
1102
1102
  * @description: Retrieve configuration for refund modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
1103
1103
  */
1104
1104
  async fetchRefundModeConfig(
@@ -1259,7 +1259,7 @@ class Order {
1259
1259
  * @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
1260
1260
  * Success response
1261
1261
  * @name generatePOSReceiptByOrderId
1262
- * @summary: Generate POS receipt by order ID.
1262
+ * @summary: Generate POS receipt by order ID
1263
1263
  * @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/).
1264
1264
  */
1265
1265
  async generatePOSReceiptByOrderId(
@@ -1349,7 +1349,7 @@ class Order {
1349
1349
  * @returns {Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>} -
1350
1350
  * Success response
1351
1351
  * @name getAllowedStateTransition
1352
- * @summary: Get allowed state transition.
1352
+ * @summary: Get allowed state transition
1353
1353
  * @description: Retrieve next possible states based on logged in user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
1354
1354
  */
1355
1355
  async getAllowedStateTransition(
@@ -1511,7 +1511,7 @@ class Order {
1511
1511
  * @param {import("../PlatformAPIClient").Options} - Options
1512
1512
  * @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
1513
1513
  * @name getAnnouncements
1514
- * @summary: Get announcements.
1514
+ * @summary: Get announcements
1515
1515
  * @description: Retrieve announcements related to orders or shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
1516
1516
  */
1517
1517
  async getAnnouncements(
@@ -1592,7 +1592,7 @@ class Order {
1592
1592
  * @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
1593
1593
  * Success response
1594
1594
  * @name getBagById
1595
- * @summary: Get bag by ID.
1595
+ * @summary: Get bag by ID
1596
1596
  * @description: Retrieve detailed information about a specific bag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
1597
1597
  */
1598
1598
  async getBagById(
@@ -1676,7 +1676,7 @@ class Order {
1676
1676
  * @param {import("../PlatformAPIClient").Options} - Options
1677
1677
  * @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
1678
1678
  * @name getBags
1679
- * @summary: Get bags.
1679
+ * @summary: Get bags
1680
1680
  * @description: Retrieve Bags for the order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
1681
1681
  */
1682
1682
  async getBags(
@@ -1790,7 +1790,7 @@ class Order {
1790
1790
  * @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
1791
1791
  * Success response
1792
1792
  * @name getBulkActionTemplate
1793
- * @summary: Get bulk action template.
1793
+ * @summary: Get bulk action template
1794
1794
  * @description: Retrieve bulk action seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
1795
1795
  */
1796
1796
  async getBulkActionTemplate(
@@ -1865,7 +1865,7 @@ class Order {
1865
1865
  * @param {import("../PlatformAPIClient").Options} - Options
1866
1866
  * @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
1867
1867
  * @name getBulkShipmentExcelFile
1868
- * @summary: Get bulk shipment Excel file.
1868
+ * @summary: Get bulk shipment Excel file
1869
1869
  * @description: Retrieve a bulk shipment Excel report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
1870
1870
  */
1871
1871
  async getBulkShipmentExcelFile(
@@ -1994,7 +1994,7 @@ class Order {
1994
1994
  * @param {import("../PlatformAPIClient").Options} - Options
1995
1995
  * @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
1996
1996
  * @name getChannelConfig
1997
- * @summary: Get channel configuration.
1997
+ * @summary: Get channel configuration
1998
1998
  * @description: Retrieve configuration settings for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
1999
1999
  */
2000
2000
  async getChannelConfig(
@@ -2159,7 +2159,7 @@ class Order {
2159
2159
  * @param {import("../PlatformAPIClient").Options} - Options
2160
2160
  * @returns {Promise<OrderPlatformModel.LaneConfigResponse>} - Success response
2161
2161
  * @name getLaneConfig
2162
- * @summary: Get lane configuration.
2162
+ * @summary: Get lane configuration
2163
2163
  * @description: Retrieve configuration settings for lanes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
2164
2164
  */
2165
2165
  async getLaneConfig(
@@ -2703,7 +2703,7 @@ class Order {
2703
2703
  * @param {import("../PlatformAPIClient").Options} - Options
2704
2704
  * @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
2705
2705
  * @name getOrderById
2706
- * @summary: Get order by ID.
2706
+ * @summary: Get order by ID
2707
2707
  * @description: Retrieve detailed information about a specific order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
2708
2708
  */
2709
2709
  async getOrderById(
@@ -2789,7 +2789,7 @@ class Order {
2789
2789
  * @param {import("../PlatformAPIClient").Options} - Options
2790
2790
  * @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
2791
2791
  * @name getOrders
2792
- * @summary: Get orders.
2792
+ * @summary: Get orders
2793
2793
  * @description: Retrieve a list of available orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
2794
2794
  */
2795
2795
  async getOrders(
@@ -2958,7 +2958,7 @@ class Order {
2958
2958
  * @param {import("../PlatformAPIClient").Options} - Options
2959
2959
  * @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
2960
2960
  * @name getRoleBasedActions
2961
- * @summary: Get role-based actions.
2961
+ * @summary: Get role-based actions
2962
2962
  * @description: Retrieve role based actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
2963
2963
  */
2964
2964
  async getRoleBasedActions(
@@ -3033,7 +3033,7 @@ class Order {
3033
3033
  * @param {import("../PlatformAPIClient").Options} - Options
3034
3034
  * @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
3035
3035
  * @name getShipmentById
3036
- * @summary: Get shipment by ID.
3036
+ * @summary: Get shipment by ID
3037
3037
  * @description: Retrieve detailed information about a specific shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
3038
3038
  */
3039
3039
  async getShipmentById(
@@ -3128,7 +3128,7 @@ class Order {
3128
3128
  * @param {import("../PlatformAPIClient").Options} - Options
3129
3129
  * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
3130
3130
  * @name getShipmentHistory
3131
- * @summary: Get shipment history.
3131
+ * @summary: Get shipment history
3132
3132
  * @description: Retrieve the shipment history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
3133
3133
  */
3134
3134
  async getShipmentHistory(
@@ -3212,7 +3212,7 @@ class Order {
3212
3212
  * @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
3213
3213
  * Success response
3214
3214
  * @name getShipmentReasons
3215
- * @summary: Get shipment reasons.
3215
+ * @summary: Get shipment reasons
3216
3216
  * @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/).
3217
3217
  */
3218
3218
  async getShipmentReasons(
@@ -3297,7 +3297,7 @@ class Order {
3297
3297
  * - Success response
3298
3298
  *
3299
3299
  * @name getShipments
3300
- * @summary: Get shipments.
3300
+ * @summary: Get shipments
3301
3301
  * @description: Retrieve a list of available shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
3302
3302
  */
3303
3303
  async getShipments(
@@ -3498,7 +3498,7 @@ class Order {
3498
3498
  * @param {import("../PlatformAPIClient").Options} - Options
3499
3499
  * @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
3500
3500
  * @name getStateTransitionMap
3501
- * @summary: Get state transition map.
3501
+ * @summary: Get state transition map
3502
3502
  * @description: Retrieve a map of state transitions for orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
3503
3503
  */
3504
3504
  async getStateTransitionMap(
@@ -3650,7 +3650,7 @@ class Order {
3650
3650
  * @param {import("../PlatformAPIClient").Options} - Options
3651
3651
  * @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
3652
3652
  * @name getfilters
3653
- * @summary: Get filters.
3653
+ * @summary: Get filters
3654
3654
  * @description: Retrieve listing filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
3655
3655
  */
3656
3656
  async getfilters(
@@ -3732,7 +3732,7 @@ class Order {
3732
3732
  * @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
3733
3733
  * Success response
3734
3734
  * @name invalidateShipmentCache
3735
- * @summary: Invalidate shipment cache.
3735
+ * @summary: Invalidate shipment cache
3736
3736
  * @description: Invalidate shipment Cache. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
3737
3737
  */
3738
3738
  async invalidateShipmentCache(
@@ -3888,7 +3888,7 @@ class Order {
3888
3888
  * @param {import("../PlatformAPIClient").Options} - Options
3889
3889
  * @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
3890
3890
  * @name orderUpdate
3891
- * @summary: Order update.
3891
+ * @summary: Order update
3892
3892
  * @description: Modify the details and status of an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
3893
3893
  */
3894
3894
  async orderUpdate(
@@ -3965,7 +3965,7 @@ class Order {
3965
3965
  * @param {import("../PlatformAPIClient").Options} - Options
3966
3966
  * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
3967
3967
  * @name postShipmentHistory
3968
- * @summary: Post shipment history.
3968
+ * @summary: Post shipment history
3969
3969
  * @description: Add history records for a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
3970
3970
  */
3971
3971
  async postShipmentHistory(
@@ -4124,7 +4124,7 @@ class Order {
4124
4124
  * @param {import("../PlatformAPIClient").Options} - Options
4125
4125
  * @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
4126
4126
  * @name reassignLocation
4127
- * @summary: Reassign location.
4127
+ * @summary: Reassign location
4128
4128
  * @description: Change the assigned location for an order or shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
4129
4129
  */
4130
4130
  async reassignLocation(
@@ -4203,7 +4203,7 @@ class Order {
4203
4203
  * @param {import("../PlatformAPIClient").Options} - Options
4204
4204
  * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
4205
4205
  * @name sendSmsNinja
4206
- * @summary: Send SMS via Ninja.
4206
+ * @summary: Send SMS via Ninja
4207
4207
  * @description: Send SMS Ninja Panel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
4208
4208
  */
4209
4209
  async sendSmsNinja(
@@ -4280,7 +4280,7 @@ class Order {
4280
4280
  * @param {import("../PlatformAPIClient").Options} - Options
4281
4281
  * @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
4282
4282
  * @name sendUserMobileOTP
4283
- * @summary: Send user mobile OTP.
4283
+ * @summary: Send user mobile OTP
4284
4284
  * @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/).
4285
4285
  */
4286
4286
  async sendUserMobileOTP(
@@ -4360,7 +4360,7 @@ class Order {
4360
4360
  * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
4361
4361
  * Success response
4362
4362
  * @name trackShipment
4363
- * @summary: Track shipment.
4363
+ * @summary: Track shipment
4364
4364
  * @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/).
4365
4365
  */
4366
4366
  async trackShipment(
@@ -4449,7 +4449,7 @@ class Order {
4449
4449
  * @param {import("../PlatformAPIClient").Options} - Options
4450
4450
  * @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
4451
4451
  * @name updateAddress
4452
- * @summary: Update address.
4452
+ * @summary: Update address
4453
4453
  * @description: Modify the shipping address for an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
4454
4454
  */
4455
4455
  async updateAddress(
@@ -4578,7 +4578,7 @@ class Order {
4578
4578
  * - Success response
4579
4579
  *
4580
4580
  * @name updatePackagingDimensions
4581
- * @summary: Update packaging dimensions.
4581
+ * @summary: Update packaging dimensions
4582
4582
  * @description: Modify the dimensions of packaging. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
4583
4583
  */
4584
4584
  async updatePackagingDimensions(
@@ -4660,7 +4660,7 @@ class Order {
4660
4660
  * @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
4661
4661
  * Success response
4662
4662
  * @name updateShipmentLock
4663
- * @summary: Update shipment lock.
4663
+ * @summary: Update shipment lock
4664
4664
  * @description: Modify shipment/bag lock and check status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
4665
4665
  */
4666
4666
  async updateShipmentLock(
@@ -4741,7 +4741,7 @@ class Order {
4741
4741
  * - Success response
4742
4742
  *
4743
4743
  * @name updateShipmentStatus
4744
- * @summary: Update shipment status.
4744
+ * @summary: Update shipment status
4745
4745
  * @description: Shipment state transition or Shipment data update or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
4746
4746
  */
4747
4747
  async updateShipmentStatus(
@@ -4821,7 +4821,7 @@ class Order {
4821
4821
  * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingDetails>} -
4822
4822
  * Success response
4823
4823
  * @name updateShipmentTracking
4824
- * @summary: Update shipment tracking.
4824
+ * @summary: Update shipment tracking
4825
4825
  * @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/).
4826
4826
  */
4827
4827
  async updateShipmentTracking(
@@ -4981,7 +4981,7 @@ class Order {
4981
4981
  * @param {import("../PlatformAPIClient").Options} - Options
4982
4982
  * @returns {Promise<OrderPlatformModel.VerifyOtpResponse>} - Success response
4983
4983
  * @name verifyMobileOTP
4984
- * @summary: Verify mobile OTP.
4984
+ * @summary: Verify mobile OTP
4985
4985
  * @description: Verify Mobile OTP - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
4986
4986
  */
4987
4987
  async verifyMobileOTP(
@@ -769,7 +769,7 @@ export = OrderPlatformModel;
769
769
  * @typedef UserInfo
770
770
  * @property {string} [user_id]
771
771
  * @property {string} [user_type]
772
- * @property {string} primary_email
772
+ * @property {string} [primary_email]
773
773
  * @property {string} [gender]
774
774
  * @property {string} first_name
775
775
  * @property {string} [last_name]
@@ -810,6 +810,8 @@ export = OrderPlatformModel;
810
810
  * @property {Object} [config]
811
811
  * @property {PaymentInfo} payment_info
812
812
  * @property {UserInfo} [user_info]
813
+ * @property {number} [ordering_store_id]
814
+ * @property {string} [order_platform]
813
815
  */
814
816
  /**
815
817
  * @typedef CreateOrderErrorReponse
@@ -2269,6 +2271,7 @@ export = OrderPlatformModel;
2269
2271
  * @property {number} [shipment_quantity]
2270
2272
  * @property {CompanyDetails} [company_details]
2271
2273
  * @property {OrderingStoreDetails} [ordering_store]
2274
+ * @property {string} [order_platform]
2272
2275
  * @property {boolean} [lock_status]
2273
2276
  * @property {string} [platform_logo]
2274
2277
  * @property {string} [user_agent]
@@ -3908,7 +3911,7 @@ declare function UserInfo(): UserInfo;
3908
3911
  type UserInfo = {
3909
3912
  user_id?: string;
3910
3913
  user_type?: string;
3911
- primary_email: string;
3914
+ primary_email?: string;
3912
3915
  gender?: string;
3913
3916
  first_name: string;
3914
3917
  last_name?: string;
@@ -3953,6 +3956,8 @@ type CreateOrderAPI = {
3953
3956
  config?: any;
3954
3957
  payment_info: PaymentInfo;
3955
3958
  user_info?: UserInfo;
3959
+ ordering_store_id?: number;
3960
+ order_platform?: string;
3956
3961
  };
3957
3962
  /** @returns {CreateOrderErrorReponse} */
3958
3963
  declare function CreateOrderErrorReponse(): CreateOrderErrorReponse;
@@ -5649,6 +5654,7 @@ type PlatformShipment = {
5649
5654
  shipment_quantity?: number;
5650
5655
  company_details?: CompanyDetails;
5651
5656
  ordering_store?: OrderingStoreDetails;
5657
+ order_platform?: string;
5652
5658
  lock_status?: boolean;
5653
5659
  platform_logo?: string;
5654
5660
  user_agent?: string;
@@ -859,7 +859,7 @@ const Joi = require("joi");
859
859
  * @typedef UserInfo
860
860
  * @property {string} [user_id]
861
861
  * @property {string} [user_type]
862
- * @property {string} primary_email
862
+ * @property {string} [primary_email]
863
863
  * @property {string} [gender]
864
864
  * @property {string} first_name
865
865
  * @property {string} [last_name]
@@ -904,6 +904,8 @@ const Joi = require("joi");
904
904
  * @property {Object} [config]
905
905
  * @property {PaymentInfo} payment_info
906
906
  * @property {UserInfo} [user_info]
907
+ * @property {number} [ordering_store_id]
908
+ * @property {string} [order_platform]
907
909
  */
908
910
 
909
911
  /**
@@ -2522,6 +2524,7 @@ const Joi = require("joi");
2522
2524
  * @property {number} [shipment_quantity]
2523
2525
  * @property {CompanyDetails} [company_details]
2524
2526
  * @property {OrderingStoreDetails} [ordering_store]
2527
+ * @property {string} [order_platform]
2525
2528
  * @property {boolean} [lock_status]
2526
2529
  * @property {string} [platform_logo]
2527
2530
  * @property {string} [user_agent]
@@ -4175,7 +4178,7 @@ class OrderPlatformModel {
4175
4178
  return Joi.object({
4176
4179
  user_id: Joi.string().allow(""),
4177
4180
  user_type: Joi.string().allow(""),
4178
- primary_email: Joi.string().allow("").required(),
4181
+ primary_email: Joi.string().allow(""),
4179
4182
  gender: Joi.string().allow(""),
4180
4183
  first_name: Joi.string().allow("").required(),
4181
4184
  last_name: Joi.string().allow(""),
@@ -4228,6 +4231,8 @@ class OrderPlatformModel {
4228
4231
  config: Joi.any(),
4229
4232
  payment_info: OrderPlatformModel.PaymentInfo().required(),
4230
4233
  user_info: OrderPlatformModel.UserInfo(),
4234
+ ordering_store_id: Joi.number(),
4235
+ order_platform: Joi.string().allow(""),
4231
4236
  });
4232
4237
  }
4233
4238
 
@@ -6190,6 +6195,7 @@ class OrderPlatformModel {
6190
6195
  shipment_quantity: Joi.number().allow(null),
6191
6196
  company_details: OrderPlatformModel.CompanyDetails(),
6192
6197
  ordering_store: OrderPlatformModel.OrderingStoreDetails(),
6198
+ order_platform: Joi.string().allow(""),
6193
6199
  lock_status: Joi.boolean().allow(null),
6194
6200
  platform_logo: Joi.string().allow("").allow(null),
6195
6201
  user_agent: Joi.string().allow("").allow(null),
@@ -9,7 +9,7 @@ declare class Partner {
9
9
  * @param {import("../PlatformAPIClient").Options} - Options
10
10
  * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
11
11
  * @name addProxyPath
12
- * @summary: Add proxy path.
12
+ * @summary: Add proxy path
13
13
  * @description: Create and add a new proxy path. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
14
14
  */
15
15
  addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.AddProxyResponse>;
@@ -19,7 +19,7 @@ declare class Partner {
19
19
  * @param {import("../PlatformAPIClient").Options} - Options
20
20
  * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
21
21
  * @name removeProxyPath
22
- * @summary: Remove proxy path.
22
+ * @summary: Remove proxy path
23
23
  * @description: Delete a proxy path from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
24
24
  */
25
25
  removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.RemoveProxyResponse>;
@@ -21,7 +21,7 @@ class Partner {
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
22
  * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
23
23
  * @name addProxyPath
24
- * @summary: Add proxy path.
24
+ * @summary: Add proxy path
25
25
  * @description: Create and add a new proxy path. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
26
26
  */
27
27
  async addProxyPath(
@@ -102,7 +102,7 @@ class Partner {
102
102
  * @param {import("../PlatformAPIClient").Options} - Options
103
103
  * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
104
104
  * @name removeProxyPath
105
- * @summary: Remove proxy path.
105
+ * @summary: Remove proxy path
106
106
  * @description: Delete a proxy path from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
107
107
  */
108
108
  async removeProxyPath(