@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.10

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 (326) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +2 -3
  7. package/sdk/application/ApplicationClient.d.ts +0 -2
  8. package/sdk/application/ApplicationClient.js +0 -20
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +55 -97
  10. package/sdk/application/Cart/CartApplicationClient.js +60 -1262
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +80 -162
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +148 -1313
  13. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -9
  14. package/sdk/application/Common/CommonApplicationClient.js +5 -90
  15. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -145
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -80
  18. package/sdk/application/Configuration/ConfigurationApplicationClient.js +31 -725
  19. package/sdk/application/Content/ContentApplicationClient.d.ts +63 -85
  20. package/sdk/application/Content/ContentApplicationClient.js +126 -942
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -15
  22. package/sdk/application/FileStorage/FileStorageApplicationClient.js +26 -130
  23. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -17
  24. package/sdk/application/Lead/LeadApplicationClient.js +32 -201
  25. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -62
  26. package/sdk/application/Logistic/LogisticApplicationClient.js +51 -647
  27. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -56
  28. package/sdk/application/Order/OrderApplicationClient.js +86 -555
  29. package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -209
  30. package/sdk/application/Payment/PaymentApplicationClient.js +57 -2099
  31. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -26
  32. package/sdk/application/Rewards/RewardsApplicationClient.js +17 -303
  33. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  34. package/sdk/application/Share/ShareApplicationClient.js +34 -294
  35. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  36. package/sdk/application/Theme/ThemeApplicationClient.js +30 -166
  37. package/sdk/application/User/UserApplicationClient.d.ts +87 -138
  38. package/sdk/application/User/UserApplicationClient.js +47 -1817
  39. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
  40. package/sdk/application/Webhook/WebhookApplicationClient.js +6 -49
  41. package/sdk/application/index.d.ts +0 -19
  42. package/sdk/application/index.js +0 -35
  43. package/sdk/common/Utility.d.ts +1 -1
  44. package/sdk/common/Utility.js +10 -7
  45. package/sdk/common/Validator.d.ts +1 -0
  46. package/sdk/common/Validator.js +20 -0
  47. package/sdk/common/utils.d.ts +0 -1
  48. package/sdk/common/utils.js +0 -14
  49. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
  50. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
  51. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
  52. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
  53. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
  54. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  56. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  58. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
  60. package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
  61. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +85 -767
  62. package/sdk/partner/Logistics/LogisticsPartnerModel.js +76 -429
  63. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
  64. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +6 -120
  65. package/sdk/partner/OAuthClient.js +1 -0
  66. package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
  67. package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
  68. package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
  69. package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
  70. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  71. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
  72. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
  73. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
  74. package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
  75. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
  76. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
  77. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
  78. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
  79. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
  80. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  82. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  87. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  88. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  89. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  90. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  91. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  92. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
  94. package/sdk/platform/Cart/CartPlatformApplicationClient.js +112 -407
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -111
  96. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -106
  97. package/sdk/platform/Cart/CartPlatformModel.d.ts +1328 -4975
  98. package/sdk/platform/Cart/CartPlatformModel.js +1229 -1922
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -208
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +358 -383
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +126 -122
  102. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +68 -66
  103. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +118 -141
  104. package/sdk/platform/Catalog/CatalogPlatformClient.js +170 -193
  105. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1744 -1501
  106. package/sdk/platform/Catalog/CatalogPlatformModel.js +1211 -1383
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
  108. package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
  109. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
  110. package/sdk/platform/Common/CommonPlatformClient.js +2 -3
  111. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  112. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  117. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
  118. package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
  121. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  125. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
  126. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
  127. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  129. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
  130. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
  131. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +138 -283
  132. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +100 -219
  133. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
  134. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
  135. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
  136. package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
  137. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
  138. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
  139. package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
  140. package/sdk/platform/Content/ContentPlatformClient.js +336 -523
  141. package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
  142. package/sdk/platform/Content/ContentPlatformModel.js +390 -521
  143. package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
  144. package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
  145. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
  146. package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
  147. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  148. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  149. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  150. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  151. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
  152. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
  153. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
  154. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
  155. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
  156. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
  157. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
  158. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
  159. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  160. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  161. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  162. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  163. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
  164. package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
  165. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  166. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  167. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  168. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  169. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  170. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  171. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -25
  172. package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -175
  173. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -52
  174. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -34
  175. package/sdk/platform/Order/OrderPlatformClient.d.ts +103 -174
  176. package/sdk/platform/Order/OrderPlatformClient.js +275 -528
  177. package/sdk/platform/Order/OrderPlatformModel.d.ts +3078 -5449
  178. package/sdk/platform/Order/OrderPlatformModel.js +1659 -3501
  179. package/sdk/platform/Order/OrderPlatformValidator.d.ts +219 -234
  180. package/sdk/platform/Order/OrderPlatformValidator.js +118 -146
  181. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  182. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  183. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  184. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  185. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +106 -94
  186. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +146 -131
  187. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -64
  188. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -62
  189. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  190. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  191. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +507 -386
  192. package/sdk/platform/Payment/PaymentPlatformModel.js +376 -323
  193. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +10 -10
  194. package/sdk/platform/Payment/PaymentPlatformValidator.js +10 -10
  195. package/sdk/platform/PlatformClient.d.ts +2 -0
  196. package/sdk/platform/PlatformClient.js +4 -0
  197. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  198. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  199. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  200. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  201. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  202. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  203. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +35 -45
  204. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -117
  205. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +13 -22
  206. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -24
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
  209. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +396 -620
  210. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +326 -501
  211. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +11 -11
  212. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +10 -10
  213. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  214. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  215. package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
  216. package/sdk/platform/Share/SharePlatformModel.js +4 -27
  217. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  218. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
  219. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
  220. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
  221. package/sdk/platform/Theme/ThemePlatformModel.d.ts +13 -76
  222. package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
  223. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  224. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  225. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  226. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  227. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  228. package/sdk/platform/User/UserPlatformModel.js +23 -23
  229. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  230. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  231. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
  232. package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
  233. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  234. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  235. package/sdk/platform/index.d.ts +1 -0
  236. package/sdk/platform/index.js +2 -0
  237. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
  238. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -8
  239. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  240. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  241. package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
  242. package/sdk/public/Content/ContentPublicClient.js +19 -793
  243. package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
  244. package/sdk/public/Content/ContentPublicModel.js +3 -649
  245. package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
  246. package/sdk/public/Content/ContentPublicValidator.js +2 -88
  247. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  248. package/sdk/public/Partner/PartnerPublicClient.js +14 -2
  249. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  250. package/sdk/public/Webhook/WebhookPublicClient.js +13 -10
  251. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  252. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  253. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  254. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  255. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -4340
  256. package/sdk/application/Cart/CartApplicationModel.js +0 -2718
  257. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -788
  258. package/sdk/application/Cart/CartApplicationValidator.js +0 -546
  259. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3909
  260. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2667
  261. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  262. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  263. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  264. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  265. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  266. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  267. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  268. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  269. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  270. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  271. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2544
  272. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1875
  273. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  274. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  275. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2189
  276. package/sdk/application/Content/ContentApplicationModel.js +0 -1640
  277. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -290
  278. package/sdk/application/Content/ContentApplicationValidator.js +0 -269
  279. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -270
  280. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -188
  281. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  282. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  283. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -36
  284. package/sdk/application/Finance/FinanceApplicationClient.js +0 -202
  285. package/sdk/application/Finance/FinanceApplicationModel.d.ts +0 -289
  286. package/sdk/application/Finance/FinanceApplicationModel.js +0 -208
  287. package/sdk/application/Finance/FinanceApplicationValidator.d.ts +0 -25
  288. package/sdk/application/Finance/FinanceApplicationValidator.js +0 -31
  289. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  290. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  291. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  292. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  293. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -2034
  294. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1391
  295. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -299
  296. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -224
  297. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2612
  298. package/sdk/application/Order/OrderApplicationModel.js +0 -1669
  299. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -279
  300. package/sdk/application/Order/OrderApplicationValidator.js +0 -210
  301. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4062
  302. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2632
  303. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  304. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  305. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  306. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  307. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  308. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  309. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  310. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  311. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  312. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  313. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1744
  314. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1446
  315. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -79
  316. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -65
  317. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  318. package/sdk/application/User/UserApplicationModel.js +0 -1382
  319. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  320. package/sdk/application/User/UserApplicationValidator.js +0 -573
  321. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -54
  322. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -48
  323. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  324. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  325. package/sdk/common/Clickstream.d.ts +0 -1
  326. package/sdk/common/Clickstream.js +0 -464
