@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.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 (314) 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 +2 -0
  8. package/sdk/application/ApplicationClient.js +2 -18
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
  10. package/sdk/application/Cart/CartApplicationClient.js +108 -1199
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
  13. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
  14. package/sdk/application/Common/CommonApplicationClient.js +2 -92
  15. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
  18. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
  19. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -111
  20. package/sdk/application/Content/ContentApplicationClient.js +43 -1065
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
  22. package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
  23. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  24. package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
  25. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
  26. package/sdk/application/Lead/LeadApplicationClient.js +5 -217
  27. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
  28. package/sdk/application/Logistic/LogisticApplicationClient.js +91 -493
  29. package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
  30. package/sdk/application/Order/OrderApplicationClient.js +52 -507
  31. package/sdk/application/Payment/PaymentApplicationClient.d.ts +103 -213
  32. package/sdk/application/Payment/PaymentApplicationClient.js +84 -2105
  33. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
  34. package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
  35. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  36. package/sdk/application/Share/ShareApplicationClient.js +7 -309
  37. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  38. package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
  39. package/sdk/application/User/UserApplicationClient.d.ts +87 -138
  40. package/sdk/application/User/UserApplicationClient.js +44 -1820
  41. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
  42. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
  43. package/sdk/application/index.d.ts +0 -18
  44. package/sdk/application/index.js +0 -33
  45. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  46. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  47. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  48. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  49. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  50. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  51. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  52. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  53. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  54. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  55. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +157 -30
  56. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1177 -56
  57. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1662 -249
  58. package/sdk/partner/Logistics/LogisticsPartnerModel.js +774 -162
  59. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
  60. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +141 -12
  61. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  62. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  63. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  64. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  65. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  66. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  67. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  68. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  69. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  70. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  71. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  73. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  75. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  82. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  83. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  84. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  85. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  86. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  87. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  89. package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
  91. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
  92. package/sdk/platform/Cart/CartPlatformModel.d.ts +5060 -1300
  93. package/sdk/platform/Cart/CartPlatformModel.js +1985 -1217
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
  97. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
  98. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +178 -117
  99. package/sdk/platform/Catalog/CatalogPlatformClient.js +468 -172
  100. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6554 -1772
  101. package/sdk/platform/Catalog/CatalogPlatformModel.js +3264 -1690
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +116 -31
  103. package/sdk/platform/Catalog/CatalogPlatformValidator.js +85 -24
  104. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  105. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  106. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  107. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  111. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  112. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  113. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  114. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  120. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  124. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  126. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  128. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  130. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +122 -191
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.js +447 -831
  132. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +174 -220
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +164 -199
  134. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  135. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  136. package/sdk/platform/Content/ContentPlatformModel.d.ts +1233 -476
  137. package/sdk/platform/Content/ContentPlatformModel.js +514 -487
  138. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  139. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  140. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  141. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  142. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  143. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  144. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  145. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  150. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  152. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  154. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  156. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  157. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  158. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  159. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  160. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
  161. package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
  162. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
  163. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
  164. package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
  165. package/sdk/platform/Order/OrderPlatformClient.js +424 -198
  166. package/sdk/platform/Order/OrderPlatformModel.d.ts +7747 -1342
  167. package/sdk/platform/Order/OrderPlatformModel.js +3960 -1262
  168. package/sdk/platform/Order/OrderPlatformValidator.d.ts +292 -109
  169. package/sdk/platform/Order/OrderPlatformValidator.js +145 -77
  170. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  171. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  172. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  173. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  174. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  175. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  176. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  177. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  178. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  179. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  180. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
  181. package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
  182. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  183. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  184. package/sdk/platform/PlatformClient.d.ts +0 -2
  185. package/sdk/platform/PlatformClient.js +0 -4
  186. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  187. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  188. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  189. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  190. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  191. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +132 -44
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +681 -64
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2458 -650
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1266 -572
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +176 -47
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -28
  202. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  203. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  204. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  205. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  206. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  208. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  210. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  211. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  212. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  213. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  214. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  215. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  216. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  217. package/sdk/platform/User/UserPlatformModel.js +23 -23
  218. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  219. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  220. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  221. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  222. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  223. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  224. package/sdk/platform/index.d.ts +0 -1
  225. package/sdk/platform/index.js +0 -2
  226. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  227. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
  228. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  229. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  230. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  231. package/sdk/public/Content/ContentPublicClient.js +795 -7
  232. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  233. package/sdk/public/Content/ContentPublicModel.js +649 -3
  234. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  235. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  236. package/sdk/public/Partner/PartnerPublicClient.js +4 -2
  237. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  238. package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
  239. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  240. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  241. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  242. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  243. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
  244. package/sdk/application/Cart/CartApplicationModel.js +0 -2497
  245. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
  246. package/sdk/application/Cart/CartApplicationValidator.js +0 -530
  247. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
  248. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
  249. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  250. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  251. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  252. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  253. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  254. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  255. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  256. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  257. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  258. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  259. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
  260. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
  261. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  262. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  263. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
  264. package/sdk/application/Content/ContentApplicationModel.js +0 -1589
  265. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
  266. package/sdk/application/Content/ContentApplicationValidator.js +0 -264
  267. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
  268. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
  269. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  270. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  271. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  272. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  273. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  274. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  275. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
  276. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
  277. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
  278. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
  279. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
  280. package/sdk/application/Order/OrderApplicationModel.js +0 -1471
  281. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
  282. package/sdk/application/Order/OrderApplicationValidator.js +0 -197
  283. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
  284. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
  285. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  286. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  287. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  288. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  289. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  290. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  291. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  292. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  293. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  294. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  295. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
  296. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
  297. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
  298. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
  299. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  300. package/sdk/application/User/UserApplicationModel.js +0 -1382
  301. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  302. package/sdk/application/User/UserApplicationValidator.js +0 -573
  303. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
  304. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
  305. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  306. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  307. package/sdk/common/Clickstream.d.ts +0 -1
  308. package/sdk/common/Clickstream.js +0 -464
  309. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  310. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  311. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  312. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  313. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  314. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -1,4 +1,9 @@
1
1
  export = ContentPlatformModel;
2
+ /**
3
+ * @typedef ValidationError
4
+ * @property {string} message - A brief description of the error encountered.
5
+ * @property {string} field - The field in the request that caused the error.
6
+ */
2
7
  /**
3
8
  * @typedef GenerateSEOContent
4
9
  * @property {string} [text]
@@ -156,7 +161,7 @@ export = ContentPlatformModel;
156
161
  * @property {string} [end]
157
162
  */
158
163
  /**
159
- * @typedef BlogGetResponse
164
+ * @typedef BlogGetDetails
160
165
  * @property {BlogSchema[]} [items]
161
166
  * @property {Page} [page]
162
167
  * @property {BlogFilters} [filters]
@@ -241,7 +246,7 @@ export = ContentPlatformModel;
241
246
  * @property {string} [modified_on]
242
247
  */
243
248
  /**
244
- * @typedef BlogRequest
249
+ * @typedef BlogPayload
245
250
  * @property {string} [application]
246
251
  * @property {Object} [_custom_json]
247
252
  * @property {Author} [author]
@@ -319,22 +324,6 @@ export = ContentPlatformModel;
319
324
  * @property {string} [start]
320
325
  * @property {string} [end]
321
326
  */
322
- /**
323
- * @typedef ConfigurationSchema
324
- * @property {number} [sleep_time]
325
- * @property {boolean} [start_on_launch]
326
- * @property {number} [duration]
327
- * @property {string} [slide_direction]
328
- */
329
- /**
330
- * @typedef SlideshowMedia
331
- * @property {string} [type]
332
- * @property {string} [url]
333
- * @property {string} [bg_color]
334
- * @property {number} [duration]
335
- * @property {boolean} [auto_decide_duration]
336
- * @property {Action} [action]
337
- */
338
327
  /**
339
328
  * @typedef UpdateHandpickedSchema
340
329
  * @property {HandpickedTagSchema} [tag]
@@ -390,7 +379,7 @@ export = ContentPlatformModel;
390
379
  * @property {DataLoaderSchema[]} [items]
391
380
  */
392
381
  /**
393
- * @typedef TagDeleteSuccessResponse
382
+ * @typedef TagDeleteSuccessDetails
394
383
  * @property {boolean} [success]
395
384
  */
396
385
  /**
@@ -503,7 +492,7 @@ export = ContentPlatformModel;
503
492
  * @property {number} [size] - The number of items per page.
504
493
  */
505
494
  /**
506
- * @typedef LandingPageGetResponse
495
+ * @typedef LandingPageGetDetails
507
496
  * @property {LandingPageSchema[]} [items]
508
497
  * @property {Page} [page]
509
498
  */
@@ -520,11 +509,11 @@ export = ContentPlatformModel;
520
509
  * @property {Object} [_custom_json]
521
510
  */
522
511
  /**
523
- * @typedef DefaultNavigationResponse
512
+ * @typedef DefaultNavigationDetails
524
513
  * @property {NavigationSchema[]} [items]
525
514
  */
526
515
  /**
527
- * @typedef NavigationGetResponse
516
+ * @typedef NavigationGetDetails
528
517
  * @property {NavigationSchema[]} [items]
529
518
  * @property {Page} [page]
530
519
  */
@@ -548,7 +537,7 @@ export = ContentPlatformModel;
548
537
  * @property {NavigationReference[]} [navigation]
549
538
  */
550
539
  /**
551
- * @typedef NavigationRequest
540
+ * @typedef NavigationPayload
552
541
  * @property {string} [name]
553
542
  * @property {string} [slug]
554
543
  * @property {string[]} [platform]
@@ -556,7 +545,7 @@ export = ContentPlatformModel;
556
545
  * @property {NavigationReference[]} [navigation]
557
546
  */
558
547
  /**
559
- * @typedef PageGetResponse
548
+ * @typedef PageGetDetails
560
549
  * @property {PageSchema[]} [items]
561
550
  * @property {Page} [page]
562
551
  */
@@ -607,7 +596,7 @@ export = ContentPlatformModel;
607
596
  * @property {string} [id]
608
597
  */
609
598
  /**
610
- * @typedef PageRequest
599
+ * @typedef PagePayload
611
600
  * @property {CronSchedule} [_schedule]
612
601
  * @property {string} [application]
613
602
  * @property {Author} [author]
@@ -630,7 +619,7 @@ export = ContentPlatformModel;
630
619
  * @property {number} [duration]
631
620
  */
632
621
  /**
633
- * @typedef PagePublishRequest
622
+ * @typedef PagePublishPayload
634
623
  * @property {boolean} [publish]
635
624
  */
636
625
  /**
@@ -639,32 +628,6 @@ export = ContentPlatformModel;
639
628
  * @property {PageSchema[]} [custom_pages]
640
629
  * @property {string} [application_id]
641
630
  */
642
- /**
643
- * @typedef SlideshowGetResponse
644
- * @property {SlideshowSchema[]} [items]
645
- * @property {Page} [page]
646
- */
647
- /**
648
- * @typedef SlideshowSchema
649
- * @property {string} [_id]
650
- * @property {string} [slug]
651
- * @property {DateMeta} [date_meta]
652
- * @property {string} [application]
653
- * @property {string} [platform]
654
- * @property {ConfigurationSchema} [configuration]
655
- * @property {SlideshowMedia[]} [media]
656
- * @property {boolean} [active]
657
- * @property {boolean} [archived]
658
- * @property {Object} [_custom_json]
659
- */
660
- /**
661
- * @typedef SlideshowRequest
662
- * @property {string} [slug]
663
- * @property {string} [platform]
664
- * @property {ConfigurationSchema} [configuration]
665
- * @property {SlideshowMedia} [media]
666
- * @property {boolean} [active]
667
- */
668
631
  /**
669
632
  * @typedef Support
670
633
  * @property {boolean} [created]
@@ -737,93 +700,108 @@ export = ContentPlatformModel;
737
700
  */
738
701
  /**
739
702
  * @typedef FieldValidations
740
- * @property {string} [name]
741
- * @property {string} [type]
703
+ * @property {string} [name] - Name of validation
704
+ * @property {string} [type] - Type of validation
742
705
  * @property {Object} [value]
743
706
  */
