@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15

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 (278) hide show
  1. package/README.md +23 -26
  2. package/package.json +5 -1
  3. package/sdk/application/ApplicationClient.d.ts +5 -6
  4. package/sdk/application/ApplicationClient.js +24 -20
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
  6. package/sdk/application/Cart/CartApplicationClient.js +444 -76
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
  16. package/sdk/application/Content/ContentApplicationClient.js +274 -111
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +6 -6
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
  26. package/sdk/application/Order/OrderApplicationClient.js +217 -17
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
  28. package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
  32. package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
  33. package/sdk/application/User/UserApplicationClient.d.ts +103 -53
  34. package/sdk/application/User/UserApplicationClient.js +308 -49
  35. package/sdk/common/AxiosHelper.js +11 -4
  36. package/sdk/common/Constant.d.ts +27 -4
  37. package/sdk/common/Constant.js +33 -6
  38. package/sdk/common/utils.d.ts +10 -0
  39. package/sdk/common/utils.js +24 -3
  40. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
  41. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
  42. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
  43. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
  44. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
  45. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
  46. package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
  47. package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
  48. package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
  49. package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
  50. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
  51. package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
  52. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
  53. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
  54. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
  55. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
  56. package/sdk/partner/PartnerClient.d.ts +5 -2
  57. package/sdk/partner/PartnerClient.js +21 -7
  58. package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
  59. package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
  60. package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
  61. package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
  62. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  63. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
  64. package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
  65. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
  66. package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
  67. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
  68. package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
  69. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
  70. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
  71. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  73. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
  75. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  81. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  82. package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
  83. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  84. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  85. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  86. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  87. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
  89. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
  91. package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
  92. package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
  93. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
  97. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
  98. package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
  99. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
  100. package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
  101. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
  103. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
  104. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  105. package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
  106. package/sdk/platform/Common/CommonPlatformModel.js +25 -14
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
  111. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  112. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  113. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
  114. package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
  124. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
  126. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
  128. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  130. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
  132. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
  134. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
  135. package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
  136. package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
  137. package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
  138. package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
  139. package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
  140. package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
  141. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
  142. package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
  143. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
  144. package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  146. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
  150. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
  152. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
  154. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  156. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  159. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  160. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  161. package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
  162. package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
  163. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
  164. package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
  165. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
  166. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
  167. package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
  168. package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
  169. package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
  170. package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
  171. package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
  172. package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
  173. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
  175. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  177. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
  178. package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
  179. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
  180. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
  181. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
  182. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
  183. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
  184. package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
  185. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
  186. package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
  187. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  188. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  189. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  190. package/sdk/platform/PlatformApplicationClient.js +0 -4
  191. package/sdk/platform/PlatformClient.d.ts +5 -4
  192. package/sdk/platform/PlatformClient.js +32 -22
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
  203. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  204. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
  206. package/sdk/platform/Share/SharePlatformModel.js +31 -6
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  212. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
  214. package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
  215. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
  216. package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
  217. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
  218. package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
  219. package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
  220. package/sdk/platform/User/UserPlatformModel.js +607 -46
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  226. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  227. package/sdk/platform/index.d.ts +0 -2
  228. package/sdk/platform/index.js +0 -4
  229. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  230. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  231. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  232. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  233. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  234. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
  239. package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
  240. package/sdk/public/Content/ContentPublicClient.js +1067 -17
  241. package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
  242. package/sdk/public/Content/ContentPublicModel.js +751 -3
  243. package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
  244. package/sdk/public/Content/ContentPublicValidator.js +119 -2
  245. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  246. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  247. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  248. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  249. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  250. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  251. package/sdk/public/PublicClient.d.ts +5 -2
  252. package/sdk/public/PublicClient.js +16 -6
  253. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
  254. package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
  255. package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
  256. package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
  257. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  258. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  259. package/sdk/public/index.d.ts +1 -0
  260. package/sdk/public/index.js +2 -0
  261. package/utility.d.ts +3 -0
  262. package/utility.js +7 -0
  263. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  264. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  265. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
  266. package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
  267. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  268. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  269. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  270. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  271. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  272. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
@@ -1,12 +1,12 @@
1
1
  export = CompanyProfilePlatformModel;
2
2
  /**
3
- * @typedef CompanyTaxesSerializer
3
+ * @typedef CompanyTaxesSchema
4
4
  * @property {string} [effective_date]
5
5
  * @property {number} [rate]
6
6
  * @property {boolean} [enable]
7
7
  */
8
8
  /**
9
- * @typedef UserSerializer
9
+ * @typedef UserSchema
10
10
  * @property {string} [user_id]
11
11
  * @property {string} [contact]
12
12
  * @property {string} [username]
@@ -51,10 +51,10 @@ export = CompanyProfilePlatformModel;
51
51
  * @property {string} [url]
52
52
  */
53
53
  /**
54
- * @typedef GetAddressSerializer
54
+ * @typedef GetAddressSchema
55
55
  * @property {string} [landmark]
56
56
  * @property {string} [country_code]
57
- * @property {number} [pincode]
57
+ * @property {string} [pincode]
58
58
  * @property {string} [address_type]
59
59
  * @property {number} longitude
60
60
  * @property {string} [country]
@@ -67,14 +67,14 @@ export = CompanyProfilePlatformModel;
67
67
  * @property {number} latitude
68
68
  */
69
69
  /**
70
- * @typedef GetCompanyProfileSerializerResponse
70
+ * @typedef GetCompanyProfileSerializerResponseSchema
71
71
  * @property {string} [business_info]
72
- * @property {CompanyTaxesSerializer[]} [taxes]
72
+ * @property {CompanyTaxesSchema[]} [taxes]
73
73
  * @property {string} [business_type]
74
74
  * @property {string} [name]
75
75
  * @property {Object} [_custom_json]
76
76
  * @property {string} [verified_on]
77
- * @property {UserSerializer} [created_by]
77
+ * @property {UserSchema} [created_by]
78
78
  * @property {string} [created_on]
79
79
  * @property {Object} [warnings]
80
80
  * @property {BusinessDetails} [business_details]
@@ -87,29 +87,29 @@ export = CompanyProfilePlatformModel;
87
87
  * @property {string} [stage]
88
88
  * @property {string} company_type
89
89
  * @property {Document[]} [documents]
90
- * @property {GetAddressSerializer[]} [addresses]
91
- * @property {UserSerializer} [verified_by]
90
+ * @property {GetAddressSchema[]} [addresses]
91
+ * @property {UserSchema} [verified_by]
92
92
  * @property {string[]} [notification_emails]
93
- * @property {UserSerializer} [modified_by]
93
+ * @property {UserSchema} [modified_by]
94
94
  */
