@gofynd/fdk-client-javascript 1.4.12 → 1.4.14

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 (297) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +60 -53
  6. package/sdk/application/Cart/CartApplicationClient.js +130 -53
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +489 -143
  8. package/sdk/application/Cart/CartApplicationModel.js +380 -159
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +38 -19
  10. package/sdk/application/Cart/CartApplicationValidator.js +34 -18
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +88 -68
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +114 -94
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +194 -142
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +171 -133
  15. package/sdk/application/Common/CommonApplicationClient.d.ts +3 -2
  16. package/sdk/application/Common/CommonApplicationClient.js +6 -5
  17. package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
  18. package/sdk/application/Common/CommonApplicationModel.js +6 -6
  19. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -27
  20. package/sdk/application/Configuration/ConfigurationApplicationClient.js +34 -27
  21. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +45 -57
  22. package/sdk/application/Configuration/ConfigurationApplicationModel.js +35 -47
  23. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
  24. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
  25. package/sdk/application/Content/ContentApplicationClient.d.ts +23 -33
  26. package/sdk/application/Content/ContentApplicationClient.js +54 -75
  27. package/sdk/application/Content/ContentApplicationModel.d.ts +96 -39
  28. package/sdk/application/Content/ContentApplicationModel.js +88 -34
  29. package/sdk/application/Content/ContentApplicationValidator.d.ts +23 -17
  30. package/sdk/application/Content/ContentApplicationValidator.js +15 -10
  31. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -8
  32. package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -13
  33. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +23 -25
  34. package/sdk/application/FileStorage/FileStorageApplicationModel.js +16 -18
  35. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
  36. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
  37. package/sdk/application/Finance/FinanceApplicationClient.d.ts +36 -0
  38. package/sdk/application/Finance/FinanceApplicationClient.js +202 -0
  39. package/sdk/application/Finance/FinanceApplicationModel.d.ts +289 -0
  40. package/sdk/application/Finance/FinanceApplicationModel.js +208 -0
  41. package/sdk/application/Finance/FinanceApplicationValidator.d.ts +25 -0
  42. package/sdk/application/Finance/FinanceApplicationValidator.js +31 -0
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +2 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
  46. package/sdk/application/Lead/LeadApplicationModel.js +19 -19
  47. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +39 -16
  48. package/sdk/application/Logistic/LogisticApplicationClient.js +189 -21
  49. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +532 -173
  50. package/sdk/application/Logistic/LogisticApplicationModel.js +409 -139
  51. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +54 -9
  52. package/sdk/application/Logistic/LogisticApplicationValidator.js +42 -8
  53. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -10
  54. package/sdk/application/Order/OrderApplicationClient.js +96 -13
  55. package/sdk/application/Order/OrderApplicationModel.d.ts +434 -102
  56. package/sdk/application/Order/OrderApplicationModel.js +278 -73
  57. package/sdk/application/Order/OrderApplicationValidator.d.ts +17 -3
  58. package/sdk/application/Order/OrderApplicationValidator.js +15 -2
  59. package/sdk/application/Payment/PaymentApplicationClient.d.ts +96 -99
  60. package/sdk/application/Payment/PaymentApplicationClient.js +111 -114
  61. package/sdk/application/Payment/PaymentApplicationModel.d.ts +293 -289
  62. package/sdk/application/Payment/PaymentApplicationModel.js +243 -241
  63. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
  64. package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
  65. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -16
  66. package/sdk/application/Rewards/RewardsApplicationClient.js +19 -22
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
  69. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
  70. package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
  71. package/sdk/application/Share/ShareApplicationModel.js +1 -1
  72. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  73. package/sdk/application/Theme/ThemeApplicationClient.js +8 -6
  74. package/sdk/application/Theme/ThemeApplicationModel.d.ts +51 -19
  75. package/sdk/application/Theme/ThemeApplicationModel.js +47 -24
  76. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +16 -3
  77. package/sdk/application/Theme/ThemeApplicationValidator.js +9 -2
  78. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  79. package/sdk/application/User/UserApplicationClient.js +10 -10
  80. package/sdk/application/User/UserApplicationModel.d.ts +17 -17
  81. package/sdk/application/User/UserApplicationModel.js +16 -16
  82. package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
  83. package/sdk/application/User/UserApplicationValidator.js +2 -2
  84. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  85. package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
  86. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +11 -9
  87. package/sdk/application/Webhook/WebhookApplicationModel.js +8 -6
  88. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
  89. package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
  90. package/sdk/application/index.d.ts +1 -0
  91. package/sdk/application/index.js +2 -0
  92. package/sdk/common/Clickstream.js +12 -0
  93. package/sdk/common/Constant.d.ts +5 -0
  94. package/sdk/common/Constant.js +5 -0
  95. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  96. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  97. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  98. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  99. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  100. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  101. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  102. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  103. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  104. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  105. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
  106. package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
  107. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +767 -85
  108. package/sdk/partner/Logistics/LogisticsPartnerModel.js +429 -76
  109. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
  110. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +120 -6
  111. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  112. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  113. package/sdk/partner/Theme/ThemePartnerModel.d.ts +99 -39
  114. package/sdk/partner/Theme/ThemePartnerModel.js +95 -38
  115. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  116. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  117. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  118. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  119. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  120. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  121. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  122. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  123. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  124. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  125. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  126. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  127. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  128. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  129. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  130. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  131. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  132. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  133. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  134. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  135. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  136. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  137. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  138. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  139. package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
  140. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
  141. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
  142. package/sdk/platform/Cart/CartPlatformModel.d.ts +4978 -1303
  143. package/sdk/platform/Cart/CartPlatformModel.js +1922 -1217
  144. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +192 -164
  145. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +371 -343
  146. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +99 -99
  147. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +54 -54
  148. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +139 -116
  149. package/sdk/platform/Catalog/CatalogPlatformClient.js +191 -168
  150. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1374 -749
  151. package/sdk/platform/Catalog/CatalogPlatformModel.js +1241 -830
  152. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
  153. package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
  154. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  155. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  156. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  157. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  158. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  159. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  160. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  161. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  162. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  163. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  168. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  169. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  172. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  173. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  174. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  175. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  176. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  177. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  178. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  179. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  180. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
  181. package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
  182. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
  183. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
  184. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  185. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  186. package/sdk/platform/Content/ContentPlatformModel.d.ts +1244 -397
  187. package/sdk/platform/Content/ContentPlatformModel.js +526 -392
  188. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  189. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  190. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  191. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  192. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  193. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  194. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  195. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  196. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  197. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  198. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  199. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  200. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  201. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  202. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  203. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  204. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  205. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  206. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  207. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  208. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  209. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  210. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +15 -4
  211. package/sdk/platform/Order/OrderPlatformApplicationClient.js +83 -5
  212. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +25 -4
  213. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  214. package/sdk/platform/Order/OrderPlatformClient.d.ts +138 -101
  215. package/sdk/platform/Order/OrderPlatformClient.js +267 -203
  216. package/sdk/platform/Order/OrderPlatformModel.d.ts +4497 -877
  217. package/sdk/platform/Order/OrderPlatformModel.js +2336 -812
  218. package/sdk/platform/Order/OrderPlatformValidator.d.ts +147 -50
  219. package/sdk/platform/Order/OrderPlatformValidator.js +75 -46
  220. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  221. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  222. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  223. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  224. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  225. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  226. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  227. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  228. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  229. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  230. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +327 -313
  231. package/sdk/platform/Payment/PaymentPlatformModel.js +283 -273
  232. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  233. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  234. package/sdk/platform/PlatformClient.d.ts +0 -2
  235. package/sdk/platform/PlatformClient.js +0 -4
  236. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  237. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  238. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  239. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  240. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  241. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  242. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +45 -35
  243. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +117 -38
  244. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +22 -13
  245. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +24 -12
  246. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
  247. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
  248. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +602 -341
  249. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +483 -284
  250. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
  251. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
  252. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  253. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  254. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  255. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  256. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  257. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  258. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  259. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  260. package/sdk/platform/Theme/ThemePlatformModel.d.ts +40 -13
  261. package/sdk/platform/Theme/ThemePlatformModel.js +38 -17
  262. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  263. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  264. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  265. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  266. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  267. package/sdk/platform/User/UserPlatformModel.js +23 -23
  268. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  269. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  270. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  271. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  272. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  273. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  274. package/sdk/platform/index.d.ts +0 -1
  275. package/sdk/platform/index.js +0 -2
  276. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  277. package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
  278. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  279. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  280. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  281. package/sdk/public/Content/ContentPublicClient.js +791 -5
  282. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  283. package/sdk/public/Content/ContentPublicModel.js +649 -3
  284. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  285. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  286. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  287. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  288. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  289. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  290. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  291. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  292. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  293. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  294. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  295. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  296. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  297. 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]
@@ -390,7 +395,7 @@ export = ContentPlatformModel;
390
395
  * @property {DataLoaderSchema[]} [items]
391
396
  */
392
397
  /**
393
- * @typedef TagDeleteSuccessResponse
398
+ * @typedef TagDeleteSuccessDetails
394
399
  * @property {boolean} [success]
395
400
  */
396
401
  /**
@@ -503,7 +508,7 @@ export = ContentPlatformModel;
503
508
  * @property {number} [size] - The number of items per page.
504
509
  */
505
510
  /**
506
- * @typedef LandingPageGetResponse
511
+ * @typedef LandingPageGetDetails
507
512
  * @property {LandingPageSchema[]} [items]
508
513
  * @property {Page} [page]
509
514
  */
@@ -520,11 +525,11 @@ export = ContentPlatformModel;
520
525
  * @property {Object} [_custom_json]
521
526
  */
522
527
  /**
523
- * @typedef DefaultNavigationResponse
528
+ * @typedef DefaultNavigationDetails
524
529
  * @property {NavigationSchema[]} [items]
525
530
  */
526
531
  /**
527
- * @typedef NavigationGetResponse
532
+ * @typedef NavigationGetDetails
528
533
  * @property {NavigationSchema[]} [items]
529
534
  * @property {Page} [page]
530
535
  */
@@ -548,7 +553,7 @@ export = ContentPlatformModel;
548
553
  * @property {NavigationReference[]} [navigation]
549
554
  */
550
555
  /**
551
- * @typedef NavigationRequest
556
+ * @typedef NavigationPayload
552
557
  * @property {string} [name]
553
558
  * @property {string} [slug]
554
559
  * @property {string[]} [platform]
@@ -556,7 +561,7 @@ export = ContentPlatformModel;
556
561
  * @property {NavigationReference[]} [navigation]
557
562
  */
558
563
  /**
559
- * @typedef PageGetResponse
564
+ * @typedef PageGetDetails
560
565
  * @property {PageSchema[]} [items]
561
566
  * @property {Page} [page]
562
567
  */
@@ -607,7 +612,7 @@ export = ContentPlatformModel;
607
612
  * @property {string} [id]
608
613
  */
609
614
  /**
610
- * @typedef PageRequest
615
+ * @typedef PagePayload
611
616
  * @property {CronSchedule} [_schedule]
612
617
  * @property {string} [application]
613
618
  * @property {Author} [author]
@@ -630,7 +635,7 @@ export = ContentPlatformModel;
630
635
  * @property {number} [duration]
631
636
  */
632
637
  /**
633
- * @typedef PagePublishRequest
638
+ * @typedef PagePublishPayload
634
639
  * @property {boolean} [publish]
635
640
  */
636
641
  /**
@@ -640,7 +645,7 @@ export = ContentPlatformModel;
640
645
  * @property {string} [application_id]
641
646
  */