@@ -1,1669 +0,0 @@
1
- const Joi = require("joi");
2
-
3
- /**
4
- * @typedef OrderPage
5
- * @property {string} [type] - Specifies type of pagination. If it is 'cursor'
6
- * based or 'number' based.
7
- * @property {number} [item_total] - Total number of items available across all
8
- * pages. It provides a count of all the items that match the query criteria,
9
- * regardless of pagination.
10
- * @property {number} [current] - Specifies the current page number. It helps in
11
- * identifying the position within the paginated results.
12
- * @property {number} [size] - Represents the number of items on the current
13
- * page. It indicates how many items are included in each page of the
14
- * paginated response.
15
- * @property {boolean} [has_next] - Indicates whether there is a next page
16
- * available. It is true if a next page exists and false if the current page
17
- * is the last one.
18
- */
19
-
20
- /**
21
- * @typedef UserInfo
22
- * @property {string} [first_name] - First name of the user.
23
- * @property {string} [gender] - Gender of the user.
24
- * @property {string} [name] - Full name of the user (including first and last names).
25
- * @property {string} [last_name] - Last name of the user.
26
- * @property {string} [mobile] - Mobile number of the user.
27
- * @property {string} [email] - Email address of the user.
28
- */
29
-
30
- /**
31
- * @typedef BreakupValues
32
- * @property {number} [value] - The numerical value associated with the entity.
33
- * @property {string} [currency_symbol] - Symbol representing the currency used
34
- * for the value.
35
- * @property {string} [name] - The official name of the entity.
36
- * @property {string} [display] - The name of the entity as it should be displayed.
37
- * @property {string} [currency_code] - The international currency code
38
- * representing the currency used for the value. This specifies the currency
39
- * code for all amounts. The currency_code field will hold a string value
40
- * representing the code for the currency in which all monetary amounts are
41
- * denominated. This code typically follows the ISO 4217 standard, which uses
42
- * three-letter alphabetic codes to define different currencies around the
43
- * world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
44
- */
45
-
46
- /**
47
- * @typedef ShipmentPayment
48
- * @property {string} [mop] - Abbreviation or code for the payment mode.
49
- * @property {string} [payment_mode] - The specific payment mode used.
50
- * @property {string} [status] - The current status of the payment.
51
- * @property {string} [mode] - The payment mode.
52
- * @property {string} [logo] - URL of the logo representing the payment mode.
53
- * @property {string} [display_name] - The name to be displayed for the payment mode.
54
- */
55
-
56
- /**
57
- * @typedef ShipmentPaymentInfo
58
- * @property {string} [mop] - Stands for "Mode of Payment". This is a short code
59
- * (like "COD" for Cash On Delivery) that represents the payment method used.
60
- * @property {string} [payment_mode] - Information about the payment mode,
61
- * indicates whether COD or PREPAID.
62
- * @property {string} [status] - Indicates the current status of the payment,
63
- * Paid or Unpaid.
64
- * @property {string} [mode] - Information about the payment source. For eg, NB_ICICI.
65
- * @property {string} [logo] - A URL to an image representing the payment method.
66
- * @property {string} [display_name] - The name of the payment method as it
67
- * should be displayed to the user.
68
- * @property {number} [amount] - Amount paid using this payment method.
69
- */
70
-
71
- /**
72
- * @typedef ShipmentUserInfo
73
- * @property {string} [first_name] - The unique identifier of the store.
74
- * @property {string} [gender] - A code associated with the store.
75
- * @property {string} [name] - The name of the store.
76
- * @property {string} [last_name] - The name of the company associated with the store.
77
- * @property {string} [mobile] - The identifier of the company associated with the store.
78
- * @property {string} [email] - Email address of the user.
79
- */
80
-
81
- /**
82
- * @typedef FulfillingStore
83
- * @property {number} [id] - The unique identifier of the store.
84
- * @property {string} [code] - A code associated with the store.
85
- * @property {string} [name] - The name of the store.
86
- * @property {string} [company_name] - The name of the company associated with the store.
87
- * @property {number} [company_id] - Schema for fulfilling store.
88
- */
89
-
90
- /**
91
- * @typedef ChargeDistributionSchema
92
- * @property {string} type - This field defines the distribution type, e.g
93
- * values('multi', 'single') multi: distribute the changes across all entity
94
- * single: distribute the changes across to any one single entity
95
- * @property {string} logic - This field defines the distribution logic e.g
96
- * values('apportion', 'equally') apportion: distribute charge amount based of
97
- * weighted average amount of all the entity (like article with [10, 20] will
98
- * get charge of 9 as [3, 6]) equally: distribute charge amount 'equally' to
99
- * all the entity
100
- */
101
-
102
- /**
103
- * @typedef ChargeDistributionLogic
104
- * @property {ChargeDistributionSchema} distribution
105
- * @property {string} distribution_level - This field defines the distribution
106
- * level, e.g distribution level is (order, shipment, article)
107
- */
108
-
109
- /**
110
- * @typedef ChargeAmountCurrency
111
- * @property {number} value - Charge currency value or amount
112
- * @property {string} currency - Charge currency code
113
- */
114
-
115
- /**
116
- * @typedef ChargeAmount
117
- * @property {ChargeAmountCurrency} base_currency
118
- * @property {ChargeAmountCurrency} ordering_currency
119
- */
120
-
121
- /**
122
- * @typedef PriceAdjustmentCharge
123
- * @property {string} [code] - Code defined for charge
124
- * @property {string} name - Display name for charge (charge is unique by the name)
125
- * @property {string} [type] - Type defined for charge
126
- * @property {ChargeAmount} amount
127
- * @property {ChargeDistributionLogic} distribution_logic
128
- */
129
-
130
- /**
131
- * @typedef ShipmentStatus
132
- * @property {string} [value] - The internal or code value representing the
133
- * shipment status.
134
- * @property {string} [title] - The title or display name representing the
135
- * shipment status.
136
- * @property {string} [hex_code] - The hexadecimal color code associated with
137
- * the shipment status. Each state of a shipment (like "processing",
138
- * "cancelled", "delivered", etc.) is associated with a unique color,
139
- * represented by a hex code. This color coding makes it visually intuitive
140
- * for users to understand the status of their shipment at a glance.
141
- */
142
-
143
- /**
144
- * @typedef Invoice
145
- * @property {string} [invoice_url] - URL providing access to the invoice.
146
- * @property {string} [updated_date] - The date and time when the invoice was
147
- * last updated.
148
- * @property {string} [label_url] - URL providing access to the invoice label.
149
- */
150
-
151
- /**
152
- * @typedef NestedTrackingDetails
153
- * @property {boolean} [is_passed] - Indicates whether the tracking event has
154
- * passed or occurred.
155
- * @property {string} [time] - The time associated with the tracking event.
156
- * @property {boolean} [is_current] - Indicates whether the tracking event is
157
- * the current or active status.
158
- * @property {string} [status] - The status of the tracking event.
159
- */
160
-
161
- /**
162
- * @typedef TrackingDetails
163
- * @property {string} [value] - Current value or state of the process.
164
- * @property {boolean} [is_current] - Indicates whether the tracking event is
165
- * the current or active status.
166
- * @property {boolean} [is_passed] - Indicates whether the tracking event has
167
- * passed or occurred.
168
- * @property {string} [status] - The status of the tracking event.
169
- * @property {string} [time] - The time associated with the tracking event.
170
- * @property {string} [created_ts] - Timestamp when this status was created.
171
- * @property {NestedTrackingDetails[]} [tracking_details] - Nested tracking details.
172
- */
173
-
174
- /**
175
- * @typedef TimeStampData
176
- * @property {string} [min] - The minimum timestamp value.
177
- * @property {string} [max] - The maximum timestamp value.
178
- */
179
-
180
- /**
181
- * @typedef Promise
182
- * @property {boolean} [show_promise] - Indicates whether the promise details
183
- * should be shown.
184
- * @property {TimeStampData} [timestamp]
185
- */
186
-
187
- /**
188
- * @typedef ShipmentTotalDetails
189
- * @property {number} [pieces] - The total number of pieces included.
190
- * @property {number} [total_price] - The total price of the order or item.
191
- * @property {number} [sizes] - The number of different sizes included.
192
- */
193
-
194
- /**
195
- * @typedef Prices
196
- * @property {number} [delivery_charge] - The delivery charge for the order.
197
- * @property {number} [coupon_value] - The value of the coupon applied.
198
- * @property {number} [brand_calculated_amount] - The amount calculated by the brand.
199
- * @property {number} [value_of_good] - The value of the goods before tax and
200
- * other charges.
201
- * @property {number} [price_marked] - The original marked price of the item.
202
- * @property {number} [coupon_effective_discount] - The effective discount from coupons.
203
- * @property {string} [currency_symbol] - The symbol of the currency used.
204
- * @property {number} [discount] - The discount applied to the item.
205
- * @property {number} [gst_tax_percentage] - The GST tax percentage applied.
206
- * @property {number} [cod_charges] - The cash on delivery charges, if applicable.
207
- * @property {number} [amount_paid] - The total amount paid by the customer.
208
- * @property {boolean} [added_to_fynd_cash] - Indicates if the refund amount was
209
- * added to Fynd Cash.
210
- * @property {number} [transfer_price] - The transfer price of the item.
211
- * @property {number} [cashback_applied] - The amount of cashback applied.
212
- * @property {number} [price_effective] - The effective price after all adjustments.
213
- * @property {number} [cashback] - The cashback amount earned.
214
- * @property {number} [refund_credit] - The amount credited for refund .
215
- * @property {number} [amount_paid_roundoff] - The rounded-off amount paid by
216
- * the customer.
217
- * @property {number} [promotion_effective_discount] - The effective discount
218
- * from promotions.
219
- * @property {number} [refund_amount] - The amount refunded to the customer.
220
- * @property {string} [currency_code] - This specifies the currency code for all
221
- * amounts. The currency_code field will hold a string value representing the
222
- * code for the currency in which all monetary amounts are denominated. This
223
- * code typically follows the ISO 4217 standard, which uses three-letter
224
- * alphabetic codes to define different currencies around the world. For
225
- * example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
226
- * @property {number} [fynd_credits] - The amount of Fynd credits used.
227
- * @property {number} [amount_to_be_collected] - The total amount that needs to
228
- * be collected from the customer.
229
- */
230
-
231
- /**
232
- * @typedef ItemBrand
233
- * @property {string} [logo] - The URL of the brand's logo.
234
- * @property {string} [name] - The name of the brand.
235
- */
236
-
237
- /**
238
- * @typedef Item
239
- * @property {string[]} [image] - An array of URLs pointing to images of the item.
240
- * @property {string[]} [l1_categories] - An array of level 1 categories the item belongs.
241
- * @property {ItemBrand} [brand]
242
- * @property {string} [seller_identifier] - The identifier for the seller .
243
- * @property {string} [code] - The code or SKU of the item.
244
- * @property {number} [id] - The unique identifier of the item.
245
- * @property {string} [name] - The name of the item.
246
- * @property {string} [l3_category_name] - This key specifies the name of the
247
- * third-level category under which the product is listed, offering a more
248
- * detailed classification within the e-commerce platform's hierarchy.
249
- * @property {string} [slug_key] - A unique key or identifier for the item slug.
250
- * @property {string[]} [l2_categories] - An array of level 2 categories the
251
- * item belongs to.
252
- * @property {string} [size] - The size of the item.
253
- * @property {Object} [attributes] - An object containing various attributes of the item.
254
- */
255
-
256
- /**
257
- * @typedef AppliedFreeArticles
258
- * @property {string} [article_id] - The unique identifier for the article.
259
- * @property {Object} [free_gift_item_details] - An object containing details
260
- * about the free gift item.
261
- * @property {string} [parent_item_identifier] - The identifier for the parent
262
- * item to which this free article is related.
263
- * @property {number} [quantity] - The quantity of the free article.
264
- */
265
-
266
- /**
267
- * @typedef AppliedPromos
268
- * @property {boolean} [mrp_promotion] - Indicates if the promotion is applied to the MRP.
269
- * @property {string} [promotion_name] - The name of the promotion .
270
- * @property {number} [article_quantity] - The quantity of articles required to
271
- * qualify for the promotion.
272
- * @property {string} [promo_id] - The unique identifier for the promotion.
273
- * @property {number} [amount] - The discount amount provided by the promotion.
274
- * @property {string} [promotion_type] - Specifies the type of discount or deal
275
- * applied to the current promotion, defining how the promotion modifies the
276
- * price or adds value to the purchase. Each type represents a different
277
- * promotional strategy - percentage- Discount by a percentage of the original
278
- * price. - amount- Discount by a specific amount off the original price. -
279
- * fixed_price- Sets the price to a specific fixed amount. - bogo- Buy One Get
280
- * One or at a discount. - contract_price- Special pricing based on a contract
281
- * or agreement. - shipping_price- Discount or deal related to the shipping
282
- * cost. - ladder_price- Price changes based on quantity purchased. -
283
- * bundle_price_percentage- Discount on a bundle purchase by a percentage. -
284
- * bundle_price_amount- Discount on a bundle purchase by a specific amount. -
285
- * bundle_amount_percentage- A percentage of the purchase amount is applied as
286
- * a discount when buying in a bundle. - custom- A custom promotion not
287
- * covered by other types. - free_gift_items- Free gift items are included
288
- * with the purchase. - free_non_sellable_items- Free items that are not for
289
- * sale are included with the purchase.
290
- * @property {AppliedFreeArticles[]} [applied_free_articles] - An array
291
- * containing details of free articles applied under the promotion.
292
- */
293
-
294
- /**
295
- * @typedef Identifiers
296
- * @property {string} [ean] - The European Article Number (EAN) of the item.
297
- * @property {string} [sku_code] - The Stock Keeping Unit (SKU) code of the item
298
- * - uniquely identifies each distinct product. SKUs are used to track
299
- * inventory levels, facilitate accurate stocktaking, and streamline order
300
- * fulfillment processes. This code is essential for inventory management,
301
- * allowing for the differentiation between products based on attributes such
302
- * as price, color, and size.
303
- */
304
-
305
- /**
306
- * @typedef FinancialBreakup
307
- * @property {number} [coupon_value] - The value of the coupon applied.
308
- * @property {number} [delivery_charge] - The delivery charge for the order.
309
- * @property {number} [brand_calculated_amount] - The amount calculated by the brand.
310
- * @property {number} [value_of_good] - The value of the goods before tax and
311
- * other charges.
312
- * @property {number} [price_marked] - The original marked price of the item.
313
- * @property {number} [coupon_effective_discount] - The effective discount from coupons.
314
- * @property {string} [hsn_code] - The HSN Code (Harmonized System of
315
- * Nomenclature Code) is an internationally standardized system for
316
- * classifying goods. It is used in trade and commerce to identify products
317
- * and services uniformly across different countries and industries. The
318
- * system was developed by the World Customs Organization (WCO) and is widely
319
- * used in customs processes and tax systems.
320
- * @property {number} [discount] - The discount applied to the item.
321
- * @property {number} [gst_tax_percentage] - The GST tax percentage applied .
322
- * @property {number} [cod_charges] - The cash on delivery charges, if applicable.
323
- * @property {number} [amount_paid] - The total amount paid by the customer.
324
- * @property {boolean} [added_to_fynd_cash] - Indicates if the refund amount was
325
- * added to Fynd Cash.
326
- * @property {string} [size] - The size of the item .
327
- * @property {number} [transfer_price] - The transfer price of the item.
328
- * @property {number} [cashback_applied] - The amount of cashback applied.
329
- * @property {number} [price_effective] - The effective price after all adjustments.
330
- * @property {number} [cashback] - The cashback amount earned.
331
- * @property {number} [refund_credit] - The amount credited for refund .
332
- * @property {number} [amount_paid_roundoff] - The rounded-off amount paid by
333
- * the customer.
334
- * @property {number} [total_units] - The total number of units purchased.
335
- * @property {Identifiers} [identifiers]
336
- * @property {string} [gst_tag] - The GST tag indicating the type of GST applied.
337
- * @property {string} [item_name] - The name of the item.
338
- * @property {number} [promotion_effective_discount] - The effective discount
339
- * from promotions.
340
- * @property {number} [gst_fee] - The GST fee applied to the item.
341
- * @property {number} [refund_amount] - The amount refunded to the customer.
342
- * @property {number} [fynd_credits] - The amount of Fynd credits used.
343
- * @property {number} [amount_to_be_collected] - The total amount that needs to
344
- * be collected from the customer.
345
- */
346
-
347
- /**
348
- * @typedef CurrentStatus
349
- * @property {string} [updated_at] - The date and time when the status was last updated.
350
- * @property {string} [name] - The name or label indicating the current state or status.
351
- * @property {string} [status] - The current status of the bag.
352
- * @property {string} [journey_type] - It is a type being used to represent the
353
- * journey of shipment through the performed status transition. Forward
354
- * Journey: The forward journey encompasses all the stages of shipping,
355
- * including order placement, packing, dispatch, in-transit updates, and
356
- * delivery. Return Journey: Contrary to the forward journey, the return
357
- * journey involves the process of sending items back from the customer to the
358
- * original sender or a designated return facility.
359
- */
360
-
361
- /**
362
- * @typedef Bags
363
- * @property {string} [delivery_date] - The date and time when the item is
364
- * expected to be delivered .
365
- * @property {number} [line_number] - The line number of the item in the order.
366
- * @property {string} [currency_symbol] - The symbol of the currency used.
367
- * @property {Item} [item]
368
- * @property {AppliedPromos[]} [applied_promos] - An array containing
369
- * information about applied promotions.
370
- * @property {number} [quantity] - The quantity of the item.
371
- * @property {Prices} [prices]
372
- * @property {boolean} [can_cancel] - Indicates if the item can be canceled.
373
- * @property {boolean} [can_return] - Indicates if the item can be returned.
374
- * @property {number} [id] - The unique identifier for the order item.
375
- * @property {string} [returnable_date] - The last date and time by which the
376
- * item can be returned.
377
- * @property {FinancialBreakup[]} [financial_breakup] - An array containing
378
- * financial details of the item.
379
- * @property {Object} [parent_promo_bags] - An object containing details of
380
- * parent promotional bags.
381
- * @property {Object} [meta] - It contains the additional properties related to
382
- * shipment status transition like Kafka_emission_status, user_name, etc.
383
- * Additionally it is dynamic.
384
- * @property {string} [currency_code] - This specifies the currency code for all
385
- * amounts. The currency_code field will hold a string value representing the
386
- * code for the currency in which all monetary amounts are denominated. This
387
- * code typically follows the ISO 4217 standard, which uses three-letter
388
- * alphabetic codes to define different currencies around the world. For
389
- * example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
390
- * @property {string} [seller_identifier] - The identifier for the seller.
391
- * @property {CurrentStatus} [current_status]
392
- * @property {Article} [article]
393
- * @property {PriceAdjustmentCharge[]} [charges]
394
- */
395
-
396
- /**
397
- * @typedef FulfillingCompany
398
- * @property {number} [id] - The unique identifier for the fulfilling company.
399
- * @property {string} [name] - The name of the fulfilling company.
400
- */
401
-
402
- /**
403
- * @typedef Article
404
- * @property {string[]} [tags] - An array of tags associated with the article.
405
- */
406
-
407
- /**
408
- * @typedef Address
409
- * @property {string} [pincode] - The postal code of the address.
410
- * @property {string} [phone] - The phone number of the person associated with
411
- * the address.
412
- * @property {number} [latitude] - The latitude coordinate.
413
- * @property {string} [address2] - The secondary line of the address.
414
- * @property {string} [landmark] - A nearby landmark.
415
- * @property {string} [area] - The area or locality.
416
- * @property {string} [city] - The city of the address.
417
- * @property {string} [address] - The full address.
418
- * @property {string} [address_type] - The type of the address (e.g., home, office).
419
- * @property {number} [longitude] - The longitude coordinate.
420
- * @property {string} [country_iso_code] - The ISO code for the country.
421
- * @property {string} [state] - The state of the address.
422
- * @property {string} [created_at] - The date and time when the address was created.
423
- * @property {string} [address1] - The primary line of the address.
424
- * @property {string} [display_address] - The formatted display address,
425
- * typically used for printing or displaying in user interfaces.
426
- * @property {string} [name] - The name of the person associated with the address.
427
- * @property {string} [contact_person] - The name of the contact person.
428
- * @property {string} [address_category] - Category or classification of the
429
- * address. The address_category field that includes "store", "delivery", and
430
- * "billing" serves to classify addresses based on various business processes
431
- *
432
- * - 'store': Identifies addresses associated with physical retail locations or
433
- * warehouses which is essential for inventory management, order
434
- * fulfillment, and facilitating in-store pickups or returns.
435
- * - 'delivery': Identifies addresses where orders are shipped to customers which
436
- * ensures successful delivery, enhancing customer satisfaction, and
437
- * optimizing logistics operations.
438
- * - 'billing': Identifies addresses used for billing and financial transactions
439
- * which are essential for payment processing, invoice generation, and
440
- * maintaining financial accuracy.
441
- *
442
- * @property {string} [email] - The email address.
443
- * @property {string} [country_phone_code] - The country phone code.
444
- * @property {string} [version] - The version of the address format.
445
- * @property {string} [updated_at] - The date and time when the address was last updated .
446
- * @property {string} [country] - The country of the address.
447
- */
448
-
449
- /**
450
- * @typedef Shipments
451
- * @property {ShipmentPayment} [payment]
452
- * @property {ShipmentPaymentInfo[]} [payment_info] - Array of objects
453
- * containing payment methods used for placing an order. Each object will
454
- * provide information about corresponding payment method with relevant details.
455
- * @property {string} [order_type] - Defines the specific journey a shipment
456
- * will follow based on the application's operational needs and customer
457
- * preferences. This field categorizes orders into distinct types, each
458
- * associated with a unique processing flow. For example:
459
- *
460
- * - "HomeDelivery": The order undergoes all state transitions typical for a
461
- * delivery, from processing the shipment to final delivery at the
462
- * customer's address.
463
- * - "PickAtStore": The order is prepared for pickup and moved to a state where it
464
- * is ready to be handed over directly to the customer at the store. This
465
- * type streamlines the process by bypassing traditional shipping stages
466
- * and facilitating a quicker transition to the final handover stage.
467
- *
468
- * @property {string} [gstin_code] - A GST Number (Goods and Services Tax
469
- * Identification Number, often abbreviated as GSTIN) is a unique identifier
470
- * assigned to a business or individual registered under the Goods and
471
- * Services Tax (GST) system in countries like India. The GST number is
472
- * essential for businesses to comply with tax regulations and for the
473
- * government to track tax payments and returns.
474
- * @property {boolean} [show_download_invoice] - Indicates if the download
475
- * invoice option should be shown.
476
- * @property {boolean} [can_cancel] - Indicates if the shipment can be canceled.
477
- * @property {ShipmentUserInfo} [user_info]
478
- * @property {string} [shipment_id] - The unique identifier for the shipment.
479
- * @property {FulfillingStore} [fulfilling_store]
480
- * @property {Object[]} [custom_meta] - An object containing custom metadata for
481
- * the shipment.
482
- * @property {ShipmentStatus} [shipment_status]
483
- * @property {string} [comment] - Any comments related to the shipment.
484
- * @property {Invoice} [invoice]
485
- * @property {boolean} [show_track_link] - Indicates if the track link should be shown.
486
- * @property {Object} [refund_details] - An object containing details of any refunds.
487
- * @property {BreakupValues[]} [breakup_values] - An array containing the
488
- * breakup of various charges and discounts.
489
- * @property {Object} [can_break] - An object containing details about the
490
- * breakability of the shipment.
491
- * @property {string} [traking_no] - The tracking number for the shipment.
492
- * @property {TrackingDetails[]} [tracking_details] - An array containing
493
- * details of the tracking history of the shipment.
494
- * @property {Promise} [promise]
495
- * @property {number} [total_bags] - The total number of bags in the shipment.
496
- * @property {ShipmentTotalDetails} [total_details]
497
- * @property {Prices} [prices]
498
- * @property {string} [returnable_date] - The last date by which the item can be returned.
499
- * @property {string} [shipment_created_at] - The date and time when the
500
- * shipment was created.
501
- * @property {string} [shipment_created_ts] - The timestamp when the shipment was created.
502
- * @property {Object} [size_info] - An object containing size information for
503
- * the items in the shipment.
504
- * @property {Bags[]} [bags] - An array containing details about the individual
505
- * bags in the shipment.
506
- * @property {string} [dp_name] - The name of the delivery partner.
507
- * @property {string} [awb_no] - The airway bill number for the shipment.
508
- * @property {boolean} [beneficiary_details] - Indicates if there are any
509
- * beneficiary details.
510
- * @property {FulfillingCompany} [fulfilling_company]
511
- * @property {boolean} [can_return] - Indicates if the shipment can be returned.
512
- * @property {Address} [delivery_address]
513
- * @property {Address} [billing_address]
514
- * @property {string} [track_url] - The URL for tracking the shipment.
515
- * @property {string} [order_id] - The unique identifier for the order.
516
- * @property {string} [need_help_url] - The URL for customer support or help.
517
- * @property {Object} [return_meta] - An object containing metadata about the
518
- * return process.
519
- * @property {string} [delivery_date] - The expected delivery date.
520
- * @property {OrderRequestSchema} [order]
521
- * @property {PriceAdjustmentCharge[]} [charges]
522
- */
523
-
524
- /**
525
- * @typedef BagsForReorderArticleAssignment
526
- * @property {string} [strategy] - The strategy used for article assignment.
527
- * @property {string} [level] - The level at which the article assignment is made.
528
- */
529
-
530
- /**
531
- * @typedef BagsForReorder
532
- * @property {string} [item_size] - The size of the item.
533
- * @property {number} [quantity] - The quantity of the item.
534
- * @property {number} [store_id] - The identifier for the store.
535
- * @property {BagsForReorderArticleAssignment} [article_assignment]
536
- * @property {number} [seller_id] - The identifier for the seller.
537
- * @property {number} [item_id] - The unique identifier for the item.
538
- */
539
-
540
- /**
541
- * @typedef OrderSchema
542
- * @property {number} [total_shipments_in_order] - The total number of shipments
543
- * in the order.
544
- * @property {string} [gstin_code] - A GST Number (Goods and Services Tax
545
- * Identification Number, often abbreviated as GSTIN) is a unique identifier
546
- * assigned to a business or individual registered under the Goods and
547
- * Services Tax (GST) system in countries like India. The GST number is
548
- * essential for businesses to comply with tax regulations and for the
549
- * government to track tax payments and returns.
550
- * @property {UserInfo} [user_info]
551
- * @property {BreakupValues[]} [breakup_values] - An array containing the
552
- * breakup of various charges and discounts.
553
- * @property {string} [order_created_time] - The date and time when the order was created.
554
- * @property {string} [order_created_ts] - The timestamp when the order was created.
555
- * @property {string} [order_id] - The unique identifier for the order.
556
- * @property {Shipments[]} [shipments] - An array containing details of
557
- * individual shipments within the order.
558
- * @property {BagsForReorder[]} [bags_for_reorder] - Order details.
559
- * @property {PriceAdjustmentCharge[]} [charges] - An array containing details
560
- * of bags available for reorder.
561
- * @property {Object} [meta] - An object containing additional metadata for the order.
562
- */
563
-
564
- /**
565
- * @typedef OrderStatuses
566
- * @property {number} [value] - The value representing the selection.
567
- * @property {boolean} [is_selected] - Indicates whether this option is
568
- * currently selected.
569
- * @property {string} [display] - The text to display .
570
- */
571
-
572
- /**
573
- * @typedef OrderFilters
574
- * @property {OrderStatuses[]} [statuses] - An array containing the order statuses.
575
- */
576
-
577
- /**
578
- * @typedef OrderList
579
- * @property {OrderPage} [page]
580
- * @property {OrderSchema[]} [items] - List of orders, each containing detailed
581
- * information about individual orders and their respective shipments.
582
- * @property {OrderFilters} [filters]
583
- */
584
-
585
- /**
586
- * @typedef ApefaceApiError
587
- * @property {string} [message] - Contains any message related to the operation.
588
- * @property {boolean} [success] - Indicates if the operation was successful.
589
- */
590
-
591
- /**
592
- * @typedef OrderById
593
- * @property {OrderSchema} [order]
594
- */
595
-
596
- /**
597
- * @typedef ShipmentById
598
- * @property {Shipments} [shipment]
599
- */
600
-
601
- /**
602
- * @typedef ResponseGetInvoiceShipment
603
- * @property {string} presigned_type - Type of presigned URL.
604
- * @property {boolean} success - Indicates if the operation was successful .
605
- * @property {string} shipment_id - Identifier for the shipment.
606
- * @property {string} presigned_url - The presigned URL for accessing the
607
- * shipment data, obtained from the response data.
608
- */
609
-
610
- /**
611
- * @typedef Track
612
- * @property {string} [account_name] - The name of the account handling the shipment.
613
- * @property {string} [shipment_type] - The type of shipment.
614
- * @property {string} [status] - The current status of the shipment.
615
- * @property {string} [last_location_recieved_at] - The last known location of
616
- * the shipment.
617
- * @property {string} [updated_time] - The timestamp of the last update.
618
- * @property {string} [updated_at] - The date and time when the shipment was last updated.
619
- * @property {string} [reason] - The reason or additional information about the shipment.
620
- * @property {string} [awb] - The Air Waybill (AWB) number for the shipment.
621
- */
622
-
623
- /**
624
- * @typedef ShipmentTrack
625
- * @property {Track[]} [results] - A array containing tracking details.
626
- */
627
-
628
- /**
629
- * @typedef CustomerDetailsResponseSchema
630
- * @property {string} [phone] - Customer's phone number.
631
- * @property {string} [shipment_id] - Unique identifier of the shipment.
632
- * @property {string} [name] - Customer's name.
633
- * @property {string} [order_id] - Unique identifier of the order.
634
- * @property {string} [country] - Country of the customer.
635
- */
636
-
637
- /**
638
- * @typedef SendOtpToCustomerResponseSchema
639
- * @property {string} [request_id] - Unique identifier for the request.
640
- * @property {string} [message] - Message indicating the result of the request.
641
- * @property {boolean} [success] - Indicates whether the request was successful.
642
- * @property {number} [resend_timer] - Time in seconds before the OTP can be resent.
643
- */
644
-
645
- /**
646
- * @typedef VerifyOtp
647
- * @property {string} [otp_code] - The OTP code provided by the user for verification.
648
- * @property {string} [request_id] - Unique identifier for the request.
649
- */
650
-
651
- /**
652
- * @typedef VerifyOtpResponseSchema
653
- * @property {boolean} [success] - Indicates whether the request was successful.
654
- */
655
-
656
- /**
657
- * @typedef BagReasonMeta
658
- * @property {boolean} [show_text_area] - Indicates whether to display a text
659
- * box on the front end.
660
- */
661
-
662
- /**
663
- * @typedef QuestionSet
664
- * @property {number} [id] - The unique identifier for the question.
665
- * @property {string} [display_name] - The text displayed for the question.
666
- */
667
-
668
- /**
669
- * @typedef BagReasons
670
- * @property {string[]} [qc_type] - List of QC (Quality Control) types -- having
671
- * return reason types indicating the stage at which QC is performed. -
672
- * "Doorstep QC" refers to the quality control checks that occur at the
673
- * customer's doorstep. This could be part of a delivery process where the
674
- * product is inspected for any damages, defects, or discrepancies in the
675
- * presence of the customer before the final handover. - "Pre QC" represents a
676
- * proactive quality control approach where the customer plays an active role
677
- * in the QC process before the product is collected for return or exchange.
678
- * In this procedure, customers are required to upload photos of the product
679
- * for a preliminary quality check by the operations team. Approval from this
680
- * team is necessary before a delivery partner is dispatched to pick up the
681
- * product. This innovative method ensures that the product meets return or
682
- * exchange criteria, streamlining the process for both the customer and the
683
- * operations team, and minimizing unnecessary logistics movements.
684
- * @property {number} [id] - The unique identifier.
685
- * @property {string} [display_name] - The text displayed.
686
- * @property {BagReasonMeta} [meta]
687
- * @property {QuestionSet[]} [question_set] - A list of questions for delivery partner.
688
- * @property {BagReasons[]} [reasons] - A list of reasons.
689
- */
690
-
691
- /**
692
- * @typedef ShipmentBagReasons
693
- * @property {BagReasons[]} [reasons] - A list of shipment's bag reasons.
694
- * @property {boolean} [success] - Indicates if the operation was successful.
695
- * @property {number} [rule_id] - The unique identifier for the rule that is
696
- * associated with the given reasons. This ID serves as a reference to the
697
- * specific rule within the RMA system that governs or influences the reasons listed.
698
- */
699
-
700
- /**
701
- * @typedef ShipmentReason
702
- * @property {number} [priority] - The priority level of the reason.
703
- * @property {boolean} [show_text_area] - A flag indicating whether to show a
704
- * textbox on the frontend.
705
- * @property {number} [reason_id] - The unique identifier for the reason.
706
- * @property {string} [feedback_type] - The type of feedback.
707
- * @property {string} [reason_text] - The text describing the reason.
708
- * @property {string} [flow] - The process flow related to the reason.
709
- */
710
-
711
- /**
712
- * @typedef ShipmentReasons
713
- * @property {ShipmentReason[]} [reasons] - A list of shipment reasons.
714
- */
715
-
716
- /**
717
- * @typedef ProductsReasonsData
718
- * @property {number} [reason_id] - The unique identifier for the reason.
719
- * @property {string} [reason_text] - The text describing the reason.
720
- */
721
-
722
- /**
723
- * @typedef ProductsReasonsFilters
724
- * @property {number} [line_number] - The specific line item of bag.
725
- * @property {number} [quantity] - The quantity of the product.
726
- * @property {string} [identifier] - The unique identifier for the product.
727
- */
728
-
729
- /**
730
- * @typedef ProductsReasons
731
- * @property {ProductsReasonsData} [data]
732
- * @property {ProductsReasonsFilters[]} [filters] - Criteria applied to filter
733
- * the products.
734
- */
735
-
736
- /**
737
- * @typedef EntityReasonData
738
- * @property {number} [reason_id] - The unique identifier for the reason.
739
- * @property {string} [reason_text] - The text describing the reason.
740
- */
741
-
742
- /**
743
- * @typedef EntitiesReasons
744
- * @property {EntityReasonData} [data]
745
- * @property {Object[]} [filters] - Criteria applied to filter the shipment.
746
- */
747
-
748
- /**
749
- * @typedef ReasonsData
750
- * @property {ProductsReasons[]} [products] - Reasons data for bags.
751
- * @property {EntitiesReasons[]} [entities] - Reasons data for shipments.
752
- */
753
-
754
- /**
755
- * @typedef Products
756
- * @property {number} [line_number] - The specific line item of bag.
757
- * @property {number} [quantity] - The quantity of the product.
758
- * @property {string} [identifier] - The unique identifier for the product.
759
- */
760
-
761
- /**
762
- * @typedef ProductsDataUpdatesFilters
763
- * @property {number} [line_number] - Represents the specific line item within a
764
- * bag, used to identify and reference a particular product in a list. This
765
- * helps in pinpointing the exact item being updated or processed.
766
- * @property {string} [identifier] - A unique string that serves as the
767
- * product’s identifier, such as a SKU, barcode, or another distinct code.
768
- * This ensures the product is correctly identified and distinguished from
769
- * other items in the system.
770
- * @property {number} [quantity] - The quantity of the product or item,
771
- * specified as an integer. This indicates how many units of the product are
772
- * being referenced or processed, such as the number of items in a bag or shipment.
773
- */
774
-
775
- /**
776
- * @typedef ProductsDataUpdates
777
- * @property {Object} [data] - Information about the data to be updated.
778
- * @property {ProductsDataUpdatesFilters[]} [filters] - Criteria applied to
779
- * filter the products.
780
- */
781
-
782
- /**
783
- * @typedef EntitiesDataUpdates
784
- * @property {Object} [data] - Information about the data to be updated.
785
- * @property {Object[]} [filters] - Criteria applied to filter the shipments.
786
- */
787
-
788
- /**
789
- * @typedef DataUpdates
790
- * @property {ProductsDataUpdates[]} [products] - Data updates for bags.
791
- * @property {EntitiesDataUpdates[]} [entities] - Data updates for shipments.
792
- */
793
-
794
- /**
795
- * @typedef ShipmentsRequestSchema
796
- * @property {ReasonsData} [reasons]
797
- * @property {Products[]} [products] - Specific bag to be updated.
798
- * @property {DataUpdates} [data_updates]
799
- * @property {string} identifier - The unique identifier for request which is
800
- * the shipment_id.
801
- */
802
-
803
- /**
804
- * @typedef StatuesRequestSchema
805
- * @property {ShipmentsRequestSchema[]} [shipments] - A list containing
806
- * information about shipments.
807
- * @property {string} [exclude_bags_next_state] - State to be change for
808
- * Remaining Bag/Products.
809
- * @property {string} [status] - The status to which the entity is to be transitioned.
810
- */
811
-
812
- /**
813
- * @typedef OrderRequestSchema
814
- * @property {Object} [meta] - Metadata for the order.
815
- */
816
-
817
- /**
818
- * @typedef UpdateShipmentStatusRequestSchema
819
- * @property {StatuesRequestSchema[]} [statuses] - An array containing different
820
- * status details.
821
- * @property {boolean} [task] - Indicates whether the task is active or required.
822
- * @property {boolean} [lock_after_transition] - Indicates whether the status
823
- * should be locked after the transition.
824
- * @property {boolean} [force_transition] - Indicates whether the transition
825
- * should be forced.
826
- * @property {boolean} [unlock_before_transition] - Indicates whether the status
827
- * should be unlocked before the transition.
828
- */
829
-
830
- /**
831
- * @typedef StatusesBodyResponseSchema
832
- * @property {Object[]} [shipments] - List of shipments.
833
- */
834
-
835
- /**
836
- * @typedef ShipmentApplicationStatusResponseSchema
837
- * @property {StatusesBodyResponseSchema[]} [statuses] - An array containing
838
- * different status options of shipments.
839
- */
840
-
841
- /**
842
- * @typedef ErrorResponseSchema
843
- * @property {string} [code] - The HTTP status code of the response.
844
- * @property {string} [message] - A message providing details about the response.
845
- * @property {number} [status] - An additional code providing more context about
846
- * the response.
847
- * @property {string} [exception] - Details of any exception that occurred.
848
- * @property {string} [stack_trace] - The stack trace of any exception that occurred.
849
- */
850
-
851
- class OrderApplicationModel {
852
- /** @returns {OrderPage} */
853
- static OrderPage() {
854
- return Joi.object({
855
- type: Joi.string().allow(""),
856
- item_total: Joi.number(),
857
- current: Joi.number(),
858
- size: Joi.number(),
859
- has_next: Joi.boolean(),
860
- });
861
- }
862
-
863
- /** @returns {UserInfo} */
864
- static UserInfo() {
865
- return Joi.object({
866
- first_name: Joi.string().allow(""),
867
- gender: Joi.string().allow(""),
868
- name: Joi.string().allow(""),
869
- last_name: Joi.string().allow(""),
870
- mobile: Joi.string().allow(""),
871
- email: Joi.string().allow(""),
872
- });
873
- }
874
-
875
- /** @returns {BreakupValues} */
876
- static BreakupValues() {
877
- return Joi.object({
878
- value: Joi.number(),
879
- currency_symbol: Joi.string().allow(""),
880
- name: Joi.string().allow(""),
881
- display: Joi.string().allow(""),
882
- currency_code: Joi.string().allow(""),
883
- });
884
- }
885
-
886
- /** @returns {ShipmentPayment} */
887
- static ShipmentPayment() {
888
- return Joi.object({
889
- mop: Joi.string().allow(""),
890
- payment_mode: Joi.string().allow(""),
891
- status: Joi.string().allow(""),
892
- mode: Joi.string().allow(""),
893
- logo: Joi.string().allow(""),
894
- display_name: Joi.string().allow(""),
895
- });
896
- }
897
-
898
- /** @returns {ShipmentPaymentInfo} */
899
- static ShipmentPaymentInfo() {
900
- return Joi.object({
901
- mop: Joi.string().allow(""),
902
- payment_mode: Joi.string().allow(""),
903
- status: Joi.string().allow(""),
904
- mode: Joi.string().allow(""),
905
- logo: Joi.string().allow(""),
906
- display_name: Joi.string().allow(""),
907
- amount: Joi.number(),
908
- });
909
- }
910
-
911
- /** @returns {ShipmentUserInfo} */
912
- static ShipmentUserInfo() {
913
- return Joi.object({
914
- first_name: Joi.string().allow(""),
915
- gender: Joi.string().allow(""),
916
- name: Joi.string().allow(""),
917
- last_name: Joi.string().allow(""),
918
- mobile: Joi.string().allow(""),
919
- email: Joi.string().allow(""),
920
- });
921
- }
922
-
923
- /** @returns {FulfillingStore} */
924
- static FulfillingStore() {
925
- return Joi.object({
926
- id: Joi.number(),
927
- code: Joi.string().allow(""),
928
- name: Joi.string().allow(""),
929
- company_name: Joi.string().allow(""),
930
- company_id: Joi.number(),
931
- });
932
- }
933
-
934
- /** @returns {ChargeDistributionSchema} */
935
- static ChargeDistributionSchema() {
936
- return Joi.object({
937
- type: Joi.string().allow("").required(),
938
- logic: Joi.string().allow("").required(),
939
- });
940
- }
941
-
942
- /** @returns {ChargeDistributionLogic} */
943
- static ChargeDistributionLogic() {
944
- return Joi.object({
945
- distribution: OrderApplicationModel.ChargeDistributionSchema().required(),
946
- distribution_level: Joi.string().allow("").required(),
947
- });
948
- }
949
-
950
- /** @returns {ChargeAmountCurrency} */
951
- static ChargeAmountCurrency() {
952
- return Joi.object({
953
- value: Joi.number().required(),
954
- currency: Joi.string().allow("").required(),
955
- });
956
- }
957
-
958
- /** @returns {ChargeAmount} */
959
- static ChargeAmount() {
960
- return Joi.object({
961
- base_currency: OrderApplicationModel.ChargeAmountCurrency().required(),
962
- ordering_currency: OrderApplicationModel.ChargeAmountCurrency().required(),
963
- });
964
- }
965
-
966
- /** @returns {PriceAdjustmentCharge} */
967
- static PriceAdjustmentCharge() {
968
- return Joi.object({
969
- code: Joi.string().allow("").allow(null),
970
- name: Joi.string().allow("").required(),
971
- type: Joi.string().allow("").allow(null),
972
- amount: OrderApplicationModel.ChargeAmount().required(),
973
- distribution_logic: OrderApplicationModel.ChargeDistributionLogic().required(),
974
- });
975
- }
976
-
977
- /** @returns {ShipmentStatus} */
978
- static ShipmentStatus() {
979
- return Joi.object({
980
- value: Joi.string().allow("").allow(null),
981
- title: Joi.string().allow(""),
982
- hex_code: Joi.string().allow(""),
983
- });
984
- }
985
-
986
- /** @returns {Invoice} */
987
- static Invoice() {
988
- return Joi.object({
989
- invoice_url: Joi.string().allow(""),
990
- updated_date: Joi.string().allow(""),
991
- label_url: Joi.string().allow(""),
992
- });
993
- }
994
-
995
- /** @returns {NestedTrackingDetails} */
996
- static NestedTrackingDetails() {
997
- return Joi.object({
998
- is_passed: Joi.boolean(),
999
- time: Joi.string().allow(""),
1000
- is_current: Joi.boolean(),
1001
- status: Joi.string().allow(""),
1002
- });
1003
- }
1004
-
1005
- /** @returns {TrackingDetails} */
1006
- static TrackingDetails() {
1007
- return Joi.object({
1008
- value: Joi.string().allow("").allow(null),
1009
- is_current: Joi.boolean(),
1010
- is_passed: Joi.boolean(),
1011
- status: Joi.string().allow(""),
1012
- time: Joi.string().allow(""),
1013
- created_ts: Joi.string().allow(""),
1014
- tracking_details: Joi.array().items(
1015
- OrderApplicationModel.NestedTrackingDetails()
1016
- ),
1017
- });
1018
- }
1019
-
1020
- /** @returns {TimeStampData} */
1021
- static TimeStampData() {
1022
- return Joi.object({
1023
- min: Joi.string().allow(""),
1024
- max: Joi.string().allow(""),
1025
- });
1026
- }
1027
-
1028
- /** @returns {Promise} */
1029
- static Promise() {
1030
- return Joi.object({
1031
- show_promise: Joi.boolean(),
1032
- timestamp: OrderApplicationModel.TimeStampData(),
1033
- });
1034
- }
1035
-
1036
- /** @returns {ShipmentTotalDetails} */
1037
- static ShipmentTotalDetails() {
1038
- return Joi.object({
1039
- pieces: Joi.number(),
1040
- total_price: Joi.number(),
1041
- sizes: Joi.number(),
1042
- });
1043
- }
1044
-
1045
- /** @returns {Prices} */
1046
- static Prices() {
1047
- return Joi.object({
1048
- delivery_charge: Joi.number(),
1049
- coupon_value: Joi.number(),
1050
- brand_calculated_amount: Joi.number(),
1051
- value_of_good: Joi.number(),
1052
- price_marked: Joi.number(),
1053
- coupon_effective_discount: Joi.number(),
1054
- currency_symbol: Joi.string().allow(""),
1055
- discount: Joi.number(),
1056
- gst_tax_percentage: Joi.number(),
1057
- cod_charges: Joi.number(),
1058
- amount_paid: Joi.number(),
1059
- added_to_fynd_cash: Joi.boolean(),
1060
- transfer_price: Joi.number(),
1061
- cashback_applied: Joi.number(),
1062
- price_effective: Joi.number(),
1063
- cashback: Joi.number(),
1064
- refund_credit: Joi.number(),
1065
- amount_paid_roundoff: Joi.number(),
1066
- promotion_effective_discount: Joi.number(),
1067
- refund_amount: Joi.number(),
1068
- currency_code: Joi.string().allow(""),
1069
- fynd_credits: Joi.number(),
1070
- amount_to_be_collected: Joi.number(),
1071
- });
1072
- }
1073
-
1074
- /** @returns {ItemBrand} */
1075
- static ItemBrand() {
1076
- return Joi.object({
1077
- logo: Joi.string().allow(""),
1078
- name: Joi.string().allow(""),
1079
- });
1080
- }
1081
-
1082
- /** @returns {Item} */
1083
- static Item() {
1084
- return Joi.object({
1085
- image: Joi.array().items(Joi.string().allow("")),
1086
- l1_categories: Joi.array().items(Joi.string().allow("")),
1087
- brand: OrderApplicationModel.ItemBrand(),
1088
- seller_identifier: Joi.string().allow(""),
1089
- code: Joi.string().allow(""),
1090
- id: Joi.number(),
1091
- name: Joi.string().allow(""),
1092
- l3_category_name: Joi.string().allow(""),
1093
- slug_key: Joi.string().allow(""),
1094
- l2_categories: Joi.array().items(Joi.string().allow("")),
1095
- size: Joi.string().allow(""),
1096
- attributes: Joi.object().pattern(/\S/, Joi.any()),
1097
- });
1098
- }
1099
-
1100
- /** @returns {AppliedFreeArticles} */
1101
- static AppliedFreeArticles() {
1102
- return Joi.object({
1103
- article_id: Joi.string().allow(""),
1104
- free_gift_item_details: Joi.object().pattern(/\S/, Joi.any()),
1105
- parent_item_identifier: Joi.string().allow(""),
1106
- quantity: Joi.number(),
1107
- });
1108
- }
1109
-
1110
- /** @returns {AppliedPromos} */
1111
- static AppliedPromos() {
1112
- return Joi.object({
1113
- mrp_promotion: Joi.boolean(),
1114
- promotion_name: Joi.string().allow(""),
1115
- article_quantity: Joi.number(),
1116
- promo_id: Joi.string().allow(""),
1117
- amount: Joi.number(),
1118
- promotion_type: Joi.string().allow(""),
1119
- applied_free_articles: Joi.array().items(
1120
- OrderApplicationModel.AppliedFreeArticles()
1121
- ),
1122
- });
1123
- }
1124
-
1125
- /** @returns {Identifiers} */
1126
- static Identifiers() {
1127
- return Joi.object({
1128
- ean: Joi.string().allow(""),
1129
- sku_code: Joi.string().allow(""),
1130
- });
1131
- }
1132
-
1133
- /** @returns {FinancialBreakup} */
1134
- static FinancialBreakup() {
1135
- return Joi.object({
1136
- coupon_value: Joi.number(),
1137
- delivery_charge: Joi.number(),
1138
- brand_calculated_amount: Joi.number(),
1139
- value_of_good: Joi.number(),
1140
- price_marked: Joi.number(),
1141
- coupon_effective_discount: Joi.number(),
1142
- hsn_code: Joi.string().allow(""),
1143
- discount: Joi.number(),
1144
- gst_tax_percentage: Joi.number(),
1145
- cod_charges: Joi.number(),
1146
- amount_paid: Joi.number(),
1147
- added_to_fynd_cash: Joi.boolean(),
1148
- size: Joi.string().allow(""),
1149
- transfer_price: Joi.number(),
1150
- cashback_applied: Joi.number(),
1151
- price_effective: Joi.number(),
1152
- cashback: Joi.number(),
1153
- refund_credit: Joi.number(),
1154
- amount_paid_roundoff: Joi.number(),
1155
- total_units: Joi.number(),
1156
- identifiers: OrderApplicationModel.Identifiers(),
1157
- gst_tag: Joi.string().allow(""),
1158
- item_name: Joi.string().allow(""),
1159
- promotion_effective_discount: Joi.number(),
1160
- gst_fee: Joi.number(),
1161
- refund_amount: Joi.number(),
1162
- fynd_credits: Joi.number(),
1163
- amount_to_be_collected: Joi.number(),
1164
- });
1165
- }
1166
-
1167
- /** @returns {CurrentStatus} */
1168
- static CurrentStatus() {
1169
- return Joi.object({
1170
- updated_at: Joi.string().allow(""),
1171
- name: Joi.string().allow(""),
1172
- status: Joi.string().allow(""),
1173
- journey_type: Joi.string().allow("").allow(null),
1174
- });
1175
- }
1176
-
1177
- /** @returns {Bags} */
1178
- static Bags() {
1179
- return Joi.object({
1180
- delivery_date: Joi.string().allow("").allow(null),
1181
- line_number: Joi.number(),
1182
- currency_symbol: Joi.string().allow(""),
1183
- item: OrderApplicationModel.Item(),
1184
- applied_promos: Joi.array().items(OrderApplicationModel.AppliedPromos()),
1185
- quantity: Joi.number(),
1186
- prices: OrderApplicationModel.Prices(),
1187
- can_cancel: Joi.boolean(),
1188
- can_return: Joi.boolean(),
1189
- id: Joi.number(),
1190
- returnable_date: Joi.string().allow("").allow(null),
1191
- financial_breakup: Joi.array().items(
1192
- OrderApplicationModel.FinancialBreakup()
1193
- ),
1194
- parent_promo_bags: Joi.object().pattern(/\S/, Joi.any()),
1195
- meta: Joi.object().pattern(/\S/, Joi.any()),
1196
- currency_code: Joi.string().allow(""),
1197
- seller_identifier: Joi.string().allow(""),
1198
- current_status: OrderApplicationModel.CurrentStatus(),
1199
- article: OrderApplicationModel.Article(),
1200
- charges: Joi.array().items(OrderApplicationModel.PriceAdjustmentCharge()),
1201
- });
1202
- }
1203
-
1204
- /** @returns {FulfillingCompany} */
1205
- static FulfillingCompany() {
1206
- return Joi.object({
1207
- id: Joi.number(),
1208
- name: Joi.string().allow(""),
1209
- });
1210
- }
1211
-
1212
- /** @returns {Article} */
1213
- static Article() {
1214
- return Joi.object({
1215
- tags: Joi.array().items(Joi.string().allow("")),
1216
- }).allow(null);
1217
- }
1218
-
1219
- /** @returns {Address} */
1220
- static Address() {
1221
- return Joi.object({
1222
- pincode: Joi.string().allow(""),
1223
- phone: Joi.string().allow(""),
1224
- latitude: Joi.number().allow(null),
1225
- address2: Joi.string().allow(""),
1226
- landmark: Joi.string().allow(""),
1227
- area: Joi.string().allow(""),
1228
- city: Joi.string().allow(""),
1229
- address: Joi.string().allow(""),
1230
- address_type: Joi.string().allow(""),
1231
- longitude: Joi.number().allow(null),
1232
- country_iso_code: Joi.string().allow(""),
1233
- state: Joi.string().allow(""),
1234
- created_at: Joi.string().allow(""),
1235
- address1: Joi.string().allow(""),
1236
- display_address: Joi.string().allow(""),
1237
- name: Joi.string().allow(""),
1238
- contact_person: Joi.string().allow(""),
1239
- address_category: Joi.string().allow(""),
1240
- email: Joi.string().allow(""),
1241
- country_phone_code: Joi.string().allow(""),
1242
- version: Joi.string().allow(""),
1243
- updated_at: Joi.string().allow(""),
1244
- country: Joi.string().allow(""),
1245
- });
1246
- }
1247
-
1248
- /** @returns {Shipments} */
1249
- static Shipments() {
1250
- return Joi.object({
1251
- payment: OrderApplicationModel.ShipmentPayment(),
1252
- payment_info: Joi.array().items(
1253
- OrderApplicationModel.ShipmentPaymentInfo()
1254
- ),
1255
- order_type: Joi.string().allow("").allow(null),
1256
- gstin_code: Joi.string().allow(""),
1257
- show_download_invoice: Joi.boolean(),
1258
- can_cancel: Joi.boolean(),
1259
- user_info: OrderApplicationModel.ShipmentUserInfo(),
1260
- shipment_id: Joi.string().allow(""),
1261
- fulfilling_store: OrderApplicationModel.FulfillingStore(),
1262
- custom_meta: Joi.array().items(Joi.any()),
1263
- shipment_status: OrderApplicationModel.ShipmentStatus(),
1264
- comment: Joi.string().allow(""),
1265
- invoice: OrderApplicationModel.Invoice(),
1266
- show_track_link: Joi.boolean(),
1267
- refund_details: Joi.object().pattern(/\S/, Joi.any()),
1268
- breakup_values: Joi.array().items(OrderApplicationModel.BreakupValues()),
1269
- can_break: Joi.object().pattern(/\S/, Joi.any()),
1270
- traking_no: Joi.string().allow(""),
1271
- tracking_details: Joi.array().items(
1272
- OrderApplicationModel.TrackingDetails()
1273
- ),
1274
- promise: OrderApplicationModel.Promise(),
1275
- total_bags: Joi.number(),
1276
- total_details: OrderApplicationModel.ShipmentTotalDetails(),
1277
- prices: OrderApplicationModel.Prices(),
1278
- returnable_date: Joi.string().allow("").allow(null),
1279
- shipment_created_at: Joi.string().allow(""),
1280
- shipment_created_ts: Joi.string().allow(""),
1281
- size_info: Joi.object().pattern(/\S/, Joi.any()),
1282
- bags: Joi.array().items(OrderApplicationModel.Bags()),
1283
- dp_name: Joi.string().allow(""),
1284
- awb_no: Joi.string().allow(""),
1285
- beneficiary_details: Joi.boolean(),
1286
- fulfilling_company: OrderApplicationModel.FulfillingCompany(),
1287
- can_return: Joi.boolean(),
1288
- delivery_address: OrderApplicationModel.Address(),
1289
- billing_address: OrderApplicationModel.Address(),
1290
- track_url: Joi.string().allow(""),
1291
- order_id: Joi.string().allow(""),
1292
- need_help_url: Joi.string().allow(""),
1293
- return_meta: Joi.object().pattern(/\S/, Joi.any()),
1294
- delivery_date: Joi.string().allow("").allow(null),
1295
- order: OrderApplicationModel.OrderRequestSchema(),
1296
- charges: Joi.array().items(OrderApplicationModel.PriceAdjustmentCharge()),
1297
- });
1298
- }
1299
-
1300
- /** @returns {BagsForReorderArticleAssignment} */
1301
- static BagsForReorderArticleAssignment() {
1302
- return Joi.object({
1303
- strategy: Joi.string().allow(""),
1304
- level: Joi.string().allow(""),
1305
- });
1306
- }
1307
-
1308
- /** @returns {BagsForReorder} */
1309
- static BagsForReorder() {
1310
- return Joi.object({
1311
- item_size: Joi.string().allow(""),
1312
- quantity: Joi.number(),
1313
- store_id: Joi.number(),
1314
- article_assignment: OrderApplicationModel.BagsForReorderArticleAssignment(),
1315
- seller_id: Joi.number(),
1316
- item_id: Joi.number(),
1317
- });
1318
- }
1319
-
1320
- /** @returns {OrderSchema} */
1321
- static OrderSchema() {
1322
- return Joi.object({
1323
- total_shipments_in_order: Joi.number(),
1324
- gstin_code: Joi.string().allow(""),
1325
- user_info: OrderApplicationModel.UserInfo(),
1326
- breakup_values: Joi.array().items(OrderApplicationModel.BreakupValues()),
1327
- order_created_time: Joi.string().allow(""),
1328
- order_created_ts: Joi.string().allow(""),
1329
- order_id: Joi.string().allow(""),
1330
- shipments: Joi.array().items(OrderApplicationModel.Shipments()),
1331
- bags_for_reorder: Joi.array().items(
1332
- OrderApplicationModel.BagsForReorder()
1333
- ),
1334
- charges: Joi.array().items(OrderApplicationModel.PriceAdjustmentCharge()),
1335
- meta: Joi.object().pattern(/\S/, Joi.any()),
1336
- });
1337
- }
1338
-
1339
- /** @returns {OrderStatuses} */
1340
- static OrderStatuses() {
1341
- return Joi.object({
1342
- value: Joi.number(),
1343
- is_selected: Joi.boolean(),
1344
- display: Joi.string().allow(""),
1345
- });
1346
- }
1347
-
1348
- /** @returns {OrderFilters} */
1349
- static OrderFilters() {
1350
- return Joi.object({
1351
- statuses: Joi.array().items(OrderApplicationModel.OrderStatuses()),
1352
- });
1353
- }
1354
-
1355
- /** @returns {OrderList} */
1356
- static OrderList() {
1357
- return Joi.object({
1358
- page: OrderApplicationModel.OrderPage(),
1359
- items: Joi.array().items(OrderApplicationModel.OrderSchema()),
1360
- filters: OrderApplicationModel.OrderFilters(),
1361
- });
1362
- }
1363
-
1364
- /** @returns {ApefaceApiError} */
1365
- static ApefaceApiError() {
1366
- return Joi.object({
1367
- message: Joi.string().allow(""),
1368
- success: Joi.boolean(),
1369
- });
1370
- }
1371
-
1372
- /** @returns {OrderById} */
1373
- static OrderById() {
1374
- return Joi.object({
1375
- order: OrderApplicationModel.OrderSchema(),
1376
- });
1377
- }
1378
-
1379
- /** @returns {ShipmentById} */
1380
- static ShipmentById() {
1381
- return Joi.object({
1382
- shipment: OrderApplicationModel.Shipments(),
1383
- });
1384
- }
1385
-
1386
- /** @returns {ResponseGetInvoiceShipment} */
1387
- static ResponseGetInvoiceShipment() {
1388
- return Joi.object({
1389
- presigned_type: Joi.string().allow("").required(),
1390
- success: Joi.boolean().required(),
1391
- shipment_id: Joi.string().allow("").required(),
1392
- presigned_url: Joi.string().allow("").required(),
1393
- });
1394
- }
1395
-
1396
- /** @returns {Track} */
1397
- static Track() {
1398
- return Joi.object({
1399
- account_name: Joi.string().allow(""),
1400
- shipment_type: Joi.string().allow(""),
1401
- status: Joi.string().allow(""),
1402
- last_location_recieved_at: Joi.string().allow(""),
1403
- updated_time: Joi.string().allow(""),
1404
- updated_at: Joi.string().allow(""),
1405
- reason: Joi.string().allow(""),
1406
- awb: Joi.string().allow(""),
1407
- });
1408
- }
1409
-
1410
- /** @returns {ShipmentTrack} */
1411
- static ShipmentTrack() {
1412
- return Joi.object({
1413
- results: Joi.array().items(OrderApplicationModel.Track()),
1414
- });
1415
- }
1416
-
1417
- /** @returns {CustomerDetailsResponseSchema} */
1418
- static CustomerDetailsResponseSchema() {
1419
- return Joi.object({
1420
- phone: Joi.string().allow(""),
1421
- shipment_id: Joi.string().allow(""),
1422
- name: Joi.string().allow(""),
1423
- order_id: Joi.string().allow(""),
1424
- country: Joi.string().allow(""),
1425
- });
1426
- }
1427
-
1428
- /** @returns {SendOtpToCustomerResponseSchema} */
1429
- static SendOtpToCustomerResponseSchema() {
1430
- return Joi.object({
1431
- request_id: Joi.string().allow(""),
1432
- message: Joi.string().allow(""),
1433
- success: Joi.boolean(),
1434
- resend_timer: Joi.number(),
1435
- });
1436
- }
1437
-
1438
- /** @returns {VerifyOtp} */
1439
- static VerifyOtp() {
1440
- return Joi.object({
1441
- otp_code: Joi.string().allow(""),
1442
- request_id: Joi.string().allow(""),
1443
- });
1444
- }
1445
-
1446
- /** @returns {VerifyOtpResponseSchema} */
1447
- static VerifyOtpResponseSchema() {
1448
- return Joi.object({
1449
- success: Joi.boolean(),
1450
- });
1451
- }
1452
-
1453
- /** @returns {BagReasonMeta} */
1454
- static BagReasonMeta() {
1455
- return Joi.object({
1456
- show_text_area: Joi.boolean(),
1457
- });
1458
- }
1459
-
1460
- /** @returns {QuestionSet} */
1461
- static QuestionSet() {
1462
- return Joi.object({
1463
- id: Joi.number(),
1464
- display_name: Joi.string().allow(""),
1465
- });
1466
- }
1467
-
1468
- /** @returns {BagReasons} */
1469
- static BagReasons() {
1470
- return Joi.object({
1471
- qc_type: Joi.array().items(Joi.string().allow("")),
1472
- id: Joi.number(),
1473
- display_name: Joi.string().allow(""),
1474
- meta: OrderApplicationModel.BagReasonMeta(),
1475
- question_set: Joi.array().items(OrderApplicationModel.QuestionSet()),
1476
- reasons: Joi.array().items(Joi.link("#BagReasons")),
1477
- }).id("BagReasons");
1478
- }
1479
-
1480
- /** @returns {ShipmentBagReasons} */
1481
- static ShipmentBagReasons() {
1482
- return Joi.object({
1483
- reasons: Joi.array().items(OrderApplicationModel.BagReasons()),
1484
- success: Joi.boolean(),
1485
- rule_id: Joi.number().allow(null),
1486
- });
1487
- }
1488
-
1489
- /** @returns {ShipmentReason} */
1490
- static ShipmentReason() {
1491
- return Joi.object({
1492
- priority: Joi.number(),
1493
- show_text_area: Joi.boolean(),
1494
- reason_id: Joi.number(),
1495
- feedback_type: Joi.string().allow(""),
1496
- reason_text: Joi.string().allow(""),
1497
- flow: Joi.string().allow(""),
1498
- });
1499
- }
1500
-
1501
- /** @returns {ShipmentReasons} */
1502
- static ShipmentReasons() {
1503
- return Joi.object({
1504
- reasons: Joi.array().items(OrderApplicationModel.ShipmentReason()),
1505
- });
1506
- }
1507
-
1508
- /** @returns {ProductsReasonsData} */
1509
- static ProductsReasonsData() {
1510
- return Joi.object({
1511
- reason_id: Joi.number(),
1512
- reason_text: Joi.string().allow(""),
1513
- });
1514
- }
1515
-
1516
- /** @returns {ProductsReasonsFilters} */
1517
- static ProductsReasonsFilters() {
1518
- return Joi.object({
1519
- line_number: Joi.number(),
1520
- quantity: Joi.number(),
1521
- identifier: Joi.string().allow(""),
1522
- });
1523
- }
1524
-
1525
- /** @returns {ProductsReasons} */
1526
- static ProductsReasons() {
1527
- return Joi.object({
1528
- data: OrderApplicationModel.ProductsReasonsData(),
1529
- filters: Joi.array().items(
1530
- OrderApplicationModel.ProductsReasonsFilters()
1531
- ),
1532
- });
1533
- }
1534
-
1535
- /** @returns {EntityReasonData} */
1536
- static EntityReasonData() {
1537
- return Joi.object({
1538
- reason_id: Joi.number(),
1539
- reason_text: Joi.string().allow(""),
1540
- });
1541
- }
1542
-
1543
- /** @returns {EntitiesReasons} */
1544
- static EntitiesReasons() {
1545
- return Joi.object({
1546
- data: OrderApplicationModel.EntityReasonData(),
1547
- filters: Joi.array().items(Joi.any()),
1548
- });
1549
- }
1550
-
1551
- /** @returns {ReasonsData} */
1552
- static ReasonsData() {
1553
- return Joi.object({
1554
- products: Joi.array().items(OrderApplicationModel.ProductsReasons()),
1555
- entities: Joi.array().items(OrderApplicationModel.EntitiesReasons()),
1556
- });
1557
- }
1558
-
1559
- /** @returns {Products} */
1560
- static Products() {
1561
- return Joi.object({
1562
- line_number: Joi.number(),
1563
- quantity: Joi.number(),
1564
- identifier: Joi.string().allow(""),
1565
- });
1566
- }
1567
-
1568
- /** @returns {ProductsDataUpdatesFilters} */
1569
- static ProductsDataUpdatesFilters() {
1570
- return Joi.object({
1571
- line_number: Joi.number(),
1572
- identifier: Joi.string().allow(""),
1573
- quantity: Joi.number(),
1574
- });
1575
- }
1576
-
1577
- /** @returns {ProductsDataUpdates} */
1578
- static ProductsDataUpdates() {
1579
- return Joi.object({
1580
- data: Joi.object().pattern(/\S/, Joi.any()),
1581
- filters: Joi.array().items(
1582
- OrderApplicationModel.ProductsDataUpdatesFilters()
1583
- ),
1584
- });
1585
- }
1586
-
1587
- /** @returns {EntitiesDataUpdates} */
1588
- static EntitiesDataUpdates() {
1589
- return Joi.object({
1590
- data: Joi.object().pattern(/\S/, Joi.any()),
1591
- filters: Joi.array().items(Joi.any()),
1592
- });
1593
- }
1594
-
1595
- /** @returns {DataUpdates} */
1596
- static DataUpdates() {
1597
- return Joi.object({
1598
- products: Joi.array().items(OrderApplicationModel.ProductsDataUpdates()),
1599
- entities: Joi.array().items(OrderApplicationModel.EntitiesDataUpdates()),
1600
- });
1601
- }
1602
-
1603
- /** @returns {ShipmentsRequestSchema} */
1604
- static ShipmentsRequestSchema() {
1605
- return Joi.object({
1606
- reasons: OrderApplicationModel.ReasonsData(),
1607
- products: Joi.array().items(OrderApplicationModel.Products()),
1608
- data_updates: OrderApplicationModel.DataUpdates(),
1609
- identifier: Joi.string().allow("").required(),
1610
- });
1611
- }
1612
-
1613
- /** @returns {StatuesRequestSchema} */
1614
- static StatuesRequestSchema() {
1615
- return Joi.object({
1616
- shipments: Joi.array().items(
1617
- OrderApplicationModel.ShipmentsRequestSchema()
1618
- ),
1619
- exclude_bags_next_state: Joi.string().allow(""),
1620
- status: Joi.string().allow(""),
1621
- });
1622
- }
1623
-
1624
- /** @returns {OrderRequestSchema} */
1625
- static OrderRequestSchema() {
1626
- return Joi.object({
1627
- meta: Joi.object().pattern(/\S/, Joi.any()),
1628
- });
1629
- }
1630
-
1631
- /** @returns {UpdateShipmentStatusRequestSchema} */
1632
- static UpdateShipmentStatusRequestSchema() {
1633
- return Joi.object({
1634
- statuses: Joi.array().items(OrderApplicationModel.StatuesRequestSchema()),
1635
- task: Joi.boolean(),
1636
- lock_after_transition: Joi.boolean(),
1637
- force_transition: Joi.boolean(),
1638
- unlock_before_transition: Joi.boolean(),
1639
- });
1640
- }
1641
-
1642
- /** @returns {StatusesBodyResponseSchema} */
1643
- static StatusesBodyResponseSchema() {
1644
- return Joi.object({
1645
- shipments: Joi.array().items(Joi.any()),
1646
- });
1647
- }
1648
-
1649
- /** @returns {ShipmentApplicationStatusResponseSchema} */
1650
- static ShipmentApplicationStatusResponseSchema() {
1651
- return Joi.object({
1652
- statuses: Joi.array().items(
1653
- OrderApplicationModel.StatusesBodyResponseSchema()
1654
- ),
1655
- });
1656
- }
1657
-
1658
- /** @returns {ErrorResponseSchema} */
1659
- static ErrorResponseSchema() {
1660
- return Joi.object({
1661
- code: Joi.string().allow("").allow(null),
1662
- message: Joi.string().allow("").allow(null),
1663
- status: Joi.number(),
1664
- exception: Joi.string().allow("").allow(null),
1665
- stack_trace: Joi.string().allow("").allow(null),
1666
- });
1667
- }
1668
- }
1669
- module.exports = OrderApplicationModel;