744
707
  /**
745
708
  * @typedef FieldDefinitionSchema
746
- * @property {string} [_id]
747
- * @property {string} [creator]
748
- * @property {string} [resource]
749
- * @property {string} [name]
750
- * @property {string} [namespace]
751
- * @property {string} [key]
752
- * @property {string} [description]
753
- * @property {string} [type]
754
- * @property {boolean} [multi_value]
755
- * @property {FieldValidations[]} [validations]
756
- * @property {string} [company_id]
757
- * @property {string} [created_by]
758
- * @property {string} [updated_by]
759
- * @property {boolean} [required]
760
- * @property {boolean} [is_deleted]
761
- * @property {string} [created_at]
762
- * @property {string} [updated_at]
763
- * @property {string} [type_name]
764
- * @property {number} [invalid_fields_count]
709
+ * @property {string} [id] - Unique system generated id
710
+ * @property {string} [resource] - Resource type to which custom field belongs
711
+ * @property {string} [name] - Name of custom field
712
+ * @property {string} [namespace] - Namespace of custom field
713
+ * @property {string} [slug] - Slug of custom field
714
+ * @property {string} [description] - Description of custom field definition
715
+ * @property {string} [type] - Data type of custom field
716
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
717
+ * multivalued or not
718
+ * @property {FieldValidations[]} [validations] - List of validations applied
719
+ * @property {string} [company_id] - Id of company
720
+ * @property {boolean} [required] - Whether the custom field is required or not
721
+ * @property {boolean} [is_deleted] - Whether the custom field is deleted or not
722
+ * @property {string} [type_name] - Type of type field
723
+ * @property {number} [invalid_fields_count] - Count of invalid fields after validation
765
724
  */
766
725
  /**
767
726
  * @typedef CustomFieldDefinitionsSchema
768
- * @property {FieldDefinitionSchema[]} [items]
727
+ * @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
769
728
  * @property {Page} [page]
770
729
  */
771
730
  /**
772
731
  * @typedef CustomFieldDefinitionRequestSchema
773
- * @property {string} [resource]
774
- * @property {string} [type]
775
- * @property {string} [key]
776
- * @property {string} [namespace]
777
- * @property {boolean} [multi_value]
778
- * @property {string} [name]
779
- * @property {string} [description]
780
- * @property {FieldValidations[]} [validations]
732
+ * @property {string} [type] - Data type of custom field
733
+ * @property {string} [slug] - Slug of custom field definition
734
+ * @property {string} [namespace] - Namespace of custom field definition
735
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
736
+ * multi valued or not
737
+ * @property {string} [name] - Name of custom field definition
738
+ * @property {string} [description] - Description of a custom field definition
739
+ * @property {FieldValidations[]} [validations] - Validations for a custom field
781
740
  */
782
741
  /**
783
742
  * @typedef CustomObjectCustomFieldDefinitions
784
- * @property {string} [id]
785
- * @property {string} [type]
786
- * @property {string} [description]
787
- * @property {string} [name]
788
- * @property {boolean} [multi_value]
789
- * @property {boolean} [required]
790
- * @property {string} [key]
791
- * @property {FieldValidations[]} [validations]
743
+ * @property {string} [id] - Unique identifer for a custom field
744
+ * @property {string} [type] - Data type of custom field
745
+ * @property {string} [description] - Description of custom field
746
+ * @property {string} [name] - Name of custom field
747
+ * @property {boolean} [multi_value] - Flag to denote if cusom field is multi
748
+ * valued or not
749
+ * @property {boolean} [required] - Whether the field is required or not
750
+ * @property {string} [slug] - Slug of custom field definition
751
+ * @property {FieldValidations[]} [validations] - Validations added against the
752
+ * custom field
792
753
  * @property {string} [action]
793
754
  */
794
755
  /**
795
756
  * @typedef CustomObjectDefinitionUpdateRequestSchema
796
- * @property {string} [type]
797
- * @property {string} [description]
798
- * @property {string} [name]
799
- * @property {string} [display_name_key]
757
+ * @property {string} [description] - Description of custom object definiton
758
+ * @property {string} [name] - Name of custom object definition
759
+ * @property {string} [display_name_key] - Custom field slug which is used as a
760
+ * display key in
800
761
  * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
801
762
  */
802
763
  /**
803
764
  * @typedef CustomFieldDefinitionDetailResSchema
804
- * @property {string} [creator]
805
- * @property {string} [resource]
806
- * @property {string} [name]
807
- * @property {string} [namespace]
808
- * @property {string} [key]
809
- * @property {string} [description]
810
- * @property {string} [type]
811
- * @property {boolean} [multi_value]
812
- * @property {string} [company_id]
813
- * @property {string} [application_id]
814
- * @property {string} [created_by]
815
- * @property {string} [updated_by]
816
- * @property {boolean} [required]
817
- * @property {boolean} [is_deleted]
818
- * @property {string} [_id]
765
+ * @property {string} [resource] - Resource to which custom field is associated
766
+ * @property {string} [name] - Name of custom field
767
+ * @property {string} [namespace] - Namespace of custom field
768
+ * @property {string} [slug] - Slug of custom field
769
+ * @property {string} [description] - Description regarding custom field
770
+ * @property {string} [type] - Data type of custom field
771
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
772
+ * multi valued or not
773
+ * @property {string} [company_id] - Company Identifer
774
+ * @property {string} [application_id] - Sales channel identifier
775
+ * @property {boolean} [required] - Whether the customfield is required or not
776
+ * @property {boolean} [is_deleted] - Is custom field deleted
777
+ * @property {string} [id] - Unique system generated id
819
778
  * @property {Object[]} [validations]
820
- * @property {string} [created_at]
821
- * @property {string} [updated_at]
779
+ * @property {string} [created_at] - Date time at which field was created
780
+ * @property {string} [updated_at] - Date time at for a field's last modification
781
+ */
782
+ /**
783
+ * @typedef MetaFieldDefinitionDetailResSchema
784
+ * @property {string} [resource] - Resource to which meta field is associated
785
+ * @property {string} [name] - Name of meta field
786
+ * @property {string} [namespace] - Namespace of meta field
787
+ * @property {string} [slug] - Slug of meta field
788
+ * @property {string} [description] - Description regarding meta field
789
+ * @property {string} [type] - Data type of meta field
790
+ * @property {boolean} [multi_value] - Flag to denote whether meta field is
791
+ * multi valued or not
792
+ * @property {string} [company_id] - Company Identifer
793
+ * @property {string} [application_id] - Sales channel identifier
794
+ * @property {boolean} [required] - Whether the field is required or not
795
+ * @property {boolean} [is_deleted] - Is meta field deleted
796
+ * @property {string} [id] - Unique system generated id
797
+ * @property {Object[]} [validations]
798
+ * @property {string} [created_at] - Date time at which field was created
799
+ * @property {string} [updated_at] - Date time at for a field's last modification
822
800
  */
823
801
  /**
824
802
  * @typedef CustomDataDeleteSchema
825
- * @property {boolean} [success]
826
- * @property {string} [message]
803
+ * @property {boolean} [success] - Denotes the success of the delete operation
804
+ * @property {string} [message] - Denotes the message of delete operation
827
805
  */
828
806
  /**
829
807
  * @typedef CustomFieldValue
@@ -831,29 +809,31 @@ export = ContentPlatformModel;
831
809
  */
832
810
  /**
833
811
  * @typedef CustomFieldSchema
834
- * @property {string} [_id]
835
- * @property {string} [namespace]
836
- * @property {string} [key]
837
- * @property {string} [resource]
838
- * @property {string} [creator]
812
+ * @property {string} [id] - Unique system generated id
813
+ * @property {string} [namespace] - Namespace of custom field definition
814
+ * @property {string} [slug] - Slug of custom field definition
815
+ * @property {string} [resource] - The resource for which custom field is being created
839
816
  * @property {CustomFieldValue[]} [value]
840
- * @property {string} [resource_id]
841
- * @property {string} [type]
842
- * @property {boolean} [multi_value]
843
- * @property {string} [company_id]
844
- * @property {string} [definition_id]
817
+ * @property {string} [resource_slug] - Unique identifier of the resource
818
+ * @property {string} [type] - Data type of custom field
819
+ * @property {boolean} [multi_value] - Whether custom field is multi valued
820
+ * @property {string} [company_id] - Identifer for a company
845
821
  * @property {boolean} [has_invalid_values]
846
822
  * @property {Object[]} [invalid_value_errors]
847
- * @property {string} [created_by]
848
- * @property {boolean} [is_deleted]
849
- * @property {string} [created_at]
850
- * @property {string} [updated_at]
823
+ * @property {boolean} [is_deleted] - Indicates whether custom field is deleted
824
+ * @property {string} [created_at] - Time at which customer field was created
825
+ * @property {string} [updated_at] - Time at which custom field was updated
851
826
  */
852
827
  /**
853
828
  * @typedef CustomFieldsResponseSchema
854
829
  * @property {CustomFieldSchema[]} [items]
855
830
  * @property {Page} [page]
856
831
  */
832
+ /**
833
+ * @typedef CustomFieldsDeleteSchema
834
+ * @property {boolean} [success]
835
+ * @property {string} [message]
836
+ */
857
837
  /**
858
838
  * @typedef CustomFieldsResponseByResourceIdSchema
859
839
  * @property {CustomFieldSchema[]} [items]
@@ -861,7 +841,9 @@ export = ContentPlatformModel;
861
841
  /**
862
842
  * @typedef CustomField
863
843
  * @property {Object[]} [value]
864
- * @property {string} [definition_id]
844
+ * @property {string} [namespace] - This is the namespace to which custom field belongs
845
+ * @property {string} [slug] - This is the slug of custom field used while
846
+ * creating a custom field definition
865
847
  */
866
848
  /**
867
849
  * @typedef CustomFieldRequestSchema
@@ -869,146 +851,140 @@ export = ContentPlatformModel;
869
851
  */
870
852
  /**
871
853
  * @typedef CustomObjectSchema
872
- * @property {string} [_id]
873
- * @property {string} [creator]
874
- * @property {string} [company_id]
875
- * @property {string} [application_id]
876
- * @property {string} [created_by]
877
- * @property {string} [updated_by]
878
- * @property {string} [status]
879
- * @property {string} [type]
880
- * @property {string} [display_name]
881
- * @property {string} [definition_id]
882
- * @property {CustomFieldSchema[]} [fields]
854
+ * @property {string} [id] - Unique system generated id
855
+ * @property {string} [company_id] - Identifer for a company
856
+ * @property {string} [application_id] - Identifer for a sales channel
857
+ * @property {string} [status] - Status of custom object
858
+ * @property {string} [type] - Slug of custom object definition
859
+ * @property {string} [definition_slug] - Slug for custom object definition
860
+ * @property {string} [display_name] - Value of custom field used for displaying
861
+ * custom object
862
+ * @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
883
863
  */
884
864
  /**
885
865
  * @typedef CustomObjectDefinitionRequestSchema
886
- * @property {string} [type]
887
- * @property {string} [description]
888
- * @property {string} [name]
889
- * @property {string} [display_name_key]
890
- * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
891
- */
892
- /**
893
- * @typedef CustomObjectCustomFieldDefinitionResSchema
894
- * @property {string} [creator]
895
- * @property {string} [resource]
896
- * @property {string} [name]
897
- * @property {string} [namespace]
898
- * @property {string} [key]
899
- * @property {string} [description]
900
- * @property {string} [type]
901
- * @property {boolean} [multi_value]
902
- * @property {FieldValidations[]} [validations]
903
- * @property {string} [company_id]
904
- * @property {string} [created_by]
905
- * @property {string} [metaobject_definition_id]
906
- * @property {boolean} [required]
907
- * @property {boolean} [is_deleted]
908
- * @property {string} [_id]
909
- * @property {string} [created_at]
910
- * @property {string} [updated_at]
911
- */
912
- /**
913
- * @typedef CustomObjectDefinitionSchema
914
- * @property {string} [_id]
915
- * @property {string} [name]
916
- * @property {string} [type]
917
- * @property {string} [display_name_key]
918
- * @property {string} [description]
919
- * @property {string} [creator]
920
- * @property {string} [created_by]
921
- * @property {string} [updated_by]
922
- * @property {CustomObjectCustomFieldDefinitionResSchema[]} [field_definitions]
866
+ * @property {string} [type] - Namespace/Slug of Custom object definition
867
+ * @property {string} [definition_slug] - Unique slug for a custom object definition
868
+ * @property {string} [description] - Description of custom object definition
869
+ * @property {string} [name] - Name of custom object
870
+ * @property {string} [display_name_key] - Denotes which custom field to be used
871
+ * for displaying custom object
872
+ * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
873
+ * of custom field definitions belonging to this custom object definition
874
+ */
875
+ /**
876
+ * @typedef CustomObjectDefinitionSlugSchema
877
+ * @property {string} [id] - Unique system generated custom object definition id
878
+ * @property {string} [name] - Display name of custom object definition
879
+ * @property {string} [type] - Type of custom object definiton
880
+ * @property {string} [definition_slug] - Slug of custom object definiton
881
+ * @property {string} [display_name_key] - Display name of custom object definition
882
+ * @property {string} [description] - Description of custom object definition
883
+ * @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
884
+ * Custom fields inside custom objects
923
885
  */