642
647
  /**
643
- * @typedef SlideshowGetResponse
648
+ * @typedef SlideshowGetDetails
644
649
  * @property {SlideshowSchema[]} [items]
645
650
  * @property {Page} [page]
646
651
  */
@@ -658,7 +663,7 @@ export = ContentPlatformModel;
658
663
  * @property {Object} [_custom_json]
659
664
  */
660
665
  /**
661
- * @typedef SlideshowRequest
666
+ * @typedef SlideshowPayload
662
667
  * @property {string} [slug]
663
668
  * @property {string} [platform]
664
669
  * @property {ConfigurationSchema} [configuration]
@@ -737,93 +742,108 @@ export = ContentPlatformModel;
737
742
  */
738
743
  /**
739
744
  * @typedef FieldValidations
740
- * @property {string} [name]
741
- * @property {string} [type]
745
+ * @property {string} [name] - Name of validation
746
+ * @property {string} [type] - Type of validation
742
747
  * @property {Object} [value]
743
748
  */
744
749
  /**
745
750
  * @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]
751
+ * @property {string} [id] - Unique system generated id
752
+ * @property {string} [resource] - Resource type to which custom field belongs
753
+ * @property {string} [name] - Name of custom field
754
+ * @property {string} [namespace] - Namespace of custom field
755
+ * @property {string} [slug] - Slug of custom field
756
+ * @property {string} [description] - Description of custom field definition
757
+ * @property {string} [type] - Data type of custom field
758
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
759
+ * multivalued or not
760
+ * @property {FieldValidations[]} [validations] - List of validations applied
761
+ * @property {string} [company_id] - Id of company
762
+ * @property {boolean} [required] - Whether the custom field is required or not
763
+ * @property {boolean} [is_deleted] - Whether the custom field is deleted or not
764
+ * @property {string} [type_name] - Type of type field
765
+ * @property {number} [invalid_fields_count] - Count of invalid fields after validation
765
766
  */
766
767
  /**
767
768
  * @typedef CustomFieldDefinitionsSchema
768
- * @property {FieldDefinitionSchema[]} [items]
769
+ * @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
769
770
  * @property {Page} [page]
770
771
  */
771
772
  /**
772
773
  * @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]
774
+ * @property {string} [type] - Data type of custom field
775
+ * @property {string} [slug] - Slug of custom field definition
776
+ * @property {string} [namespace] - Namespace of custom field definition
777
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
778
+ * multi valued or not
779
+ * @property {string} [name] - Name of custom field definition
780
+ * @property {string} [description] - Description of a custom field definition
781
+ * @property {FieldValidations[]} [validations] - Validations for a custom field
781
782
  */
782
783
  /**
783
784
  * @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]
785
+ * @property {string} [id] - Unique identifer for a custom field
786
+ * @property {string} [type] - Data type of custom field
787
+ * @property {string} [description] - Description of custom field
788
+ * @property {string} [name] - Name of custom field
789
+ * @property {boolean} [multi_value] - Flag to denote if cusom field is multi
790
+ * valued or not
791
+ * @property {boolean} [required] - Whether the field is required or not
792
+ * @property {string} [slug] - Slug of custom field definition
793
+ * @property {FieldValidations[]} [validations] - Validations added against the
794
+ * custom field
792
795
  * @property {string} [action]
793
796
  */
794
797
  /**
795
798
  * @typedef CustomObjectDefinitionUpdateRequestSchema
796
- * @property {string} [type]
797
- * @property {string} [description]
798
- * @property {string} [name]
799
- * @property {string} [display_name_key]
799
+ * @property {string} [description] - Description of custom object definiton
800
+ * @property {string} [name] - Name of custom object definition
801
+ * @property {string} [display_name_key] - Custom field slug which is used as a
802
+ * display key in
800
803
  * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
801
804
  */
802
805
  /**
803
806
  * @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]
807
+ * @property {string} [resource] - Resource to which custom field is associated
808
+ * @property {string} [name] - Name of custom field
809
+ * @property {string} [namespace] - Namespace of custom field
810
+ * @property {string} [slug] - Slug of custom field
811
+ * @property {string} [description] - Description regarding custom field
812
+ * @property {string} [type] - Data type of custom field
813
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
814
+ * multi valued or not
815
+ * @property {string} [company_id] - Company Identifer
816
+ * @property {string} [application_id] - Sales channel identifier
817
+ * @property {boolean} [required] - Whether the customfield is required or not
818
+ * @property {boolean} [is_deleted] - Is custom field deleted
819
+ * @property {string} [id] - Unique system generated id
819
820
  * @property {Object[]} [validations]
820
- * @property {string} [created_at]
821
- * @property {string} [updated_at]
821
+ * @property {string} [created_at] - Date time at which field was created
822
+ * @property {string} [updated_at] - Date time at for a field's last modification
823
+ */
824
+ /**
825
+ * @typedef MetaFieldDefinitionDetailResSchema
826
+ * @property {string} [resource] - Resource to which meta field is associated
827
+ * @property {string} [name] - Name of meta field
828
+ * @property {string} [namespace] - Namespace of meta field
829
+ * @property {string} [slug] - Slug of meta field
830
+ * @property {string} [description] - Description regarding meta field
831
+ * @property {string} [type] - Data type of meta field
832
+ * @property {boolean} [multi_value] - Flag to denote whether meta field is
833
+ * multi valued or not
834
+ * @property {string} [company_id] - Company Identifer
835
+ * @property {string} [application_id] - Sales channel identifier
836
+ * @property {boolean} [required] - Whether the field is required or not
837
+ * @property {boolean} [is_deleted] - Is meta field deleted
838
+ * @property {string} [id] - Unique system generated id
839
+ * @property {Object[]} [validations]
840
+ * @property {string} [created_at] - Date time at which field was created
841
+ * @property {string} [updated_at] - Date time at for a field's last modification
822
842
  */
823
843
  /**
824
844
  * @typedef CustomDataDeleteSchema
825
- * @property {boolean} [success]
826
- * @property {string} [message]
845
+ * @property {boolean} [success] - Denotes the success of the delete operation
846
+ * @property {string} [message] - Denotes the message of delete operation
827
847
  */
828
848
  /**
829
849
  * @typedef CustomFieldValue
@@ -831,29 +851,31 @@ export = ContentPlatformModel;
831
851
  */
832
852
  /**
833
853
  * @typedef CustomFieldSchema
834
- * @property {string} [_id]
835
- * @property {string} [namespace]
836
- * @property {string} [key]
837
- * @property {string} [resource]
838
- * @property {string} [creator]
854
+ * @property {string} [id] - Unique system generated id
855
+ * @property {string} [namespace] - Namespace of custom field definition
856
+ * @property {string} [slug] - Slug of custom field definition
857
+ * @property {string} [resource] - The resource for which custom field is being created
839
858
  * @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]
859
+ * @property {string} [resource_slug] - Unique identifier of the resource
860
+ * @property {string} [type] - Data type of custom field
861
+ * @property {boolean} [multi_value] - Whether custom field is multi valued
862
+ * @property {string} [company_id] - Identifer for a company
845
863
  * @property {boolean} [has_invalid_values]
846
864
  * @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]
865
+ * @property {boolean} [is_deleted] - Indicates whether custom field is deleted
866
+ * @property {string} [created_at] - Time at which customer field was created
867
+ * @property {string} [updated_at] - Time at which custom field was updated
851
868
  */
852
869
  /**
853
870
  * @typedef CustomFieldsResponseSchema
854
871
  * @property {CustomFieldSchema[]} [items]
855
872
  * @property {Page} [page]
856
873
  */
874
+ /**
875
+ * @typedef CustomFieldsDeleteSchema
876
+ * @property {boolean} [success]
877
+ * @property {string} [message]
878
+ */
857
879
  /**
858
880
  * @typedef CustomFieldsResponseByResourceIdSchema
859
881
  * @property {CustomFieldSchema[]} [items]
@@ -861,7 +883,9 @@ export = ContentPlatformModel;
861
883
  /**
862
884
  * @typedef CustomField
863
885
  * @property {Object[]} [value]
864
- * @property {string} [definition_id]
886
+ * @property {string} [namespace] - This is the namespace to which custom field belongs
887
+ * @property {string} [slug] - This is the slug of custom field used while
888
+ * creating a custom field definition
865
889
  */
866
890
  /**
867
891
  * @typedef CustomFieldRequestSchema
@@ -869,146 +893,140 @@ export = ContentPlatformModel;
869
893
  */
870
894
  /**
871
895
  * @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]
896
+ * @property {string} [id] - Unique system generated id
897
+ * @property {string} [company_id] - Identifer for a company
898
+ * @property {string} [application_id] - Identifer for a sales channel
899
+ * @property {string} [status] - Status of custom object
900
+ * @property {string} [type] - Slug of custom object definition
901
+ * @property {string} [definition_slug] - Slug for custom object definition
902
+ * @property {string} [display_name] - Value of custom field used for displaying
903
+ * custom object
904
+ * @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
883
905
  */
884
906
  /**
885
907
  * @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]
908
+ * @property {string} [type] - Namespace/Slug of Custom object definition
909
+ * @property {string} [definition_slug] - Unique slug for a custom object definition
910
+ * @property {string} [description] - Description of custom object definition
911
+ * @property {string} [name] - Name of custom object
912
+ * @property {string} [display_name_key] - Denotes which custom field to be used
913
+ * for displaying custom object
914
+ * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
915
+ * of custom field definitions belonging to this custom object definition
916
+ */
917
+ /**
918
+ * @typedef CustomObjectDefinitionSlugSchema
919
+ * @property {string} [id] - Unique system generated custom object definition id
920
+ * @property {string} [name] - Display name of custom object definition
921
+ * @property {string} [type] - Type of custom object definiton
922
+ * @property {string} [definition_slug] - Slug of custom object definiton
923
+ * @property {string} [display_name_key] - Display name of custom object definition
924
+ * @property {string} [description] - Description of custom object definition
925
+ * @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
926
+ * Custom fields inside custom objects
923
927
  */
924
928
  /**
925
929
  * @typedef CustomObjectDefinitionDeleteResponseSchema
926
- * @property {boolean} [success]
927
- * @property {string} [message]
930
+ * @property {boolean} [success] - Success status of delete custom object definition.
931
+ * @property {string} [message] - Response message when custom object definition
932
+ * is deleted.
928
933
  */
929
934
  /**
930
- * @typedef CustomObjectEntryBulkUploadResponse
931
- * @property {string} [url]
932
- * @property {number} [total_records]
935
+ * @typedef CustomObjectEntryBulkUploadDetails
936
+ * @property {string} [url] - Signed url of csv
937
+ * @property {number} [total_records] - Total no of records in csv file
933
938
  */
934
939
  /**
935
- * @typedef CustomObjectListItemDefinationSchema
936
- * @property {string} [_id]
937
- * @property {string} [name]
938
- * @property {string} [type]
940
+ * @typedef CustomObjectListItemDefinitionModel
941
+ * @property {string} [id] - Unique system generated id
942
+ * @property {string} [name] - Name of custom object
943
+ * @property {string} [type] - Type of custom object entry
939
944
  */
940
945
  /**
941
946
  * @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]
947
+ * @property {string} [id] - Unique system generated id
948
+ * @property {string} [status] - Status of custom object
949
+ * @property {string} [created_at] - Creation time of custom object document
950
+ * @property {string} [updated_at] - Updation time of custom object document
951
+ * @property {string} [display_name] - Display name of custom object
952
+ * @property {CustomObjectListItemDefinitionModel} [definition]
953
+ * @property {number} [references] - References of the custom object entry
949
954
  */