95
95
  /**
96
- * @typedef ErrorResponse
97
- * @property {string} [message]
98
- * @property {string} [code]
99
- * @property {number} [status]
100
- * @property {Object} [meta]
96
+ * @typedef ErrorResponseSchema
97
+ * @property {string} [message] - A descriptive message providing details about
98
+ * the error, intended to convey the nature and context of the issue.
99
+ * @property {Object} [error] - An object containing additional error details,
100
+ * which may vary depending on the error type.
101
101
  */
102
102
  /**
103
- * @typedef CompanyTaxesSerializer1
103
+ * @typedef CompanyRequestTaxesSchema
104
104
  * @property {string} [effective_date]
105
105
  * @property {number} [rate]
106
106
  * @property {boolean} [enable]
107
107
  */
108
108
  /**
109
- * @typedef CreateUpdateAddressSerializer
109
+ * @typedef CreateUpdateAddressSchema
110
110
  * @property {string} [landmark]
111
111
  * @property {string} [country_code]
112
- * @property {number} pincode
112
+ * @property {string} pincode
113
113
  * @property {string} address_type
114
114
  * @property {number} longitude
115
115
  * @property {string} country
@@ -126,18 +126,18 @@ export = CompanyProfilePlatformModel;
126
126
  * @property {Object} [warnings]
127
127
  * @property {string} [company_type]
128
128
  * @property {Object} [_custom_json]
129
- * @property {CompanyTaxesSerializer1[]} [taxes]
129
+ * @property {CompanyRequestTaxesSchema[]} [taxes]
130
130
  * @property {BusinessDetails} [business_details]
131
131
  * @property {Document[]} [documents]
132
132
  * @property {string} [business_type]
133
- * @property {CreateUpdateAddressSerializer[]} [addresses]
133
+ * @property {CreateUpdateAddressSchema[]} [addresses]
134
134
  * @property {string[]} [notification_emails]
135
135
  * @property {ContactDetails} [contact_details]
136
136
  * @property {string} [reject_reason]
137
137
  * @property {string} [name]
138
138
  */
139
139
  /**
140
- * @typedef ProfileSuccessResponse
140
+ * @typedef ProfileSuccessResponseSchema
141
141
  * @property {number} [uid]
142
142
  * @property {string} [message]
143
143
  * @property {boolean} [success]
@@ -148,7 +148,7 @@ export = CompanyProfilePlatformModel;
148
148
  * @property {number} [verified]
149
149
  */
150
150
  /**
151
- * @typedef MetricsSerializer
151
+ * @typedef MetricsSchema
152
152
  * @property {string} [stage]
153
153
  * @property {DocumentsObj} [store]
154
154
  * @property {DocumentsObj} [company_documents]
@@ -158,18 +158,18 @@ export = CompanyProfilePlatformModel;
158
158
  * @property {DocumentsObj} [brand]
159
159
  */
160
160
  /**
161
- * @typedef BrandBannerSerializer
161
+ * @typedef BrandBannerSchema
162
162
  * @property {string} portrait
163
163
  * @property {string} landscape
164
164
  */
165
165
  /**
166
- * @typedef GetBrandResponseSerializer
167
- * @property {UserSerializer} [modified_by]
168
- * @property {BrandBannerSerializer} [banner]
166
+ * @typedef GetBrandResponseSchema
167
+ * @property {UserSchema} [modified_by]
168
+ * @property {BrandBannerSchema} [banner]
169
169
  * @property {string} name
170
170
  * @property {Object} [_custom_json]
171
171
  * @property {string} [verified_on]
172
- * @property {UserSerializer} [created_by]
172
+ * @property {UserSchema} [created_by]
173
173
  * @property {string} [created_on]
174
174
  * @property {Object} [warnings]
175
175
  * @property {Object} [_locale_language]
@@ -179,13 +179,13 @@ export = CompanyProfilePlatformModel;
179
179
  * @property {number} [uid]
180
180
  * @property {string} [reject_reason]
181
181
  * @property {string} [stage]
182
- * @property {UserSerializer} [verified_by]
182
+ * @property {UserSchema} [verified_by]
183
183
  * @property {string} [slug_key]
184
184
  * @property {string} [logo]
185
185
  * @property {string} [description]
186
186
  */
187
187
  /**
188
- * @typedef CreateBrandRequestSerializer
188
+ * @typedef CreateBrandRequestSchema
189
189
  * @property {Object} [_custom_json]
190
190
  * @property {Object} [_locale_language]
191
191
  * @property {string[]} [synonyms]
@@ -194,12 +194,12 @@ export = CompanyProfilePlatformModel;
194
194
  * @property {string} logo
195
195
  * @property {string} [brand_tier]
196
196
  * @property {number} [uid]
197
- * @property {BrandBannerSerializer} banner
197
+ * @property {BrandBannerSchema} banner
198
198
  * @property {string} name
199
199
  * @property {string} [slug_key]
200
200
  */
201
201
  /**
202
- * @typedef UpdateBrandRequestSerializer
202
+ * @typedef UpdateBrandRequestSchema
203
203
  * @property {Object} [_custom_json]
204
204
  * @property {Object} [_locale_language]
205
205
  * @property {string[]} [synonyms]
@@ -208,7 +208,7 @@ export = CompanyProfilePlatformModel;
208
208
  * @property {string} logo
209
209
  * @property {string} [brand_tier]
210
210
  * @property {number} [uid]
211
- * @property {BrandBannerSerializer} banner
211
+ * @property {BrandBannerSchema} banner
212
212
  * @property {string} name
213
213
  */
214
214
  /**
@@ -222,169 +222,173 @@ export = CompanyProfilePlatformModel;
222
222
  * @property {string} [website_url]
223
223
  */
224
224
  /**
225
- * @typedef CompanySerializer
225
+ * @typedef CompanySchema
226
226
  * @property {string} [stage]
227
227
  * @property {Object} [_custom_json]
228
228
  * @property {string} [verified_on]
229
- * @property {UserSerializer} [verified_by]
229
+ * @property {UserSchema} [verified_by]
230
230
  * @property {string} [created_on]
231
- * @property {UserSerializer} [created_by]
231
+ * @property {UserSchema} [created_by]
232
232
  * @property {string} company_type
233
233
  * @property {string} [modified_on]
234
234
  * @property {string[]} [market_channels]
235
235
  * @property {string} business_type
236
- * @property {GetAddressSerializer[]} [addresses]
236
+ * @property {GetAddressSchema[]} [addresses]
237
237
  * @property {string[]} [notification_emails]
238
238
  * @property {CompanyDetails} [details]
239
239
  * @property {BusinessCountryInfo} [business_country_info]
240
240
  * @property {number} [uid]
241
241
  * @property {string} [reject_reason]
242
242
  * @property {string} [name]
243
- * @property {UserSerializer} [modified_by]
243
+ * @property {UserSchema} [modified_by]
244
244
  */