924
886
  /**
925
887
  * @typedef CustomObjectDefinitionDeleteResponseSchema
926
- * @property {boolean} [success]
927
- * @property {string} [message]
888
+ * @property {boolean} [success] - Success status of delete custom object definition.
889
+ * @property {string} [message] - Response message when custom object definition
890
+ * is deleted.
928
891
  */
929
892
  /**
930
- * @typedef CustomObjectEntryBulkUploadResponse
931
- * @property {string} [url]
932
- * @property {number} [total_records]
893
+ * @typedef CustomObjectEntryBulkUploadDetails
894
+ * @property {string} [url] - Signed url of csv
895
+ * @property {number} [total_records] - Total no of records in csv file
933
896
  */
934
897
  /**
935
- * @typedef CustomObjectListItemDefinationSchema
936
- * @property {string} [_id]
937
- * @property {string} [name]
938
- * @property {string} [type]
898
+ * @typedef CustomObjectListItemDefinitionModel
899
+ * @property {string} [id] - Unique system generated id
900
+ * @property {string} [name] - Name of custom object
901
+ * @property {string} [type] - Type of custom object entry
939
902
  */
940
903
  /**
941
904
  * @typedef CustomObjectListItemSchema
942
- * @property {string} [_id]
943
- * @property {string} [definition_id]
944
- * @property {string} [status]
945
- * @property {string} [updated_at]
946
- * @property {string} [display_name]
947
- * @property {CustomObjectListItemDefinationSchema} [definition]
948
- * @property {number} [references]
905
+ * @property {string} [id] - Unique system generated id
906
+ * @property {string} [status] - Status of custom object
907
+ * @property {string} [created_at] - Creation time of custom object document
908
+ * @property {string} [updated_at] - Updation time of custom object document
909
+ * @property {string} [display_name] - Display name of custom object
910
+ * @property {CustomObjectListItemDefinitionModel} [definition]
911
+ * @property {number} [references] - References of the custom object entry
949
912
  */
950
913
  /**
951
914
  * @typedef CustomObjectsSchema
952
- * @property {CustomObjectListItemSchema[]} [items]
915
+ * @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
916
+ * object entries
953
917
  * @property {Page} [page]
954
918
  */
955
919
  /**
956
- * @typedef CustomObjectFieldSchema
957
- * @property {string} [_id]
958
- * @property {string} [key]
959
- * @property {Object[]} [value]
960
- * @property {string} [type]
961
- * @property {string} [definition_id]
920
+ * @typedef CustomObjectFieldDefinition
921
+ * @property {string} [id] - Unique system generate id
922
+ * @property {string} [slug] - Slug of custom field definition
923
+ * @property {string} [namespace] - Namespace of custom field definition
924
+ * @property {Object[]} [value] - Value of custom field
925
+ * @property {string} [type] - Data type of the custom field
962
926
  */
963
927
  /**
964
- * @typedef CustomObjectByIdSchema
965
- * @property {string} [_id]
966
- * @property {string} [status]
967
- * @property {string} [display_name]
968
- * @property {CustomObjectListItemDefinationSchema} [definition]
969
- * @property {Object[]} [references]
970
- * @property {CustomObjectFieldSchema[]} [fields]
928
+ * @typedef CustomObjectBySlugSchema
929
+ * @property {string} [id] - Unique system generated identifer for a Custom Object
930
+ * @property {string} [status] - Status of Custom Object
931
+ * @property {string} [display_name] - Display name for the Custom Object
932
+ * @property {CustomObjectListItemDefinitionModel} [definition]
933
+ * @property {Object[]} [references] - Places where the custom object has been
934
+ * used as a custom field
935
+ * @property {string} [slug] - Slug of custom object entry
936
+ * @property {string} [definition_slug] - Slug of custom object definition
937
+ * @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
938
+ * inside the custom object
971
939
  */
972
940
  /**
973
941
  * @typedef CustomObjectBulkEntryInitiateDownload
974
- * @property {string} [message]
975
- * @property {string} [task_id]
942
+ * @property {string} [message] - Message for the user
943
+ * @property {string} [task_id] - Identifer for a task
976
944
  */
977
945
  /**
978
946
  * @typedef CustomObjectMetaSchema
979
- * @property {number} [mo_total_count]
980
- * @property {number} [mo_success_count]
981
- * @property {number} [mo_error_count]
982
- * @property {string} [mo_defintion_type]
947
+ * @property {number} [mo_total_count] - Total number of entries in the bulk entry
948
+ * @property {number} [mo_success_count] - Number of entries which were successful
949
+ * @property {number} [mo_error_count] - Number of entries which were failed
950
+ * @property {string} [mo_defintion_type] - Type of object
951
+ */
952
+ /**
953
+ * @typedef JobSchema
954
+ * @property {string} [id] - Unique system generated id
955
+ * @property {string[]} [jobs] - List of total jobs
956
+ * @property {string[]} [finished_jobs] - List of finished jobs
957
+ * @property {string[]} [error_jobs] - List of jobs which resulted in an error
958
+ * @property {string[]} [errors_occured] - List of errors occurred in the job
959
+ * @property {string} [company_id] - Company Identifer
960
+ * @property {string} [status] - Status of job
961
+ * @property {string} [action_type] - Type of job
962
+ * @property {string} [entity] - Entity against which job is running
963
+ * @property {string} [error_url] - URL which contains the file with errors
964
+ * @property {number} [finished_count] - Number of items successfully finished
965
+ * @property {number} [error_count] - Number of items in error
966
+ * @property {number} [success_count] - Number of successful items
967
+ * @property {number} [total_jobs] - Total number of jobs
968
+ * @property {CustomObjectMetaSchema} [meta]
969
+ * @property {string} [created_by] - Source from where the bulk job is created
970
+ * @property {string} [created_at] - Date/Time when the job was created
971
+ * @property {string} [updated_at] - Date/Time when the job was updated
972
+ * @property {string} [application_id] - Sales Channel Identifier
983
973
  */
984
974
  /**
985
- * @typedef CustomObjectJobSchema
986
- * @property {string} [_id]
987
- * @property {string[]} [jobs]
988
- * @property {string[]} [finished_jobs]
989
- * @property {string[]} [error_jobs]
990
- * @property {string[]} [errors_occured]
991
- * @property {string} [company_id]
992
- * @property {string} [creator]
993
- * @property {string} [url]
994
- * @property {string} [status]
995
- * @property {string} [action_type]
996
- * @property {string} [entity]
997
- * @property {string} [error_url]
998
- * @property {number} [finished_count]
999
- * @property {number} [error_count]
1000
- * @property {number} [success_count]
1001
- * @property {number} [total_jobs]
1002
- * @property {CustomObjectMetaSchema} [meta]
1003
- * @property {string} [created_by]
1004
- * @property {string} [created_at]
1005
- * @property {string} [updated_at]
975
+ * @typedef CustomFieldBulkEntry
976
+ * @property {JobSchema[]} [items]
977
+ * @property {Page} [page]
1006
978
  */
1007
979
  /**
1008
980
  * @typedef CustomObjectBulkEntry
1009
- * @property {CustomObjectJobSchema[]} [items]
981
+ * @property {JobSchema[]} [items]
1010
982
  * @property {Page} [page]
1011
983
  */
984
+ /**
985
+ * @typedef MetafieldTypesSchema
986
+ * @property {CustomFieldTypeSchema} [metafield_types]
987
+ */
1012
988
  /**
1013
989
  * @typedef CustomFieldTypeSchema
1014
990
  * @property {StringSingleLine} [string_single_line]
@@ -1024,6 +1000,8 @@ export = ContentPlatformModel;
1024
1000
  * @property {Url} [url]
1025
1001
  * @property {Metaobject} [metaobject]
1026
1002
  * @property {Product} [product]
1003
+ * @property {HTML} [html]
1004
+ * @property {Duration} [duration]
1027
1005
  */
1028
1006
  /**
1029
1007
  * @typedef SupportedValidationsMetaExampleSchema
@@ -1042,117 +1020,149 @@ export = ContentPlatformModel;
1042
1020
  * @property {boolean} [required]
1043
1021
  * @property {SupportedValidationsMetaSchema} [meta]
1044
1022
  */
1023
+ /**
1024
+ * @typedef Duration
1025
+ * @property {string} [name] - Name data type of custom field
1026
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1027
+ * @property {string} [type] - Type of custom field
1028
+ * @property {string} [category] - Category of custom field
1029
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1030
+ * validations available for the field
1031
+ */
1032
+ /**
1033
+ * @typedef HTML
1034
+ * @property {string} [name] - Name data type of custom field
1035
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1036
+ * @property {string} [type] - Type of custom field
1037
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1038
+ * validations available for the field
1039
+ */
1045
1040
  /**
1046
1041
  * @typedef StringSingleLine
1047
- * @property {string} [name]
1048
- * @property {boolean} [list_enabled]
1049
- * @property {string} [category]
1050
- * @property {string} [type]
1051
- * @property {SupportedValidationsSchema[]} [supported_validations]
1042
+ * @property {string} [name] - Name data type of custom field
1043
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1044
+ * @property {string} [category] - Category of custom field
1045
+ * @property {string} [type] - Type of custom field
1046
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1047
+ * validations available for the field
1052
1048
  */
1053
1049
  /**
1054
1050
  * @typedef StringMultiLine
1055
- * @property {string} [name]
1056
- * @property {boolean} [list_enabled]
1057
- * @property {string} [category]
1058
- * @property {string} [type]
1059
- * @property {SupportedValidationsSchema[]} [supported_validations]
1051
+ * @property {string} [name] - Name data type of custom field
1052
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1053
+ * @property {string} [category] - Category of custom field
1054
+ * @property {string} [type] - Type of custom field
1055
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1056
+ * validations available for the field
1060
1057
  */
1061
1058
  /**
1062
1059
  * @typedef Dropdown
1063
- * @property {string} [name]
1064
- * @property {boolean} [list_enabled]
1065
- * @property {string} [category]
1066
- * @property {string} [type]
1067
- * @property {SupportedValidationsSchema[]} [supported_validations]
1060
+ * @property {string} [name] - Name data type of custom field
1061
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1062
+ * @property {string} [category] - Category of custom field
1063
+ * @property {string} [type] - Category of custom field
1064
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1065
+ * validations available for the field
1068
1066
  */
1069
1067
  /**
1070
1068
  * @typedef Integer
1071
- * @property {string} [name]
1072
- * @property {boolean} [list_enabled]
1073
- * @property {string} [type]
1074
- * @property {string} [category]
1075
- * @property {SupportedValidationsSchema[]} [supported_validations]
1069
+ * @property {string} [name] - Name data type of custom field
1070
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1071
+ * @property {string} [type] - Type of custom field
1072
+ * @property {string} [category] - Category of custom field
1073
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1074
+ * validations available for the field
1076
1075
  */
1077
1076
  /**
1078
1077
  * @typedef FloatType
1079
- * @property {string} [name]
1080
- * @property {boolean} [list_enabled]
1081
- * @property {string} [type]
1082
- * @property {string} [category]
1083
- * @property {SupportedValidationsSchema[]} [supported_validations]
1078
+ * @property {string} [name] - Name data type of custom field
1079
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1080
+ * @property {string} [type] - Type of custom field
1081
+ * @property {string} [category] - Category of custom field
1082
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1083
+ * validations available for the field
1084
1084
  */
1085
1085
  /**
1086
1086
  * @typedef BooleanType
1087
- * @property {string} [name]
1088
- * @property {string} [category]
1089
- * @property {boolean} [list_enabled]
1090
- * @property {string} [type]
1091
- * @property {SupportedValidationsSchema[]} [supported_validations]
1087
+ * @property {string} [name] - Name data type of custom field
1088
+ * @property {string} [category] - Category of custom field
1089
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1090
+ * @property {string} [type] - Category of custom field
1091
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1092
+ * validations available for the field
1092
1093
  */