950
955
  /**
951
956
  * @typedef CustomObjectsSchema
952
- * @property {CustomObjectListItemSchema[]} [items]
957
+ * @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
958
+ * object entries
953
959
  * @property {Page} [page]
954
960
  */
955
961
  /**
956
- * @typedef CustomObjectFieldSchema
957
- * @property {string} [_id]
958
- * @property {string} [key]
959
- * @property {Object[]} [value]
960
- * @property {string} [type]
961
- * @property {string} [definition_id]
962
+ * @typedef CustomObjectFieldDefinition
963
+ * @property {string} [id] - Unique system generate id
964
+ * @property {string} [slug] - Slug of custom field definition
965
+ * @property {string} [namespace] - Namespace of custom field definition
966
+ * @property {Object[]} [value] - Value of custom field
967
+ * @property {string} [type] - Data type of the custom field
962
968
  */
963
969
  /**
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]
970
+ * @typedef CustomObjectBySlugSchema
971
+ * @property {string} [id] - Unique system generated identifer for a Custom Object
972
+ * @property {string} [status] - Status of Custom Object
973
+ * @property {string} [display_name] - Display name for the Custom Object
974
+ * @property {CustomObjectListItemDefinitionModel} [definition]
975
+ * @property {Object[]} [references] - Places where the custom object has been
976
+ * used as a custom field
977
+ * @property {string} [slug] - Slug of custom object entry
978
+ * @property {string} [definition_slug] - Slug of custom object definition
979
+ * @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
980
+ * inside the custom object
971
981
  */
972
982
  /**
973
983
  * @typedef CustomObjectBulkEntryInitiateDownload
974
- * @property {string} [message]
975
- * @property {string} [task_id]
984
+ * @property {string} [message] - Message for the user
985
+ * @property {string} [task_id] - Identifer for a task
976
986
  */
977
987
  /**
978
988
  * @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]
989
+ * @property {number} [mo_total_count] - Total number of entries in the bulk entry
990
+ * @property {number} [mo_success_count] - Number of entries which were successful
991
+ * @property {number} [mo_error_count] - Number of entries which were failed
992
+ * @property {string} [mo_defintion_type] - Type of object
993
+ */
994
+ /**
995
+ * @typedef JobSchema
996
+ * @property {string} [id] - Unique system generated id
997
+ * @property {string[]} [jobs] - List of total jobs
998
+ * @property {string[]} [finished_jobs] - List of finished jobs
999
+ * @property {string[]} [error_jobs] - List of jobs which resulted in an error
1000
+ * @property {string[]} [errors_occured] - List of errors occurred in the job
1001
+ * @property {string} [company_id] - Company Identifer
1002
+ * @property {string} [status] - Status of job
1003
+ * @property {string} [action_type] - Type of job
1004
+ * @property {string} [entity] - Entity against which job is running
1005
+ * @property {string} [error_url] - URL which contains the file with errors
1006
+ * @property {number} [finished_count] - Number of items successfully finished
1007
+ * @property {number} [error_count] - Number of items in error
1008
+ * @property {number} [success_count] - Number of successful items
1009
+ * @property {number} [total_jobs] - Total number of jobs
1010
+ * @property {CustomObjectMetaSchema} [meta]
1011
+ * @property {string} [created_by] - Source from where the bulk job is created
1012
+ * @property {string} [created_at] - Date/Time when the job was created
1013
+ * @property {string} [updated_at] - Date/Time when the job was updated
1014
+ * @property {string} [application_id] - Sales Channel Identifier
983
1015
  */
984
1016
  /**
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]
1017
+ * @typedef CustomFieldBulkEntry
1018
+ * @property {JobSchema[]} [items]
1019
+ * @property {Page} [page]
1006
1020
  */
1007
1021
  /**
1008
1022
  * @typedef CustomObjectBulkEntry
1009
- * @property {CustomObjectJobSchema[]} [items]
1023
+ * @property {JobSchema[]} [items]
1010
1024
  * @property {Page} [page]
1011
1025
  */
1026
+ /**
1027
+ * @typedef MetafieldTypesSchema
1028
+ * @property {CustomFieldTypeSchema} [metafield_types]
1029
+ */
1012
1030
  /**
1013
1031
  * @typedef CustomFieldTypeSchema
1014
1032
  * @property {StringSingleLine} [string_single_line]
@@ -1024,6 +1042,8 @@ export = ContentPlatformModel;
1024
1042
  * @property {Url} [url]
1025
1043
  * @property {Metaobject} [metaobject]
1026
1044
  * @property {Product} [product]
1045
+ * @property {HTML} [html]
1046
+ * @property {Duration} [duration]
1027
1047
  */
1028
1048
  /**
1029
1049
  * @typedef SupportedValidationsMetaExampleSchema
@@ -1042,117 +1062,149 @@ export = ContentPlatformModel;
1042
1062
  * @property {boolean} [required]
1043
1063
  * @property {SupportedValidationsMetaSchema} [meta]
1044
1064
  */
1065
+ /**
1066
+ * @typedef Duration
1067
+ * @property {string} [name] - Name data type of custom field
1068
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1069
+ * @property {string} [type] - Type of custom field
1070
+ * @property {string} [category] - Category of custom field
1071
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1072
+ * validations available for the field
1073
+ */
1074
+ /**
1075
+ * @typedef HTML
1076
+ * @property {string} [name] - Name data type of custom field
1077
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1078
+ * @property {string} [type] - Type of custom field
1079
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1080
+ * validations available for the field
1081
+ */
1045
1082
  /**
1046
1083
  * @typedef StringSingleLine
1047
- * @property {string} [name]
1048
- * @property {boolean} [list_enabled]
1049
- * @property {string} [category]
1050
- * @property {string} [type]
1051
- * @property {SupportedValidationsSchema[]} [supported_validations]
1084
+ * @property {string} [name] - Name data type of custom field
1085
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1086
+ * @property {string} [category] - Category of custom field
1087
+ * @property {string} [type] - Type of custom field
1088
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1089
+ * validations available for the field
1052
1090
  */
1053
1091
  /**
1054
1092
  * @typedef StringMultiLine
1055
- * @property {string} [name]
1056
- * @property {boolean} [list_enabled]
1057
- * @property {string} [category]
1058
- * @property {string} [type]
1059
- * @property {SupportedValidationsSchema[]} [supported_validations]
1093
+ * @property {string} [name] - Name data type of custom field
1094
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1095
+ * @property {string} [category] - Category of custom field
1096
+ * @property {string} [type] - Type of custom field
1097
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1098
+ * validations available for the field
1060
1099
  */
1061
1100
  /**
1062
1101
  * @typedef Dropdown
1063
- * @property {string} [name]
1064
- * @property {boolean} [list_enabled]
1065
- * @property {string} [category]
1066
- * @property {string} [type]
1067
- * @property {SupportedValidationsSchema[]} [supported_validations]
1102
+ * @property {string} [name] - Name data type of custom field
1103
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1104
+ * @property {string} [category] - Category of custom field
1105
+ * @property {string} [type] - Category of custom field
1106
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1107
+ * validations available for the field
1068
1108
  */
1069
1109
  /**
1070
1110
  * @typedef Integer
1071
- * @property {string} [name]
1072
- * @property {boolean} [list_enabled]
1073
- * @property {string} [type]
1074
- * @property {string} [category]
1075
- * @property {SupportedValidationsSchema[]} [supported_validations]
1111
+ * @property {string} [name] - Name data type of custom field
1112
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1113
+ * @property {string} [type] - Type of custom field
1114
+ * @property {string} [category] - Category of custom field
1115
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1116
+ * validations available for the field
1076
1117
  */
1077
1118
  /**
1078
1119
  * @typedef FloatType
1079
- * @property {string} [name]
1080
- * @property {boolean} [list_enabled]
1081
- * @property {string} [type]
1082
- * @property {string} [category]
1083
- * @property {SupportedValidationsSchema[]} [supported_validations]
1120
+ * @property {string} [name] - Name data type of custom field
1121
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1122
+ * @property {string} [type] - Type of custom field
1123
+ * @property {string} [category] - Category of custom field
1124
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1125
+ * validations available for the field
1084
1126
  */
1085
1127
  /**
1086
1128
  * @typedef BooleanType
1087
- * @property {string} [name]
1088
- * @property {string} [category]
1089
- * @property {boolean} [list_enabled]
1090
- * @property {string} [type]
1091
- * @property {SupportedValidationsSchema[]} [supported_validations]
1129
+ * @property {string} [name] - Name data type of custom field
1130
+ * @property {string} [category] - Category of custom field
1131
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1132
+ * @property {string} [type] - Category of custom field
1133
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1134
+ * validations available for the field
1092
1135
  */
1093
1136
  /**
1094
1137
  * @typedef Date
1095
- * @property {string} [name]
1096
- * @property {boolean} [list_enabled]
1097
- * @property {string} [category]
1098
- * @property {string} [type]
1099
- * @property {SupportedValidationsSchema[]} [supported_validations]
1138
+ * @property {string} [name] - Name data type of custom field
1139
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1140
+ * @property {string} [category] - Category of custom field
1141
+ * @property {string} [type] - Type of custom field
1142
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1143
+ * validations available for the field
1100
1144
  */
1101
1145
  /**
1102
1146
  * @typedef Datetime
1103
- * @property {string} [name]
1104
- * @property {string} [category]
1105
- * @property {boolean} [list_enabled]
1106
- * @property {string} [type]
1107
- * @property {SupportedValidationsSchema[]} [supported_validations]
1147
+ * @property {string} [name] - Name data type of custom field
1148
+ * @property {string} [category] - Category of custom field
1149
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1150
+ * @property {string} [type] - Type of custom field
1151
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1152
+ * validations available for the field
1108
1153
  */
1109
1154
  /**
1110
1155
  * @typedef Json
1111
- * @property {string} [name]
1112
- * @property {boolean} [list_enabled]
1113
- * @property {string} [category]
1114
- * @property {string} [type]
1115
- * @property {SupportedValidationsSchema[]} [supported_validations]
1156
+ * @property {string} [name] - Name data type of custom field
1157
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1158
+ * @property {string} [category] - Category of custom field
1159
+ * @property {string} [type] - Type of custom field
1160
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1161
+ * validations available for the field
1116
1162
  */
1117
1163
  /**
1118
1164
  * @typedef File
1119
- * @property {string} [name]
1120
- * @property {string} [category]
1121
- * @property {boolean} [list_enabled]
1122
- * @property {string} [type]
1165
+ * @property {string} [name] - Name data type of custom field
1166
+ * @property {string} [category] - Category of custom field
1167
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1168
+ * @property {string} [type] - Type of custom field
1123
1169
  * @property {SupportedValidationsSchema[]} [supported_validations]
1124
1170
  */
1125
1171
  /**
1126
1172
  * @typedef Url
1127
- * @property {string} [name]
1128
- * @property {boolean} [list_enabled]
1129
- * @property {string} [type]
1130
- * @property {SupportedValidationsSchema[]} [supported_validations]
1173
+ * @property {string} [name] - Name data type of custom field
1174
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1175
+ * @property {string} [type] - Type of custom field
1176
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1177
+ * validations available for the field
1131
1178
  */
1132
1179
  /**
1133
1180
  * @typedef Metaobject
1134
- * @property {string} [name]
1135
- * @property {boolean} [list_enabled]
1136
- * @property {string} [category]
1137
- * @property {string} [type]
1181
+ * @property {string} [name] - Name of Custom Object
1182
+ * @property {boolean} [list_enabled] - Whether the field is allowed to have
1183
+ * multiple list items
1184
+ * @property {string} [category] - Category of Custom Object Definition that
1185
+ * Custom Object belongs to
1186
+ * @property {string} [type] - Type of Custom Object Definition
1138
1187
  * @property {SupportedValidationsSchema[]} [supported_validations]
1139
1188
  */