245
245
  /**
246
- * @typedef CompanyBrandSerializer
246
+ * @typedef CompanyBrandSchema
247
247
  * @property {string} [stage]
248
248
  * @property {string} [verified_on]
249
- * @property {UserSerializer} [verified_by]
249
+ * @property {UserSchema} [verified_by]
250
250
  * @property {string} [created_on]
251
- * @property {UserSerializer} [created_by]
252
- * @property {CompanySerializer} [company]
251
+ * @property {UserSchema} [created_by]
252
+ * @property {CompanySchema} [company]
253
253
  * @property {Object} [warnings]
254
254
  * @property {string} [modified_on]
255
255
  * @property {number} [uid]
256
256
  * @property {string} [reject_reason]
257
- * @property {GetBrandResponseSerializer} [brand]
258
- * @property {UserSerializer} [modified_by]
257
+ * @property {GetBrandResponseSchema} [brand]
258
+ * @property {UserSchema} [modified_by]
259
259
  */
260
260
  /**
261
261
  * @typedef Page
262
- * @property {number} [item_total] - The total number of items on the page.
262
+ * @property {number} [item_total] - The total number of all items across all pages.
263
263
  * @property {string} [next_id] - The identifier for the next page.
264
264
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
265
265
  * @property {boolean} [has_next] - Indicates whether there is a next page.
266
266
  * @property {number} [current] - The current page number.
267
- * @property {string} type - The type of the page, such as 'PageType'.
267
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
268
268
  * @property {number} [size] - The number of items per page.
269
+ * @property {number} [page_size] - The number of items per page.
269
270
  */
270
271
  /**
271
- * @typedef CompanyBrandListSerializer
272
- * @property {CompanyBrandSerializer[]} [items]
272
+ * @typedef CompanyBrandListSchema
273
+ * @property {CompanyBrandSchema[]} [items]
273
274
  * @property {Page} [page]
274
275
  */
275
276
  /**
276
- * @typedef CompanyBrandPostRequestSerializer
277
+ * @typedef CompanyBrandPostRequestSchema
277
278
  * @property {number} [uid]
278
279
  * @property {number[]} brands
279
280
  * @property {number} company
280
281
  */
281
282
  /**
282
- * @typedef InvoiceCredSerializer
283
+ * @typedef InvoiceCredSchema
283
284
  * @property {string} [username]
284
285
  * @property {boolean} [enabled]
285
286
  * @property {string} [password]
286
287
  */
287
288
  /**
288
- * @typedef InvoiceDetailsSerializer
289
- * @property {InvoiceCredSerializer} [e_invoice]
290
- * @property {InvoiceCredSerializer} [e_waybill]
289
+ * @typedef InvoiceDetailsSchema
290
+ * @property {InvoiceCredSchema} [e_invoice]
291
+ * @property {InvoiceCredSchema} [e_waybill]
291
292
  */
292
293
  /**
293
- * @typedef GetCompanySerializer
294
+ * @typedef GetCompanySchema
294
295
  * @property {string} [stage]
295
296
  * @property {string} [verified_on]
296
- * @property {UserSerializer} [verified_by]
297
+ * @property {UserSchema} [verified_by]
297
298
  * @property {string} [created_on]
298
- * @property {UserSerializer} [created_by]
299
+ * @property {UserSchema} [created_by]
299
300
  * @property {string} [company_type]
300
301
  * @property {string} [modified_on]
301
302
  * @property {string} [business_type]
302
- * @property {GetAddressSerializer[]} [addresses]
303
+ * @property {GetAddressSchema[]} [addresses]
303
304
  * @property {number} [uid]
304
305
  * @property {string} [reject_reason]
305
306
  * @property {string} [name]
306
- * @property {UserSerializer} [modified_by]
307
+ * @property {UserSchema} [modified_by]
307
308
  */
308
309
  /**
309
- * @typedef LocationManagerSerializer
310
+ * @typedef LocationManagerSchema
310
311
  * @property {string} [email]
311
312
  * @property {SellerPhoneNumber} mobile_no
312
313
  * @property {string} [name]
313
314
  */
314
315
  /**
315
- * @typedef LocationTimingSerializer
316
+ * @typedef LocationTimingSchema
316
317
  * @property {number} hour
317
318
  * @property {number} minute
318
319
  */
319
320
  /**
320
- * @typedef LocationDayWiseSerializer
321
+ * @typedef LocationDayWiseSchema
321
322
  * @property {boolean} open
322
323
  * @property {string} weekday
323
- * @property {LocationTimingSerializer} [opening]
324
- * @property {LocationTimingSerializer} [closing]
324
+ * @property {LocationTimingSchema} [opening]
325
+ * @property {LocationTimingSchema} [closing]
325
326
  */
326
327
  /**
327
- * @typedef HolidayDateSerializer
328
+ * @typedef HolidayDateSchema
328
329
  * @property {string} end_date
329
330
  * @property {string} start_date
330
331
  */
331
332
  /**
332
- * @typedef HolidaySchemaSerializer
333
- * @property {HolidayDateSerializer} date
333
+ * @typedef HolidaySchemaSchema
334
+ * @property {HolidayDateSchema} date
334
335
  * @property {string} title
335
336
  * @property {string} holiday_type
336
337
  */
337
338
  /**
338
- * @typedef ProductReturnConfigSerializer
339
+ * @typedef ProductReturnConfigSchema
339
340
  * @property {boolean} [on_same_store]
340
341
  * @property {number} [store_uid]
341
342
  */
342
343
  /**
343
- * @typedef GetLocationSerializer
344
+ * @typedef GetLocationSchema
344
345
  * @property {string} code
345
346
  * @property {string} [phone_number]
346
347
  * @property {SellerPhoneNumber[]} [contact_numbers]
347
- * @property {InvoiceDetailsSerializer} [gst_credentials]
348
+ * @property {InvoiceDetailsSchema} [gst_credentials]
348
349
  * @property {string} name
349
350
  * @property {Object} [_custom_json]
350
351
  * @property {string} [verified_on]
351
- * @property {UserSerializer} [created_by]
352
+ * @property {UserSchema} [created_by]
352
353
  * @property {string} [created_on]
353
- * @property {GetCompanySerializer} [company]
354
- * @property {GetAddressSerializer} address
354
+ * @property {GetCompanySchema} [company]
355
+ * @property {GetAddressSchema} address
355
356
  * @property {Object} [warnings]
356
357
  * @property {string} [store_type]
357
- * @property {LocationManagerSerializer} [manager]
358
+ * @property {LocationManagerSchema} [manager]
358
359
  * @property {boolean} [auto_invoice]
359
360
  * @property {string} [modified_on]
360
361
  * @property {number} [uid]
361
- * @property {LocationDayWiseSerializer[]} [timing]
362
+ * @property {LocationDayWiseSchema[]} [timing]
362
363
  * @property {string} [stage]
363
364
  * @property {Document[]} [documents]
364
365
  * @property {boolean} [credit_note]
365
- * @property {HolidaySchemaSerializer[]} [holiday]
366
+ * @property {HolidaySchemaSchema[]} [holiday]
366
367
  * @property {string} display_name
367
- * @property {ProductReturnConfigSerializer} [product_return_config]
368
- * @property {UserSerializer} [verified_by]
368
+ * @property {ProductReturnConfigSchema} [product_return_config]
369
+ * @property {UserSchema} [verified_by]
369
370
  * @property {string[]} [notification_emails]
370
- * @property {UserSerializer} [modified_by]
371
+ * @property {UserSchema} [modified_by]
371
372
  * @property {string[]} [tags]
372
373
  * @property {boolean} [default_order_acceptance_timing]
373
- * @property {LocationDayWiseSerializer[]} [order_acceptance_timing]
374
+ * @property {LocationDayWiseSchema[]} [order_acceptance_timing]
374
375
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
375
376
  * @property {boolean} [bulk_shipment]
377
+ * @property {boolean} [multi_piece_shipment] - Flag indicating if multi-piece
378
+ * shipment is enabled for the location.
376
379
  * @property {boolean} [auto_assign_courier_partner]
380
+ * @property {boolean} [qc_based_return_inventory_sync]
377
381
  */