1093
1094
  /**
1094
1095
  * @typedef Date
1095
- * @property {string} [name]
1096
- * @property {boolean} [list_enabled]
1097
- * @property {string} [category]
1098
- * @property {string} [type]
1099
- * @property {SupportedValidationsSchema[]} [supported_validations]
1096
+ * @property {string} [name] - Name data type of custom field
1097
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1098
+ * @property {string} [category] - Category of custom field
1099
+ * @property {string} [type] - Type of custom field
1100
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1101
+ * validations available for the field
1100
1102
  */
1101
1103
  /**
1102
1104
  * @typedef Datetime
1103
- * @property {string} [name]
1104
- * @property {string} [category]
1105
- * @property {boolean} [list_enabled]
1106
- * @property {string} [type]
1107
- * @property {SupportedValidationsSchema[]} [supported_validations]
1105
+ * @property {string} [name] - Name data type of custom field
1106
+ * @property {string} [category] - Category of custom field
1107
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1108
+ * @property {string} [type] - Type of custom field
1109
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1110
+ * validations available for the field
1108
1111
  */
1109
1112
  /**
1110
1113
  * @typedef Json
1111
- * @property {string} [name]
1112
- * @property {boolean} [list_enabled]
1113
- * @property {string} [category]
1114
- * @property {string} [type]
1115
- * @property {SupportedValidationsSchema[]} [supported_validations]
1114
+ * @property {string} [name] - Name data type of custom field
1115
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1116
+ * @property {string} [category] - Category of custom field
1117
+ * @property {string} [type] - Type of custom field
1118
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1119
+ * validations available for the field
1116
1120
  */
1117
1121
  /**
1118
1122
  * @typedef File
1119
- * @property {string} [name]
1120
- * @property {string} [category]
1121
- * @property {boolean} [list_enabled]
1122
- * @property {string} [type]
1123
+ * @property {string} [name] - Name data type of custom field
1124
+ * @property {string} [category] - Category of custom field
1125
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1126
+ * @property {string} [type] - Type of custom field
1123
1127
  * @property {SupportedValidationsSchema[]} [supported_validations]
1124
1128
  */
1125
1129
  /**
1126
1130
  * @typedef Url
1127
- * @property {string} [name]
1128
- * @property {boolean} [list_enabled]
1129
- * @property {string} [type]
1130
- * @property {SupportedValidationsSchema[]} [supported_validations]
1131
+ * @property {string} [name] - Name data type of custom field
1132
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1133
+ * @property {string} [type] - Type of custom field
1134
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1135
+ * validations available for the field
1131
1136
  */
1132
1137
  /**
1133
1138
  * @typedef Metaobject
1134
- * @property {string} [name]
1135
- * @property {boolean} [list_enabled]
1136
- * @property {string} [category]
1137
- * @property {string} [type]
1139
+ * @property {string} [name] - Name of Custom Object
1140
+ * @property {boolean} [list_enabled] - Whether the field is allowed to have
1141
+ * multiple list items
1142
+ * @property {string} [category] - Category of Custom Object Definition that
1143
+ * Custom Object belongs to
1144
+ * @property {string} [type] - Type of Custom Object Definition
1138
1145
  * @property {SupportedValidationsSchema[]} [supported_validations]
1139
1146
  */
1140
1147
  /**
1141
1148
  * @typedef Product
1142
- * @property {string} [name]
1143
- * @property {boolean} [list_enabled]
1144
- * @property {string} [category]
1145
- * @property {string} [type]
1149
+ * @property {string} [name] - Name of Product
1150
+ * @property {boolean} [list_enabled] - Whether the field is allowed to have
1151
+ * multiple list items
1152
+ * @property {string} [category] - Category of Custom Object Definition that
1153
+ * Product is associated with
1154
+ * @property {string} [type] - Custom Object Definition that Product is associated with
1146
1155
  * @property {SupportedValidationsSchema[]} [supported_validations]
1147
1156
  */
1148
1157
  /**
1149
1158
  * @typedef CustomObjectEntry
1150
- * @property {string} [_id]
1151
- * @property {string} [name]
1152
- * @property {string} [type]
1153
- * @property {string} [updated_at]
1154
- * @property {number} [entries_count]
1155
- * @property {number} [fields_count]
1159
+ * @property {string} [id] - Unique system generated id
1160
+ * @property {string} [name] - Name of Custom Object definition
1161
+ * @property {string} [type] - Type of Custom Object Definition
1162
+ * @property {string} [updated_at] - Updation time of a Custom Object
1163
+ * @property {number} [entries_count] - Number of entries against the Custom
1164
+ * Object definition
1165
+ * @property {number} [fields_count] - Number of fields against a Custom Object definition
1156
1166
  */
1157
1167
  /**
1158
1168
  * @typedef CustomObjectDefinitionsSchema
@@ -1161,19 +1171,29 @@ export = ContentPlatformModel;
1161
1171
  */
1162
1172
  /**
1163
1173
  * @typedef CustomObjectEntryFieldSchema
1164
- * @property {string} [definition_id]
1165
- * @property {Object[]} [value]
1174
+ * @property {string} [namespace] - This is namespace for a custom field definition
1175
+ * @property {string} [slug] - This is slug for a custom field definition
1176
+ */
1177
+ /**
1178
+ * @typedef CustomObjectEntryFieldSchemaWithoutID
1179
+ * @property {string} [slug] - Custom fields belonging to a custom object
1180
+ * @property {Object} [value] - Value of custom field inside a custom object
1166
1181
  */
1167
1182
  /**
1168
1183
  * @typedef CustomObjectRequestSchema
1169
- * @property {string} [status]
1170
- * @property {string} [definition_id]
1171
- * @property {CustomObjectEntryFieldSchema[]} [fields]
1184
+ * @property {string} [status] - Flag to denote status of Custom Object
1185
+ * @property {string} [slug] - This is slug for a custom field definition
1186
+ * @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
1187
+ */
1188
+ /**
1189
+ * @typedef CustomObjectRequestSchemaWithoutId
1190
+ * @property {string} [status] - Status of the custom object entry.
1191
+ * @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
1172
1192
  */
1173
1193
  /**
1174
1194
  * @typedef CustomObjectBulkSchema
1175
- * @property {string} [url]
1176
- * @property {number} [total_records]
1195
+ * @property {string} [url] - Full URL for the bulk operations data
1196
+ * @property {number} [total_records] - Total records in the upload.
1177
1197
  */
1178
1198
  /**
1179
1199
  * @typedef ActionPage
@@ -1236,8 +1256,20 @@ export = ContentPlatformModel;
1236
1256
  declare class ContentPlatformModel {
1237
1257
  }
1238
1258
  declare namespace ContentPlatformModel {
1239
- export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, SlideshowGetResponse, SlideshowSchema, SlideshowRequest, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadResponse, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, CustomObjectJobSchema, CustomObjectBulkEntry, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectRequestSchema, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
1259
+ export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
1240
1260
  }
1261
+ /** @returns {ValidationError} */
1262
+ declare function ValidationError(): ValidationError;
1263
+ type ValidationError = {
1264
+ /**
1265
+ * - A brief description of the error encountered.
1266
+ */
1267
+ message: string;
1268
+ /**
1269
+ * - The field in the request that caused the error.
1270
+ */
1271
+ field: string;
1272
+ };
1241
1273
  /** @returns {GenerateSEOContent} */
1242
1274
  declare function GenerateSEOContent(): GenerateSEOContent;