1140
1189
  /**
1141
1190
  * @typedef Product
1142
- * @property {string} [name]
1143
- * @property {boolean} [list_enabled]
1144
- * @property {string} [category]
1145
- * @property {string} [type]
1191
+ * @property {string} [name] - Name of Product
1192
+ * @property {boolean} [list_enabled] - Whether the field is allowed to have
1193
+ * multiple list items
1194
+ * @property {string} [category] - Category of Custom Object Definition that
1195
+ * Product is associated with
1196
+ * @property {string} [type] - Custom Object Definition that Product is associated with
1146
1197
  * @property {SupportedValidationsSchema[]} [supported_validations]
1147
1198
  */
1148
1199
  /**
1149
1200
  * @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]
1201
+ * @property {string} [id] - Unique system generated id
1202
+ * @property {string} [name] - Name of Custom Object definition
1203
+ * @property {string} [type] - Type of Custom Object Definition
1204
+ * @property {string} [updated_at] - Updation time of a Custom Object
1205
+ * @property {number} [entries_count] - Number of entries against the Custom
1206
+ * Object definition
1207
+ * @property {number} [fields_count] - Number of fields against a Custom Object definition
1156
1208
  */
1157
1209
  /**
1158
1210
  * @typedef CustomObjectDefinitionsSchema
@@ -1161,19 +1213,29 @@ export = ContentPlatformModel;
1161
1213
  */
1162
1214
  /**
1163
1215
  * @typedef CustomObjectEntryFieldSchema
1164
- * @property {string} [definition_id]
1165
- * @property {Object[]} [value]
1216
+ * @property {string} [namespace] - This is namespace for a custom field definition
1217
+ * @property {string} [slug] - This is slug for a custom field definition
1218
+ */
1219
+ /**
1220
+ * @typedef CustomObjectEntryFieldSchemaWithoutID
1221
+ * @property {string} [slug] - Custom fields belonging to a custom object
1222
+ * @property {Object} [value] - Value of custom field inside a custom object
1166
1223
  */
1167
1224
  /**
1168
1225
  * @typedef CustomObjectRequestSchema
1169
- * @property {string} [status]
1170
- * @property {string} [definition_id]
1171
- * @property {CustomObjectEntryFieldSchema[]} [fields]
1226
+ * @property {string} [status] - Flag to denote status of Custom Object
1227
+ * @property {string} [slug] - This is slug for a custom field definition
1228
+ * @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
1229
+ */
1230
+ /**
1231
+ * @typedef CustomObjectRequestSchemaWithoutId
1232
+ * @property {string} [status] - Status of the custom object entry.
1233
+ * @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
1172
1234
  */
1173
1235
  /**
1174
1236
  * @typedef CustomObjectBulkSchema
1175
- * @property {string} [url]
1176
- * @property {number} [total_records]
1237
+ * @property {string} [url] - Full URL for the bulk operations data
1238
+ * @property {number} [total_records] - Total records in the upload.
1177
1239
  */
1178
1240
  /**
1179
1241
  * @typedef ActionPage
@@ -1230,13 +1292,26 @@ export = ContentPlatformModel;
1230
1292
  * | "register"
1231
1293
  * | "shipping-policy"
1232
1294
  * | "return-policy"
1233
- * | "order-status"} PageType
1295
+ * | "order-status"
1296
+ * | "locate-us"} PageType
1234
1297
  */
1235
1298
  declare class ContentPlatformModel {
1236
1299
  }
1237
1300
  declare namespace ContentPlatformModel {
1238
- 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 };
1301
+ 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, ConfigurationSchema, SlideshowMedia, 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, SlideshowGetDetails, SlideshowSchema, SlideshowPayload, 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 };
1239
1302
  }
1303
+ /** @returns {ValidationError} */
1304
+ declare function ValidationError(): ValidationError;
1305
+ type ValidationError = {
1306
+ /**
1307
+ * - A brief description of the error encountered.
1308
+ */
1309
+ message: string;
1310
+ /**
1311
+ * - The field in the request that caused the error.
1312
+ */
1313
+ field: string;
1314
+ };
1240
1315
  /** @returns {GenerateSEOContent} */
1241
1316
  declare function GenerateSEOContent(): GenerateSEOContent;