378
382
  /**
379
- * @typedef LocationListSerializer
380
- * @property {GetLocationSerializer[]} [items]
383
+ * @typedef LocationListSchema
384
+ * @property {GetLocationSchema[]} [items]
381
385
  * @property {Page} [page]
382
386
  */
383
387
  /**
384
- * @typedef AddressSerializer
388
+ * @typedef AddressSchema
385
389
  * @property {string} [landmark]
386
390
  * @property {string} country_code
387
- * @property {number} [pincode]
391
+ * @property {string} [pincode]
388
392
  * @property {string} [address_type]
389
393
  * @property {number} longitude
390
394
  * @property {string} [country]
@@ -397,39 +401,44 @@ export = CompanyProfilePlatformModel;
397
401
  * @property {number} latitude
398
402
  */
399
403
  /**
400
- * @typedef LocationSerializer
401
- * @property {string} code
402
- * @property {InvoiceDetailsSerializer} [gst_credentials]
404
+ * @typedef LocationSchema
405
+ * @property {string} code - A unique identifier for the store location. Must be
406
+ * a non-empty string with a maximum length of 100 characters.
407
+ * @property {InvoiceDetailsSchema} [gst_credentials]
403
408
  * @property {SellerPhoneNumber[]} [contact_numbers]
404
- * @property {string} name
409
+ * @property {string} name - The value of the name. Should be a non-empty string
410
+ * and length should not exceed 300 characters.
405
411
  * @property {Object} [_custom_json]
406
412
  * @property {Object} [warnings]
407
- * @property {AddressSerializer} address
413
+ * @property {AddressSchema} address
408
414
  * @property {number} company
409
415
  * @property {string} [store_type]
410
- * @property {LocationManagerSerializer} [manager]
416
+ * @property {LocationManagerSchema} [manager]
411
417
  * @property {boolean} [auto_invoice]
412
418
  * @property {number} [uid]
413
- * @property {LocationDayWiseSerializer[]} [timing]
419
+ * @property {LocationDayWiseSchema[]} [timing]
414
420
  * @property {string} [stage]
415
421
  * @property {Document[]} documents
416
422
  * @property {boolean} [credit_note]
417
- * @property {HolidaySchemaSerializer[]} [holiday]
418
- * @property {ProductReturnConfigSerializer} [product_return_config]
419
- * @property {string} display_name
423
+ * @property {HolidaySchemaSchema[]} [holiday]
424
+ * @property {ProductReturnConfigSchema} [product_return_config]
425
+ * @property {string} display_name - The value of the display_name. Should be a
426
+ * non-empty string and length should not exceed 300 characters.
420
427
  * @property {string[]} [notification_emails]
421
428
  * @property {string[]} [tags]
422
429
  * @property {boolean} [default_order_acceptance_timing] - Flag to set
423
430
  * order_acceptance_timing as default timing
424
- * @property {LocationDayWiseSerializer[]} [order_acceptance_timing] - Order
431
+ * @property {LocationDayWiseSchema[]} [order_acceptance_timing] - Order
425
432
  * acceptance timing of the store
426
433
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
427
434
  * @property {boolean} [bulk_shipment]
435
+ * @property {boolean} [multi_piece_shipment] - Flag indicating if multi-piece
436
+ * shipment is enabled for the location.
428
437
  * @property {boolean} [auto_assign_courier_partner]
429
438
  */
430
439
  /**
431
- * @typedef BulkLocationSerializer
432
- * @property {LocationSerializer[]} [data]
440
+ * @typedef BulkLocationSchema
441
+ * @property {LocationSchema[]} [data]
433
442
  */