1243
1275
  type GenerateSEOContent = {
@@ -1415,9 +1447,9 @@ type NextSchedule = {
1415
1447
  start?: string;
1416
1448
  end?: string;
1417
1449
  };
1418
- /** @returns {BlogGetResponse} */
1419
- declare function BlogGetResponse(): BlogGetResponse;
1420
- type BlogGetResponse = {
1450
+ /** @returns {BlogGetDetails} */
1451
+ declare function BlogGetDetails(): BlogGetDetails;
1452
+ type BlogGetDetails = {
1421
1453
  items?: BlogSchema[];
1422
1454
  page?: Page;
1423
1455
  filters?: BlogFilters;
@@ -1513,9 +1545,9 @@ type DateMeta = {
1513
1545
  created_on?: string;
1514
1546
  modified_on?: string;
1515
1547
  };
1516
- /** @returns {BlogRequest} */
1517
- declare function BlogRequest(): BlogRequest;
1518
- type BlogRequest = {
1548
+ /** @returns {BlogPayload} */
1549
+ declare function BlogPayload(): BlogPayload;
1550
+ type BlogPayload = {
1519
1551
  application?: string;
1520
1552
  _custom_json?: any;
1521
1553
  author?: Author;
@@ -1605,24 +1637,6 @@ type CronBasedScheduleSchema = {
1605
1637
  start?: string;
1606
1638
  end?: string;
1607
1639
  };
1608
- /** @returns {ConfigurationSchema} */
1609
- declare function ConfigurationSchema(): ConfigurationSchema;
1610
- type ConfigurationSchema = {
1611
- sleep_time?: number;
1612
- start_on_launch?: boolean;
1613
- duration?: number;
1614
- slide_direction?: string;
1615
- };
1616
- /** @returns {SlideshowMedia} */
1617
- declare function SlideshowMedia(): SlideshowMedia;
1618
- type SlideshowMedia = {
1619
- type?: string;
1620
- url?: string;
1621
- bg_color?: string;
1622
- duration?: number;
1623
- auto_decide_duration?: boolean;
1624
- action?: Action;
1625
- };
1626
1640
  /** @returns {UpdateHandpickedSchema} */
1627
1641
  declare function UpdateHandpickedSchema(): UpdateHandpickedSchema;
1628
1642
  type UpdateHandpickedSchema = {
@@ -1685,9 +1699,9 @@ declare function DataLoadersSchema(): DataLoadersSchema;
1685
1699
  type DataLoadersSchema = {
1686
1700
  items?: DataLoaderSchema[];
1687
1701
  };
1688
- /** @returns {TagDeleteSuccessResponse} */
1689
- declare function TagDeleteSuccessResponse(): TagDeleteSuccessResponse;
1690
- type TagDeleteSuccessResponse = {
1702
+ /** @returns {TagDeleteSuccessDetails} */
1703
+ declare function TagDeleteSuccessDetails(): TagDeleteSuccessDetails;
1704
+ type TagDeleteSuccessDetails = {
1691
1705
  success?: boolean;
1692
1706
  };
1693
1707
  /** @returns {ContentAPIError} */
@@ -1837,9 +1851,9 @@ type Page = {
1837
1851
  */
1838
1852
  size?: number;
1839
1853
  };
1840
- /** @returns {LandingPageGetResponse} */
1841
- declare function LandingPageGetResponse(): LandingPageGetResponse;
1842
- type LandingPageGetResponse = {
1854
+ /** @returns {LandingPageGetDetails} */
1855
+ declare function LandingPageGetDetails(): LandingPageGetDetails;
1856
+ type LandingPageGetDetails = {
1843
1857
  items?: LandingPageSchema[];
1844
1858
  page?: Page;
1845
1859
  };
@@ -1856,14 +1870,14 @@ type LandingPageSchema = {
1856
1870
  archived?: boolean;
1857
1871
  _custom_json?: any;
1858
1872
  };
1859
- /** @returns {DefaultNavigationResponse} */
1860
- declare function DefaultNavigationResponse(): DefaultNavigationResponse;
1861
- type DefaultNavigationResponse = {
1873
+ /** @returns {DefaultNavigationDetails} */
1874
+ declare function DefaultNavigationDetails(): DefaultNavigationDetails;
1875
+ type DefaultNavigationDetails = {
1862
1876
  items?: NavigationSchema[];
1863
1877
  };
1864
- /** @returns {NavigationGetResponse} */
1865
- declare function NavigationGetResponse(): NavigationGetResponse;
1866
- type NavigationGetResponse = {
1878
+ /** @returns {NavigationGetDetails} */
1879
+ declare function NavigationGetDetails(): NavigationGetDetails;
1880
+ type NavigationGetDetails = {
1867
1881
  items?: NavigationSchema[];
1868
1882
  page?: Page;
1869
1883
  };
@@ -1888,18 +1902,18 @@ type NavigationSchema = {
1888
1902
  version?: number;
1889
1903
  navigation?: NavigationReference[];
1890
1904
  };
1891
- /** @returns {NavigationRequest} */
1892
- declare function NavigationRequest(): NavigationRequest;
1893
- type NavigationRequest = {
1905
+ /** @returns {NavigationPayload} */
1906
+ declare function NavigationPayload(): NavigationPayload;
1907
+ type NavigationPayload = {
1894
1908
  name?: string;
1895
1909
  slug?: string;
1896
1910
  platform?: string[];
1897
1911
  orientation?: Orientation;
1898
1912
  navigation?: NavigationReference[];
1899
1913
  };
1900
- /** @returns {PageGetResponse} */
1901
- declare function PageGetResponse(): PageGetResponse;
1902
- type PageGetResponse = {
1914
+ /** @returns {PageGetDetails} */
1915
+ declare function PageGetDetails(): PageGetDetails;
1916
+ type PageGetDetails = {
1903
1917
  items?: PageSchema[];
1904
1918
  page?: Page;
1905
1919
  };
@@ -1957,9 +1971,9 @@ declare function CreatedBySchema(): CreatedBySchema;
1957
1971
  type CreatedBySchema = {
1958
1972
  id?: string;
1959
1973
  };
1960
- /** @returns {PageRequest} */
1961
- declare function PageRequest(): PageRequest;
1962
- type PageRequest = {
1974
+ /** @returns {PagePayload} */
1975
+ declare function PagePayload(): PagePayload;
1976
+ type PagePayload = {
1963
1977
  _schedule?: CronSchedule;
1964
1978
  application?: string;
1965
1979
  author?: Author;
@@ -1982,9 +1996,9 @@ type CronSchedule = {
1982
1996
  end?: string;
1983
1997
  duration?: number;
1984
1998
  };
1985
- /** @returns {PagePublishRequest} */
1986
- declare function PagePublishRequest(): PagePublishRequest;
1987
- type PagePublishRequest = {
1999
+ /** @returns {PagePublishPayload} */
2000
+ declare function PagePublishPayload(): PagePublishPayload;
2001
+ type PagePublishPayload = {
1988
2002
  publish?: boolean;
1989
2003
  };
1990
2004
  /** @returns {PageMetaSchema} */
@@ -1994,35 +2008,6 @@ type PageMetaSchema = {
1994
2008
  custom_pages?: PageSchema[];
1995
2009
  application_id?: string;
1996
2010
  };
1997
- /** @returns {SlideshowGetResponse} */
1998
- declare function SlideshowGetResponse(): SlideshowGetResponse;
1999
- type SlideshowGetResponse = {
2000
- items?: SlideshowSchema[];
2001
- page?: Page;
2002
- };
2003
- /** @returns {SlideshowSchema} */
2004
- declare function SlideshowSchema(): SlideshowSchema;
2005
- type SlideshowSchema = {
2006
- _id?: string;
2007
- slug?: string;
2008
- date_meta?: DateMeta;
2009
- application?: string;
2010
- platform?: string;
2011
- configuration?: ConfigurationSchema;
2012
- media?: SlideshowMedia[];
2013
- active?: boolean;
2014
- archived?: boolean;
2015
- _custom_json?: any;
2016
- };
2017
- /** @returns {SlideshowRequest} */
2018
- declare function SlideshowRequest(): SlideshowRequest;
2019
- type SlideshowRequest = {
2020
- slug?: string;
2021
- platform?: string;
2022
- configuration?: ConfigurationSchema;
2023
- media?: SlideshowMedia;
2024
- active?: boolean;
2025
- };
2026
2011
  /** @returns {Support} */
2027
2012
  declare function Support(): Support;
2028
2013
  type Support = {
@@ -2116,99 +2101,310 @@ type ResourceSchema = {
2116
2101
  /** @returns {FieldValidations} */
2117
2102
  declare function FieldValidations(): FieldValidations;
2118
2103
  type FieldValidations = {
2104
+ /**
2105
+ * - Name of validation
2106
+ */
2119
2107
  name?: string;
2108
+ /**
2109
+ * - Type of validation
2110
+ */
2120
2111
  type?: string;
2121
2112
  value?: any;
2122
2113
  };
2123
2114
  /** @returns {FieldDefinitionSchema} */
2124
2115
  declare function FieldDefinitionSchema(): FieldDefinitionSchema;
2125
2116
  type FieldDefinitionSchema = {
2126
- _id?: string;
2127
- creator?: string;
2117
+ /**
2118
+ * - Unique system generated id
2119
+ */
2120
+ id?: string;
2121
+ /**
2122
+ * - Resource type to which custom field belongs
2123
+ */
2128
2124
  resource?: string;
2125
+ /**
2126
+ * - Name of custom field
2127
+ */
2129
2128
  name?: string;
2129
+ /**
2130
+ * - Namespace of custom field
2131
+ */
2130
2132
  namespace?: string;
2131
- key?: string;
2133
+ /**
2134
+ * - Slug of custom field
2135
+ */
2136
+ slug?: string;
2137
+ /**
2138
+ * - Description of custom field definition
2139
+ */
2132
2140
  description?: string;
2141
+ /**
2142
+ * - Data type of custom field
2143
+ */
2133
2144
  type?: string;
2145
+ /**
2146
+ * - Flag to denote whether custom field is
2147
+ * multivalued or not
2148
+ */
2134
2149
  multi_value?: boolean;
2150
+ /**
2151
+ * - List of validations applied
2152
+ */
2135
2153
  validations?: FieldValidations[];
2154
+ /**
2155
+ * - Id of company
2156
+ */
2136
2157
  company_id?: string;
2137
- created_by?: string;
2138
- updated_by?: string;
2158
+ /**
2159
+ * - Whether the custom field is required or not
2160
+ */
2139
2161
  required?: boolean;
2162
+ /**
2163
+ * - Whether the custom field is deleted or not
2164
+ */
2140
2165
  is_deleted?: boolean;
2141
- created_at?: string;
2142
- updated_at?: string;
2166
+ /**
2167
+ * - Type of type field
2168
+ */
2143
2169
  type_name?: string;
2170
+ /**
2171
+ * - Count of invalid fields after validation
2172
+ */
2144
2173
  invalid_fields_count?: number;
2145
2174
  };
2146
2175
  /** @returns {CustomFieldDefinitionsSchema} */
2147
2176
  declare function CustomFieldDefinitionsSchema(): CustomFieldDefinitionsSchema;
2148
2177
  type CustomFieldDefinitionsSchema = {
2178
+ /**
2179
+ * - List of custom field definitions
2180
+ */
2149
2181
  items?: FieldDefinitionSchema[];
2150
2182
  page?: Page;
2151
2183
  };
2152
2184
  /** @returns {CustomFieldDefinitionRequestSchema} */
2153
2185
  declare function CustomFieldDefinitionRequestSchema(): CustomFieldDefinitionRequestSchema;
2154
2186
  type CustomFieldDefinitionRequestSchema = {
2155
- resource?: string;
2187
+ /**
2188
+ * - Data type of custom field
2189
+ */
2156
2190
  type?: string;
2157
- key?: string;
2191
+ /**
2192
+ * - Slug of custom field definition
2193
+ */
2194
+ slug?: string;
2195
+ /**
2196
+ * - Namespace of custom field definition
2197
+ */
2158
2198
  namespace?: string;
2199
+ /**
2200
+ * - Flag to denote whether custom field is
2201
+ * multi valued or not
2202
+ */
2159
2203
  multi_value?: boolean;
2204
+ /**
2205
+ * - Name of custom field definition
2206
+ */
2160
2207
  name?: string;
2208
+ /**
2209
+ * - Description of a custom field definition
2210
+ */
2161
2211
  description?: string;
2212
+ /**
2213
+ * - Validations for a custom field
2214
+ */
2162
2215
  validations?: FieldValidations[];
2163
2216
  };
2164
2217
  /** @returns {CustomObjectCustomFieldDefinitions} */
2165
2218
  declare function CustomObjectCustomFieldDefinitions(): CustomObjectCustomFieldDefinitions;
2166
2219
  type CustomObjectCustomFieldDefinitions = {
2220
+ /**
2221
+ * - Unique identifer for a custom field
2222
+ */
2167
2223
  id?: string;
2224
+ /**
2225
+ * - Data type of custom field
2226
+ */
2168
2227
  type?: string;
2228
+ /**
2229
+ * - Description of custom field
2230
+ */
2169
2231
  description?: string;
2232
+ /**
2233
+ * - Name of custom field
2234
+ */
2170
2235
  name?: string;
2236
+ /**
2237
+ * - Flag to denote if cusom field is multi
2238
+ * valued or not
2239
+ */
2171
2240
  multi_value?: boolean;
2241
+ /**
2242
+ * - Whether the field is required or not
2243
+ */
2172
2244
  required?: boolean;
2173
- key?: string;
2245
+ /**
2246
+ * - Slug of custom field definition
2247
+ */
2248
+ slug?: string;
2249
+ /**
2250
+ * - Validations added against the
2251
+ * custom field
2252
+ */
2174
2253
  validations?: FieldValidations[];
2175
2254
  action?: string;
2176
2255
  };
2177
2256
  /** @returns {CustomObjectDefinitionUpdateRequestSchema} */
2178
2257
  declare function CustomObjectDefinitionUpdateRequestSchema(): CustomObjectDefinitionUpdateRequestSchema;
2179
2258
  type CustomObjectDefinitionUpdateRequestSchema = {
2180
- type?: string;
2259
+ /**
2260
+ * - Description of custom object definiton
2261
+ */
2181
2262
  description?: string;
2263
+ /**
2264
+ * - Name of custom object definition
2265
+ */
2182
2266
  name?: string;
2267
+ /**
2268
+ * - Custom field slug which is used as a
2269
+ * display key in
2270
+ */
2183
2271
  display_name_key?: string;
2184
2272
  field_definitions?: CustomObjectCustomFieldDefinitions[];
2185
2273
  };
2186
2274
  /** @returns {CustomFieldDefinitionDetailResSchema} */
2187
2275
  declare function CustomFieldDefinitionDetailResSchema(): CustomFieldDefinitionDetailResSchema;
2188
2276
  type CustomFieldDefinitionDetailResSchema = {
2189
- creator?: string;
2277
+ /**
2278
+ * - Resource to which custom field is associated
2279
+ */
2190
2280
  resource?: string;
2281
+ /**
2282
+ * - Name of custom field
2283
+ */
2191
2284
  name?: string;
2285
+ /**
2286
+ * - Namespace of custom field
2287
+ */
2192
2288
  namespace?: string;
2193
- key?: string;
2289
+ /**
2290
+ * - Slug of custom field
2291
+ */
2292
+ slug?: string;
2293
+ /**
2294
+ * - Description regarding custom field
2295
+ */
2194
2296
  description?: string;
2297
+ /**
2298
+ * - Data type of custom field
2299
+ */
2195
2300
  type?: string;
2301
+ /**
2302
+ * - Flag to denote whether custom field is
2303
+ * multi valued or not
2304
+ */
2196
2305
  multi_value?: boolean;
2306
+ /**
2307
+ * - Company Identifer
2308
+ */
2197
2309
  company_id?: string;
2310
+ /**
2311
+ * - Sales channel identifier
2312
+ */
2198
2313
  application_id?: string;
2199
- created_by?: string;
2200
- updated_by?: string;
2314
+ /**
2315
+ * - Whether the customfield is required or not
2316
+ */
2201
2317
  required?: boolean;
2318
+ /**
2319
+ * - Is custom field deleted
2320
+ */
2202
2321
  is_deleted?: boolean;
2203
- _id?: string;
2322
+ /**
2323
+ * - Unique system generated id
2324
+ */
2325
+ id?: string;
2204
2326
  validations?: any[];
2327
+ /**
2328
+ * - Date time at which field was created
2329
+ */
2205
2330
  created_at?: string;
2331
+ /**
2332
+ * - Date time at for a field's last modification
2333
+ */
2334
+ updated_at?: string;
2335
+ };
2336
+ /** @returns {MetaFieldDefinitionDetailResSchema} */
2337
+ declare function MetaFieldDefinitionDetailResSchema(): MetaFieldDefinitionDetailResSchema;
2338
+ type MetaFieldDefinitionDetailResSchema = {
2339
+ /**
2340
+ * - Resource to which meta field is associated
2341
+ */
2342
+ resource?: string;
2343
+ /**
2344
+ * - Name of meta field
2345
+ */
2346
+ name?: string;
2347
+ /**
2348
+ * - Namespace of meta field
2349
+ */
2350
+ namespace?: string;
2351
+ /**
2352
+ * - Slug of meta field
2353
+ */
2354
+ slug?: string;
2355
+ /**
2356
+ * - Description regarding meta field
2357
+ */
2358
+ description?: string;
2359
+ /**
2360
+ * - Data type of meta field
2361
+ */
2362
+ type?: string;
2363
+ /**
2364
+ * - Flag to denote whether meta field is
2365
+ * multi valued or not
2366
+ */
2367
+ multi_value?: boolean;
2368
+ /**
2369
+ * - Company Identifer
2370
+ */
2371
+ company_id?: string;
2372
+ /**
2373
+ * - Sales channel identifier
2374
+ */
2375
+ application_id?: string;
2376
+ /**
2377
+ * - Whether the field is required or not
2378
+ */
2379
+ required?: boolean;
2380
+ /**
2381
+ * - Is meta field deleted
2382
+ */
2383
+ is_deleted?: boolean;
2384
+ /**
2385
+ * - Unique system generated id
2386
+ */
2387
+ id?: string;
2388
+ validations?: any[];
2389
+ /**
2390
+ * - Date time at which field was created
2391
+ */
2392
+ created_at?: string;
2393
+ /**
2394
+ * - Date time at for a field's last modification
2395
+ */
2206
2396
  updated_at?: string;
2207
2397
  };
2208
2398
  /** @returns {CustomDataDeleteSchema} */
2209
2399
  declare function CustomDataDeleteSchema(): CustomDataDeleteSchema;
2210
2400
  type CustomDataDeleteSchema = {
2401
+ /**
2402
+ * - Denotes the success of the delete operation
2403
+ */
2211
2404
  success?: boolean;
2405
+ /**
2406
+ * - Denotes the message of delete operation
2407
+ */
2212
2408
  message?: string;
2213
2409
  };
2214
2410
  /** @returns {CustomFieldValue} */
@@ -2219,22 +2415,52 @@ type CustomFieldValue = {
2219
2415
  /** @returns {CustomFieldSchema} */
2220
2416
  declare function CustomFieldSchema(): CustomFieldSchema;
2221
2417
  type CustomFieldSchema = {
2222
- _id?: string;
2418
+ /**
2419
+ * - Unique system generated id
2420
+ */
2421
+ id?: string;
2422
+ /**
2423
+ * - Namespace of custom field definition
2424
+ */
2223
2425
  namespace?: string;
2224
- key?: string;
2426
+ /**
2427
+ * - Slug of custom field definition
2428
+ */
2429
+ slug?: string;
2430
+ /**
2431
+ * - The resource for which custom field is being created
2432
+ */
2225
2433
  resource?: string;
2226
- creator?: string;
2227
2434
  value?: CustomFieldValue[];
2228
- resource_id?: string;
2435
+ /**
2436
+ * - Unique identifier of the resource
2437
+ */
2438
+ resource_slug?: string;
2439
+ /**
2440
+ * - Data type of custom field
2441
+ */
2229
2442
  type?: string;
2443
+ /**
2444
+ * - Whether custom field is multi valued
2445
+ */
2230
2446
  multi_value?: boolean;
2447
+ /**
2448
+ * - Identifer for a company
2449
+ */
2231
2450
  company_id?: string;
2232
- definition_id?: string;
2233
2451
  has_invalid_values?: boolean;
2234
2452
  invalid_value_errors?: any[];
2235
- created_by?: string;
2453
+ /**
2454
+ * - Indicates whether custom field is deleted
2455
+ */
2236
2456
  is_deleted?: boolean;
2457
+ /**
2458
+ * - Time at which customer field was created
2459
+ */
2237
2460
  created_at?: string;
2461
+ /**
2462
+ * - Time at which custom field was updated
2463
+ */
2238
2464
  updated_at?: string;
2239
2465
  };
2240
2466
  /** @returns {CustomFieldsResponseSchema} */
@@ -2243,6 +2469,12 @@ type CustomFieldsResponseSchema = {
2243
2469
  items?: CustomFieldSchema[];
2244
2470
  page?: Page;
2245
2471
  };
2472
+ /** @returns {CustomFieldsDeleteSchema} */
2473
+ declare function CustomFieldsDeleteSchema(): CustomFieldsDeleteSchema;
2474
+ type CustomFieldsDeleteSchema = {
2475
+ success?: boolean;
2476
+ message?: string;
2477
+ };
2246
2478
  /** @returns {CustomFieldsResponseByResourceIdSchema} */
2247
2479
  declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseByResourceIdSchema;
2248
2480
  type CustomFieldsResponseByResourceIdSchema = {
@@ -2252,7 +2484,15 @@ type CustomFieldsResponseByResourceIdSchema = {
2252
2484
  declare function CustomField(): CustomField;
2253
2485
  type CustomField = {
2254
2486
  value?: any[];
2255
- definition_id?: string;
2487
+ /**
2488
+ * - This is the namespace to which custom field belongs
2489
+ */
2490
+ namespace?: string;
2491
+ /**
2492
+ * - This is the slug of custom field used while
2493
+ * creating a custom field definition
2494
+ */
2495
+ slug?: string;
2256
2496
  };
2257
2497
  /** @returns {CustomFieldRequestSchema} */
2258
2498
  declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
@@ -2262,160 +2502,368 @@ type CustomFieldRequestSchema = {
2262
2502
  /** @returns {CustomObjectSchema} */
2263
2503
  declare function CustomObjectSchema(): CustomObjectSchema;
2264
2504
  type CustomObjectSchema = {
2265
- _id?: string;
2266
- creator?: string;
2505
+ /**
2506
+ * - Unique system generated id
2507
+ */
2508
+ id?: string;
2509
+ /**
2510
+ * - Identifer for a company
2511
+ */
2267
2512
  company_id?: string;
2513
+ /**
2514
+ * - Identifer for a sales channel
2515
+ */
2268
2516
  application_id?: string;
2269
- created_by?: string;
2270
- updated_by?: string;
2517
+ /**
2518
+ * - Status of custom object
2519
+ */
2271
2520
  status?: string;
2521
+ /**
2522
+ * - Slug of custom object definition
2523
+ */
2272
2524
  type?: string;
2525
+ /**
2526
+ * - Slug for custom object definition
2527
+ */
2528
+ definition_slug?: string;
2529
+ /**
2530
+ * - Value of custom field used for displaying
2531
+ * custom object
2532
+ */
2273
2533
  display_name?: string;
2274
- definition_id?: string;
2534
+ /**
2535
+ * - Fields associated to the custom object
2536
+ */
2275
2537
  fields?: CustomFieldSchema[];
2276
2538
  };
2277
2539
  /** @returns {CustomObjectDefinitionRequestSchema} */
2278
2540
  declare function CustomObjectDefinitionRequestSchema(): CustomObjectDefinitionRequestSchema;
2279
2541
  type CustomObjectDefinitionRequestSchema = {
2542
+ /**
2543
+ * - Namespace/Slug of Custom object definition
2544
+ */
2280
2545
  type?: string;
2546
+ /**
2547
+ * - Unique slug for a custom object definition
2548
+ */
2549
+ definition_slug?: string;
2550
+ /**
2551
+ * - Description of custom object definition
2552
+ */
2281
2553
  description?: string;
2554
+ /**
2555
+ * - Name of custom object
2556
+ */
2282
2557
  name?: string;
2558
+ /**
2559
+ * - Denotes which custom field to be used
2560
+ * for displaying custom object
2561
+ */
2283
2562
  display_name_key?: string;
2563
+ /**
2564
+ * - List
2565
+ * of custom field definitions belonging to this custom object definition
2566
+ */
2284
2567
  field_definitions?: CustomObjectCustomFieldDefinitions[];
2285
2568
  };
2286
- /** @returns {CustomObjectCustomFieldDefinitionResSchema} */
2287
- declare function CustomObjectCustomFieldDefinitionResSchema(): CustomObjectCustomFieldDefinitionResSchema;
2288
- type CustomObjectCustomFieldDefinitionResSchema = {
2289
- creator?: string;
2290
- resource?: string;
2291
- name?: string;
2292
- namespace?: string;
2293
- key?: string;
2294
- description?: string;
2295
- type?: string;
2296
- multi_value?: boolean;
2297
- validations?: FieldValidations[];
2298
- company_id?: string;
2299
- created_by?: string;
2300
- metaobject_definition_id?: string;
2301
- required?: boolean;
2302
- is_deleted?: boolean;
2303
- _id?: string;
2304
- created_at?: string;
2305
- updated_at?: string;
2306
- };
2307
- /** @returns {CustomObjectDefinitionSchema} */
2308
- declare function CustomObjectDefinitionSchema(): CustomObjectDefinitionSchema;
2309
- type CustomObjectDefinitionSchema = {
2310
- _id?: string;
2569
+ /** @returns {CustomObjectDefinitionSlugSchema} */
2570
+ declare function CustomObjectDefinitionSlugSchema(): CustomObjectDefinitionSlugSchema;
2571
+ type CustomObjectDefinitionSlugSchema = {
2572
+ /**
2573
+ * - Unique system generated custom object definition id
2574
+ */
2575
+ id?: string;
2576
+ /**
2577
+ * - Display name of custom object definition
2578
+ */
2311
2579
  name?: string;
2580
+ /**
2581
+ * - Type of custom object definiton
2582
+ */
2312
2583
  type?: string;
2584
+ /**
2585
+ * - Slug of custom object definiton
2586
+ */
2587
+ definition_slug?: string;
2588
+ /**
2589
+ * - Display name of custom object definition
2590
+ */
2313
2591
  display_name_key?: string;
2592
+ /**
2593
+ * - Description of custom object definition
2594
+ */
2314
2595
  description?: string;
2315
- creator?: string;
2316
- created_by?: string;
2317
- updated_by?: string;
2318
- field_definitions?: CustomObjectCustomFieldDefinitionResSchema[];
2596
+ /**
2597
+ * -
2598
+ * Custom fields inside custom objects
2599
+ */
2600
+ field_definitions?: CustomFieldDefinitionDetailResSchema[];
2319
2601
  };
2320
2602
  /** @returns {CustomObjectDefinitionDeleteResponseSchema} */
2321
2603
  declare function CustomObjectDefinitionDeleteResponseSchema(): CustomObjectDefinitionDeleteResponseSchema;
2322
2604
  type CustomObjectDefinitionDeleteResponseSchema = {
2605
+ /**
2606
+ * - Success status of delete custom object definition.
2607
+ */
2323
2608
  success?: boolean;
2609
+ /**
2610
+ * - Response message when custom object definition
2611
+ * is deleted.
2612
+ */
2324
2613
  message?: string;
2325
2614
  };
2326
- /** @returns {CustomObjectEntryBulkUploadResponse} */
2327
- declare function CustomObjectEntryBulkUploadResponse(): CustomObjectEntryBulkUploadResponse;
2328
- type CustomObjectEntryBulkUploadResponse = {
2615
+ /** @returns {CustomObjectEntryBulkUploadDetails} */
2616
+ declare function CustomObjectEntryBulkUploadDetails(): CustomObjectEntryBulkUploadDetails;
2617
+ type CustomObjectEntryBulkUploadDetails = {
2618
+ /**
2619
+ * - Signed url of csv
2620
+ */
2329
2621
  url?: string;
2622
+ /**
2623
+ * - Total no of records in csv file
2624
+ */
2330
2625
  total_records?: number;
2331
2626
  };
2332
- /** @returns {CustomObjectListItemDefinationSchema} */
2333
- declare function CustomObjectListItemDefinationSchema(): CustomObjectListItemDefinationSchema;
2334
- type CustomObjectListItemDefinationSchema = {
2335
- _id?: string;
2627
+ /** @returns {CustomObjectListItemDefinitionModel} */
2628
+ declare function CustomObjectListItemDefinitionModel(): CustomObjectListItemDefinitionModel;
2629
+ type CustomObjectListItemDefinitionModel = {
2630
+ /**
2631
+ * - Unique system generated id
2632
+ */
2633
+ id?: string;
2634
+ /**
2635
+ * - Name of custom object
2636
+ */
2336
2637
  name?: string;
2638
+ /**
2639
+ * - Type of custom object entry
2640
+ */
2337
2641
  type?: string;
2338
2642
  };
2339
2643
  /** @returns {CustomObjectListItemSchema} */
2340
2644
  declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
2341
2645
  type CustomObjectListItemSchema = {
2342
- _id?: string;
2343
- definition_id?: string;
2646
+ /**
2647
+ * - Unique system generated id
2648
+ */
2649
+ id?: string;
2650
+ /**
2651
+ * - Status of custom object
2652
+ */
2344
2653
  status?: string;
2654
+ /**
2655
+ * - Creation time of custom object document
2656
+ */
2657
+ created_at?: string;
2658
+ /**
2659
+ * - Updation time of custom object document
2660
+ */
2345
2661
  updated_at?: string;
2662
+ /**
2663
+ * - Display name of custom object
2664
+ */
2346
2665
  display_name?: string;
2347
- definition?: CustomObjectListItemDefinationSchema;
2666
+ definition?: CustomObjectListItemDefinitionModel;
2667
+ /**
2668
+ * - References of the custom object entry
2669
+ */
2348
2670
  references?: number;
2349
2671
  };
2350
2672
  /** @returns {CustomObjectsSchema} */
2351
2673
  declare function CustomObjectsSchema(): CustomObjectsSchema;
2352
2674
  type CustomObjectsSchema = {
2675
+ /**
2676
+ * - List of paginated custom
2677
+ * object entries
2678
+ */
2353
2679
  items?: CustomObjectListItemSchema[];
2354
2680
  page?: Page;
2355
2681
  };
2356
- /** @returns {CustomObjectFieldSchema} */
2357
- declare function CustomObjectFieldSchema(): CustomObjectFieldSchema;
2358
- type CustomObjectFieldSchema = {
2359
- _id?: string;
2360
- key?: string;
2682
+ /** @returns {CustomObjectFieldDefinition} */
2683
+ declare function CustomObjectFieldDefinition(): CustomObjectFieldDefinition;
2684
+ type CustomObjectFieldDefinition = {
2685
+ /**
2686
+ * - Unique system generate id
2687
+ */
2688
+ id?: string;
2689
+ /**
2690
+ * - Slug of custom field definition
2691
+ */
2692
+ slug?: string;
2693
+ /**
2694
+ * - Namespace of custom field definition
2695
+ */
2696
+ namespace?: string;
2697
+ /**
2698
+ * - Value of custom field
2699
+ */
2361
2700
  value?: any[];
2701
+ /**
2702
+ * - Data type of the custom field
2703
+ */
2362
2704
  type?: string;
2363
- definition_id?: string;
2364
2705
  };
2365
- /** @returns {CustomObjectByIdSchema} */
2366
- declare function CustomObjectByIdSchema(): CustomObjectByIdSchema;
2367
- type CustomObjectByIdSchema = {
2368
- _id?: string;
2706
+ /** @returns {CustomObjectBySlugSchema} */
2707
+ declare function CustomObjectBySlugSchema(): CustomObjectBySlugSchema;
2708
+ type CustomObjectBySlugSchema = {
2709
+ /**
2710
+ * - Unique system generated identifer for a Custom Object
2711
+ */
2712
+ id?: string;
2713
+ /**
2714
+ * - Status of Custom Object
2715
+ */
2369
2716
  status?: string;
2717
+ /**
2718
+ * - Display name for the Custom Object
2719
+ */
2370
2720
  display_name?: string;
2371
- definition?: CustomObjectListItemDefinationSchema;
2721
+ definition?: CustomObjectListItemDefinitionModel;
2722
+ /**
2723
+ * - Places where the custom object has been
2724
+ * used as a custom field
2725
+ */
2372
2726
  references?: any[];
2373
- fields?: CustomObjectFieldSchema[];
2727
+ /**
2728
+ * - Slug of custom object entry
2729
+ */
2730
+ slug?: string;
2731
+ /**
2732
+ * - Slug of custom object definition
2733
+ */
2734
+ definition_slug?: string;
2735
+ /**
2736
+ * - List of custom fields
2737
+ * inside the custom object
2738
+ */
2739
+ fields?: CustomObjectFieldDefinition[];
2374
2740
  };
2375
2741
  /** @returns {CustomObjectBulkEntryInitiateDownload} */
2376
2742
  declare function CustomObjectBulkEntryInitiateDownload(): CustomObjectBulkEntryInitiateDownload;
2377
2743
  type CustomObjectBulkEntryInitiateDownload = {
2744
+ /**
2745
+ * - Message for the user
2746
+ */
2378
2747
  message?: string;
2748
+ /**
2749
+ * - Identifer for a task
2750
+ */
2379
2751
  task_id?: string;
2380
2752
  };
2381
2753
  /** @returns {CustomObjectMetaSchema} */
2382
2754
  declare function CustomObjectMetaSchema(): CustomObjectMetaSchema;
2383
2755
  type CustomObjectMetaSchema = {
2756
+ /**
2757
+ * - Total number of entries in the bulk entry
2758
+ */
2384
2759
  mo_total_count?: number;
2760
+ /**
2761
+ * - Number of entries which were successful
2762
+ */
2385
2763
  mo_success_count?: number;
2764
+ /**
2765
+ * - Number of entries which were failed
2766
+ */
2386
2767
  mo_error_count?: number;
2768
+ /**
2769
+ * - Type of object
2770
+ */
2387
2771
  mo_defintion_type?: string;
2388
2772
  };
2389
- /** @returns {CustomObjectJobSchema} */
2390
- declare function CustomObjectJobSchema(): CustomObjectJobSchema;
2391
- type CustomObjectJobSchema = {
2392
- _id?: string;
2773
+ /** @returns {JobSchema} */
2774
+ declare function JobSchema(): JobSchema;
2775
+ type JobSchema = {
2776
+ /**
2777
+ * - Unique system generated id
2778
+ */
2779
+ id?: string;
2780
+ /**
2781
+ * - List of total jobs
2782
+ */
2393
2783
  jobs?: string[];
2784
+ /**
2785
+ * - List of finished jobs
2786
+ */
2394
2787
  finished_jobs?: string[];
2788
+ /**
2789
+ * - List of jobs which resulted in an error
2790
+ */
2395
2791
  error_jobs?: string[];
2792
+ /**
2793
+ * - List of errors occurred in the job
2794
+ */
2396
2795
  errors_occured?: string[];
2796
+ /**
2797
+ * - Company Identifer
2798
+ */
2397
2799
  company_id?: string;
2398
- creator?: string;
2399
- url?: string;
2800
+ /**
2801
+ * - Status of job
2802
+ */
2400
2803
  status?: string;
2804
+ /**
2805
+ * - Type of job
2806
+ */
2401
2807
  action_type?: string;
2808
+ /**
2809
+ * - Entity against which job is running
2810
+ */
2402
2811
  entity?: string;
2812
+ /**
2813
+ * - URL which contains the file with errors
2814
+ */
2403
2815
  error_url?: string;
2816
+ /**
2817
+ * - Number of items successfully finished
2818
+ */
2404
2819
  finished_count?: number;
2820
+ /**
2821
+ * - Number of items in error
2822
+ */
2405
2823
  error_count?: number;
2824
+ /**
2825
+ * - Number of successful items
2826
+ */
2406
2827
  success_count?: number;
2828
+ /**
2829
+ * - Total number of jobs
2830
+ */
2407
2831
  total_jobs?: number;
2408
2832
  meta?: CustomObjectMetaSchema;
2833
+ /**
2834
+ * - Source from where the bulk job is created
2835
+ */
2409
2836
  created_by?: string;
2837
+ /**
2838
+ * - Date/Time when the job was created
2839
+ */
2410
2840
  created_at?: string;
2841
+ /**
2842
+ * - Date/Time when the job was updated
2843
+ */
2411
2844
  updated_at?: string;
2845
+ /**
2846
+ * - Sales Channel Identifier
2847
+ */
2848
+ application_id?: string;
2849
+ };
2850
+ /** @returns {CustomFieldBulkEntry} */
2851
+ declare function CustomFieldBulkEntry(): CustomFieldBulkEntry;
2852
+ type CustomFieldBulkEntry = {
2853
+ items?: JobSchema[];
2854
+ page?: Page;
2412
2855
  };
2413
2856
  /** @returns {CustomObjectBulkEntry} */
2414
2857
  declare function CustomObjectBulkEntry(): CustomObjectBulkEntry;
2415
2858
  type CustomObjectBulkEntry = {
2416
- items?: CustomObjectJobSchema[];
2859
+ items?: JobSchema[];
2417
2860
  page?: Page;
2418
2861
  };
2862
+ /** @returns {MetafieldTypesSchema} */
2863
+ declare function MetafieldTypesSchema(): MetafieldTypesSchema;
2864
+ type MetafieldTypesSchema = {
2865
+ metafield_types?: CustomFieldTypeSchema;
2866
+ };
2419
2867
  /** @returns {CustomFieldTypeSchema} */
2420
2868
  declare function CustomFieldTypeSchema(): CustomFieldTypeSchema;
2421
2869
  type CustomFieldTypeSchema = {
@@ -2432,6 +2880,8 @@ type CustomFieldTypeSchema = {
2432
2880
  url?: Url;
2433
2881
  metaobject?: Metaobject;
2434
2882
  product?: Product;
2883
+ html?: HTML;
2884
+ duration?: Duration;
2435
2885
  };
2436
2886
  /** @returns {SupportedValidationsMetaExampleSchema} */
2437
2887
  declare function SupportedValidationsMetaExampleSchema(): SupportedValidationsMetaExampleSchema;
@@ -2453,130 +2903,392 @@ type SupportedValidationsSchema = {
2453
2903
  required?: boolean;
2454
2904
  meta?: SupportedValidationsMetaSchema;
2455
2905
  };
2906
+ /** @returns {Duration} */
2907
+ declare function Duration(): Duration;
2908
+ type Duration = {
2909
+ /**
2910
+ * - Name data type of custom field
2911
+ */
2912
+ name?: string;
2913
+ /**
2914
+ * - Flag for listing enabled or not
2915
+ */
2916
+ list_enabled?: boolean;
2917
+ /**
2918
+ * - Type of custom field
2919
+ */
2920
+ type?: string;
2921
+ /**
2922
+ * - Category of custom field
2923
+ */
2924
+ category?: string;
2925
+ /**
2926
+ * - List of
2927
+ * validations available for the field
2928
+ */
2929
+ supported_validations?: SupportedValidationsSchema[];
2930
+ };
2931
+ /** @returns {HTML} */
2932
+ declare function HTML(): HTML;
2933
+ type HTML = {
2934
+ /**
2935
+ * - Name data type of custom field
2936
+ */
2937
+ name?: string;
2938
+ /**
2939
+ * - Flag for listing enabled or not
2940
+ */
2941
+ list_enabled?: boolean;
2942
+ /**
2943
+ * - Type of custom field
2944
+ */
2945
+ type?: string;
2946
+ /**
2947
+ * - List of
2948
+ * validations available for the field
2949
+ */
2950
+ supported_validations?: SupportedValidationsSchema[];
2951
+ };
2456
2952
  /** @returns {StringSingleLine} */
2457
2953
  declare function StringSingleLine(): StringSingleLine;
2458
2954
  type StringSingleLine = {
2955
+ /**
2956
+ * - Name data type of custom field
2957
+ */
2459
2958
  name?: string;
2959
+ /**
2960
+ * - Flag for listing enabled or not
2961
+ */
2460
2962
  list_enabled?: boolean;
2963
+ /**
2964
+ * - Category of custom field
2965
+ */
2461
2966
  category?: string;
2967
+ /**
2968
+ * - Type of custom field
2969
+ */
2462
2970
  type?: string;
2971
+ /**
2972
+ * - List of
2973
+ * validations available for the field
2974
+ */
2463
2975
  supported_validations?: SupportedValidationsSchema[];
2464
2976
  };
2465
2977
  /** @returns {StringMultiLine} */
2466
2978
  declare function StringMultiLine(): StringMultiLine;
2467
2979
  type StringMultiLine = {
2980
+ /**
2981
+ * - Name data type of custom field
2982
+ */
2468
2983
  name?: string;
2984
+ /**
2985
+ * - Flag for listing enabled or not
2986
+ */
2469
2987
  list_enabled?: boolean;
2988
+ /**
2989
+ * - Category of custom field
2990
+ */
2470
2991
  category?: string;
2992
+ /**
2993
+ * - Type of custom field
2994
+ */
2471
2995
  type?: string;
2996
+ /**
2997
+ * - List of
2998
+ * validations available for the field
2999
+ */
2472
3000
  supported_validations?: SupportedValidationsSchema[];
2473
3001
  };
2474
3002
  /** @returns {Dropdown} */
2475
3003
  declare function Dropdown(): Dropdown;
2476
3004
  type Dropdown = {
3005
+ /**
3006
+ * - Name data type of custom field
3007
+ */
2477
3008
  name?: string;
3009
+ /**
3010
+ * - Flag for listing enabled or not
3011
+ */
2478
3012
  list_enabled?: boolean;
3013
+ /**
3014
+ * - Category of custom field
3015
+ */
2479
3016
  category?: string;
3017
+ /**
3018
+ * - Category of custom field
3019
+ */
2480
3020
  type?: string;
3021
+ /**
3022
+ * - List of
3023
+ * validations available for the field
3024
+ */
2481
3025
  supported_validations?: SupportedValidationsSchema[];
2482
3026
  };
2483
3027
  /** @returns {Integer} */
2484
3028
  declare function Integer(): Integer;
2485
3029
  type Integer = {
3030
+ /**
3031
+ * - Name data type of custom field
3032
+ */
2486
3033
  name?: string;
3034
+ /**
3035
+ * - Flag for listing enabled or not
3036
+ */
2487
3037
  list_enabled?: boolean;
3038
+ /**
3039
+ * - Type of custom field
3040
+ */
2488
3041
  type?: string;
3042
+ /**
3043
+ * - Category of custom field
3044
+ */
2489
3045
  category?: string;
3046
+ /**
3047
+ * - List of
3048
+ * validations available for the field
3049
+ */
2490
3050
  supported_validations?: SupportedValidationsSchema[];
2491
3051
  };
2492
3052
  /** @returns {FloatType} */
2493
3053
  declare function FloatType(): FloatType;
2494
3054
  type FloatType = {
3055
+ /**
3056
+ * - Name data type of custom field
3057
+ */
2495
3058
  name?: string;
3059
+ /**
3060
+ * - Flag for listing enabled or not
3061
+ */
2496
3062
  list_enabled?: boolean;
3063
+ /**
3064
+ * - Type of custom field
3065
+ */
2497
3066
  type?: string;
3067
+ /**
3068
+ * - Category of custom field
3069
+ */
2498
3070
  category?: string;
3071
+ /**
3072
+ * - List of
3073
+ * validations available for the field
3074
+ */
2499
3075
  supported_validations?: SupportedValidationsSchema[];
2500
3076
  };
2501
3077
  /** @returns {BooleanType} */
2502
3078
  declare function BooleanType(): BooleanType;
2503
3079
  type BooleanType = {
3080
+ /**
3081
+ * - Name data type of custom field
3082
+ */
2504
3083
  name?: string;
3084
+ /**
3085
+ * - Category of custom field
3086
+ */
2505
3087
  category?: string;
3088
+ /**
3089
+ * - Flag for listing enabled or not
3090
+ */
2506
3091
  list_enabled?: boolean;
3092
+ /**
3093
+ * - Category of custom field
3094
+ */
2507
3095
  type?: string;
3096
+ /**
3097
+ * - List of
3098
+ * validations available for the field
3099
+ */
2508
3100
  supported_validations?: SupportedValidationsSchema[];
2509
3101
  };
2510
3102
  /** @returns {Date} */
2511
3103
  declare function Date(): Date;
2512
3104
  type Date = {
3105
+ /**
3106
+ * - Name data type of custom field
3107
+ */
2513
3108
  name?: string;
3109
+ /**
3110
+ * - Flag for listing enabled or not
3111
+ */
2514
3112
  list_enabled?: boolean;
3113
+ /**
3114
+ * - Category of custom field
3115
+ */
2515
3116
  category?: string;
3117
+ /**
3118
+ * - Type of custom field
3119
+ */
2516
3120
  type?: string;
3121
+ /**
3122
+ * - List of
3123
+ * validations available for the field
3124
+ */
2517
3125
  supported_validations?: SupportedValidationsSchema[];
2518
3126
  };
2519
3127
  /** @returns {Datetime} */
2520
3128
  declare function Datetime(): Datetime;
2521
3129
  type Datetime = {
3130
+ /**
3131
+ * - Name data type of custom field
3132
+ */
2522
3133
  name?: string;
3134
+ /**
3135
+ * - Category of custom field
3136
+ */
2523
3137
  category?: string;
3138
+ /**
3139
+ * - Flag for listing enabled or not
3140
+ */
2524
3141
  list_enabled?: boolean;
3142
+ /**
3143
+ * - Type of custom field
3144
+ */
2525
3145
  type?: string;
3146
+ /**
3147
+ * - List of
3148
+ * validations available for the field
3149
+ */
2526
3150
  supported_validations?: SupportedValidationsSchema[];
2527
3151
  };
2528
3152
  /** @returns {Json} */
2529
3153
  declare function Json(): Json;
2530
3154
  type Json = {
3155
+ /**
3156
+ * - Name data type of custom field
3157
+ */
2531
3158
  name?: string;
3159
+ /**
3160
+ * - Flag for listing enabled or not
3161
+ */
2532
3162
  list_enabled?: boolean;
3163
+ /**
3164
+ * - Category of custom field
3165
+ */
2533
3166
  category?: string;
3167
+ /**
3168
+ * - Type of custom field
3169
+ */
2534
3170
  type?: string;
3171
+ /**
3172
+ * - List of
3173
+ * validations available for the field
3174
+ */
2535
3175
  supported_validations?: SupportedValidationsSchema[];
2536
3176
  };
2537
3177
  /** @returns {File} */
2538
3178
  declare function File(): File;
2539
3179
  type File = {
3180
+ /**
3181
+ * - Name data type of custom field
3182
+ */
2540
3183
  name?: string;
3184
+ /**
3185
+ * - Category of custom field
3186
+ */
2541
3187
  category?: string;
3188
+ /**
3189
+ * - Flag for listing enabled or not
3190
+ */
2542
3191
  list_enabled?: boolean;
3192
+ /**
3193
+ * - Type of custom field
3194
+ */
2543
3195
  type?: string;
2544
3196
  supported_validations?: SupportedValidationsSchema[];
2545
3197
  };
2546
3198
  /** @returns {Url} */
2547
3199
  declare function Url(): Url;
2548
3200
  type Url = {
3201
+ /**
3202
+ * - Name data type of custom field
3203
+ */
2549
3204
  name?: string;
3205
+ /**
3206
+ * - Flag for listing enabled or not
3207
+ */
2550
3208
  list_enabled?: boolean;
3209
+ /**
3210
+ * - Type of custom field
3211
+ */
2551
3212
  type?: string;
3213
+ /**
3214
+ * - List of
3215
+ * validations available for the field
3216
+ */
2552
3217
  supported_validations?: SupportedValidationsSchema[];
2553
3218
  };
2554
3219
  /** @returns {Metaobject} */
2555
3220
  declare function Metaobject(): Metaobject;
2556
3221
  type Metaobject = {
3222
+ /**
3223
+ * - Name of Custom Object
3224
+ */
2557
3225
  name?: string;
3226
+ /**
3227
+ * - Whether the field is allowed to have
3228
+ * multiple list items
3229
+ */
2558
3230
  list_enabled?: boolean;
3231
+ /**
3232
+ * - Category of Custom Object Definition that
3233
+ * Custom Object belongs to
3234
+ */
2559
3235
  category?: string;
3236
+ /**
3237
+ * - Type of Custom Object Definition
3238
+ */
2560
3239
  type?: string;
2561
3240
  supported_validations?: SupportedValidationsSchema[];
2562
3241
  };
2563
3242
  /** @returns {Product} */
2564
3243
  declare function Product(): Product;
2565
3244
  type Product = {
3245
+ /**
3246
+ * - Name of Product
3247
+ */
2566
3248
  name?: string;
3249
+ /**
3250
+ * - Whether the field is allowed to have
3251
+ * multiple list items
3252
+ */
2567
3253
  list_enabled?: boolean;
3254
+ /**
3255
+ * - Category of Custom Object Definition that
3256
+ * Product is associated with
3257
+ */
2568
3258
  category?: string;
3259
+ /**
3260
+ * - Custom Object Definition that Product is associated with
3261
+ */
2569
3262
  type?: string;
2570
3263
  supported_validations?: SupportedValidationsSchema[];
2571
3264
  };
2572
3265
  /** @returns {CustomObjectEntry} */
2573
3266
  declare function CustomObjectEntry(): CustomObjectEntry;
2574
3267
  type CustomObjectEntry = {
2575
- _id?: string;
3268
+ /**
3269
+ * - Unique system generated id
3270
+ */
3271
+ id?: string;
3272
+ /**
3273
+ * - Name of Custom Object definition
3274
+ */
2576
3275
  name?: string;
3276
+ /**
3277
+ * - Type of Custom Object Definition
3278
+ */
2577
3279
  type?: string;
3280
+ /**
3281
+ * - Updation time of a Custom Object
3282
+ */
2578
3283
  updated_at?: string;
3284
+ /**
3285
+ * - Number of entries against the Custom
3286
+ * Object definition
3287
+ */
2579
3288
  entries_count?: number;
3289
+ /**
3290
+ * - Number of fields against a Custom Object definition
3291
+ */
2580
3292
  fields_count?: number;
2581
3293
  };
2582
3294
  /** @returns {CustomObjectDefinitionsSchema} */
@@ -2588,20 +3300,65 @@ type CustomObjectDefinitionsSchema = {
2588
3300
  /** @returns {CustomObjectEntryFieldSchema} */
2589
3301
  declare function CustomObjectEntryFieldSchema(): CustomObjectEntryFieldSchema;
2590
3302
  type CustomObjectEntryFieldSchema = {
2591
- definition_id?: string;
2592
- value?: any[];
3303
+ /**
3304
+ * - This is namespace for a custom field definition
3305
+ */
3306
+ namespace?: string;
3307
+ /**
3308
+ * - This is slug for a custom field definition
3309
+ */
3310
+ slug?: string;
3311
+ };
3312
+ /** @returns {CustomObjectEntryFieldSchemaWithoutID} */
3313
+ declare function CustomObjectEntryFieldSchemaWithoutID(): CustomObjectEntryFieldSchemaWithoutID;
3314
+ type CustomObjectEntryFieldSchemaWithoutID = {
3315
+ /**
3316
+ * - Custom fields belonging to a custom object
3317
+ */
3318
+ slug?: string;
3319
+ /**
3320
+ * - Value of custom field inside a custom object
3321
+ */
3322
+ value?: any;
2593
3323
  };
2594
3324
  /** @returns {CustomObjectRequestSchema} */
2595
3325
  declare function CustomObjectRequestSchema(): CustomObjectRequestSchema;
2596
3326
  type CustomObjectRequestSchema = {
3327
+ /**
3328
+ * - Flag to denote status of Custom Object
3329
+ */
2597
3330
  status?: string;
2598
- definition_id?: string;
3331
+ /**
3332
+ * - This is slug for a custom field definition
3333
+ */
3334
+ slug?: string;
3335
+ /**
3336
+ * - List of custom fields
3337
+ */
2599
3338
  fields?: CustomObjectEntryFieldSchema[];
2600
3339
  };
3340
+ /** @returns {CustomObjectRequestSchemaWithoutId} */
3341
+ declare function CustomObjectRequestSchemaWithoutId(): CustomObjectRequestSchemaWithoutId;
3342
+ type CustomObjectRequestSchemaWithoutId = {
3343
+ /**
3344
+ * - Status of the custom object entry.
3345
+ */
3346
+ status?: string;
3347
+ /**
3348
+ * - List of custom fields
3349
+ */
3350
+ fields?: CustomObjectEntryFieldSchemaWithoutID[];
3351
+ };
2601
3352
  /** @returns {CustomObjectBulkSchema} */
2602
3353
  declare function CustomObjectBulkSchema(): CustomObjectBulkSchema;
2603
3354
  type CustomObjectBulkSchema = {
3355
+ /**
3356
+ * - Full URL for the bulk operations data
3357
+ */
2604
3358
  url?: string;
3359
+ /**
3360
+ * - Total records in the upload.
3361
+ */
2605
3362
  total_records?: number;
2606
3363
  };
2607
3364
  /** @returns {ActionPage} */