1242
1317
  type GenerateSEOContent = {
@@ -1414,9 +1489,9 @@ type NextSchedule = {
1414
1489
  start?: string;
1415
1490
  end?: string;
1416
1491
  };
1417
- /** @returns {BlogGetResponse} */
1418
- declare function BlogGetResponse(): BlogGetResponse;
1419
- type BlogGetResponse = {
1492
+ /** @returns {BlogGetDetails} */
1493
+ declare function BlogGetDetails(): BlogGetDetails;
1494
+ type BlogGetDetails = {
1420
1495
  items?: BlogSchema[];
1421
1496
  page?: Page;
1422
1497
  filters?: BlogFilters;
@@ -1512,9 +1587,9 @@ type DateMeta = {
1512
1587
  created_on?: string;
1513
1588
  modified_on?: string;
1514
1589
  };
1515
- /** @returns {BlogRequest} */
1516
- declare function BlogRequest(): BlogRequest;
1517
- type BlogRequest = {
1590
+ /** @returns {BlogPayload} */
1591
+ declare function BlogPayload(): BlogPayload;
1592
+ type BlogPayload = {
1518
1593
  application?: string;
1519
1594
  _custom_json?: any;
1520
1595
  author?: Author;
@@ -1684,9 +1759,9 @@ declare function DataLoadersSchema(): DataLoadersSchema;
1684
1759
  type DataLoadersSchema = {
1685
1760
  items?: DataLoaderSchema[];
1686
1761
  };
1687
- /** @returns {TagDeleteSuccessResponse} */
1688
- declare function TagDeleteSuccessResponse(): TagDeleteSuccessResponse;
1689
- type TagDeleteSuccessResponse = {
1762
+ /** @returns {TagDeleteSuccessDetails} */
1763
+ declare function TagDeleteSuccessDetails(): TagDeleteSuccessDetails;
1764
+ type TagDeleteSuccessDetails = {
1690
1765
  success?: boolean;
1691
1766
  };
1692
1767
  /** @returns {ContentAPIError} */
@@ -1836,9 +1911,9 @@ type Page = {
1836
1911
  */
1837
1912
  size?: number;
1838
1913
  };
1839
- /** @returns {LandingPageGetResponse} */
1840
- declare function LandingPageGetResponse(): LandingPageGetResponse;
1841
- type LandingPageGetResponse = {
1914
+ /** @returns {LandingPageGetDetails} */
1915
+ declare function LandingPageGetDetails(): LandingPageGetDetails;
1916
+ type LandingPageGetDetails = {
1842
1917
  items?: LandingPageSchema[];
1843
1918
  page?: Page;
1844
1919
  };
@@ -1855,14 +1930,14 @@ type LandingPageSchema = {
1855
1930
  archived?: boolean;
1856
1931
  _custom_json?: any;
1857
1932
  };
1858
- /** @returns {DefaultNavigationResponse} */
1859
- declare function DefaultNavigationResponse(): DefaultNavigationResponse;
1860
- type DefaultNavigationResponse = {
1933
+ /** @returns {DefaultNavigationDetails} */
1934
+ declare function DefaultNavigationDetails(): DefaultNavigationDetails;
1935
+ type DefaultNavigationDetails = {
1861
1936
  items?: NavigationSchema[];
1862
1937
  };
1863
- /** @returns {NavigationGetResponse} */
1864
- declare function NavigationGetResponse(): NavigationGetResponse;
1865
- type NavigationGetResponse = {
1938
+ /** @returns {NavigationGetDetails} */
1939
+ declare function NavigationGetDetails(): NavigationGetDetails;
1940
+ type NavigationGetDetails = {
1866
1941
  items?: NavigationSchema[];
1867
1942
  page?: Page;
1868
1943
  };
@@ -1887,18 +1962,18 @@ type NavigationSchema = {
1887
1962
  version?: number;
1888
1963
  navigation?: NavigationReference[];
1889
1964
  };
1890
- /** @returns {NavigationRequest} */
1891
- declare function NavigationRequest(): NavigationRequest;
1892
- type NavigationRequest = {
1965
+ /** @returns {NavigationPayload} */
1966
+ declare function NavigationPayload(): NavigationPayload;
1967
+ type NavigationPayload = {
1893
1968
  name?: string;
1894
1969
  slug?: string;
1895
1970
  platform?: string[];
1896
1971
  orientation?: Orientation;
1897
1972
  navigation?: NavigationReference[];
1898
1973
  };
1899
- /** @returns {PageGetResponse} */
1900
- declare function PageGetResponse(): PageGetResponse;
1901
- type PageGetResponse = {
1974
+ /** @returns {PageGetDetails} */
1975
+ declare function PageGetDetails(): PageGetDetails;
1976
+ type PageGetDetails = {
1902
1977
  items?: PageSchema[];
1903
1978
  page?: Page;
1904
1979
  };
@@ -1956,9 +2031,9 @@ declare function CreatedBySchema(): CreatedBySchema;
1956
2031
  type CreatedBySchema = {
1957
2032
  id?: string;
1958
2033
  };
1959
- /** @returns {PageRequest} */
1960
- declare function PageRequest(): PageRequest;
1961
- type PageRequest = {
2034
+ /** @returns {PagePayload} */
2035
+ declare function PagePayload(): PagePayload;
2036
+ type PagePayload = {
1962
2037
  _schedule?: CronSchedule;
1963
2038
  application?: string;
1964
2039
  author?: Author;
@@ -1981,9 +2056,9 @@ type CronSchedule = {
1981
2056
  end?: string;
1982
2057
  duration?: number;
1983
2058
  };
1984
- /** @returns {PagePublishRequest} */
1985
- declare function PagePublishRequest(): PagePublishRequest;
1986
- type PagePublishRequest = {
2059
+ /** @returns {PagePublishPayload} */
2060
+ declare function PagePublishPayload(): PagePublishPayload;
2061
+ type PagePublishPayload = {
1987
2062
  publish?: boolean;
1988
2063
  };
1989
2064
  /** @returns {PageMetaSchema} */
@@ -1993,9 +2068,9 @@ type PageMetaSchema = {
1993
2068
  custom_pages?: PageSchema[];
1994
2069
  application_id?: string;
1995
2070
  };
1996
- /** @returns {SlideshowGetResponse} */
1997
- declare function SlideshowGetResponse(): SlideshowGetResponse;
1998
- type SlideshowGetResponse = {
2071
+ /** @returns {SlideshowGetDetails} */
2072
+ declare function SlideshowGetDetails(): SlideshowGetDetails;
2073
+ type SlideshowGetDetails = {
1999
2074
  items?: SlideshowSchema[];
2000
2075
  page?: Page;
2001
2076
  };
@@ -2013,9 +2088,9 @@ type SlideshowSchema = {
2013
2088
  archived?: boolean;
2014
2089
  _custom_json?: any;
2015
2090
  };
2016
- /** @returns {SlideshowRequest} */
2017
- declare function SlideshowRequest(): SlideshowRequest;
2018
- type SlideshowRequest = {
2091
+ /** @returns {SlideshowPayload} */
2092
+ declare function SlideshowPayload(): SlideshowPayload;
2093
+ type SlideshowPayload = {
2019
2094
  slug?: string;
2020
2095
  platform?: string;
2021
2096
  configuration?: ConfigurationSchema;
@@ -2115,99 +2190,310 @@ type ResourceSchema = {
2115
2190
  /** @returns {FieldValidations} */
2116
2191
  declare function FieldValidations(): FieldValidations;
2117
2192
  type FieldValidations = {
2193
+ /**
2194
+ * - Name of validation
2195
+ */
2118
2196
  name?: string;
2197
+ /**
2198
+ * - Type of validation
2199
+ */
2119
2200
  type?: string;
2120
2201
  value?: any;
2121
2202
  };
2122
2203
  /** @returns {FieldDefinitionSchema} */
2123
2204
  declare function FieldDefinitionSchema(): FieldDefinitionSchema;
2124
2205
  type FieldDefinitionSchema = {
2125
- _id?: string;
2126
- creator?: string;
2206
+ /**
2207
+ * - Unique system generated id
2208
+ */
2209
+ id?: string;
2210
+ /**
2211
+ * - Resource type to which custom field belongs
2212
+ */
2127
2213
  resource?: string;
2214
+ /**
2215
+ * - Name of custom field
2216
+ */
2128
2217
  name?: string;
2218
+ /**
2219
+ * - Namespace of custom field
2220
+ */
2129
2221
  namespace?: string;
2130
- key?: string;
2222
+ /**
2223
+ * - Slug of custom field
2224
+ */
2225
+ slug?: string;
2226
+ /**
2227
+ * - Description of custom field definition
2228
+ */
2131
2229
  description?: string;
2230
+ /**
2231
+ * - Data type of custom field
2232
+ */
2132
2233
  type?: string;
2234
+ /**
2235
+ * - Flag to denote whether custom field is
2236
+ * multivalued or not
2237
+ */
2133
2238
  multi_value?: boolean;
2239
+ /**
2240
+ * - List of validations applied
2241
+ */
2134
2242
  validations?: FieldValidations[];
2243
+ /**
2244
+ * - Id of company
2245
+ */
2135
2246
  company_id?: string;
2136
- created_by?: string;
2137
- updated_by?: string;
2247
+ /**
2248
+ * - Whether the custom field is required or not
2249
+ */
2138
2250
  required?: boolean;
2251
+ /**
2252
+ * - Whether the custom field is deleted or not
2253
+ */
2139
2254
  is_deleted?: boolean;
2140
- created_at?: string;
2141
- updated_at?: string;
2255
+ /**
2256
+ * - Type of type field
2257
+ */
2142
2258
  type_name?: string;
2259
+ /**
2260
+ * - Count of invalid fields after validation
2261
+ */
2143
2262
  invalid_fields_count?: number;
2144
2263
  };
2145
2264
  /** @returns {CustomFieldDefinitionsSchema} */
2146
2265
  declare function CustomFieldDefinitionsSchema(): CustomFieldDefinitionsSchema;
2147
2266
  type CustomFieldDefinitionsSchema = {
2267
+ /**
2268
+ * - List of custom field definitions
2269
+ */
2148
2270
  items?: FieldDefinitionSchema[];
2149
2271
  page?: Page;
2150
2272
  };
2151
2273
  /** @returns {CustomFieldDefinitionRequestSchema} */
2152
2274
  declare function CustomFieldDefinitionRequestSchema(): CustomFieldDefinitionRequestSchema;
2153
2275
  type CustomFieldDefinitionRequestSchema = {
2154
- resource?: string;
2276
+ /**
2277
+ * - Data type of custom field
2278
+ */
2155
2279
  type?: string;
2156
- key?: string;
2280
+ /**
2281
+ * - Slug of custom field definition
2282
+ */
2283
+ slug?: string;
2284
+ /**
2285
+ * - Namespace of custom field definition
2286
+ */
2157
2287
  namespace?: string;
2288
+ /**
2289
+ * - Flag to denote whether custom field is
2290
+ * multi valued or not
2291
+ */
2158
2292
  multi_value?: boolean;
2293
+ /**
2294
+ * - Name of custom field definition
2295
+ */
2159
2296
  name?: string;
2297
+ /**
2298
+ * - Description of a custom field definition
2299
+ */
2160
2300
  description?: string;
2301
+ /**
2302
+ * - Validations for a custom field
2303
+ */
2161
2304
  validations?: FieldValidations[];
2162
2305
  };
2163
2306
  /** @returns {CustomObjectCustomFieldDefinitions} */
2164
2307
  declare function CustomObjectCustomFieldDefinitions(): CustomObjectCustomFieldDefinitions;
2165
2308
  type CustomObjectCustomFieldDefinitions = {
2309
+ /**
2310
+ * - Unique identifer for a custom field
2311
+ */
2166
2312
  id?: string;
2313
+ /**
2314
+ * - Data type of custom field
2315
+ */
2167
2316
  type?: string;
2317
+ /**
2318
+ * - Description of custom field
2319
+ */
2168
2320
  description?: string;
2321
+ /**
2322
+ * - Name of custom field
2323
+ */
2169
2324
  name?: string;
2325
+ /**
2326
+ * - Flag to denote if cusom field is multi
2327
+ * valued or not
2328
+ */
2170
2329
  multi_value?: boolean;
2330
+ /**
2331
+ * - Whether the field is required or not
2332
+ */
2171
2333
  required?: boolean;
2172
- key?: string;
2334
+ /**
2335
+ * - Slug of custom field definition
2336
+ */
2337
+ slug?: string;
2338
+ /**
2339
+ * - Validations added against the
2340
+ * custom field
2341
+ */
2173
2342
  validations?: FieldValidations[];
2174
2343
  action?: string;
2175
2344
  };
2176
2345
  /** @returns {CustomObjectDefinitionUpdateRequestSchema} */
2177
2346
  declare function CustomObjectDefinitionUpdateRequestSchema(): CustomObjectDefinitionUpdateRequestSchema;
2178
2347
  type CustomObjectDefinitionUpdateRequestSchema = {
2179
- type?: string;
2348
+ /**
2349
+ * - Description of custom object definiton
2350
+ */
2180
2351
  description?: string;
2352
+ /**
2353
+ * - Name of custom object definition
2354
+ */
2181
2355
  name?: string;
2356
+ /**
2357
+ * - Custom field slug which is used as a
2358
+ * display key in
2359
+ */
2182
2360
  display_name_key?: string;
2183
2361
  field_definitions?: CustomObjectCustomFieldDefinitions[];
2184
2362
  };
2185
2363
  /** @returns {CustomFieldDefinitionDetailResSchema} */
2186
2364
  declare function CustomFieldDefinitionDetailResSchema(): CustomFieldDefinitionDetailResSchema;
2187
2365
  type CustomFieldDefinitionDetailResSchema = {
2188
- creator?: string;
2366
+ /**
2367
+ * - Resource to which custom field is associated
2368
+ */
2189
2369
  resource?: string;
2370
+ /**
2371
+ * - Name of custom field
2372
+ */
2190
2373
  name?: string;
2374
+ /**
2375
+ * - Namespace of custom field
2376
+ */
2191
2377
  namespace?: string;
2192
- key?: string;
2378
+ /**
2379
+ * - Slug of custom field
2380
+ */
2381
+ slug?: string;
2382
+ /**
2383
+ * - Description regarding custom field
2384
+ */
2193
2385
  description?: string;
2386
+ /**
2387
+ * - Data type of custom field
2388
+ */
2194
2389
  type?: string;
2390
+ /**
2391
+ * - Flag to denote whether custom field is
2392
+ * multi valued or not
2393
+ */
2195
2394
  multi_value?: boolean;
2395
+ /**
2396
+ * - Company Identifer
2397
+ */
2196
2398
  company_id?: string;
2399
+ /**
2400
+ * - Sales channel identifier
2401
+ */
2197
2402
  application_id?: string;
2198
- created_by?: string;
2199
- updated_by?: string;
2403
+ /**
2404
+ * - Whether the customfield is required or not
2405
+ */
2200
2406
  required?: boolean;
2407
+ /**
2408
+ * - Is custom field deleted
2409
+ */
2201
2410
  is_deleted?: boolean;
2202
- _id?: string;
2411
+ /**
2412
+ * - Unique system generated id
2413
+ */
2414
+ id?: string;
2203
2415
  validations?: any[];
2416
+ /**
2417
+ * - Date time at which field was created
2418
+ */
2204
2419
  created_at?: string;
2420
+ /**
2421
+ * - Date time at for a field's last modification
2422
+ */
2423
+ updated_at?: string;
2424
+ };
2425
+ /** @returns {MetaFieldDefinitionDetailResSchema} */
2426
+ declare function MetaFieldDefinitionDetailResSchema(): MetaFieldDefinitionDetailResSchema;
2427
+ type MetaFieldDefinitionDetailResSchema = {
2428
+ /**
2429
+ * - Resource to which meta field is associated
2430
+ */
2431
+ resource?: string;
2432
+ /**
2433
+ * - Name of meta field
2434
+ */
2435
+ name?: string;
2436
+ /**
2437
+ * - Namespace of meta field
2438
+ */
2439
+ namespace?: string;
2440
+ /**
2441
+ * - Slug of meta field
2442
+ */
2443
+ slug?: string;
2444
+ /**
2445
+ * - Description regarding meta field
2446
+ */
2447
+ description?: string;
2448
+ /**
2449
+ * - Data type of meta field
2450
+ */
2451
+ type?: string;
2452
+ /**
2453
+ * - Flag to denote whether meta field is
2454
+ * multi valued or not
2455
+ */
2456
+ multi_value?: boolean;
2457
+ /**
2458
+ * - Company Identifer
2459
+ */
2460
+ company_id?: string;
2461
+ /**
2462
+ * - Sales channel identifier
2463
+ */
2464
+ application_id?: string;
2465
+ /**
2466
+ * - Whether the field is required or not
2467
+ */
2468
+ required?: boolean;
2469
+ /**
2470
+ * - Is meta field deleted
2471
+ */
2472
+ is_deleted?: boolean;
2473
+ /**
2474
+ * - Unique system generated id
2475
+ */
2476
+ id?: string;
2477
+ validations?: any[];
2478
+ /**
2479
+ * - Date time at which field was created
2480
+ */
2481
+ created_at?: string;
2482
+ /**
2483
+ * - Date time at for a field's last modification
2484
+ */
2205
2485
  updated_at?: string;
2206
2486
  };
2207
2487
  /** @returns {CustomDataDeleteSchema} */
2208
2488
  declare function CustomDataDeleteSchema(): CustomDataDeleteSchema;
2209
2489
  type CustomDataDeleteSchema = {
2490
+ /**
2491
+ * - Denotes the success of the delete operation
2492
+ */
2210
2493
  success?: boolean;
2494
+ /**
2495
+ * - Denotes the message of delete operation
2496
+ */
2211
2497
  message?: string;
2212
2498
  };
2213
2499
  /** @returns {CustomFieldValue} */
@@ -2218,22 +2504,52 @@ type CustomFieldValue = {
2218
2504
  /** @returns {CustomFieldSchema} */
2219
2505
  declare function CustomFieldSchema(): CustomFieldSchema;
2220
2506
  type CustomFieldSchema = {
2221
- _id?: string;
2507
+ /**
2508
+ * - Unique system generated id
2509
+ */
2510
+ id?: string;
2511
+ /**
2512
+ * - Namespace of custom field definition
2513
+ */
2222
2514
  namespace?: string;
2223
- key?: string;
2515
+ /**
2516
+ * - Slug of custom field definition
2517
+ */
2518
+ slug?: string;
2519
+ /**
2520
+ * - The resource for which custom field is being created
2521
+ */
2224
2522
  resource?: string;
2225
- creator?: string;
2226
2523
  value?: CustomFieldValue[];
2227
- resource_id?: string;
2524
+ /**
2525
+ * - Unique identifier of the resource
2526
+ */
2527
+ resource_slug?: string;
2528
+ /**
2529
+ * - Data type of custom field
2530
+ */
2228
2531
  type?: string;
2532
+ /**
2533
+ * - Whether custom field is multi valued
2534
+ */
2229
2535
  multi_value?: boolean;
2536
+ /**
2537
+ * - Identifer for a company
2538
+ */
2230
2539
  company_id?: string;
2231
- definition_id?: string;
2232
2540
  has_invalid_values?: boolean;
2233
2541
  invalid_value_errors?: any[];
2234
- created_by?: string;
2542
+ /**
2543
+ * - Indicates whether custom field is deleted
2544
+ */
2235
2545
  is_deleted?: boolean;
2546
+ /**
2547
+ * - Time at which customer field was created
2548
+ */
2236
2549
  created_at?: string;
2550
+ /**
2551
+ * - Time at which custom field was updated
2552
+ */
2237
2553
  updated_at?: string;
2238
2554
  };
2239
2555
  /** @returns {CustomFieldsResponseSchema} */
@@ -2242,6 +2558,12 @@ type CustomFieldsResponseSchema = {
2242
2558
  items?: CustomFieldSchema[];
2243
2559
  page?: Page;
2244
2560
  };
2561
+ /** @returns {CustomFieldsDeleteSchema} */
2562
+ declare function CustomFieldsDeleteSchema(): CustomFieldsDeleteSchema;
2563
+ type CustomFieldsDeleteSchema = {
2564
+ success?: boolean;
2565
+ message?: string;
2566
+ };
2245
2567
  /** @returns {CustomFieldsResponseByResourceIdSchema} */
2246
2568
  declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseByResourceIdSchema;
2247
2569
  type CustomFieldsResponseByResourceIdSchema = {
@@ -2251,7 +2573,15 @@ type CustomFieldsResponseByResourceIdSchema = {
2251
2573
  declare function CustomField(): CustomField;
2252
2574
  type CustomField = {
2253
2575
  value?: any[];
2254
- definition_id?: string;
2576
+ /**
2577
+ * - This is the namespace to which custom field belongs
2578
+ */
2579
+ namespace?: string;
2580
+ /**
2581
+ * - This is the slug of custom field used while
2582
+ * creating a custom field definition
2583
+ */
2584
+ slug?: string;
2255
2585
  };
2256
2586
  /** @returns {CustomFieldRequestSchema} */
2257
2587
  declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
@@ -2261,160 +2591,368 @@ type CustomFieldRequestSchema = {
2261
2591
  /** @returns {CustomObjectSchema} */
2262
2592
  declare function CustomObjectSchema(): CustomObjectSchema;
2263
2593
  type CustomObjectSchema = {
2264
- _id?: string;
2265
- creator?: string;
2594
+ /**
2595
+ * - Unique system generated id
2596
+ */
2597
+ id?: string;
2598
+ /**
2599
+ * - Identifer for a company
2600
+ */
2266
2601
  company_id?: string;
2602
+ /**
2603
+ * - Identifer for a sales channel
2604
+ */
2267
2605
  application_id?: string;
2268
- created_by?: string;
2269
- updated_by?: string;
2606
+ /**
2607
+ * - Status of custom object
2608
+ */
2270
2609
  status?: string;
2610
+ /**
2611
+ * - Slug of custom object definition
2612
+ */
2271
2613
  type?: string;
2614
+ /**
2615
+ * - Slug for custom object definition
2616
+ */
2617
+ definition_slug?: string;
2618
+ /**
2619
+ * - Value of custom field used for displaying
2620
+ * custom object
2621
+ */
2272
2622
  display_name?: string;
2273
- definition_id?: string;
2623
+ /**
2624
+ * - Fields associated to the custom object
2625
+ */
2274
2626
  fields?: CustomFieldSchema[];
2275
2627
  };
2276
2628
  /** @returns {CustomObjectDefinitionRequestSchema} */
2277
2629
  declare function CustomObjectDefinitionRequestSchema(): CustomObjectDefinitionRequestSchema;
2278
2630
  type CustomObjectDefinitionRequestSchema = {
2631
+ /**
2632
+ * - Namespace/Slug of Custom object definition
2633
+ */
2279
2634
  type?: string;
2635
+ /**
2636
+ * - Unique slug for a custom object definition
2637
+ */
2638
+ definition_slug?: string;
2639
+ /**
2640
+ * - Description of custom object definition
2641
+ */
2280
2642
  description?: string;
2643
+ /**
2644
+ * - Name of custom object
2645
+ */
2281
2646
  name?: string;
2647
+ /**
2648
+ * - Denotes which custom field to be used
2649
+ * for displaying custom object
2650
+ */
2282
2651
  display_name_key?: string;
2652
+ /**
2653
+ * - List
2654
+ * of custom field definitions belonging to this custom object definition
2655
+ */
2283
2656
  field_definitions?: CustomObjectCustomFieldDefinitions[];
2284
2657
  };
2285
- /** @returns {CustomObjectCustomFieldDefinitionResSchema} */
2286
- declare function CustomObjectCustomFieldDefinitionResSchema(): CustomObjectCustomFieldDefinitionResSchema;
2287
- type CustomObjectCustomFieldDefinitionResSchema = {
2288
- creator?: string;
2289
- resource?: string;
2290
- name?: string;
2291
- namespace?: string;
2292
- key?: string;
2293
- description?: string;
2294
- type?: string;
2295
- multi_value?: boolean;
2296
- validations?: FieldValidations[];
2297
- company_id?: string;
2298
- created_by?: string;
2299
- metaobject_definition_id?: string;
2300
- required?: boolean;
2301
- is_deleted?: boolean;
2302
- _id?: string;
2303
- created_at?: string;
2304
- updated_at?: string;
2305
- };
2306
- /** @returns {CustomObjectDefinitionSchema} */
2307
- declare function CustomObjectDefinitionSchema(): CustomObjectDefinitionSchema;
2308
- type CustomObjectDefinitionSchema = {
2309
- _id?: string;
2658
+ /** @returns {CustomObjectDefinitionSlugSchema} */
2659
+ declare function CustomObjectDefinitionSlugSchema(): CustomObjectDefinitionSlugSchema;
2660
+ type CustomObjectDefinitionSlugSchema = {
2661
+ /**
2662
+ * - Unique system generated custom object definition id
2663
+ */
2664
+ id?: string;
2665
+ /**
2666
+ * - Display name of custom object definition
2667
+ */
2310
2668
  name?: string;
2669
+ /**
2670
+ * - Type of custom object definiton
2671
+ */
2311
2672
  type?: string;
2673
+ /**
2674
+ * - Slug of custom object definiton
2675
+ */
2676
+ definition_slug?: string;
2677
+ /**
2678
+ * - Display name of custom object definition
2679
+ */
2312
2680
  display_name_key?: string;
2681
+ /**
2682
+ * - Description of custom object definition
2683
+ */
2313
2684
  description?: string;
2314
- creator?: string;
2315
- created_by?: string;
2316
- updated_by?: string;
2317
- field_definitions?: CustomObjectCustomFieldDefinitionResSchema[];
2685
+ /**
2686
+ * -
2687
+ * Custom fields inside custom objects
2688
+ */
2689
+ field_definitions?: CustomFieldDefinitionDetailResSchema[];
2318
2690
  };
2319
2691
  /** @returns {CustomObjectDefinitionDeleteResponseSchema} */
2320
2692
  declare function CustomObjectDefinitionDeleteResponseSchema(): CustomObjectDefinitionDeleteResponseSchema;
2321
2693
  type CustomObjectDefinitionDeleteResponseSchema = {
2694
+ /**
2695
+ * - Success status of delete custom object definition.
2696
+ */
2322
2697
  success?: boolean;
2698
+ /**
2699
+ * - Response message when custom object definition
2700
+ * is deleted.
2701
+ */
2323
2702
  message?: string;
2324
2703
  };
2325
- /** @returns {CustomObjectEntryBulkUploadResponse} */
2326
- declare function CustomObjectEntryBulkUploadResponse(): CustomObjectEntryBulkUploadResponse;
2327
- type CustomObjectEntryBulkUploadResponse = {
2704
+ /** @returns {CustomObjectEntryBulkUploadDetails} */
2705
+ declare function CustomObjectEntryBulkUploadDetails(): CustomObjectEntryBulkUploadDetails;
2706
+ type CustomObjectEntryBulkUploadDetails = {
2707
+ /**
2708
+ * - Signed url of csv
2709
+ */
2328
2710
  url?: string;
2711
+ /**
2712
+ * - Total no of records in csv file
2713
+ */
2329
2714
  total_records?: number;
2330
2715
  };
2331
- /** @returns {CustomObjectListItemDefinationSchema} */
2332
- declare function CustomObjectListItemDefinationSchema(): CustomObjectListItemDefinationSchema;
2333
- type CustomObjectListItemDefinationSchema = {
2334
- _id?: string;
2716
+ /** @returns {CustomObjectListItemDefinitionModel} */
2717
+ declare function CustomObjectListItemDefinitionModel(): CustomObjectListItemDefinitionModel;
2718
+ type CustomObjectListItemDefinitionModel = {
2719
+ /**
2720
+ * - Unique system generated id
2721
+ */
2722
+ id?: string;
2723
+ /**
2724
+ * - Name of custom object
2725
+ */
2335
2726
  name?: string;
2727
+ /**
2728
+ * - Type of custom object entry
2729
+ */
2336
2730
  type?: string;
2337
2731
  };
2338
2732
  /** @returns {CustomObjectListItemSchema} */
2339
2733
  declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
2340
2734
  type CustomObjectListItemSchema = {
2341
- _id?: string;
2342
- definition_id?: string;
2735
+ /**
2736
+ * - Unique system generated id
2737
+ */
2738
+ id?: string;
2739
+ /**
2740
+ * - Status of custom object
2741
+ */
2343
2742
  status?: string;
2743
+ /**
2744
+ * - Creation time of custom object document
2745
+ */
2746
+ created_at?: string;
2747
+ /**
2748
+ * - Updation time of custom object document
2749
+ */
2344
2750
  updated_at?: string;
2751
+ /**
2752
+ * - Display name of custom object
2753
+ */
2345
2754
  display_name?: string;
2346
- definition?: CustomObjectListItemDefinationSchema;
2755
+ definition?: CustomObjectListItemDefinitionModel;
2756
+ /**
2757
+ * - References of the custom object entry
2758
+ */
2347
2759
  references?: number;
2348
2760
  };
2349
2761
  /** @returns {CustomObjectsSchema} */
2350
2762
  declare function CustomObjectsSchema(): CustomObjectsSchema;
2351
2763
  type CustomObjectsSchema = {
2764
+ /**
2765
+ * - List of paginated custom
2766
+ * object entries
2767
+ */
2352
2768
  items?: CustomObjectListItemSchema[];
2353
2769
  page?: Page;
2354
2770
  };
2355
- /** @returns {CustomObjectFieldSchema} */
2356
- declare function CustomObjectFieldSchema(): CustomObjectFieldSchema;
2357
- type CustomObjectFieldSchema = {
2358
- _id?: string;
2359
- key?: string;
2771
+ /** @returns {CustomObjectFieldDefinition} */
2772
+ declare function CustomObjectFieldDefinition(): CustomObjectFieldDefinition;
2773
+ type CustomObjectFieldDefinition = {
2774
+ /**
2775
+ * - Unique system generate id
2776
+ */
2777
+ id?: string;
2778
+ /**
2779
+ * - Slug of custom field definition
2780
+ */
2781
+ slug?: string;
2782
+ /**
2783
+ * - Namespace of custom field definition
2784
+ */
2785
+ namespace?: string;
2786
+ /**
2787
+ * - Value of custom field
2788
+ */
2360
2789
  value?: any[];
2790
+ /**
2791
+ * - Data type of the custom field
2792
+ */
2361
2793
  type?: string;
2362
- definition_id?: string;
2363
2794
  };
2364
- /** @returns {CustomObjectByIdSchema} */
2365
- declare function CustomObjectByIdSchema(): CustomObjectByIdSchema;
2366
- type CustomObjectByIdSchema = {
2367
- _id?: string;
2795
+ /** @returns {CustomObjectBySlugSchema} */
2796
+ declare function CustomObjectBySlugSchema(): CustomObjectBySlugSchema;
2797
+ type CustomObjectBySlugSchema = {
2798
+ /**
2799
+ * - Unique system generated identifer for a Custom Object
2800
+ */
2801
+ id?: string;
2802
+ /**
2803
+ * - Status of Custom Object
2804
+ */
2368
2805
  status?: string;
2806
+ /**
2807
+ * - Display name for the Custom Object
2808
+ */
2369
2809
  display_name?: string;
2370
- definition?: CustomObjectListItemDefinationSchema;
2810
+ definition?: CustomObjectListItemDefinitionModel;
2811
+ /**
2812
+ * - Places where the custom object has been
2813
+ * used as a custom field
2814
+ */
2371
2815
  references?: any[];
2372
- fields?: CustomObjectFieldSchema[];
2816
+ /**
2817
+ * - Slug of custom object entry
2818
+ */
2819
+ slug?: string;
2820
+ /**
2821
+ * - Slug of custom object definition
2822
+ */
2823
+ definition_slug?: string;
2824
+ /**
2825
+ * - List of custom fields
2826
+ * inside the custom object
2827
+ */
2828
+ fields?: CustomObjectFieldDefinition[];
2373
2829
  };
2374
2830
  /** @returns {CustomObjectBulkEntryInitiateDownload} */
2375
2831
  declare function CustomObjectBulkEntryInitiateDownload(): CustomObjectBulkEntryInitiateDownload;
2376
2832
  type CustomObjectBulkEntryInitiateDownload = {
2833
+ /**
2834
+ * - Message for the user
2835
+ */
2377
2836
  message?: string;
2837
+ /**
2838
+ * - Identifer for a task
2839
+ */
2378
2840
  task_id?: string;
2379
2841
  };
2380
2842
  /** @returns {CustomObjectMetaSchema} */
2381
2843
  declare function CustomObjectMetaSchema(): CustomObjectMetaSchema;
2382
2844
  type CustomObjectMetaSchema = {
2845
+ /**
2846
+ * - Total number of entries in the bulk entry
2847
+ */
2383
2848
  mo_total_count?: number;
2849
+ /**
2850
+ * - Number of entries which were successful
2851
+ */
2384
2852
  mo_success_count?: number;
2853
+ /**
2854
+ * - Number of entries which were failed
2855
+ */
2385
2856
  mo_error_count?: number;
2857
+ /**
2858
+ * - Type of object
2859
+ */
2386
2860
  mo_defintion_type?: string;
2387
2861
  };
2388
- /** @returns {CustomObjectJobSchema} */
2389
- declare function CustomObjectJobSchema(): CustomObjectJobSchema;
2390
- type CustomObjectJobSchema = {
2391
- _id?: string;
2862
+ /** @returns {JobSchema} */
2863
+ declare function JobSchema(): JobSchema;
2864
+ type JobSchema = {
2865
+ /**
2866
+ * - Unique system generated id
2867
+ */
2868
+ id?: string;
2869
+ /**
2870
+ * - List of total jobs
2871
+ */
2392
2872
  jobs?: string[];
2873
+ /**
2874
+ * - List of finished jobs
2875
+ */
2393
2876
  finished_jobs?: string[];
2877
+ /**
2878
+ * - List of jobs which resulted in an error
2879
+ */
2394
2880
  error_jobs?: string[];
2881
+ /**
2882
+ * - List of errors occurred in the job
2883
+ */
2395
2884
  errors_occured?: string[];
2885
+ /**
2886
+ * - Company Identifer
2887
+ */
2396
2888
  company_id?: string;
2397
- creator?: string;
2398
- url?: string;
2889
+ /**
2890
+ * - Status of job
2891
+ */
2399
2892
  status?: string;
2893
+ /**
2894
+ * - Type of job
2895
+ */
2400
2896
  action_type?: string;
2897
+ /**
2898
+ * - Entity against which job is running
2899
+ */
2401
2900
  entity?: string;
2901
+ /**
2902
+ * - URL which contains the file with errors
2903
+ */
2402
2904
  error_url?: string;
2905
+ /**
2906
+ * - Number of items successfully finished
2907
+ */
2403
2908
  finished_count?: number;
2909
+ /**
2910
+ * - Number of items in error
2911
+ */
2404
2912
  error_count?: number;
2913
+ /**
2914
+ * - Number of successful items
2915
+ */
2405
2916
  success_count?: number;
2917
+ /**
2918
+ * - Total number of jobs
2919
+ */
2406
2920
  total_jobs?: number;
2407
2921
  meta?: CustomObjectMetaSchema;
2922
+ /**
2923
+ * - Source from where the bulk job is created
2924
+ */
2408
2925
  created_by?: string;
2926
+ /**
2927
+ * - Date/Time when the job was created
2928
+ */
2409
2929
  created_at?: string;
2930
+ /**
2931
+ * - Date/Time when the job was updated
2932
+ */
2410
2933
  updated_at?: string;
2934
+ /**
2935
+ * - Sales Channel Identifier
2936
+ */
2937
+ application_id?: string;
2938
+ };
2939
+ /** @returns {CustomFieldBulkEntry} */
2940
+ declare function CustomFieldBulkEntry(): CustomFieldBulkEntry;
2941
+ type CustomFieldBulkEntry = {
2942
+ items?: JobSchema[];
2943
+ page?: Page;
2411
2944
  };
2412
2945
  /** @returns {CustomObjectBulkEntry} */
2413
2946
  declare function CustomObjectBulkEntry(): CustomObjectBulkEntry;
2414
2947
  type CustomObjectBulkEntry = {
2415
- items?: CustomObjectJobSchema[];
2948
+ items?: JobSchema[];
2416
2949
  page?: Page;
2417
2950
  };
2951
+ /** @returns {MetafieldTypesSchema} */
2952
+ declare function MetafieldTypesSchema(): MetafieldTypesSchema;
2953
+ type MetafieldTypesSchema = {
2954
+ metafield_types?: CustomFieldTypeSchema;
2955
+ };
2418
2956
  /** @returns {CustomFieldTypeSchema} */
2419
2957
  declare function CustomFieldTypeSchema(): CustomFieldTypeSchema;
2420
2958
  type CustomFieldTypeSchema = {
@@ -2431,6 +2969,8 @@ type CustomFieldTypeSchema = {
2431
2969
  url?: Url;
2432
2970
  metaobject?: Metaobject;
2433
2971
  product?: Product;
2972
+ html?: HTML;
2973
+ duration?: Duration;
2434
2974
  };
2435
2975
  /** @returns {SupportedValidationsMetaExampleSchema} */
2436
2976
  declare function SupportedValidationsMetaExampleSchema(): SupportedValidationsMetaExampleSchema;
@@ -2452,130 +2992,392 @@ type SupportedValidationsSchema = {
2452
2992
  required?: boolean;
2453
2993
  meta?: SupportedValidationsMetaSchema;
2454
2994
  };
2995
+ /** @returns {Duration} */
2996
+ declare function Duration(): Duration;
2997
+ type Duration = {
2998
+ /**
2999
+ * - Name data type of custom field
3000
+ */
3001
+ name?: string;
3002
+ /**
3003
+ * - Flag for listing enabled or not
3004
+ */
3005
+ list_enabled?: boolean;
3006
+ /**
3007
+ * - Type of custom field
3008
+ */
3009
+ type?: string;
3010
+ /**
3011
+ * - Category of custom field
3012
+ */
3013
+ category?: string;
3014
+ /**
3015
+ * - List of
3016
+ * validations available for the field
3017
+ */
3018
+ supported_validations?: SupportedValidationsSchema[];
3019
+ };
3020
+ /** @returns {HTML} */
3021
+ declare function HTML(): HTML;
3022
+ type HTML = {
3023
+ /**
3024
+ * - Name data type of custom field
3025
+ */
3026
+ name?: string;
3027
+ /**
3028
+ * - Flag for listing enabled or not
3029
+ */
3030
+ list_enabled?: boolean;
3031
+ /**
3032
+ * - Type of custom field
3033
+ */
3034
+ type?: string;
3035
+ /**
3036
+ * - List of
3037
+ * validations available for the field
3038
+ */
3039
+ supported_validations?: SupportedValidationsSchema[];
3040
+ };
2455
3041
  /** @returns {StringSingleLine} */
2456
3042
  declare function StringSingleLine(): StringSingleLine;
2457
3043
  type StringSingleLine = {
3044
+ /**
3045
+ * - Name data type of custom field
3046
+ */
2458
3047
  name?: string;
3048
+ /**
3049
+ * - Flag for listing enabled or not
3050
+ */
2459
3051
  list_enabled?: boolean;
3052
+ /**
3053
+ * - Category of custom field
3054
+ */
2460
3055
  category?: string;
3056
+ /**
3057
+ * - Type of custom field
3058
+ */
2461
3059
  type?: string;
3060
+ /**
3061
+ * - List of
3062
+ * validations available for the field
3063
+ */
2462
3064
  supported_validations?: SupportedValidationsSchema[];
2463
3065
  };
2464
3066
  /** @returns {StringMultiLine} */
2465
3067
  declare function StringMultiLine(): StringMultiLine;
2466
3068
  type StringMultiLine = {
3069
+ /**
3070
+ * - Name data type of custom field
3071
+ */
2467
3072
  name?: string;
3073
+ /**
3074
+ * - Flag for listing enabled or not
3075
+ */
2468
3076
  list_enabled?: boolean;
3077
+ /**
3078
+ * - Category of custom field
3079
+ */
2469
3080
  category?: string;
3081
+ /**
3082
+ * - Type of custom field
3083
+ */
2470
3084
  type?: string;
3085
+ /**
3086
+ * - List of
3087
+ * validations available for the field
3088
+ */
2471
3089
  supported_validations?: SupportedValidationsSchema[];
2472
3090
  };
2473
3091
  /** @returns {Dropdown} */
2474
3092
  declare function Dropdown(): Dropdown;
2475
3093
  type Dropdown = {
3094
+ /**
3095
+ * - Name data type of custom field
3096
+ */
2476
3097
  name?: string;
3098
+ /**
3099
+ * - Flag for listing enabled or not
3100
+ */
2477
3101
  list_enabled?: boolean;
3102
+ /**
3103
+ * - Category of custom field
3104
+ */
2478
3105
  category?: string;
3106
+ /**
3107
+ * - Category of custom field
3108
+ */
2479
3109
  type?: string;
3110
+ /**
3111
+ * - List of
3112
+ * validations available for the field
3113
+ */
2480
3114
  supported_validations?: SupportedValidationsSchema[];
2481
3115
  };
2482
3116
  /** @returns {Integer} */
2483
3117
  declare function Integer(): Integer;
2484
3118
  type Integer = {
3119
+ /**
3120
+ * - Name data type of custom field
3121
+ */
2485
3122
  name?: string;
3123
+ /**
3124
+ * - Flag for listing enabled or not
3125
+ */
2486
3126
  list_enabled?: boolean;
3127
+ /**
3128
+ * - Type of custom field
3129
+ */
2487
3130
  type?: string;
3131
+ /**
3132
+ * - Category of custom field
3133
+ */
2488
3134
  category?: string;
3135
+ /**
3136
+ * - List of
3137
+ * validations available for the field
3138
+ */
2489
3139
  supported_validations?: SupportedValidationsSchema[];
2490
3140
  };
2491
3141
  /** @returns {FloatType} */
2492
3142
  declare function FloatType(): FloatType;
2493
3143
  type FloatType = {
3144
+ /**
3145
+ * - Name data type of custom field
3146
+ */
2494
3147
  name?: string;
3148
+ /**
3149
+ * - Flag for listing enabled or not
3150
+ */
2495
3151
  list_enabled?: boolean;
3152
+ /**
3153
+ * - Type of custom field
3154
+ */
2496
3155
  type?: string;
3156
+ /**
3157
+ * - Category of custom field
3158
+ */
2497
3159
  category?: string;
3160
+ /**
3161
+ * - List of
3162
+ * validations available for the field
3163
+ */
2498
3164
  supported_validations?: SupportedValidationsSchema[];
2499
3165
  };
2500
3166
  /** @returns {BooleanType} */
2501
3167
  declare function BooleanType(): BooleanType;
2502
3168
  type BooleanType = {
3169
+ /**
3170
+ * - Name data type of custom field
3171
+ */
2503
3172
  name?: string;
3173
+ /**
3174
+ * - Category of custom field
3175
+ */
2504
3176
  category?: string;
3177
+ /**
3178
+ * - Flag for listing enabled or not
3179
+ */
2505
3180
  list_enabled?: boolean;
3181
+ /**
3182
+ * - Category of custom field
3183
+ */
2506
3184
  type?: string;
3185
+ /**
3186
+ * - List of
3187
+ * validations available for the field
3188
+ */
2507
3189
  supported_validations?: SupportedValidationsSchema[];
2508
3190
  };
2509
3191
  /** @returns {Date} */
2510
3192
  declare function Date(): Date;
2511
3193
  type Date = {
3194
+ /**
3195
+ * - Name data type of custom field
3196
+ */
2512
3197
  name?: string;
3198
+ /**
3199
+ * - Flag for listing enabled or not
3200
+ */
2513
3201
  list_enabled?: boolean;
3202
+ /**
3203
+ * - Category of custom field
3204
+ */
2514
3205
  category?: string;
3206
+ /**
3207
+ * - Type of custom field
3208
+ */
2515
3209
  type?: string;
3210
+ /**
3211
+ * - List of
3212
+ * validations available for the field
3213
+ */
2516
3214
  supported_validations?: SupportedValidationsSchema[];
2517
3215
  };
2518
3216
  /** @returns {Datetime} */
2519
3217
  declare function Datetime(): Datetime;
2520
3218
  type Datetime = {
3219
+ /**
3220
+ * - Name data type of custom field
3221
+ */
2521
3222
  name?: string;
3223
+ /**
3224
+ * - Category of custom field
3225
+ */
2522
3226
  category?: string;
3227
+ /**
3228
+ * - Flag for listing enabled or not
3229
+ */
2523
3230
  list_enabled?: boolean;
3231
+ /**
3232
+ * - Type of custom field
3233
+ */
2524
3234
  type?: string;
3235
+ /**
3236
+ * - List of
3237
+ * validations available for the field
3238
+ */
2525
3239
  supported_validations?: SupportedValidationsSchema[];
2526
3240
  };
2527
3241
  /** @returns {Json} */
2528
3242
  declare function Json(): Json;
2529
3243
  type Json = {
3244
+ /**
3245
+ * - Name data type of custom field
3246
+ */
2530
3247
  name?: string;
3248
+ /**
3249
+ * - Flag for listing enabled or not
3250
+ */
2531
3251
  list_enabled?: boolean;
3252
+ /**
3253
+ * - Category of custom field
3254
+ */
2532
3255
  category?: string;
3256
+ /**
3257
+ * - Type of custom field
3258
+ */
2533
3259
  type?: string;
3260
+ /**
3261
+ * - List of
3262
+ * validations available for the field
3263
+ */
2534
3264
  supported_validations?: SupportedValidationsSchema[];
2535
3265
  };
2536
3266
  /** @returns {File} */
2537
3267
  declare function File(): File;
2538
3268
  type File = {
3269
+ /**
3270
+ * - Name data type of custom field
3271
+ */
2539
3272
  name?: string;
3273
+ /**
3274
+ * - Category of custom field
3275
+ */
2540
3276
  category?: string;
3277
+ /**
3278
+ * - Flag for listing enabled or not
3279
+ */
2541
3280
  list_enabled?: boolean;
3281
+ /**
3282
+ * - Type of custom field
3283
+ */
2542
3284
  type?: string;
2543
3285
  supported_validations?: SupportedValidationsSchema[];
2544
3286
  };
2545
3287
  /** @returns {Url} */
2546
3288
  declare function Url(): Url;
2547
3289
  type Url = {
3290
+ /**
3291
+ * - Name data type of custom field
3292
+ */
2548
3293
  name?: string;
3294
+ /**
3295
+ * - Flag for listing enabled or not
3296
+ */
2549
3297
  list_enabled?: boolean;
3298
+ /**
3299
+ * - Type of custom field
3300
+ */
2550
3301
  type?: string;
3302
+ /**
3303
+ * - List of
3304
+ * validations available for the field
3305
+ */
2551
3306
  supported_validations?: SupportedValidationsSchema[];
2552
3307
  };
2553
3308
  /** @returns {Metaobject} */
2554
3309
  declare function Metaobject(): Metaobject;
2555
3310
  type Metaobject = {
3311
+ /**
3312
+ * - Name of Custom Object
3313
+ */
2556
3314
  name?: string;
3315
+ /**
3316
+ * - Whether the field is allowed to have
3317
+ * multiple list items
3318
+ */
2557
3319
  list_enabled?: boolean;
3320
+ /**
3321
+ * - Category of Custom Object Definition that
3322
+ * Custom Object belongs to
3323
+ */
2558
3324
  category?: string;
3325
+ /**
3326
+ * - Type of Custom Object Definition
3327
+ */
2559
3328
  type?: string;
2560
3329
  supported_validations?: SupportedValidationsSchema[];
2561
3330
  };
2562
3331
  /** @returns {Product} */
2563
3332
  declare function Product(): Product;
2564
3333
  type Product = {
3334
+ /**
3335
+ * - Name of Product
3336
+ */
2565
3337
  name?: string;
3338
+ /**
3339
+ * - Whether the field is allowed to have
3340
+ * multiple list items
3341
+ */
2566
3342
  list_enabled?: boolean;
3343
+ /**
3344
+ * - Category of Custom Object Definition that
3345
+ * Product is associated with
3346
+ */
2567
3347
  category?: string;
3348
+ /**
3349
+ * - Custom Object Definition that Product is associated with
3350
+ */
2568
3351
  type?: string;
2569
3352
  supported_validations?: SupportedValidationsSchema[];
2570
3353
  };
2571
3354
  /** @returns {CustomObjectEntry} */
2572
3355
  declare function CustomObjectEntry(): CustomObjectEntry;
2573
3356
  type CustomObjectEntry = {
2574
- _id?: string;
3357
+ /**
3358
+ * - Unique system generated id
3359
+ */
3360
+ id?: string;
3361
+ /**
3362
+ * - Name of Custom Object definition
3363
+ */
2575
3364
  name?: string;
3365
+ /**
3366
+ * - Type of Custom Object Definition
3367
+ */
2576
3368
  type?: string;
3369
+ /**
3370
+ * - Updation time of a Custom Object
3371
+ */
2577
3372
  updated_at?: string;
3373
+ /**
3374
+ * - Number of entries against the Custom
3375
+ * Object definition
3376
+ */
2578
3377
  entries_count?: number;
3378
+ /**
3379
+ * - Number of fields against a Custom Object definition
3380
+ */
2579
3381
  fields_count?: number;
2580
3382
  };
2581
3383
  /** @returns {CustomObjectDefinitionsSchema} */
@@ -2587,20 +3389,65 @@ type CustomObjectDefinitionsSchema = {
2587
3389
  /** @returns {CustomObjectEntryFieldSchema} */
2588
3390
  declare function CustomObjectEntryFieldSchema(): CustomObjectEntryFieldSchema;
2589
3391
  type CustomObjectEntryFieldSchema = {
2590
- definition_id?: string;
2591
- value?: any[];
3392
+ /**
3393
+ * - This is namespace for a custom field definition
3394
+ */
3395
+ namespace?: string;
3396
+ /**
3397
+ * - This is slug for a custom field definition
3398
+ */
3399
+ slug?: string;
3400
+ };
3401
+ /** @returns {CustomObjectEntryFieldSchemaWithoutID} */
3402
+ declare function CustomObjectEntryFieldSchemaWithoutID(): CustomObjectEntryFieldSchemaWithoutID;
3403
+ type CustomObjectEntryFieldSchemaWithoutID = {
3404
+ /**
3405
+ * - Custom fields belonging to a custom object
3406
+ */
3407
+ slug?: string;
3408
+ /**
3409
+ * - Value of custom field inside a custom object
3410
+ */
3411
+ value?: any;
2592
3412
  };
2593
3413
  /** @returns {CustomObjectRequestSchema} */
2594
3414
  declare function CustomObjectRequestSchema(): CustomObjectRequestSchema;
2595
3415
  type CustomObjectRequestSchema = {
3416
+ /**
3417
+ * - Flag to denote status of Custom Object
3418
+ */
2596
3419
  status?: string;
2597
- definition_id?: string;
3420
+ /**
3421
+ * - This is slug for a custom field definition
3422
+ */
3423
+ slug?: string;
3424
+ /**
3425
+ * - List of custom fields
3426
+ */
2598
3427
  fields?: CustomObjectEntryFieldSchema[];
2599
3428
  };
3429
+ /** @returns {CustomObjectRequestSchemaWithoutId} */
3430
+ declare function CustomObjectRequestSchemaWithoutId(): CustomObjectRequestSchemaWithoutId;
3431
+ type CustomObjectRequestSchemaWithoutId = {
3432
+ /**
3433
+ * - Status of the custom object entry.
3434
+ */
3435
+ status?: string;
3436
+ /**
3437
+ * - List of custom fields
3438
+ */
3439
+ fields?: CustomObjectEntryFieldSchemaWithoutID[];
3440
+ };
2600
3441
  /** @returns {CustomObjectBulkSchema} */
2601
3442
  declare function CustomObjectBulkSchema(): CustomObjectBulkSchema;
2602
3443
  type CustomObjectBulkSchema = {
3444
+ /**
3445
+ * - Full URL for the bulk operations data
3446
+ */
2603
3447
  url?: string;
3448
+ /**
3449
+ * - Total records in the upload.
3450
+ */
2604
3451
  total_records?: number;
2605
3452
  };
2606
3453
  /** @returns {ActionPage} */
@@ -2633,4 +3480,4 @@ type GenerationEntityType = "title" | "description";
2633
3480
  * @returns {PageType}
2634
3481
  */
2635
3482
  declare function PageType(): PageType;
2636
- type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";
3483
+ type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";