434
443
  /**
435
444
  * @typedef AverageOrderProcessingTime
@@ -444,18 +453,18 @@ export = CompanyProfilePlatformModel;
444
453
  declare class CompanyProfilePlatformModel {
445
454
  }
446
455
  declare namespace CompanyProfilePlatformModel {
447
- export { CompanyTaxesSerializer, UserSerializer, Website, BusinessDetails, SellerPhoneNumber, ContactDetails, CountryCurrencyInfo, BusinessCountryInfo, Document, GetAddressSerializer, GetCompanyProfileSerializerResponse, ErrorResponse, CompanyTaxesSerializer1, CreateUpdateAddressSerializer, UpdateCompany, ProfileSuccessResponse, DocumentsObj, MetricsSerializer, BrandBannerSerializer, GetBrandResponseSerializer, CreateBrandRequestSerializer, UpdateBrandRequestSerializer, CompanySocialAccounts, CompanyDetails, CompanySerializer, CompanyBrandSerializer, Page, CompanyBrandListSerializer, CompanyBrandPostRequestSerializer, InvoiceCredSerializer, InvoiceDetailsSerializer, GetCompanySerializer, LocationManagerSerializer, LocationTimingSerializer, LocationDayWiseSerializer, HolidayDateSerializer, HolidaySchemaSerializer, ProductReturnConfigSerializer, GetLocationSerializer, LocationListSerializer, AddressSerializer, LocationSerializer, BulkLocationSerializer, AverageOrderProcessingTime, StoreTagsResponseSchema };
456
+ export { CompanyTaxesSchema, UserSchema, Website, BusinessDetails, SellerPhoneNumber, ContactDetails, CountryCurrencyInfo, BusinessCountryInfo, Document, GetAddressSchema, GetCompanyProfileSerializerResponseSchema, ErrorResponseSchema, CompanyRequestTaxesSchema, CreateUpdateAddressSchema, UpdateCompany, ProfileSuccessResponseSchema, DocumentsObj, MetricsSchema, BrandBannerSchema, GetBrandResponseSchema, CreateBrandRequestSchema, UpdateBrandRequestSchema, CompanySocialAccounts, CompanyDetails, CompanySchema, CompanyBrandSchema, Page, CompanyBrandListSchema, CompanyBrandPostRequestSchema, InvoiceCredSchema, InvoiceDetailsSchema, GetCompanySchema, LocationManagerSchema, LocationTimingSchema, LocationDayWiseSchema, HolidayDateSchema, HolidaySchemaSchema, ProductReturnConfigSchema, GetLocationSchema, LocationListSchema, AddressSchema, LocationSchema, BulkLocationSchema, AverageOrderProcessingTime, StoreTagsResponseSchema };
448
457
  }
449
- /** @returns {CompanyTaxesSerializer} */
450
- declare function CompanyTaxesSerializer(): CompanyTaxesSerializer;
451
- type CompanyTaxesSerializer = {
458
+ /** @returns {CompanyTaxesSchema} */
459
+ declare function CompanyTaxesSchema(): CompanyTaxesSchema;
460
+ type CompanyTaxesSchema = {
452
461
  effective_date?: string;
453
462
  rate?: number;
454
463
  enable?: boolean;
455
464
  };
456
- /** @returns {UserSerializer} */
457
- declare function UserSerializer(): UserSerializer;
458
- type UserSerializer = {
465
+ /** @returns {UserSchema} */
466
+ declare function UserSchema(): UserSchema;
467
+ type UserSchema = {
459
468
  user_id?: string;
460
469
  contact?: string;
461
470
  username?: string;
@@ -506,12 +515,12 @@ type Document = {
506
515
  type: string;
507
516
  url?: string;
508
517
  };
509
- /** @returns {GetAddressSerializer} */
510
- declare function GetAddressSerializer(): GetAddressSerializer;
511
- type GetAddressSerializer = {
518
+ /** @returns {GetAddressSchema} */
519
+ declare function GetAddressSchema(): GetAddressSchema;
520
+ type GetAddressSchema = {
512
521
  landmark?: string;
513
522
  country_code?: string;
514
- pincode?: number;
523
+ pincode?: string;
515
524
  address_type?: string;
516
525
  longitude: number;
517
526
  country?: string;
@@ -523,16 +532,16 @@ type GetAddressSerializer = {
523
532
  city?: string;
524
533
  latitude: number;
525
534
  };
526
- /** @returns {GetCompanyProfileSerializerResponse} */
527
- declare function GetCompanyProfileSerializerResponse(): GetCompanyProfileSerializerResponse;
528
- type GetCompanyProfileSerializerResponse = {
535
+ /** @returns {GetCompanyProfileSerializerResponseSchema} */
536
+ declare function GetCompanyProfileSerializerResponseSchema(): GetCompanyProfileSerializerResponseSchema;
537
+ type GetCompanyProfileSerializerResponseSchema = {
529
538
  business_info?: string;
530
- taxes?: CompanyTaxesSerializer[];
539
+ taxes?: CompanyTaxesSchema[];
531
540
  business_type?: string;
532
541
  name?: string;
533
542
  _custom_json?: any;
534
543
  verified_on?: string;
535
- created_by?: UserSerializer;
544
+ created_by?: UserSchema;
536
545
  created_on?: string;
537
546
  warnings?: any;
538
547
  business_details?: BusinessDetails;
@@ -545,32 +554,38 @@ type GetCompanyProfileSerializerResponse = {
545
554
  stage?: string;
546
555
  company_type: string;
547
556
  documents?: Document[];
548
- addresses?: GetAddressSerializer[];
549
- verified_by?: UserSerializer;
557
+ addresses?: GetAddressSchema[];
558
+ verified_by?: UserSchema;
550
559
  notification_emails?: string[];
551
- modified_by?: UserSerializer;
560
+ modified_by?: UserSchema;
552
561
  };
553
- /** @returns {ErrorResponse} */
554
- declare function ErrorResponse(): ErrorResponse;
555
- type ErrorResponse = {
562
+ /** @returns {ErrorResponseSchema} */
563
+ declare function ErrorResponseSchema(): ErrorResponseSchema;
564
+ type ErrorResponseSchema = {
565
+ /**
566
+ * - A descriptive message providing details about
567
+ * the error, intended to convey the nature and context of the issue.
568
+ */
556
569
  message?: string;
557
- code?: string;
558
- status?: number;
559
- meta?: any;
570
+ /**
571
+ * - An object containing additional error details,
572
+ * which may vary depending on the error type.
573
+ */
574
+ error?: any;
560
575
  };
561
- /** @returns {CompanyTaxesSerializer1} */
562
- declare function CompanyTaxesSerializer1(): CompanyTaxesSerializer1;
563
- type CompanyTaxesSerializer1 = {
576
+ /** @returns {CompanyRequestTaxesSchema} */
577
+ declare function CompanyRequestTaxesSchema(): CompanyRequestTaxesSchema;
578
+ type CompanyRequestTaxesSchema = {
564
579
  effective_date?: string;
565
580
  rate?: number;
566
581
  enable?: boolean;
567
582
  };
568
- /** @returns {CreateUpdateAddressSerializer} */
569
- declare function CreateUpdateAddressSerializer(): CreateUpdateAddressSerializer;
570
- type CreateUpdateAddressSerializer = {
583
+ /** @returns {CreateUpdateAddressSchema} */
584
+ declare function CreateUpdateAddressSchema(): CreateUpdateAddressSchema;
585
+ type CreateUpdateAddressSchema = {
571
586
  landmark?: string;
572
587
  country_code?: string;
573
- pincode: number;
588
+ pincode: string;
574
589
  address_type: string;
575
590
  longitude: number;
576
591
  country: string;
@@ -588,19 +603,19 @@ type UpdateCompany = {
588
603
  warnings?: any;
589
604
  company_type?: string;
590
605
  _custom_json?: any;
591
- taxes?: CompanyTaxesSerializer1[];
606
+ taxes?: CompanyRequestTaxesSchema[];
592
607
  business_details?: BusinessDetails;
593
608
  documents?: Document[];
594
609
  business_type?: string;
595
- addresses?: CreateUpdateAddressSerializer[];
610
+ addresses?: CreateUpdateAddressSchema[];
596
611
  notification_emails?: string[];
597
612
  contact_details?: ContactDetails;
598
613
  reject_reason?: string;
599
614
  name?: string;
600
615
  };
601
- /** @returns {ProfileSuccessResponse} */
602
- declare function ProfileSuccessResponse(): ProfileSuccessResponse;
603
- type ProfileSuccessResponse = {
616
+ /** @returns {ProfileSuccessResponseSchema} */
617
+ declare function ProfileSuccessResponseSchema(): ProfileSuccessResponseSchema;
618
+ type ProfileSuccessResponseSchema = {
604
619
  uid?: number;
605
620
  message?: string;
606
621
  success?: boolean;
@@ -611,9 +626,9 @@ type DocumentsObj = {
611
626
  pending?: number;
612
627
  verified?: number;
613
628
  };
614
- /** @returns {MetricsSerializer} */
615
- declare function MetricsSerializer(): MetricsSerializer;
616
- type MetricsSerializer = {
629
+ /** @returns {MetricsSchema} */
630
+ declare function MetricsSchema(): MetricsSchema;
631
+ type MetricsSchema = {
617
632
  stage?: string;
618
633
  store?: DocumentsObj;
619
634
  company_documents?: DocumentsObj;
@@ -622,21 +637,21 @@ type MetricsSerializer = {
622
637
  uid?: number;
623
638
  brand?: DocumentsObj;
624
639
  };
625
- /** @returns {BrandBannerSerializer} */
626
- declare function BrandBannerSerializer(): BrandBannerSerializer;
627
- type BrandBannerSerializer = {
640
+ /** @returns {BrandBannerSchema} */
641
+ declare function BrandBannerSchema(): BrandBannerSchema;
642
+ type BrandBannerSchema = {
628
643
  portrait: string;
629
644
  landscape: string;
630
645
  };
631
- /** @returns {GetBrandResponseSerializer} */
632
- declare function GetBrandResponseSerializer(): GetBrandResponseSerializer;
633
- type GetBrandResponseSerializer = {
634
- modified_by?: UserSerializer;
635
- banner?: BrandBannerSerializer;
646
+ /** @returns {GetBrandResponseSchema} */
647
+ declare function GetBrandResponseSchema(): GetBrandResponseSchema;
648
+ type GetBrandResponseSchema = {
649
+ modified_by?: UserSchema;
650
+ banner?: BrandBannerSchema;
636
651
  name: string;
637
652
  _custom_json?: any;
638
653
  verified_on?: string;
639
- created_by?: UserSerializer;
654
+ created_by?: UserSchema;
640
655
  created_on?: string;
641
656
  warnings?: any;
642
657
  _locale_language?: any;
@@ -646,14 +661,14 @@ type GetBrandResponseSerializer = {
646
661
  uid?: number;
647
662
  reject_reason?: string;
648
663
  stage?: string;
649
- verified_by?: UserSerializer;
664
+ verified_by?: UserSchema;
650
665
  slug_key?: string;
651
666
  logo?: string;
652
667
  description?: string;
653
668
  };
654
- /** @returns {CreateBrandRequestSerializer} */
655
- declare function CreateBrandRequestSerializer(): CreateBrandRequestSerializer;
656
- type CreateBrandRequestSerializer = {
669
+ /** @returns {CreateBrandRequestSchema} */
670
+ declare function CreateBrandRequestSchema(): CreateBrandRequestSchema;
671
+ type CreateBrandRequestSchema = {
657
672
  _custom_json?: any;
658
673
  _locale_language?: any;
659
674
  synonyms?: string[];
@@ -662,13 +677,13 @@ type CreateBrandRequestSerializer = {
662
677
  logo: string;
663
678
  brand_tier?: string;
664
679
  uid?: number;
665
- banner: BrandBannerSerializer;
680
+ banner: BrandBannerSchema;
666
681
  name: string;
667
682
  slug_key?: string;
668
683
  };
669
- /** @returns {UpdateBrandRequestSerializer} */
670
- declare function UpdateBrandRequestSerializer(): UpdateBrandRequestSerializer;
671
- type UpdateBrandRequestSerializer = {
684
+ /** @returns {UpdateBrandRequestSchema} */
685
+ declare function UpdateBrandRequestSchema(): UpdateBrandRequestSchema;
686
+ type UpdateBrandRequestSchema = {
672
687
  _custom_json?: any;
673
688
  _locale_language?: any;
674
689
  synonyms?: string[];
@@ -677,7 +692,7 @@ type UpdateBrandRequestSerializer = {
677
692
  logo: string;
678
693
  brand_tier?: string;
679
694
  uid?: number;
680
- banner: BrandBannerSerializer;
695
+ banner: BrandBannerSchema;
681
696
  name: string;
682
697
  };
683
698
  /** @returns {CompanySocialAccounts} */
@@ -692,49 +707,49 @@ type CompanyDetails = {
692
707
  socials?: CompanySocialAccounts[];
693
708
  website_url?: string;
694
709
  };
695
- /** @returns {CompanySerializer} */
696
- declare function CompanySerializer(): CompanySerializer;
697
- type CompanySerializer = {
710
+ /** @returns {CompanySchema} */
711
+ declare function CompanySchema(): CompanySchema;
712
+ type CompanySchema = {
698
713
  stage?: string;
699
714
  _custom_json?: any;
700
715
  verified_on?: string;
701
- verified_by?: UserSerializer;
716
+ verified_by?: UserSchema;
702
717
  created_on?: string;
703
- created_by?: UserSerializer;
718
+ created_by?: UserSchema;
704
719
  company_type: string;
705
720
  modified_on?: string;
706
721
  market_channels?: string[];
707
722
  business_type: string;
708
- addresses?: GetAddressSerializer[];
723
+ addresses?: GetAddressSchema[];
709
724
  notification_emails?: string[];
710
725
  details?: CompanyDetails;
711
726
  business_country_info?: BusinessCountryInfo;
712
727
  uid?: number;
713
728
  reject_reason?: string;
714
729
  name?: string;
715
- modified_by?: UserSerializer;
730
+ modified_by?: UserSchema;
716
731
  };
717
- /** @returns {CompanyBrandSerializer} */
718
- declare function CompanyBrandSerializer(): CompanyBrandSerializer;
719
- type CompanyBrandSerializer = {
732
+ /** @returns {CompanyBrandSchema} */
733
+ declare function CompanyBrandSchema(): CompanyBrandSchema;
734
+ type CompanyBrandSchema = {
720
735
  stage?: string;
721
736
  verified_on?: string;
722
- verified_by?: UserSerializer;
737
+ verified_by?: UserSchema;
723
738
  created_on?: string;
724
- created_by?: UserSerializer;
725
- company?: CompanySerializer;
739
+ created_by?: UserSchema;
740
+ company?: CompanySchema;
726
741
  warnings?: any;
727
742
  modified_on?: string;
728
743
  uid?: number;
729
744
  reject_reason?: string;
730
- brand?: GetBrandResponseSerializer;
731
- modified_by?: UserSerializer;
745
+ brand?: GetBrandResponseSchema;
746
+ modified_by?: UserSchema;
732
747
  };
733
748
  /** @returns {Page} */
734
749
  declare function Page(): Page;
735
750
  type Page = {
736
751
  /**
737
- * - The total number of items on the page.
752
+ * - The total number of all items across all pages.
738
753
  */
739
754
  item_total?: number;
740
755
  /**
@@ -754,146 +769,156 @@ type Page = {
754
769
  */
755
770
  current?: number;
756
771
  /**
757
- * - The type of the page, such as 'PageType'.
772
+ * - The type of the page, can be 'cursor' or 'number'.
758
773
  */
759
774
  type: string;
760
775
  /**
761
776
  * - The number of items per page.
762
777
  */
763
778
  size?: number;
779
+ /**
780
+ * - The number of items per page.
781
+ */
782
+ page_size?: number;
764
783
  };
765
- /** @returns {CompanyBrandListSerializer} */
766
- declare function CompanyBrandListSerializer(): CompanyBrandListSerializer;
767
- type CompanyBrandListSerializer = {
768
- items?: CompanyBrandSerializer[];
784
+ /** @returns {CompanyBrandListSchema} */
785
+ declare function CompanyBrandListSchema(): CompanyBrandListSchema;
786
+ type CompanyBrandListSchema = {
787
+ items?: CompanyBrandSchema[];
769
788
  page?: Page;
770
789
  };
771
- /** @returns {CompanyBrandPostRequestSerializer} */
772
- declare function CompanyBrandPostRequestSerializer(): CompanyBrandPostRequestSerializer;
773
- type CompanyBrandPostRequestSerializer = {
790
+ /** @returns {CompanyBrandPostRequestSchema} */
791
+ declare function CompanyBrandPostRequestSchema(): CompanyBrandPostRequestSchema;
792
+ type CompanyBrandPostRequestSchema = {
774
793
  uid?: number;
775
794
  brands: number[];
776
795
  company: number;
777
796
  };
778
- /** @returns {InvoiceCredSerializer} */
779
- declare function InvoiceCredSerializer(): InvoiceCredSerializer;
780
- type InvoiceCredSerializer = {
797
+ /** @returns {InvoiceCredSchema} */
798
+ declare function InvoiceCredSchema(): InvoiceCredSchema;
799
+ type InvoiceCredSchema = {
781
800
  username?: string;
782
801
  enabled?: boolean;
783
802
  password?: string;
784
803
  };
785
- /** @returns {InvoiceDetailsSerializer} */
786
- declare function InvoiceDetailsSerializer(): InvoiceDetailsSerializer;
787
- type InvoiceDetailsSerializer = {
788
- e_invoice?: InvoiceCredSerializer;
789
- e_waybill?: InvoiceCredSerializer;
804
+ /** @returns {InvoiceDetailsSchema} */
805
+ declare function InvoiceDetailsSchema(): InvoiceDetailsSchema;
806
+ type InvoiceDetailsSchema = {
807
+ e_invoice?: InvoiceCredSchema;
808
+ e_waybill?: InvoiceCredSchema;
790
809
  };
791
- /** @returns {GetCompanySerializer} */
792
- declare function GetCompanySerializer(): GetCompanySerializer;
793
- type GetCompanySerializer = {
810
+ /** @returns {GetCompanySchema} */
811
+ declare function GetCompanySchema(): GetCompanySchema;
812
+ type GetCompanySchema = {
794
813
  stage?: string;
795
814
  verified_on?: string;
796
- verified_by?: UserSerializer;
815
+ verified_by?: UserSchema;
797
816
  created_on?: string;
798
- created_by?: UserSerializer;
817
+ created_by?: UserSchema;
799
818
  company_type?: string;
800
819
  modified_on?: string;
801
820
  business_type?: string;
802
- addresses?: GetAddressSerializer[];
821
+ addresses?: GetAddressSchema[];
803
822
  uid?: number;
804
823
  reject_reason?: string;
805
824
  name?: string;
806
- modified_by?: UserSerializer;
825
+ modified_by?: UserSchema;
807
826
  };
808
- /** @returns {LocationManagerSerializer} */
809
- declare function LocationManagerSerializer(): LocationManagerSerializer;
810
- type LocationManagerSerializer = {
827
+ /** @returns {LocationManagerSchema} */
828
+ declare function LocationManagerSchema(): LocationManagerSchema;
829
+ type LocationManagerSchema = {
811
830
  email?: string;
812
831
  mobile_no: SellerPhoneNumber;
813
832
  name?: string;
814
833
  };
815
- /** @returns {LocationTimingSerializer} */
816
- declare function LocationTimingSerializer(): LocationTimingSerializer;
817
- type LocationTimingSerializer = {
834
+ /** @returns {LocationTimingSchema} */
835
+ declare function LocationTimingSchema(): LocationTimingSchema;
836
+ type LocationTimingSchema = {
818
837
  hour: number;
819
838
  minute: number;
820
839
  };
821
- /** @returns {LocationDayWiseSerializer} */
822
- declare function LocationDayWiseSerializer(): LocationDayWiseSerializer;
823
- type LocationDayWiseSerializer = {
840
+ /** @returns {LocationDayWiseSchema} */
841
+ declare function LocationDayWiseSchema(): LocationDayWiseSchema;
842
+ type LocationDayWiseSchema = {
824
843
  open: boolean;
825
844
  weekday: string;
826
- opening?: LocationTimingSerializer;
827
- closing?: LocationTimingSerializer;
845
+ opening?: LocationTimingSchema;
846
+ closing?: LocationTimingSchema;
828
847
  };
829
- /** @returns {HolidayDateSerializer} */
830
- declare function HolidayDateSerializer(): HolidayDateSerializer;
831
- type HolidayDateSerializer = {
848
+ /** @returns {HolidayDateSchema} */
849
+ declare function HolidayDateSchema(): HolidayDateSchema;
850
+ type HolidayDateSchema = {
832
851
  end_date: string;
833
852
  start_date: string;
834
853
  };
835
- /** @returns {HolidaySchemaSerializer} */
836
- declare function HolidaySchemaSerializer(): HolidaySchemaSerializer;
837
- type HolidaySchemaSerializer = {
838
- date: HolidayDateSerializer;
854
+ /** @returns {HolidaySchemaSchema} */
855
+ declare function HolidaySchemaSchema(): HolidaySchemaSchema;
856
+ type HolidaySchemaSchema = {
857
+ date: HolidayDateSchema;
839
858
  title: string;
840
859
  holiday_type: string;
841
860
  };
842
- /** @returns {ProductReturnConfigSerializer} */
843
- declare function ProductReturnConfigSerializer(): ProductReturnConfigSerializer;
844
- type ProductReturnConfigSerializer = {
861
+ /** @returns {ProductReturnConfigSchema} */
862
+ declare function ProductReturnConfigSchema(): ProductReturnConfigSchema;
863
+ type ProductReturnConfigSchema = {
845
864
  on_same_store?: boolean;
846
865
  store_uid?: number;
847
866
  };
848
- /** @returns {GetLocationSerializer} */
849
- declare function GetLocationSerializer(): GetLocationSerializer;
850
- type GetLocationSerializer = {
867
+ /** @returns {GetLocationSchema} */
868
+ declare function GetLocationSchema(): GetLocationSchema;
869
+ type GetLocationSchema = {
851
870
  code: string;
852
871
  phone_number?: string;
853
872
  contact_numbers?: SellerPhoneNumber[];
854
- gst_credentials?: InvoiceDetailsSerializer;
873
+ gst_credentials?: InvoiceDetailsSchema;
855
874
  name: string;
856
875
  _custom_json?: any;
857
876
  verified_on?: string;
858
- created_by?: UserSerializer;
877
+ created_by?: UserSchema;
859
878
  created_on?: string;
860
- company?: GetCompanySerializer;
861
- address: GetAddressSerializer;
879
+ company?: GetCompanySchema;
880
+ address: GetAddressSchema;
862
881
  warnings?: any;
863
882
  store_type?: string;
864
- manager?: LocationManagerSerializer;
883
+ manager?: LocationManagerSchema;
865
884
  auto_invoice?: boolean;
866
885
  modified_on?: string;
867
886
  uid?: number;
868
- timing?: LocationDayWiseSerializer[];
887
+ timing?: LocationDayWiseSchema[];
869
888
  stage?: string;
870
889
  documents?: Document[];
871
890
  credit_note?: boolean;
872
- holiday?: HolidaySchemaSerializer[];
891
+ holiday?: HolidaySchemaSchema[];
873
892
  display_name: string;
874
- product_return_config?: ProductReturnConfigSerializer;
875
- verified_by?: UserSerializer;
893
+ product_return_config?: ProductReturnConfigSchema;
894
+ verified_by?: UserSchema;
876
895
  notification_emails?: string[];
877
- modified_by?: UserSerializer;
896
+ modified_by?: UserSchema;
878
897
  tags?: string[];
879
898
  default_order_acceptance_timing?: boolean;
880
- order_acceptance_timing?: LocationDayWiseSerializer[];
899
+ order_acceptance_timing?: LocationDayWiseSchema[];
881
900
  avg_order_processing_time?: AverageOrderProcessingTime;
882
901
  bulk_shipment?: boolean;
902
+ /**
903
+ * - Flag indicating if multi-piece
904
+ * shipment is enabled for the location.
905
+ */
906
+ multi_piece_shipment?: boolean;
883
907
  auto_assign_courier_partner?: boolean;
908
+ qc_based_return_inventory_sync?: boolean;
884
909
  };
885
- /** @returns {LocationListSerializer} */
886
- declare function LocationListSerializer(): LocationListSerializer;
887
- type LocationListSerializer = {
888
- items?: GetLocationSerializer[];
910
+ /** @returns {LocationListSchema} */
911
+ declare function LocationListSchema(): LocationListSchema;
912
+ type LocationListSchema = {
913
+ items?: GetLocationSchema[];
889
914
  page?: Page;
890
915
  };
891
- /** @returns {AddressSerializer} */
892
- declare function AddressSerializer(): AddressSerializer;
893
- type AddressSerializer = {
916
+ /** @returns {AddressSchema} */
917
+ declare function AddressSchema(): AddressSchema;
918
+ type AddressSchema = {
894
919
  landmark?: string;
895
920
  country_code: string;
896
- pincode?: number;
921
+ pincode?: string;
897
922
  address_type?: string;
898
923
  longitude: number;
899
924
  country?: string;
@@ -905,27 +930,39 @@ type AddressSerializer = {
905
930
  city?: string;
906
931
  latitude: number;
907
932
  };
908
- /** @returns {LocationSerializer} */
909
- declare function LocationSerializer(): LocationSerializer;
910
- type LocationSerializer = {
933
+ /** @returns {LocationSchema} */
934
+ declare function LocationSchema(): LocationSchema;
935
+ type LocationSchema = {
936
+ /**
937
+ * - A unique identifier for the store location. Must be
938
+ * a non-empty string with a maximum length of 100 characters.
939
+ */
911
940
  code: string;
912
- gst_credentials?: InvoiceDetailsSerializer;
941
+ gst_credentials?: InvoiceDetailsSchema;
913
942
  contact_numbers?: SellerPhoneNumber[];
943
+ /**
944
+ * - The value of the name. Should be a non-empty string
945
+ * and length should not exceed 300 characters.
946
+ */
914
947
  name: string;
915
948
  _custom_json?: any;
916
949
  warnings?: any;
917
- address: AddressSerializer;
950
+ address: AddressSchema;
918
951
  company: number;
919
952
  store_type?: string;
920
- manager?: LocationManagerSerializer;
953
+ manager?: LocationManagerSchema;
921
954
  auto_invoice?: boolean;
922
955
  uid?: number;
923
- timing?: LocationDayWiseSerializer[];
956
+ timing?: LocationDayWiseSchema[];
924
957
  stage?: string;
925
958
  documents: Document[];
926
959
  credit_note?: boolean;
927
- holiday?: HolidaySchemaSerializer[];
928
- product_return_config?: ProductReturnConfigSerializer;
960
+ holiday?: HolidaySchemaSchema[];
961
+ product_return_config?: ProductReturnConfigSchema;
962
+ /**
963
+ * - The value of the display_name. Should be a
964
+ * non-empty string and length should not exceed 300 characters.
965
+ */
929
966
  display_name: string;
930
967
  notification_emails?: string[];
931
968
  tags?: string[];
@@ -938,15 +975,20 @@ type LocationSerializer = {
938
975
  * - Order
939
976
  * acceptance timing of the store
940
977
  */
941
- order_acceptance_timing?: LocationDayWiseSerializer[];
978
+ order_acceptance_timing?: LocationDayWiseSchema[];
942
979
  avg_order_processing_time?: AverageOrderProcessingTime;
943
980
  bulk_shipment?: boolean;
981
+ /**
982
+ * - Flag indicating if multi-piece
983
+ * shipment is enabled for the location.
984
+ */
985
+ multi_piece_shipment?: boolean;
944
986
  auto_assign_courier_partner?: boolean;
945
987
  };
946
- /** @returns {BulkLocationSerializer} */
947
- declare function BulkLocationSerializer(): BulkLocationSerializer;
948
- type BulkLocationSerializer = {
949
- data?: LocationSerializer[];
988
+ /** @returns {BulkLocationSchema} */
989
+ declare function BulkLocationSchema(): BulkLocationSchema;
990
+ type BulkLocationSchema = {
991
+ data?: LocationSchema[];
950
992
  };
951
993
  /** @returns {AverageOrderProcessingTime} */
952
994
  declare function AverageOrderProcessingTime(): AverageOrderProcessingTime;