@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5

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 (239) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  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 +68 -48
  6. package/sdk/application/Cart/CartApplicationClient.js +118 -27
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  10. package/sdk/application/Common/CommonApplicationClient.js +1 -1
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
  14. package/sdk/application/Content/ContentApplicationClient.js +161 -56
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
  17. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  18. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
  20. package/sdk/application/Lead/LeadApplicationClient.js +1 -1
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
  24. package/sdk/application/Order/OrderApplicationClient.js +56 -8
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
  26. package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  30. package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
  31. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  32. package/sdk/application/User/UserApplicationClient.js +6 -6
  33. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  34. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  35. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  36. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  37. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
  38. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
  39. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  40. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  41. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  42. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  43. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  44. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  45. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
  46. package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
  47. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
  48. package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
  49. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
  50. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
  51. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  52. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  53. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  54. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  55. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  56. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  57. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  58. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  59. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  60. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  61. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  62. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  63. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  64. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  65. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  66. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  71. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  72. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  73. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  74. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  75. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  76. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  77. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  78. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  79. package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
  80. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
  81. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
  82. package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
  83. package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
  84. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
  85. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
  86. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
  87. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
  88. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
  89. package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
  90. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
  91. package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
  92. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
  93. package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
  94. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  95. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  96. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  97. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  98. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  99. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  100. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  101. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  102. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  103. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  104. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  105. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  106. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  107. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  108. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  109. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  110. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  111. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  112. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  113. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  114. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  115. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  116. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  117. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  118. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  119. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  120. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
  121. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
  122. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
  123. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
  124. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  125. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  126. package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
  127. package/sdk/platform/Content/ContentPlatformModel.js +631 -394
  128. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  129. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  130. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  131. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  132. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  133. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  134. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  136. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
  137. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  140. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
  141. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
  144. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  145. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  146. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  147. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  148. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  149. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  150. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
  151. package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
  152. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
  153. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
  154. package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
  155. package/sdk/platform/Order/OrderPlatformClient.js +416 -198
  156. package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
  157. package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
  158. package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
  159. package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
  160. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  161. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  162. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  163. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  164. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  165. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  166. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  167. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  168. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  169. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  170. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
  171. package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
  172. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  173. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  174. package/sdk/platform/PlatformClient.d.ts +0 -2
  175. package/sdk/platform/PlatformClient.js +0 -4
  176. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  177. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  178. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  179. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  180. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  181. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  182. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
  183. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
  188. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
  192. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  193. package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
  194. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
  195. package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
  196. package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
  197. package/sdk/platform/Share/SharePlatformModel.js +31 -6
  198. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  199. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  200. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  201. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  202. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  203. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  204. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  205. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  206. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  207. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  208. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  209. package/sdk/platform/User/UserPlatformModel.js +23 -23
  210. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  211. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  212. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  213. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  214. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  215. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  216. package/sdk/platform/index.d.ts +0 -1
  217. package/sdk/platform/index.js +0 -2
  218. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  219. package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
  220. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  221. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  222. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  223. package/sdk/public/Content/ContentPublicClient.js +810 -6
  224. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  225. package/sdk/public/Content/ContentPublicModel.js +649 -3
  226. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  227. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  228. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  229. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  230. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  231. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  232. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  233. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  234. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  235. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  236. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  237. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  238. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  239. 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]
@@ -52,8 +57,6 @@ export = ContentPlatformModel;
52
57
  * @property {string} [app]
53
58
  * @property {string} [_id]
54
59
  * @property {string} [robots_txt]
55
- * @property {boolean} [sitemap_enabled]
56
- * @property {string} [additional_sitemap]
57
60
  * @property {boolean} [cannonical_enabled]
58
61
  * @property {CustomMetaTag[]} [custom_meta_tags]
59
62
  * @property {Detail} [details]
@@ -156,7 +159,7 @@ export = ContentPlatformModel;
156
159
  * @property {string} [end]
157
160
  */
158
161
  /**
159
- * @typedef BlogGetResponse
162
+ * @typedef BlogGetDetails
160
163
  * @property {BlogSchema[]} [items]
161
164
  * @property {Page} [page]
162
165
  * @property {BlogFilters} [filters]
@@ -241,7 +244,51 @@ export = ContentPlatformModel;
241
244
  * @property {string} [modified_on]
242
245
  */
243
246
  /**
244
- * @typedef BlogRequest
247
+ * @typedef DefaultSitemapIndividualConfig
248
+ * @property {boolean} [enabled] - Whether sitemap configuration is enabled or
249
+ * not for this sitemap configuration
250
+ */
251
+ /**
252
+ * @typedef DefaultSitemapConfig
253
+ * @property {DefaultSitemapIndividualConfig} [root]
254
+ * @property {DefaultSitemapIndividualConfig} [brand]
255
+ * @property {DefaultSitemapIndividualConfig} [collections]
256
+ * @property {DefaultSitemapIndividualConfig} [category_l1]
257
+ * @property {DefaultSitemapIndividualConfig} [category_l2]
258
+ * @property {DefaultSitemapIndividualConfig} [category_l3]
259
+ * @property {DefaultSitemapIndividualConfig} [pages]
260
+ * @property {DefaultSitemapIndividualConfig} [blog]
261
+ * @property {DefaultSitemapIndividualConfig} [section]
262
+ * @property {DefaultSitemapIndividualConfig} [faq]
263
+ * @property {DefaultSitemapIndividualConfig} [sitemap]
264
+ */
265
+ /**
266
+ * @typedef SitemapConfigCreate
267
+ * @property {string} [name] - Unique identifier for the sitemap configuration
268
+ * @property {boolean} [is_active] - Indicates if the sitemap configuration is active
269
+ * @property {string} [sitemap] - XML string containing sitemap data in base64 encoding
270
+ */
271
+ /**
272
+ * @typedef SitemapConfig
273
+ * @property {string} [name] - Unique identifier for the sitemap configuration
274
+ * @property {boolean} [is_active] - Indicates if the sitemap configuration is
275
+ * active or not in storefront
276
+ * @property {string} [sitemap] - XML string containing sitemap data in base64 encoding
277
+ * @property {string} [created_at] - Timestamp when the configuration was created
278
+ * @property {string} [updated_at] - Timestamp when the configuration was last updated
279
+ */
280
+ /**
281
+ * @typedef SitemapConfigurationList
282
+ * @property {SitemapConfig[]} [items] - List of all Sitemap configurations
283
+ * @property {Page} [page]
284
+ */
285
+ /**
286
+ * @typedef SitemapConfigUpdate
287
+ * @property {boolean} [is_active] - Indicates if the sitemap configuration is active
288
+ * @property {string} [sitemap] - XML string containing sitemap data
289
+ */
290
+ /**
291
+ * @typedef BlogPayload
245
292
  * @property {string} [application]
246
293
  * @property {Object} [_custom_json]
247
294
  * @property {Author} [author]
@@ -390,7 +437,7 @@ export = ContentPlatformModel;
390
437
  * @property {DataLoaderSchema[]} [items]
391
438
  */
392
439
  /**
393
- * @typedef TagDeleteSuccessResponse
440
+ * @typedef TagDeleteSuccessDetails
394
441
  * @property {boolean} [success]
395
442
  */
396
443
  /**
@@ -503,7 +550,7 @@ export = ContentPlatformModel;
503
550
  * @property {number} [size] - The number of items per page.
504
551
  */
505
552
  /**
506
- * @typedef LandingPageGetResponse
553
+ * @typedef LandingPageGetDetails
507
554
  * @property {LandingPageSchema[]} [items]
508
555
  * @property {Page} [page]
509
556
  */
@@ -520,11 +567,11 @@ export = ContentPlatformModel;
520
567
  * @property {Object} [_custom_json]
521
568
  */
522
569
  /**
523
- * @typedef DefaultNavigationResponse
570
+ * @typedef DefaultNavigationDetails
524
571
  * @property {NavigationSchema[]} [items]
525
572
  */
526
573
  /**
527
- * @typedef NavigationGetResponse
574
+ * @typedef NavigationGetDetails
528
575
  * @property {NavigationSchema[]} [items]
529
576
  * @property {Page} [page]
530
577
  */
@@ -548,7 +595,7 @@ export = ContentPlatformModel;
548
595
  * @property {NavigationReference[]} [navigation]
549
596
  */
550
597
  /**
551
- * @typedef NavigationRequest
598
+ * @typedef NavigationPayload
552
599
  * @property {string} [name]
553
600
  * @property {string} [slug]
554
601
  * @property {string[]} [platform]
@@ -556,7 +603,7 @@ export = ContentPlatformModel;
556
603
  * @property {NavigationReference[]} [navigation]
557
604
  */
558
605
  /**
559
- * @typedef PageGetResponse
606
+ * @typedef PageGetDetails
560
607
  * @property {PageSchema[]} [items]
561
608
  * @property {Page} [page]
562
609
  */
@@ -607,7 +654,7 @@ export = ContentPlatformModel;
607
654
  * @property {string} [id]
608
655
  */
609
656
  /**
610
- * @typedef PageRequest
657
+ * @typedef PagePayload
611
658
  * @property {CronSchedule} [_schedule]
612
659
  * @property {string} [application]
613
660
  * @property {Author} [author]
@@ -630,7 +677,7 @@ export = ContentPlatformModel;
630
677
  * @property {number} [duration]
631
678
  */
632
679
  /**
633
- * @typedef PagePublishRequest
680
+ * @typedef PagePublishPayload
634
681
  * @property {boolean} [publish]
635
682
  */
636
683
  /**
@@ -640,7 +687,7 @@ export = ContentPlatformModel;
640
687
  * @property {string} [application_id]
641
688
  */
642
689
  /**
643
- * @typedef SlideshowGetResponse
690
+ * @typedef SlideshowGetDetails
644
691
  * @property {SlideshowSchema[]} [items]
645
692
  * @property {Page} [page]
646
693
  */
@@ -658,7 +705,7 @@ export = ContentPlatformModel;
658
705
  * @property {Object} [_custom_json]
659
706
  */
660
707
  /**
661
- * @typedef SlideshowRequest
708
+ * @typedef SlideshowPayload
662
709
  * @property {string} [slug]
663
710
  * @property {string} [platform]
664
711
  * @property {ConfigurationSchema} [configuration]
@@ -737,93 +784,108 @@ export = ContentPlatformModel;
737
784
  */
738
785
  /**
739
786
  * @typedef FieldValidations
740
- * @property {string} [name]
741
- * @property {string} [type]
787
+ * @property {string} [name] - Name of validation
788
+ * @property {string} [type] - Type of validation
742
789
  * @property {Object} [value]
743
790
  */
744
791
  /**
745
792
  * @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]
793
+ * @property {string} [id] - Unique system generated id
794
+ * @property {string} [resource] - Resource type to which custom field belongs
795
+ * @property {string} [name] - Name of custom field
796
+ * @property {string} [namespace] - Namespace of custom field
797
+ * @property {string} [slug] - Slug of custom field
798
+ * @property {string} [description] - Description of custom field definition
799
+ * @property {string} [type] - Data type of custom field
800
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
801
+ * multivalued or not
802
+ * @property {FieldValidations[]} [validations] - List of validations applied
803
+ * @property {string} [company_id] - Id of company
804
+ * @property {boolean} [required] - Whether the custom field is required or not
805
+ * @property {boolean} [is_deleted] - Whether the custom field is deleted or not
806
+ * @property {string} [type_name] - Type of type field
807
+ * @property {number} [invalid_fields_count] - Count of invalid fields after validation
765
808
  */
766
809
  /**
767
810
  * @typedef CustomFieldDefinitionsSchema
768
- * @property {FieldDefinitionSchema[]} [items]
811
+ * @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
769
812
  * @property {Page} [page]
770
813
  */
771
814
  /**
772
815
  * @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]
816
+ * @property {string} [type] - Data type of custom field
817
+ * @property {string} [slug] - Slug of custom field definition
818
+ * @property {string} [namespace] - Namespace of custom field definition
819
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
820
+ * multi valued or not
821
+ * @property {string} [name] - Name of custom field definition
822
+ * @property {string} [description] - Description of a custom field definition
823
+ * @property {FieldValidations[]} [validations] - Validations for a custom field
781
824
  */
782
825
  /**
783
826
  * @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]
827
+ * @property {string} [id] - Unique identifer for a custom field
828
+ * @property {string} [type] - Data type of custom field
829
+ * @property {string} [description] - Description of custom field
830
+ * @property {string} [name] - Name of custom field
831
+ * @property {boolean} [multi_value] - Flag to denote if cusom field is multi
832
+ * valued or not
833
+ * @property {boolean} [required] - Whether the field is required or not
834
+ * @property {string} [slug] - Slug of custom field definition
835
+ * @property {FieldValidations[]} [validations] - Validations added against the
836
+ * custom field
792
837
  * @property {string} [action]
793
838
  */
794
839
  /**
795
840
  * @typedef CustomObjectDefinitionUpdateRequestSchema
796
- * @property {string} [type]
797
- * @property {string} [description]
798
- * @property {string} [name]
799
- * @property {string} [display_name_key]
841
+ * @property {string} [description] - Description of custom object definiton
842
+ * @property {string} [name] - Name of custom object definition
843
+ * @property {string} [display_name_key] - Custom field slug which is used as a
844
+ * display key in
800
845
  * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
801
846
  */
802
847
  /**
803
848
  * @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]
849
+ * @property {string} [resource] - Resource to which custom field is associated
850
+ * @property {string} [name] - Name of custom field
851
+ * @property {string} [namespace] - Namespace of custom field
852
+ * @property {string} [slug] - Slug of custom field
853
+ * @property {string} [description] - Description regarding custom field
854
+ * @property {string} [type] - Data type of custom field
855
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
856
+ * multi valued or not
857
+ * @property {string} [company_id] - Company Identifer
858
+ * @property {string} [application_id] - Sales channel identifier
859
+ * @property {boolean} [required] - Whether the customfield is required or not
860
+ * @property {boolean} [is_deleted] - Is custom field deleted
861
+ * @property {string} [id] - Unique system generated id
819
862
  * @property {Object[]} [validations]
820
- * @property {string} [created_at]
821
- * @property {string} [updated_at]
863
+ * @property {string} [created_at] - Date time at which field was created
864
+ * @property {string} [updated_at] - Date time at for a field's last modification
865
+ */
866
+ /**
867
+ * @typedef MetaFieldDefinitionDetailResSchema
868
+ * @property {string} [resource] - Resource to which meta field is associated
869
+ * @property {string} [name] - Name of meta field
870
+ * @property {string} [namespace] - Namespace of meta field
871
+ * @property {string} [slug] - Slug of meta field
872
+ * @property {string} [description] - Description regarding meta field
873
+ * @property {string} [type] - Data type of meta field
874
+ * @property {boolean} [multi_value] - Flag to denote whether meta field is
875
+ * multi valued or not
876
+ * @property {string} [company_id] - Company Identifer
877
+ * @property {string} [application_id] - Sales channel identifier
878
+ * @property {boolean} [required] - Whether the field is required or not
879
+ * @property {boolean} [is_deleted] - Is meta field deleted
880
+ * @property {string} [id] - Unique system generated id
881
+ * @property {Object[]} [validations]
882
+ * @property {string} [created_at] - Date time at which field was created
883
+ * @property {string} [updated_at] - Date time at for a field's last modification
822
884
  */
823
885
  /**
824
886
  * @typedef CustomDataDeleteSchema
825
- * @property {boolean} [success]
826
- * @property {string} [message]
887
+ * @property {boolean} [success] - Denotes the success of the delete operation
888
+ * @property {string} [message] - Denotes the message of delete operation
827
889
  */
828
890
  /**
829
891
  * @typedef CustomFieldValue
@@ -831,29 +893,31 @@ export = ContentPlatformModel;
831
893
  */
832
894
  /**
833
895
  * @typedef CustomFieldSchema
834
- * @property {string} [_id]
835
- * @property {string} [namespace]
836
- * @property {string} [key]
837
- * @property {string} [resource]
838
- * @property {string} [creator]
896
+ * @property {string} [id] - Unique system generated id
897
+ * @property {string} [namespace] - Namespace of custom field definition
898
+ * @property {string} [slug] - Slug of custom field definition
899
+ * @property {string} [resource] - The resource for which custom field is being created
839
900
  * @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]
901
+ * @property {string} [resource_slug] - Unique identifier of the resource
902
+ * @property {string} [type] - Data type of custom field
903
+ * @property {boolean} [multi_value] - Whether custom field is multi valued
904
+ * @property {string} [company_id] - Identifer for a company
845
905
  * @property {boolean} [has_invalid_values]
846
906
  * @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]
907
+ * @property {boolean} [is_deleted] - Indicates whether custom field is deleted
908
+ * @property {string} [created_at] - Time at which customer field was created
909
+ * @property {string} [updated_at] - Time at which custom field was updated
851
910
  */
852
911
  /**
853
912
  * @typedef CustomFieldsResponseSchema
854
913
  * @property {CustomFieldSchema[]} [items]
855
914
  * @property {Page} [page]
856
915
  */
916
+ /**
917
+ * @typedef CustomFieldsDeleteSchema
918
+ * @property {boolean} [success]
919
+ * @property {string} [message]
920
+ */
857
921
  /**
858
922
  * @typedef CustomFieldsResponseByResourceIdSchema
859
923
  * @property {CustomFieldSchema[]} [items]
@@ -861,7 +925,9 @@ export = ContentPlatformModel;
861
925
  /**
862
926
  * @typedef CustomField
863
927
  * @property {Object[]} [value]
864
- * @property {string} [definition_id]
928
+ * @property {string} [namespace] - This is the namespace to which custom field belongs
929
+ * @property {string} [slug] - This is the slug of custom field used while
930
+ * creating a custom field definition
865
931
  */
866
932
  /**
867
933
  * @typedef CustomFieldRequestSchema
@@ -869,146 +935,140 @@ export = ContentPlatformModel;
869
935
  */
870
936
  /**
871
937
  * @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]
938
+ * @property {string} [id] - Unique system generated id
939
+ * @property {string} [company_id] - Identifer for a company
940
+ * @property {string} [application_id] - Identifer for a sales channel
941
+ * @property {string} [status] - Status of custom object
942
+ * @property {string} [type] - Slug of custom object definition
943
+ * @property {string} [definition_slug] - Slug for custom object definition
944
+ * @property {string} [display_name] - Value of custom field used for displaying
945
+ * custom object
946
+ * @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
883
947
  */
884
948
  /**
885
949
  * @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]
950
+ * @property {string} [type] - Namespace/Slug of Custom object definition
951
+ * @property {string} [definition_slug] - Unique slug for a custom object definition
952
+ * @property {string} [description] - Description of custom object definition
953
+ * @property {string} [name] - Name of custom object
954
+ * @property {string} [display_name_key] - Denotes which custom field to be used
955
+ * for displaying custom object
956
+ * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
957
+ * of custom field definitions belonging to this custom object definition
958
+ */
959
+ /**
960
+ * @typedef CustomObjectDefinitionSlugSchema
961
+ * @property {string} [id] - Unique system generated custom object definition id
962
+ * @property {string} [name] - Display name of custom object definition
963
+ * @property {string} [type] - Type of custom object definiton
964
+ * @property {string} [definition_slug] - Slug of custom object definiton
965
+ * @property {string} [display_name_key] - Display name of custom object definition
966
+ * @property {string} [description] - Description of custom object definition
967
+ * @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
968
+ * Custom fields inside custom objects
923
969
  */
924
970
  /**
925
971
  * @typedef CustomObjectDefinitionDeleteResponseSchema
926
- * @property {boolean} [success]
927
- * @property {string} [message]
972
+ * @property {boolean} [success] - Success status of delete custom object definition.
973
+ * @property {string} [message] - Response message when custom object definition
974
+ * is deleted.
928
975
  */
929
976
  /**
930
- * @typedef CustomObjectEntryBulkUploadResponse
931
- * @property {string} [url]
932
- * @property {number} [total_records]
977
+ * @typedef CustomObjectEntryBulkUploadDetails
978
+ * @property {string} [url] - Signed url of csv
979
+ * @property {number} [total_records] - Total no of records in csv file
933
980
  */
934
981
  /**
935
- * @typedef CustomObjectListItemDefinationSchema
936
- * @property {string} [_id]
937
- * @property {string} [name]
938
- * @property {string} [type]
982
+ * @typedef CustomObjectListItemDefinitionModel
983
+ * @property {string} [id] - Unique system generated id
984
+ * @property {string} [name] - Name of custom object
985
+ * @property {string} [type] - Type of custom object entry
939
986
  */
940
987
  /**
941
988
  * @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]
989
+ * @property {string} [id] - Unique system generated id
990
+ * @property {string} [status] - Status of custom object
991
+ * @property {string} [created_at] - Creation time of custom object document
992
+ * @property {string} [updated_at] - Updation time of custom object document
993
+ * @property {string} [display_name] - Display name of custom object
994
+ * @property {CustomObjectListItemDefinitionModel} [definition]
995
+ * @property {number} [references] - References of the custom object entry
949
996
  */
950
997
  /**
951
998
  * @typedef CustomObjectsSchema
952
- * @property {CustomObjectListItemSchema[]} [items]
999
+ * @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
1000
+ * object entries
953
1001
  * @property {Page} [page]
954
1002
  */
955
1003
  /**
956
- * @typedef CustomObjectFieldSchema
957
- * @property {string} [_id]
958
- * @property {string} [key]
959
- * @property {Object[]} [value]
960
- * @property {string} [type]
961
- * @property {string} [definition_id]
1004
+ * @typedef CustomObjectFieldDefinition
1005
+ * @property {string} [id] - Unique system generate id
1006
+ * @property {string} [slug] - Slug of custom field definition
1007
+ * @property {string} [namespace] - Namespace of custom field definition
1008
+ * @property {Object[]} [value] - Value of custom field
1009
+ * @property {string} [type] - Data type of the custom field
962
1010
  */
963
1011
  /**
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]
1012
+ * @typedef CustomObjectBySlugSchema
1013
+ * @property {string} [id] - Unique system generated identifer for a Custom Object
1014
+ * @property {string} [status] - Status of Custom Object
1015
+ * @property {string} [display_name] - Display name for the Custom Object
1016
+ * @property {CustomObjectListItemDefinitionModel} [definition]
1017
+ * @property {Object[]} [references] - Places where the custom object has been
1018
+ * used as a custom field
1019
+ * @property {string} [slug] - Slug of custom object entry
1020
+ * @property {string} [definition_slug] - Slug of custom object definition
1021
+ * @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
1022
+ * inside the custom object
971
1023
  */
972
1024
  /**
973
1025
  * @typedef CustomObjectBulkEntryInitiateDownload
974
- * @property {string} [message]
975
- * @property {string} [task_id]
1026
+ * @property {string} [message] - Message for the user
1027
+ * @property {string} [task_id] - Identifer for a task
976
1028
  */
977
1029
  /**
978
1030
  * @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]
1031
+ * @property {number} [mo_total_count] - Total number of entries in the bulk entry
1032
+ * @property {number} [mo_success_count] - Number of entries which were successful
1033
+ * @property {number} [mo_error_count] - Number of entries which were failed
1034
+ * @property {string} [mo_defintion_type] - Type of object
1035
+ */
1036
+ /**
1037
+ * @typedef JobSchema
1038
+ * @property {string} [id] - Unique system generated id
1039
+ * @property {string[]} [jobs] - List of total jobs
1040
+ * @property {string[]} [finished_jobs] - List of finished jobs
1041
+ * @property {string[]} [error_jobs] - List of jobs which resulted in an error
1042
+ * @property {string[]} [errors_occured] - List of errors occurred in the job
1043
+ * @property {string} [company_id] - Company Identifer
1044
+ * @property {string} [status] - Status of job
1045
+ * @property {string} [action_type] - Type of job
1046
+ * @property {string} [entity] - Entity against which job is running
1047
+ * @property {string} [error_url] - URL which contains the file with errors
1048
+ * @property {number} [finished_count] - Number of items successfully finished
1049
+ * @property {number} [error_count] - Number of items in error
1050
+ * @property {number} [success_count] - Number of successful items
1051
+ * @property {number} [total_jobs] - Total number of jobs
1052
+ * @property {CustomObjectMetaSchema} [meta]
1053
+ * @property {string} [created_by] - Source from where the bulk job is created
1054
+ * @property {string} [created_at] - Date/Time when the job was created
1055
+ * @property {string} [updated_at] - Date/Time when the job was updated
1056
+ * @property {string} [application_id] - Sales Channel Identifier
983
1057
  */
984
1058
  /**
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]
1059
+ * @typedef CustomFieldBulkEntry
1060
+ * @property {JobSchema[]} [items]
1061
+ * @property {Page} [page]
1006
1062
  */
1007
1063
  /**
1008
1064
  * @typedef CustomObjectBulkEntry
1009
- * @property {CustomObjectJobSchema[]} [items]
1065
+ * @property {JobSchema[]} [items]
1010
1066
  * @property {Page} [page]
1011
1067
  */
1068
+ /**
1069
+ * @typedef MetafieldTypesSchema
1070
+ * @property {CustomFieldTypeSchema} [metafield_types]
1071
+ */
1012
1072
  /**
1013
1073
  * @typedef CustomFieldTypeSchema
1014
1074
  * @property {StringSingleLine} [string_single_line]
@@ -1024,6 +1084,8 @@ export = ContentPlatformModel;
1024
1084
  * @property {Url} [url]
1025
1085
  * @property {Metaobject} [metaobject]
1026
1086
  * @property {Product} [product]
1087
+ * @property {HTML} [html]
1088
+ * @property {Duration} [duration]
1027
1089
  */
1028
1090
  /**
1029
1091
  * @typedef SupportedValidationsMetaExampleSchema
@@ -1042,117 +1104,149 @@ export = ContentPlatformModel;
1042
1104
  * @property {boolean} [required]
1043
1105
  * @property {SupportedValidationsMetaSchema} [meta]
1044
1106
  */
1107
+ /**
1108
+ * @typedef Duration
1109
+ * @property {string} [name] - Name data type of custom field
1110
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1111
+ * @property {string} [type] - Type of custom field
1112
+ * @property {string} [category] - Category of custom field
1113
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1114
+ * validations available for the field
1115
+ */
1116
+ /**
1117
+ * @typedef HTML
1118
+ * @property {string} [name] - Name data type of custom field
1119
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1120
+ * @property {string} [type] - Type of custom field
1121
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1122
+ * validations available for the field
1123
+ */
1045
1124
  /**
1046
1125
  * @typedef StringSingleLine
1047
- * @property {string} [name]
1048
- * @property {boolean} [list_enabled]
1049
- * @property {string} [category]
1050
- * @property {string} [type]
1051
- * @property {SupportedValidationsSchema[]} [supported_validations]
1126
+ * @property {string} [name] - Name data type of custom field
1127
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1128
+ * @property {string} [category] - Category of custom field
1129
+ * @property {string} [type] - Type of custom field
1130
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1131
+ * validations available for the field
1052
1132
  */
1053
1133
  /**
1054
1134
  * @typedef StringMultiLine
1055
- * @property {string} [name]
1056
- * @property {boolean} [list_enabled]
1057
- * @property {string} [category]
1058
- * @property {string} [type]
1059
- * @property {SupportedValidationsSchema[]} [supported_validations]
1135
+ * @property {string} [name] - Name data type of custom field
1136
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1137
+ * @property {string} [category] - Category of custom field
1138
+ * @property {string} [type] - Type of custom field
1139
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1140
+ * validations available for the field
1060
1141
  */
1061
1142
  /**
1062
1143
  * @typedef Dropdown
1063
- * @property {string} [name]
1064
- * @property {boolean} [list_enabled]
1065
- * @property {string} [category]
1066
- * @property {string} [type]
1067
- * @property {SupportedValidationsSchema[]} [supported_validations]
1144
+ * @property {string} [name] - Name data type of custom field
1145
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1146
+ * @property {string} [category] - Category of custom field
1147
+ * @property {string} [type] - Category of custom field
1148
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1149
+ * validations available for the field
1068
1150
  */
1069
1151
  /**
1070
1152
  * @typedef Integer
1071
- * @property {string} [name]
1072
- * @property {boolean} [list_enabled]
1073
- * @property {string} [type]
1074
- * @property {string} [category]
1075
- * @property {SupportedValidationsSchema[]} [supported_validations]
1153
+ * @property {string} [name] - Name data type of custom field
1154
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1155
+ * @property {string} [type] - Type of custom field
1156
+ * @property {string} [category] - Category of custom field
1157
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1158
+ * validations available for the field
1076
1159
  */
1077
1160
  /**
1078
1161
  * @typedef FloatType
1079
- * @property {string} [name]
1080
- * @property {boolean} [list_enabled]
1081
- * @property {string} [type]
1082
- * @property {string} [category]
1083
- * @property {SupportedValidationsSchema[]} [supported_validations]
1162
+ * @property {string} [name] - Name data type of custom field
1163
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1164
+ * @property {string} [type] - Type of custom field
1165
+ * @property {string} [category] - Category of custom field
1166
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1167
+ * validations available for the field
1084
1168
  */
1085
1169
  /**
1086
1170
  * @typedef BooleanType
1087
- * @property {string} [name]
1088
- * @property {string} [category]
1089
- * @property {boolean} [list_enabled]
1090
- * @property {string} [type]
1091
- * @property {SupportedValidationsSchema[]} [supported_validations]
1171
+ * @property {string} [name] - Name data type of custom field
1172
+ * @property {string} [category] - Category of custom field
1173
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1174
+ * @property {string} [type] - Category of custom field
1175
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1176
+ * validations available for the field
1092
1177
  */
1093
1178
  /**
1094
1179
  * @typedef Date
1095
- * @property {string} [name]
1096
- * @property {boolean} [list_enabled]
1097
- * @property {string} [category]
1098
- * @property {string} [type]
1099
- * @property {SupportedValidationsSchema[]} [supported_validations]
1180
+ * @property {string} [name] - Name data type of custom field
1181
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1182
+ * @property {string} [category] - Category of custom field
1183
+ * @property {string} [type] - Type of custom field
1184
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1185
+ * validations available for the field
1100
1186
  */
1101
1187
  /**
1102
1188
  * @typedef Datetime
1103
- * @property {string} [name]
1104
- * @property {string} [category]
1105
- * @property {boolean} [list_enabled]
1106
- * @property {string} [type]
1107
- * @property {SupportedValidationsSchema[]} [supported_validations]
1189
+ * @property {string} [name] - Name data type of custom field
1190
+ * @property {string} [category] - Category of custom field
1191
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1192
+ * @property {string} [type] - Type of custom field
1193
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1194
+ * validations available for the field
1108
1195
  */
1109
1196
  /**
1110
1197
  * @typedef Json
1111
- * @property {string} [name]
1112
- * @property {boolean} [list_enabled]
1113
- * @property {string} [category]
1114
- * @property {string} [type]
1115
- * @property {SupportedValidationsSchema[]} [supported_validations]
1198
+ * @property {string} [name] - Name data type of custom field
1199
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1200
+ * @property {string} [category] - Category of custom field
1201
+ * @property {string} [type] - Type of custom field
1202
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1203
+ * validations available for the field
1116
1204
  */
1117
1205
  /**
1118
1206
  * @typedef File
1119
- * @property {string} [name]
1120
- * @property {string} [category]
1121
- * @property {boolean} [list_enabled]
1122
- * @property {string} [type]
1207
+ * @property {string} [name] - Name data type of custom field
1208
+ * @property {string} [category] - Category of custom field
1209
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1210
+ * @property {string} [type] - Type of custom field
1123
1211
  * @property {SupportedValidationsSchema[]} [supported_validations]
1124
1212
  */
1125
1213
  /**
1126
1214
  * @typedef Url
1127
- * @property {string} [name]
1128
- * @property {boolean} [list_enabled]
1129
- * @property {string} [type]
1130
- * @property {SupportedValidationsSchema[]} [supported_validations]
1215
+ * @property {string} [name] - Name data type of custom field
1216
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1217
+ * @property {string} [type] - Type of custom field
1218
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1219
+ * validations available for the field
1131
1220
  */
1132
1221
  /**
1133
1222
  * @typedef Metaobject
1134
- * @property {string} [name]
1135
- * @property {boolean} [list_enabled]
1136
- * @property {string} [category]
1137
- * @property {string} [type]
1223
+ * @property {string} [name] - Name of Custom Object
1224
+ * @property {boolean} [list_enabled] - Whether the field is allowed to have
1225
+ * multiple list items
1226
+ * @property {string} [category] - Category of Custom Object Definition that
1227
+ * Custom Object belongs to
1228
+ * @property {string} [type] - Type of Custom Object Definition
1138
1229
  * @property {SupportedValidationsSchema[]} [supported_validations]
1139
1230
  */
1140
1231
  /**
1141
1232
  * @typedef Product
1142
- * @property {string} [name]
1143
- * @property {boolean} [list_enabled]
1144
- * @property {string} [category]
1145
- * @property {string} [type]
1233
+ * @property {string} [name] - Name of Product
1234
+ * @property {boolean} [list_enabled] - Whether the field is allowed to have
1235
+ * multiple list items
1236
+ * @property {string} [category] - Category of Custom Object Definition that
1237
+ * Product is associated with
1238
+ * @property {string} [type] - Custom Object Definition that Product is associated with
1146
1239
  * @property {SupportedValidationsSchema[]} [supported_validations]
1147
1240
  */
1148
1241
  /**
1149
1242
  * @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]
1243
+ * @property {string} [id] - Unique system generated id
1244
+ * @property {string} [name] - Name of Custom Object definition
1245
+ * @property {string} [type] - Type of Custom Object Definition
1246
+ * @property {string} [updated_at] - Updation time of a Custom Object
1247
+ * @property {number} [entries_count] - Number of entries against the Custom
1248
+ * Object definition
1249
+ * @property {number} [fields_count] - Number of fields against a Custom Object definition
1156
1250
  */
1157
1251
  /**
1158
1252
  * @typedef CustomObjectDefinitionsSchema
@@ -1161,19 +1255,29 @@ export = ContentPlatformModel;
1161
1255
  */
1162
1256
  /**
1163
1257
  * @typedef CustomObjectEntryFieldSchema
1164
- * @property {string} [definition_id]
1165
- * @property {Object[]} [value]
1258
+ * @property {string} [namespace] - This is namespace for a custom field definition
1259
+ * @property {string} [slug] - This is slug for a custom field definition
1260
+ */
1261
+ /**
1262
+ * @typedef CustomObjectEntryFieldSchemaWithoutID
1263
+ * @property {string} [slug] - Custom fields belonging to a custom object
1264
+ * @property {Object} [value] - Value of custom field inside a custom object
1166
1265
  */
1167
1266
  /**
1168
1267
  * @typedef CustomObjectRequestSchema
1169
- * @property {string} [status]
1170
- * @property {string} [definition_id]
1171
- * @property {CustomObjectEntryFieldSchema[]} [fields]
1268
+ * @property {string} [status] - Flag to denote status of Custom Object
1269
+ * @property {string} [slug] - This is slug for a custom field definition
1270
+ * @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
1271
+ */
1272
+ /**
1273
+ * @typedef CustomObjectRequestSchemaWithoutId
1274
+ * @property {string} [status] - Status of the custom object entry.
1275
+ * @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
1172
1276
  */
1173
1277
  /**
1174
1278
  * @typedef CustomObjectBulkSchema
1175
- * @property {string} [url]
1176
- * @property {number} [total_records]
1279
+ * @property {string} [url] - Full URL for the bulk operations data
1280
+ * @property {number} [total_records] - Total records in the upload.
1177
1281
  */
1178
1282
  /**
1179
1283
  * @typedef ActionPage
@@ -1236,8 +1340,20 @@ export = ContentPlatformModel;
1236
1340
  declare class ContentPlatformModel {
1237
1341
  }
1238
1342
  declare namespace ContentPlatformModel {
1239
- export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, SlideshowGetResponse, SlideshowSchema, SlideshowRequest, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadResponse, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, CustomObjectJobSchema, CustomObjectBulkEntry, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectRequestSchema, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
1343
+ 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, DefaultSitemapIndividualConfig, DefaultSitemapConfig, SitemapConfigCreate, SitemapConfig, SitemapConfigurationList, SitemapConfigUpdate, 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 };
1240
1344
  }
1345
+ /** @returns {ValidationError} */
1346
+ declare function ValidationError(): ValidationError;
1347
+ type ValidationError = {
1348
+ /**
1349
+ * - A brief description of the error encountered.
1350
+ */
1351
+ message: string;
1352
+ /**
1353
+ * - The field in the request that caused the error.
1354
+ */
1355
+ field: string;
1356
+ };
1241
1357
  /** @returns {GenerateSEOContent} */
1242
1358
  declare function GenerateSEOContent(): GenerateSEOContent;
1243
1359
  type GenerateSEOContent = {
@@ -1299,8 +1415,6 @@ type SeoSchema = {
1299
1415
  app?: string;
1300
1416
  _id?: string;
1301
1417
  robots_txt?: string;
1302
- sitemap_enabled?: boolean;
1303
- additional_sitemap?: string;
1304
1418
  cannonical_enabled?: boolean;
1305
1419
  custom_meta_tags?: CustomMetaTag[];
1306
1420
  details?: Detail;
@@ -1415,9 +1529,9 @@ type NextSchedule = {
1415
1529
  start?: string;
1416
1530
  end?: string;
1417
1531
  };
1418
- /** @returns {BlogGetResponse} */
1419
- declare function BlogGetResponse(): BlogGetResponse;
1420
- type BlogGetResponse = {
1532
+ /** @returns {BlogGetDetails} */
1533
+ declare function BlogGetDetails(): BlogGetDetails;
1534
+ type BlogGetDetails = {
1421
1535
  items?: BlogSchema[];
1422
1536
  page?: Page;
1423
1537
  filters?: BlogFilters;
@@ -1513,9 +1627,95 @@ type DateMeta = {
1513
1627
  created_on?: string;
1514
1628
  modified_on?: string;
1515
1629
  };
1516
- /** @returns {BlogRequest} */
1517
- declare function BlogRequest(): BlogRequest;
1518
- type BlogRequest = {
1630
+ /** @returns {DefaultSitemapIndividualConfig} */
1631
+ declare function DefaultSitemapIndividualConfig(): DefaultSitemapIndividualConfig;
1632
+ type DefaultSitemapIndividualConfig = {
1633
+ /**
1634
+ * - Whether sitemap configuration is enabled or
1635
+ * not for this sitemap configuration
1636
+ */
1637
+ enabled?: boolean;
1638
+ };
1639
+ /** @returns {DefaultSitemapConfig} */
1640
+ declare function DefaultSitemapConfig(): DefaultSitemapConfig;
1641
+ type DefaultSitemapConfig = {
1642
+ root?: DefaultSitemapIndividualConfig;
1643
+ brand?: DefaultSitemapIndividualConfig;
1644
+ collections?: DefaultSitemapIndividualConfig;
1645
+ category_l1?: DefaultSitemapIndividualConfig;
1646
+ category_l2?: DefaultSitemapIndividualConfig;
1647
+ category_l3?: DefaultSitemapIndividualConfig;
1648
+ pages?: DefaultSitemapIndividualConfig;
1649
+ blog?: DefaultSitemapIndividualConfig;
1650
+ section?: DefaultSitemapIndividualConfig;
1651
+ faq?: DefaultSitemapIndividualConfig;
1652
+ sitemap?: DefaultSitemapIndividualConfig;
1653
+ };
1654
+ /** @returns {SitemapConfigCreate} */
1655
+ declare function SitemapConfigCreate(): SitemapConfigCreate;
1656
+ type SitemapConfigCreate = {
1657
+ /**
1658
+ * - Unique identifier for the sitemap configuration
1659
+ */
1660
+ name?: string;
1661
+ /**
1662
+ * - Indicates if the sitemap configuration is active
1663
+ */
1664
+ is_active?: boolean;
1665
+ /**
1666
+ * - XML string containing sitemap data in base64 encoding
1667
+ */
1668
+ sitemap?: string;
1669
+ };
1670
+ /** @returns {SitemapConfig} */
1671
+ declare function SitemapConfig(): SitemapConfig;
1672
+ type SitemapConfig = {
1673
+ /**
1674
+ * - Unique identifier for the sitemap configuration
1675
+ */
1676
+ name?: string;
1677
+ /**
1678
+ * - Indicates if the sitemap configuration is
1679
+ * active or not in storefront
1680
+ */
1681
+ is_active?: boolean;
1682
+ /**
1683
+ * - XML string containing sitemap data in base64 encoding
1684
+ */
1685
+ sitemap?: string;
1686
+ /**
1687
+ * - Timestamp when the configuration was created
1688
+ */
1689
+ created_at?: string;
1690
+ /**
1691
+ * - Timestamp when the configuration was last updated
1692
+ */
1693
+ updated_at?: string;
1694
+ };
1695
+ /** @returns {SitemapConfigurationList} */
1696
+ declare function SitemapConfigurationList(): SitemapConfigurationList;
1697
+ type SitemapConfigurationList = {
1698
+ /**
1699
+ * - List of all Sitemap configurations
1700
+ */
1701
+ items?: SitemapConfig[];
1702
+ page?: Page;
1703
+ };
1704
+ /** @returns {SitemapConfigUpdate} */
1705
+ declare function SitemapConfigUpdate(): SitemapConfigUpdate;
1706
+ type SitemapConfigUpdate = {
1707
+ /**
1708
+ * - Indicates if the sitemap configuration is active
1709
+ */
1710
+ is_active?: boolean;
1711
+ /**
1712
+ * - XML string containing sitemap data
1713
+ */
1714
+ sitemap?: string;
1715
+ };
1716
+ /** @returns {BlogPayload} */
1717
+ declare function BlogPayload(): BlogPayload;
1718
+ type BlogPayload = {
1519
1719
  application?: string;
1520
1720
  _custom_json?: any;
1521
1721
  author?: Author;
@@ -1685,9 +1885,9 @@ declare function DataLoadersSchema(): DataLoadersSchema;
1685
1885
  type DataLoadersSchema = {
1686
1886
  items?: DataLoaderSchema[];
1687
1887
  };
1688
- /** @returns {TagDeleteSuccessResponse} */
1689
- declare function TagDeleteSuccessResponse(): TagDeleteSuccessResponse;
1690
- type TagDeleteSuccessResponse = {
1888
+ /** @returns {TagDeleteSuccessDetails} */
1889
+ declare function TagDeleteSuccessDetails(): TagDeleteSuccessDetails;
1890
+ type TagDeleteSuccessDetails = {
1691
1891
  success?: boolean;
1692
1892
  };
1693
1893
  /** @returns {ContentAPIError} */
@@ -1837,9 +2037,9 @@ type Page = {
1837
2037
  */
1838
2038
  size?: number;
1839
2039
  };
1840
- /** @returns {LandingPageGetResponse} */
1841
- declare function LandingPageGetResponse(): LandingPageGetResponse;
1842
- type LandingPageGetResponse = {
2040
+ /** @returns {LandingPageGetDetails} */
2041
+ declare function LandingPageGetDetails(): LandingPageGetDetails;
2042
+ type LandingPageGetDetails = {
1843
2043
  items?: LandingPageSchema[];
1844
2044
  page?: Page;
1845
2045
  };
@@ -1856,14 +2056,14 @@ type LandingPageSchema = {
1856
2056
  archived?: boolean;
1857
2057
  _custom_json?: any;
1858
2058
  };
1859
- /** @returns {DefaultNavigationResponse} */
1860
- declare function DefaultNavigationResponse(): DefaultNavigationResponse;
1861
- type DefaultNavigationResponse = {
2059
+ /** @returns {DefaultNavigationDetails} */
2060
+ declare function DefaultNavigationDetails(): DefaultNavigationDetails;
2061
+ type DefaultNavigationDetails = {
1862
2062
  items?: NavigationSchema[];
1863
2063
  };
1864
- /** @returns {NavigationGetResponse} */
1865
- declare function NavigationGetResponse(): NavigationGetResponse;
1866
- type NavigationGetResponse = {
2064
+ /** @returns {NavigationGetDetails} */
2065
+ declare function NavigationGetDetails(): NavigationGetDetails;
2066
+ type NavigationGetDetails = {
1867
2067
  items?: NavigationSchema[];
1868
2068
  page?: Page;
1869
2069
  };
@@ -1888,18 +2088,18 @@ type NavigationSchema = {
1888
2088
  version?: number;
1889
2089
  navigation?: NavigationReference[];
1890
2090
  };
1891
- /** @returns {NavigationRequest} */
1892
- declare function NavigationRequest(): NavigationRequest;
1893
- type NavigationRequest = {
2091
+ /** @returns {NavigationPayload} */
2092
+ declare function NavigationPayload(): NavigationPayload;
2093
+ type NavigationPayload = {
1894
2094
  name?: string;
1895
2095
  slug?: string;
1896
2096
  platform?: string[];
1897
2097
  orientation?: Orientation;
1898
2098
  navigation?: NavigationReference[];
1899
2099
  };
1900
- /** @returns {PageGetResponse} */
1901
- declare function PageGetResponse(): PageGetResponse;
1902
- type PageGetResponse = {
2100
+ /** @returns {PageGetDetails} */
2101
+ declare function PageGetDetails(): PageGetDetails;
2102
+ type PageGetDetails = {
1903
2103
  items?: PageSchema[];
1904
2104
  page?: Page;
1905
2105
  };
@@ -1957,9 +2157,9 @@ declare function CreatedBySchema(): CreatedBySchema;
1957
2157
  type CreatedBySchema = {
1958
2158
  id?: string;
1959
2159
  };
1960
- /** @returns {PageRequest} */
1961
- declare function PageRequest(): PageRequest;
1962
- type PageRequest = {
2160
+ /** @returns {PagePayload} */
2161
+ declare function PagePayload(): PagePayload;
2162
+ type PagePayload = {
1963
2163
  _schedule?: CronSchedule;
1964
2164
  application?: string;
1965
2165
  author?: Author;
@@ -1982,9 +2182,9 @@ type CronSchedule = {
1982
2182
  end?: string;
1983
2183
  duration?: number;
1984
2184
  };
1985
- /** @returns {PagePublishRequest} */
1986
- declare function PagePublishRequest(): PagePublishRequest;
1987
- type PagePublishRequest = {
2185
+ /** @returns {PagePublishPayload} */
2186
+ declare function PagePublishPayload(): PagePublishPayload;
2187
+ type PagePublishPayload = {
1988
2188
  publish?: boolean;
1989
2189
  };
1990
2190
  /** @returns {PageMetaSchema} */
@@ -1994,9 +2194,9 @@ type PageMetaSchema = {
1994
2194
  custom_pages?: PageSchema[];
1995
2195
  application_id?: string;
1996
2196
  };
1997
- /** @returns {SlideshowGetResponse} */
1998
- declare function SlideshowGetResponse(): SlideshowGetResponse;
1999
- type SlideshowGetResponse = {
2197
+ /** @returns {SlideshowGetDetails} */
2198
+ declare function SlideshowGetDetails(): SlideshowGetDetails;
2199
+ type SlideshowGetDetails = {
2000
2200
  items?: SlideshowSchema[];
2001
2201
  page?: Page;
2002
2202
  };
@@ -2014,9 +2214,9 @@ type SlideshowSchema = {
2014
2214
  archived?: boolean;
2015
2215
  _custom_json?: any;
2016
2216
  };
2017
- /** @returns {SlideshowRequest} */
2018
- declare function SlideshowRequest(): SlideshowRequest;
2019
- type SlideshowRequest = {
2217
+ /** @returns {SlideshowPayload} */
2218
+ declare function SlideshowPayload(): SlideshowPayload;
2219
+ type SlideshowPayload = {
2020
2220
  slug?: string;
2021
2221
  platform?: string;
2022
2222
  configuration?: ConfigurationSchema;
@@ -2116,99 +2316,310 @@ type ResourceSchema = {
2116
2316
  /** @returns {FieldValidations} */
2117
2317
  declare function FieldValidations(): FieldValidations;
2118
2318
  type FieldValidations = {
2319
+ /**
2320
+ * - Name of validation
2321
+ */
2119
2322
  name?: string;
2323
+ /**
2324
+ * - Type of validation
2325
+ */
2120
2326
  type?: string;
2121
2327
  value?: any;
2122
2328
  };
2123
2329
  /** @returns {FieldDefinitionSchema} */
2124
2330
  declare function FieldDefinitionSchema(): FieldDefinitionSchema;
2125
2331
  type FieldDefinitionSchema = {
2126
- _id?: string;
2127
- creator?: string;
2332
+ /**
2333
+ * - Unique system generated id
2334
+ */
2335
+ id?: string;
2336
+ /**
2337
+ * - Resource type to which custom field belongs
2338
+ */
2128
2339
  resource?: string;
2340
+ /**
2341
+ * - Name of custom field
2342
+ */
2129
2343
  name?: string;
2344
+ /**
2345
+ * - Namespace of custom field
2346
+ */
2130
2347
  namespace?: string;
2131
- key?: string;
2348
+ /**
2349
+ * - Slug of custom field
2350
+ */
2351
+ slug?: string;
2352
+ /**
2353
+ * - Description of custom field definition
2354
+ */
2132
2355
  description?: string;
2356
+ /**
2357
+ * - Data type of custom field
2358
+ */
2133
2359
  type?: string;
2360
+ /**
2361
+ * - Flag to denote whether custom field is
2362
+ * multivalued or not
2363
+ */
2134
2364
  multi_value?: boolean;
2365
+ /**
2366
+ * - List of validations applied
2367
+ */
2135
2368
  validations?: FieldValidations[];
2369
+ /**
2370
+ * - Id of company
2371
+ */
2136
2372
  company_id?: string;
2137
- created_by?: string;
2138
- updated_by?: string;
2373
+ /**
2374
+ * - Whether the custom field is required or not
2375
+ */
2139
2376
  required?: boolean;
2377
+ /**
2378
+ * - Whether the custom field is deleted or not
2379
+ */
2140
2380
  is_deleted?: boolean;
2141
- created_at?: string;
2142
- updated_at?: string;
2381
+ /**
2382
+ * - Type of type field
2383
+ */
2143
2384
  type_name?: string;
2385
+ /**
2386
+ * - Count of invalid fields after validation
2387
+ */
2144
2388
  invalid_fields_count?: number;
2145
2389
  };
2146
2390
  /** @returns {CustomFieldDefinitionsSchema} */
2147
2391
  declare function CustomFieldDefinitionsSchema(): CustomFieldDefinitionsSchema;
2148
2392
  type CustomFieldDefinitionsSchema = {
2393
+ /**
2394
+ * - List of custom field definitions
2395
+ */
2149
2396
  items?: FieldDefinitionSchema[];
2150
2397
  page?: Page;
2151
2398
  };
2152
2399
  /** @returns {CustomFieldDefinitionRequestSchema} */
2153
2400
  declare function CustomFieldDefinitionRequestSchema(): CustomFieldDefinitionRequestSchema;
2154
2401
  type CustomFieldDefinitionRequestSchema = {
2155
- resource?: string;
2402
+ /**
2403
+ * - Data type of custom field
2404
+ */
2156
2405
  type?: string;
2157
- key?: string;
2406
+ /**
2407
+ * - Slug of custom field definition
2408
+ */
2409
+ slug?: string;
2410
+ /**
2411
+ * - Namespace of custom field definition
2412
+ */
2158
2413
  namespace?: string;
2159
- multi_value?: boolean;
2414
+ /**
2415
+ * - Flag to denote whether custom field is
2416
+ * multi valued or not
2417
+ */
2418
+ multi_value?: boolean;
2419
+ /**
2420
+ * - Name of custom field definition
2421
+ */
2160
2422
  name?: string;
2423
+ /**
2424
+ * - Description of a custom field definition
2425
+ */
2161
2426
  description?: string;
2427
+ /**
2428
+ * - Validations for a custom field
2429
+ */
2162
2430
  validations?: FieldValidations[];
2163
2431
  };
2164
2432
  /** @returns {CustomObjectCustomFieldDefinitions} */
2165
2433
  declare function CustomObjectCustomFieldDefinitions(): CustomObjectCustomFieldDefinitions;
2166
2434
  type CustomObjectCustomFieldDefinitions = {
2435
+ /**
2436
+ * - Unique identifer for a custom field
2437
+ */
2167
2438
  id?: string;
2439
+ /**
2440
+ * - Data type of custom field
2441
+ */
2168
2442
  type?: string;
2443
+ /**
2444
+ * - Description of custom field
2445
+ */
2169
2446
  description?: string;
2447
+ /**
2448
+ * - Name of custom field
2449
+ */
2170
2450
  name?: string;
2451
+ /**
2452
+ * - Flag to denote if cusom field is multi
2453
+ * valued or not
2454
+ */
2171
2455
  multi_value?: boolean;
2456
+ /**
2457
+ * - Whether the field is required or not
2458
+ */
2172
2459
  required?: boolean;
2173
- key?: string;
2460
+ /**
2461
+ * - Slug of custom field definition
2462
+ */
2463
+ slug?: string;
2464
+ /**
2465
+ * - Validations added against the
2466
+ * custom field
2467
+ */
2174
2468
  validations?: FieldValidations[];
2175
2469
  action?: string;
2176
2470
  };
2177
2471
  /** @returns {CustomObjectDefinitionUpdateRequestSchema} */
2178
2472
  declare function CustomObjectDefinitionUpdateRequestSchema(): CustomObjectDefinitionUpdateRequestSchema;
2179
2473
  type CustomObjectDefinitionUpdateRequestSchema = {
2180
- type?: string;
2474
+ /**
2475
+ * - Description of custom object definiton
2476
+ */
2181
2477
  description?: string;
2478
+ /**
2479
+ * - Name of custom object definition
2480
+ */
2182
2481
  name?: string;
2482
+ /**
2483
+ * - Custom field slug which is used as a
2484
+ * display key in
2485
+ */
2183
2486
  display_name_key?: string;
2184
2487
  field_definitions?: CustomObjectCustomFieldDefinitions[];
2185
2488
  };
2186
2489
  /** @returns {CustomFieldDefinitionDetailResSchema} */
2187
2490
  declare function CustomFieldDefinitionDetailResSchema(): CustomFieldDefinitionDetailResSchema;
2188
2491
  type CustomFieldDefinitionDetailResSchema = {
2189
- creator?: string;
2492
+ /**
2493
+ * - Resource to which custom field is associated
2494
+ */
2190
2495
  resource?: string;
2496
+ /**
2497
+ * - Name of custom field
2498
+ */
2191
2499
  name?: string;
2500
+ /**
2501
+ * - Namespace of custom field
2502
+ */
2192
2503
  namespace?: string;
2193
- key?: string;
2504
+ /**
2505
+ * - Slug of custom field
2506
+ */
2507
+ slug?: string;
2508
+ /**
2509
+ * - Description regarding custom field
2510
+ */
2194
2511
  description?: string;
2512
+ /**
2513
+ * - Data type of custom field
2514
+ */
2195
2515
  type?: string;
2516
+ /**
2517
+ * - Flag to denote whether custom field is
2518
+ * multi valued or not
2519
+ */
2196
2520
  multi_value?: boolean;
2521
+ /**
2522
+ * - Company Identifer
2523
+ */
2197
2524
  company_id?: string;
2525
+ /**
2526
+ * - Sales channel identifier
2527
+ */
2198
2528
  application_id?: string;
2199
- created_by?: string;
2200
- updated_by?: string;
2529
+ /**
2530
+ * - Whether the customfield is required or not
2531
+ */
2201
2532
  required?: boolean;
2533
+ /**
2534
+ * - Is custom field deleted
2535
+ */
2202
2536
  is_deleted?: boolean;
2203
- _id?: string;
2537
+ /**
2538
+ * - Unique system generated id
2539
+ */
2540
+ id?: string;
2541
+ validations?: any[];
2542
+ /**
2543
+ * - Date time at which field was created
2544
+ */
2545
+ created_at?: string;
2546
+ /**
2547
+ * - Date time at for a field's last modification
2548
+ */
2549
+ updated_at?: string;
2550
+ };
2551
+ /** @returns {MetaFieldDefinitionDetailResSchema} */
2552
+ declare function MetaFieldDefinitionDetailResSchema(): MetaFieldDefinitionDetailResSchema;
2553
+ type MetaFieldDefinitionDetailResSchema = {
2554
+ /**
2555
+ * - Resource to which meta field is associated
2556
+ */
2557
+ resource?: string;
2558
+ /**
2559
+ * - Name of meta field
2560
+ */
2561
+ name?: string;
2562
+ /**
2563
+ * - Namespace of meta field
2564
+ */
2565
+ namespace?: string;
2566
+ /**
2567
+ * - Slug of meta field
2568
+ */
2569
+ slug?: string;
2570
+ /**
2571
+ * - Description regarding meta field
2572
+ */
2573
+ description?: string;
2574
+ /**
2575
+ * - Data type of meta field
2576
+ */
2577
+ type?: string;
2578
+ /**
2579
+ * - Flag to denote whether meta field is
2580
+ * multi valued or not
2581
+ */
2582
+ multi_value?: boolean;
2583
+ /**
2584
+ * - Company Identifer
2585
+ */
2586
+ company_id?: string;
2587
+ /**
2588
+ * - Sales channel identifier
2589
+ */
2590
+ application_id?: string;
2591
+ /**
2592
+ * - Whether the field is required or not
2593
+ */
2594
+ required?: boolean;
2595
+ /**
2596
+ * - Is meta field deleted
2597
+ */
2598
+ is_deleted?: boolean;
2599
+ /**
2600
+ * - Unique system generated id
2601
+ */
2602
+ id?: string;
2204
2603
  validations?: any[];
2604
+ /**
2605
+ * - Date time at which field was created
2606
+ */
2205
2607
  created_at?: string;
2608
+ /**
2609
+ * - Date time at for a field's last modification
2610
+ */
2206
2611
  updated_at?: string;
2207
2612
  };
2208
2613
  /** @returns {CustomDataDeleteSchema} */
2209
2614
  declare function CustomDataDeleteSchema(): CustomDataDeleteSchema;
2210
2615
  type CustomDataDeleteSchema = {
2616
+ /**
2617
+ * - Denotes the success of the delete operation
2618
+ */
2211
2619
  success?: boolean;
2620
+ /**
2621
+ * - Denotes the message of delete operation
2622
+ */
2212
2623
  message?: string;
2213
2624
  };
2214
2625
  /** @returns {CustomFieldValue} */
@@ -2219,22 +2630,52 @@ type CustomFieldValue = {
2219
2630
  /** @returns {CustomFieldSchema} */
2220
2631
  declare function CustomFieldSchema(): CustomFieldSchema;
2221
2632
  type CustomFieldSchema = {
2222
- _id?: string;
2633
+ /**
2634
+ * - Unique system generated id
2635
+ */
2636
+ id?: string;
2637
+ /**
2638
+ * - Namespace of custom field definition
2639
+ */
2223
2640
  namespace?: string;
2224
- key?: string;
2641
+ /**
2642
+ * - Slug of custom field definition
2643
+ */
2644
+ slug?: string;
2645
+ /**
2646
+ * - The resource for which custom field is being created
2647
+ */
2225
2648
  resource?: string;
2226
- creator?: string;
2227
2649
  value?: CustomFieldValue[];
2228
- resource_id?: string;
2650
+ /**
2651
+ * - Unique identifier of the resource
2652
+ */
2653
+ resource_slug?: string;
2654
+ /**
2655
+ * - Data type of custom field
2656
+ */
2229
2657
  type?: string;
2658
+ /**
2659
+ * - Whether custom field is multi valued
2660
+ */
2230
2661
  multi_value?: boolean;
2662
+ /**
2663
+ * - Identifer for a company
2664
+ */
2231
2665
  company_id?: string;
2232
- definition_id?: string;
2233
2666
  has_invalid_values?: boolean;
2234
2667
  invalid_value_errors?: any[];
2235
- created_by?: string;
2668
+ /**
2669
+ * - Indicates whether custom field is deleted
2670
+ */
2236
2671
  is_deleted?: boolean;
2672
+ /**
2673
+ * - Time at which customer field was created
2674
+ */
2237
2675
  created_at?: string;
2676
+ /**
2677
+ * - Time at which custom field was updated
2678
+ */
2238
2679
  updated_at?: string;
2239
2680
  };
2240
2681
  /** @returns {CustomFieldsResponseSchema} */
@@ -2243,6 +2684,12 @@ type CustomFieldsResponseSchema = {
2243
2684
  items?: CustomFieldSchema[];
2244
2685
  page?: Page;
2245
2686
  };
2687
+ /** @returns {CustomFieldsDeleteSchema} */
2688
+ declare function CustomFieldsDeleteSchema(): CustomFieldsDeleteSchema;
2689
+ type CustomFieldsDeleteSchema = {
2690
+ success?: boolean;
2691
+ message?: string;
2692
+ };
2246
2693
  /** @returns {CustomFieldsResponseByResourceIdSchema} */
2247
2694
  declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseByResourceIdSchema;
2248
2695
  type CustomFieldsResponseByResourceIdSchema = {
@@ -2252,7 +2699,15 @@ type CustomFieldsResponseByResourceIdSchema = {
2252
2699
  declare function CustomField(): CustomField;
2253
2700
  type CustomField = {
2254
2701
  value?: any[];
2255
- definition_id?: string;
2702
+ /**
2703
+ * - This is the namespace to which custom field belongs
2704
+ */
2705
+ namespace?: string;
2706
+ /**
2707
+ * - This is the slug of custom field used while
2708
+ * creating a custom field definition
2709
+ */
2710
+ slug?: string;
2256
2711
  };
2257
2712
  /** @returns {CustomFieldRequestSchema} */
2258
2713
  declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
@@ -2262,160 +2717,368 @@ type CustomFieldRequestSchema = {
2262
2717
  /** @returns {CustomObjectSchema} */
2263
2718
  declare function CustomObjectSchema(): CustomObjectSchema;
2264
2719
  type CustomObjectSchema = {
2265
- _id?: string;
2266
- creator?: string;
2720
+ /**
2721
+ * - Unique system generated id
2722
+ */
2723
+ id?: string;
2724
+ /**
2725
+ * - Identifer for a company
2726
+ */
2267
2727
  company_id?: string;
2728
+ /**
2729
+ * - Identifer for a sales channel
2730
+ */
2268
2731
  application_id?: string;
2269
- created_by?: string;
2270
- updated_by?: string;
2732
+ /**
2733
+ * - Status of custom object
2734
+ */
2271
2735
  status?: string;
2736
+ /**
2737
+ * - Slug of custom object definition
2738
+ */
2272
2739
  type?: string;
2740
+ /**
2741
+ * - Slug for custom object definition
2742
+ */
2743
+ definition_slug?: string;
2744
+ /**
2745
+ * - Value of custom field used for displaying
2746
+ * custom object
2747
+ */
2273
2748
  display_name?: string;
2274
- definition_id?: string;
2749
+ /**
2750
+ * - Fields associated to the custom object
2751
+ */
2275
2752
  fields?: CustomFieldSchema[];
2276
2753
  };
2277
2754
  /** @returns {CustomObjectDefinitionRequestSchema} */
2278
2755
  declare function CustomObjectDefinitionRequestSchema(): CustomObjectDefinitionRequestSchema;
2279
2756
  type CustomObjectDefinitionRequestSchema = {
2757
+ /**
2758
+ * - Namespace/Slug of Custom object definition
2759
+ */
2280
2760
  type?: string;
2761
+ /**
2762
+ * - Unique slug for a custom object definition
2763
+ */
2764
+ definition_slug?: string;
2765
+ /**
2766
+ * - Description of custom object definition
2767
+ */
2281
2768
  description?: string;
2769
+ /**
2770
+ * - Name of custom object
2771
+ */
2282
2772
  name?: string;
2773
+ /**
2774
+ * - Denotes which custom field to be used
2775
+ * for displaying custom object
2776
+ */
2283
2777
  display_name_key?: string;
2778
+ /**
2779
+ * - List
2780
+ * of custom field definitions belonging to this custom object definition
2781
+ */
2284
2782
  field_definitions?: CustomObjectCustomFieldDefinitions[];
2285
2783
  };
2286
- /** @returns {CustomObjectCustomFieldDefinitionResSchema} */
2287
- declare function CustomObjectCustomFieldDefinitionResSchema(): CustomObjectCustomFieldDefinitionResSchema;
2288
- type CustomObjectCustomFieldDefinitionResSchema = {
2289
- creator?: string;
2290
- resource?: string;
2291
- name?: string;
2292
- namespace?: string;
2293
- key?: string;
2294
- description?: string;
2295
- type?: string;
2296
- multi_value?: boolean;
2297
- validations?: FieldValidations[];
2298
- company_id?: string;
2299
- created_by?: string;
2300
- metaobject_definition_id?: string;
2301
- required?: boolean;
2302
- is_deleted?: boolean;
2303
- _id?: string;
2304
- created_at?: string;
2305
- updated_at?: string;
2306
- };
2307
- /** @returns {CustomObjectDefinitionSchema} */
2308
- declare function CustomObjectDefinitionSchema(): CustomObjectDefinitionSchema;
2309
- type CustomObjectDefinitionSchema = {
2310
- _id?: string;
2784
+ /** @returns {CustomObjectDefinitionSlugSchema} */
2785
+ declare function CustomObjectDefinitionSlugSchema(): CustomObjectDefinitionSlugSchema;
2786
+ type CustomObjectDefinitionSlugSchema = {
2787
+ /**
2788
+ * - Unique system generated custom object definition id
2789
+ */
2790
+ id?: string;
2791
+ /**
2792
+ * - Display name of custom object definition
2793
+ */
2311
2794
  name?: string;
2795
+ /**
2796
+ * - Type of custom object definiton
2797
+ */
2312
2798
  type?: string;
2799
+ /**
2800
+ * - Slug of custom object definiton
2801
+ */
2802
+ definition_slug?: string;
2803
+ /**
2804
+ * - Display name of custom object definition
2805
+ */
2313
2806
  display_name_key?: string;
2807
+ /**
2808
+ * - Description of custom object definition
2809
+ */
2314
2810
  description?: string;
2315
- creator?: string;
2316
- created_by?: string;
2317
- updated_by?: string;
2318
- field_definitions?: CustomObjectCustomFieldDefinitionResSchema[];
2811
+ /**
2812
+ * -
2813
+ * Custom fields inside custom objects
2814
+ */
2815
+ field_definitions?: CustomFieldDefinitionDetailResSchema[];
2319
2816
  };
2320
2817
  /** @returns {CustomObjectDefinitionDeleteResponseSchema} */
2321
2818
  declare function CustomObjectDefinitionDeleteResponseSchema(): CustomObjectDefinitionDeleteResponseSchema;
2322
2819
  type CustomObjectDefinitionDeleteResponseSchema = {
2820
+ /**
2821
+ * - Success status of delete custom object definition.
2822
+ */
2323
2823
  success?: boolean;
2824
+ /**
2825
+ * - Response message when custom object definition
2826
+ * is deleted.
2827
+ */
2324
2828
  message?: string;
2325
2829
  };
2326
- /** @returns {CustomObjectEntryBulkUploadResponse} */
2327
- declare function CustomObjectEntryBulkUploadResponse(): CustomObjectEntryBulkUploadResponse;
2328
- type CustomObjectEntryBulkUploadResponse = {
2830
+ /** @returns {CustomObjectEntryBulkUploadDetails} */
2831
+ declare function CustomObjectEntryBulkUploadDetails(): CustomObjectEntryBulkUploadDetails;
2832
+ type CustomObjectEntryBulkUploadDetails = {
2833
+ /**
2834
+ * - Signed url of csv
2835
+ */
2329
2836
  url?: string;
2837
+ /**
2838
+ * - Total no of records in csv file
2839
+ */
2330
2840
  total_records?: number;
2331
2841
  };
2332
- /** @returns {CustomObjectListItemDefinationSchema} */
2333
- declare function CustomObjectListItemDefinationSchema(): CustomObjectListItemDefinationSchema;
2334
- type CustomObjectListItemDefinationSchema = {
2335
- _id?: string;
2842
+ /** @returns {CustomObjectListItemDefinitionModel} */
2843
+ declare function CustomObjectListItemDefinitionModel(): CustomObjectListItemDefinitionModel;
2844
+ type CustomObjectListItemDefinitionModel = {
2845
+ /**
2846
+ * - Unique system generated id
2847
+ */
2848
+ id?: string;
2849
+ /**
2850
+ * - Name of custom object
2851
+ */
2336
2852
  name?: string;
2853
+ /**
2854
+ * - Type of custom object entry
2855
+ */
2337
2856
  type?: string;
2338
2857
  };
2339
2858
  /** @returns {CustomObjectListItemSchema} */
2340
2859
  declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
2341
2860
  type CustomObjectListItemSchema = {
2342
- _id?: string;
2343
- definition_id?: string;
2861
+ /**
2862
+ * - Unique system generated id
2863
+ */
2864
+ id?: string;
2865
+ /**
2866
+ * - Status of custom object
2867
+ */
2344
2868
  status?: string;
2869
+ /**
2870
+ * - Creation time of custom object document
2871
+ */
2872
+ created_at?: string;
2873
+ /**
2874
+ * - Updation time of custom object document
2875
+ */
2345
2876
  updated_at?: string;
2877
+ /**
2878
+ * - Display name of custom object
2879
+ */
2346
2880
  display_name?: string;
2347
- definition?: CustomObjectListItemDefinationSchema;
2881
+ definition?: CustomObjectListItemDefinitionModel;
2882
+ /**
2883
+ * - References of the custom object entry
2884
+ */
2348
2885
  references?: number;
2349
2886
  };
2350
2887
  /** @returns {CustomObjectsSchema} */
2351
2888
  declare function CustomObjectsSchema(): CustomObjectsSchema;
2352
2889
  type CustomObjectsSchema = {
2890
+ /**
2891
+ * - List of paginated custom
2892
+ * object entries
2893
+ */
2353
2894
  items?: CustomObjectListItemSchema[];
2354
2895
  page?: Page;
2355
2896
  };
2356
- /** @returns {CustomObjectFieldSchema} */
2357
- declare function CustomObjectFieldSchema(): CustomObjectFieldSchema;
2358
- type CustomObjectFieldSchema = {
2359
- _id?: string;
2360
- key?: string;
2897
+ /** @returns {CustomObjectFieldDefinition} */
2898
+ declare function CustomObjectFieldDefinition(): CustomObjectFieldDefinition;
2899
+ type CustomObjectFieldDefinition = {
2900
+ /**
2901
+ * - Unique system generate id
2902
+ */
2903
+ id?: string;
2904
+ /**
2905
+ * - Slug of custom field definition
2906
+ */
2907
+ slug?: string;
2908
+ /**
2909
+ * - Namespace of custom field definition
2910
+ */
2911
+ namespace?: string;
2912
+ /**
2913
+ * - Value of custom field
2914
+ */
2361
2915
  value?: any[];
2916
+ /**
2917
+ * - Data type of the custom field
2918
+ */
2362
2919
  type?: string;
2363
- definition_id?: string;
2364
2920
  };
2365
- /** @returns {CustomObjectByIdSchema} */
2366
- declare function CustomObjectByIdSchema(): CustomObjectByIdSchema;
2367
- type CustomObjectByIdSchema = {
2368
- _id?: string;
2921
+ /** @returns {CustomObjectBySlugSchema} */
2922
+ declare function CustomObjectBySlugSchema(): CustomObjectBySlugSchema;
2923
+ type CustomObjectBySlugSchema = {
2924
+ /**
2925
+ * - Unique system generated identifer for a Custom Object
2926
+ */
2927
+ id?: string;
2928
+ /**
2929
+ * - Status of Custom Object
2930
+ */
2369
2931
  status?: string;
2932
+ /**
2933
+ * - Display name for the Custom Object
2934
+ */
2370
2935
  display_name?: string;
2371
- definition?: CustomObjectListItemDefinationSchema;
2936
+ definition?: CustomObjectListItemDefinitionModel;
2937
+ /**
2938
+ * - Places where the custom object has been
2939
+ * used as a custom field
2940
+ */
2372
2941
  references?: any[];
2373
- fields?: CustomObjectFieldSchema[];
2942
+ /**
2943
+ * - Slug of custom object entry
2944
+ */
2945
+ slug?: string;
2946
+ /**
2947
+ * - Slug of custom object definition
2948
+ */
2949
+ definition_slug?: string;
2950
+ /**
2951
+ * - List of custom fields
2952
+ * inside the custom object
2953
+ */
2954
+ fields?: CustomObjectFieldDefinition[];
2374
2955
  };
2375
2956
  /** @returns {CustomObjectBulkEntryInitiateDownload} */
2376
2957
  declare function CustomObjectBulkEntryInitiateDownload(): CustomObjectBulkEntryInitiateDownload;
2377
2958
  type CustomObjectBulkEntryInitiateDownload = {
2959
+ /**
2960
+ * - Message for the user
2961
+ */
2378
2962
  message?: string;
2963
+ /**
2964
+ * - Identifer for a task
2965
+ */
2379
2966
  task_id?: string;
2380
2967
  };
2381
2968
  /** @returns {CustomObjectMetaSchema} */
2382
2969
  declare function CustomObjectMetaSchema(): CustomObjectMetaSchema;
2383
2970
  type CustomObjectMetaSchema = {
2971
+ /**
2972
+ * - Total number of entries in the bulk entry
2973
+ */
2384
2974
  mo_total_count?: number;
2975
+ /**
2976
+ * - Number of entries which were successful
2977
+ */
2385
2978
  mo_success_count?: number;
2979
+ /**
2980
+ * - Number of entries which were failed
2981
+ */
2386
2982
  mo_error_count?: number;
2983
+ /**
2984
+ * - Type of object
2985
+ */
2387
2986
  mo_defintion_type?: string;
2388
2987
  };
2389
- /** @returns {CustomObjectJobSchema} */
2390
- declare function CustomObjectJobSchema(): CustomObjectJobSchema;
2391
- type CustomObjectJobSchema = {
2392
- _id?: string;
2988
+ /** @returns {JobSchema} */
2989
+ declare function JobSchema(): JobSchema;
2990
+ type JobSchema = {
2991
+ /**
2992
+ * - Unique system generated id
2993
+ */
2994
+ id?: string;
2995
+ /**
2996
+ * - List of total jobs
2997
+ */
2393
2998
  jobs?: string[];
2999
+ /**
3000
+ * - List of finished jobs
3001
+ */
2394
3002
  finished_jobs?: string[];
3003
+ /**
3004
+ * - List of jobs which resulted in an error
3005
+ */
2395
3006
  error_jobs?: string[];
3007
+ /**
3008
+ * - List of errors occurred in the job
3009
+ */
2396
3010
  errors_occured?: string[];
3011
+ /**
3012
+ * - Company Identifer
3013
+ */
2397
3014
  company_id?: string;
2398
- creator?: string;
2399
- url?: string;
3015
+ /**
3016
+ * - Status of job
3017
+ */
2400
3018
  status?: string;
3019
+ /**
3020
+ * - Type of job
3021
+ */
2401
3022
  action_type?: string;
3023
+ /**
3024
+ * - Entity against which job is running
3025
+ */
2402
3026
  entity?: string;
3027
+ /**
3028
+ * - URL which contains the file with errors
3029
+ */
2403
3030
  error_url?: string;
3031
+ /**
3032
+ * - Number of items successfully finished
3033
+ */
2404
3034
  finished_count?: number;
3035
+ /**
3036
+ * - Number of items in error
3037
+ */
2405
3038
  error_count?: number;
3039
+ /**
3040
+ * - Number of successful items
3041
+ */
2406
3042
  success_count?: number;
3043
+ /**
3044
+ * - Total number of jobs
3045
+ */
2407
3046
  total_jobs?: number;
2408
3047
  meta?: CustomObjectMetaSchema;
3048
+ /**
3049
+ * - Source from where the bulk job is created
3050
+ */
2409
3051
  created_by?: string;
3052
+ /**
3053
+ * - Date/Time when the job was created
3054
+ */
2410
3055
  created_at?: string;
3056
+ /**
3057
+ * - Date/Time when the job was updated
3058
+ */
2411
3059
  updated_at?: string;
3060
+ /**
3061
+ * - Sales Channel Identifier
3062
+ */
3063
+ application_id?: string;
3064
+ };
3065
+ /** @returns {CustomFieldBulkEntry} */
3066
+ declare function CustomFieldBulkEntry(): CustomFieldBulkEntry;
3067
+ type CustomFieldBulkEntry = {
3068
+ items?: JobSchema[];
3069
+ page?: Page;
2412
3070
  };
2413
3071
  /** @returns {CustomObjectBulkEntry} */
2414
3072
  declare function CustomObjectBulkEntry(): CustomObjectBulkEntry;
2415
3073
  type CustomObjectBulkEntry = {
2416
- items?: CustomObjectJobSchema[];
3074
+ items?: JobSchema[];
2417
3075
  page?: Page;
2418
3076
  };
3077
+ /** @returns {MetafieldTypesSchema} */
3078
+ declare function MetafieldTypesSchema(): MetafieldTypesSchema;
3079
+ type MetafieldTypesSchema = {
3080
+ metafield_types?: CustomFieldTypeSchema;
3081
+ };
2419
3082
  /** @returns {CustomFieldTypeSchema} */
2420
3083
  declare function CustomFieldTypeSchema(): CustomFieldTypeSchema;
2421
3084
  type CustomFieldTypeSchema = {
@@ -2432,6 +3095,8 @@ type CustomFieldTypeSchema = {
2432
3095
  url?: Url;
2433
3096
  metaobject?: Metaobject;
2434
3097
  product?: Product;
3098
+ html?: HTML;
3099
+ duration?: Duration;
2435
3100
  };
2436
3101
  /** @returns {SupportedValidationsMetaExampleSchema} */
2437
3102
  declare function SupportedValidationsMetaExampleSchema(): SupportedValidationsMetaExampleSchema;
@@ -2453,130 +3118,392 @@ type SupportedValidationsSchema = {
2453
3118
  required?: boolean;
2454
3119
  meta?: SupportedValidationsMetaSchema;
2455
3120
  };
3121
+ /** @returns {Duration} */
3122
+ declare function Duration(): Duration;
3123
+ type Duration = {
3124
+ /**
3125
+ * - Name data type of custom field
3126
+ */
3127
+ name?: string;
3128
+ /**
3129
+ * - Flag for listing enabled or not
3130
+ */
3131
+ list_enabled?: boolean;
3132
+ /**
3133
+ * - Type of custom field
3134
+ */
3135
+ type?: string;
3136
+ /**
3137
+ * - Category of custom field
3138
+ */
3139
+ category?: string;
3140
+ /**
3141
+ * - List of
3142
+ * validations available for the field
3143
+ */
3144
+ supported_validations?: SupportedValidationsSchema[];
3145
+ };
3146
+ /** @returns {HTML} */
3147
+ declare function HTML(): HTML;
3148
+ type HTML = {
3149
+ /**
3150
+ * - Name data type of custom field
3151
+ */
3152
+ name?: string;
3153
+ /**
3154
+ * - Flag for listing enabled or not
3155
+ */
3156
+ list_enabled?: boolean;
3157
+ /**
3158
+ * - Type of custom field
3159
+ */
3160
+ type?: string;
3161
+ /**
3162
+ * - List of
3163
+ * validations available for the field
3164
+ */
3165
+ supported_validations?: SupportedValidationsSchema[];
3166
+ };
2456
3167
  /** @returns {StringSingleLine} */
2457
3168
  declare function StringSingleLine(): StringSingleLine;
2458
3169
  type StringSingleLine = {
3170
+ /**
3171
+ * - Name data type of custom field
3172
+ */
2459
3173
  name?: string;
3174
+ /**
3175
+ * - Flag for listing enabled or not
3176
+ */
2460
3177
  list_enabled?: boolean;
3178
+ /**
3179
+ * - Category of custom field
3180
+ */
2461
3181
  category?: string;
3182
+ /**
3183
+ * - Type of custom field
3184
+ */
2462
3185
  type?: string;
3186
+ /**
3187
+ * - List of
3188
+ * validations available for the field
3189
+ */
2463
3190
  supported_validations?: SupportedValidationsSchema[];
2464
3191
  };
2465
3192
  /** @returns {StringMultiLine} */
2466
3193
  declare function StringMultiLine(): StringMultiLine;
2467
3194
  type StringMultiLine = {
3195
+ /**
3196
+ * - Name data type of custom field
3197
+ */
2468
3198
  name?: string;
3199
+ /**
3200
+ * - Flag for listing enabled or not
3201
+ */
2469
3202
  list_enabled?: boolean;
3203
+ /**
3204
+ * - Category of custom field
3205
+ */
2470
3206
  category?: string;
3207
+ /**
3208
+ * - Type of custom field
3209
+ */
2471
3210
  type?: string;
3211
+ /**
3212
+ * - List of
3213
+ * validations available for the field
3214
+ */
2472
3215
  supported_validations?: SupportedValidationsSchema[];
2473
3216
  };
2474
3217
  /** @returns {Dropdown} */
2475
3218
  declare function Dropdown(): Dropdown;
2476
3219
  type Dropdown = {
3220
+ /**
3221
+ * - Name data type of custom field
3222
+ */
2477
3223
  name?: string;
3224
+ /**
3225
+ * - Flag for listing enabled or not
3226
+ */
2478
3227
  list_enabled?: boolean;
3228
+ /**
3229
+ * - Category of custom field
3230
+ */
2479
3231
  category?: string;
3232
+ /**
3233
+ * - Category of custom field
3234
+ */
2480
3235
  type?: string;
3236
+ /**
3237
+ * - List of
3238
+ * validations available for the field
3239
+ */
2481
3240
  supported_validations?: SupportedValidationsSchema[];
2482
3241
  };
2483
3242
  /** @returns {Integer} */
2484
3243
  declare function Integer(): Integer;
2485
3244
  type Integer = {
3245
+ /**
3246
+ * - Name data type of custom field
3247
+ */
2486
3248
  name?: string;
3249
+ /**
3250
+ * - Flag for listing enabled or not
3251
+ */
2487
3252
  list_enabled?: boolean;
3253
+ /**
3254
+ * - Type of custom field
3255
+ */
2488
3256
  type?: string;
3257
+ /**
3258
+ * - Category of custom field
3259
+ */
2489
3260
  category?: string;
3261
+ /**
3262
+ * - List of
3263
+ * validations available for the field
3264
+ */
2490
3265
  supported_validations?: SupportedValidationsSchema[];
2491
3266
  };
2492
3267
  /** @returns {FloatType} */
2493
3268
  declare function FloatType(): FloatType;
2494
3269
  type FloatType = {
3270
+ /**
3271
+ * - Name data type of custom field
3272
+ */
2495
3273
  name?: string;
3274
+ /**
3275
+ * - Flag for listing enabled or not
3276
+ */
2496
3277
  list_enabled?: boolean;
3278
+ /**
3279
+ * - Type of custom field
3280
+ */
2497
3281
  type?: string;
3282
+ /**
3283
+ * - Category of custom field
3284
+ */
2498
3285
  category?: string;
3286
+ /**
3287
+ * - List of
3288
+ * validations available for the field
3289
+ */
2499
3290
  supported_validations?: SupportedValidationsSchema[];
2500
3291
  };
2501
3292
  /** @returns {BooleanType} */
2502
3293
  declare function BooleanType(): BooleanType;
2503
3294
  type BooleanType = {
3295
+ /**
3296
+ * - Name data type of custom field
3297
+ */
2504
3298
  name?: string;
3299
+ /**
3300
+ * - Category of custom field
3301
+ */
2505
3302
  category?: string;
3303
+ /**
3304
+ * - Flag for listing enabled or not
3305
+ */
2506
3306
  list_enabled?: boolean;
3307
+ /**
3308
+ * - Category of custom field
3309
+ */
2507
3310
  type?: string;
3311
+ /**
3312
+ * - List of
3313
+ * validations available for the field
3314
+ */
2508
3315
  supported_validations?: SupportedValidationsSchema[];
2509
3316
  };
2510
3317
  /** @returns {Date} */
2511
3318
  declare function Date(): Date;
2512
3319
  type Date = {
3320
+ /**
3321
+ * - Name data type of custom field
3322
+ */
2513
3323
  name?: string;
3324
+ /**
3325
+ * - Flag for listing enabled or not
3326
+ */
2514
3327
  list_enabled?: boolean;
3328
+ /**
3329
+ * - Category of custom field
3330
+ */
2515
3331
  category?: string;
3332
+ /**
3333
+ * - Type of custom field
3334
+ */
2516
3335
  type?: string;
3336
+ /**
3337
+ * - List of
3338
+ * validations available for the field
3339
+ */
2517
3340
  supported_validations?: SupportedValidationsSchema[];
2518
3341
  };
2519
3342
  /** @returns {Datetime} */
2520
3343
  declare function Datetime(): Datetime;
2521
3344
  type Datetime = {
3345
+ /**
3346
+ * - Name data type of custom field
3347
+ */
2522
3348
  name?: string;
3349
+ /**
3350
+ * - Category of custom field
3351
+ */
2523
3352
  category?: string;
3353
+ /**
3354
+ * - Flag for listing enabled or not
3355
+ */
2524
3356
  list_enabled?: boolean;
3357
+ /**
3358
+ * - Type of custom field
3359
+ */
2525
3360
  type?: string;
3361
+ /**
3362
+ * - List of
3363
+ * validations available for the field
3364
+ */
2526
3365
  supported_validations?: SupportedValidationsSchema[];
2527
3366
  };
2528
3367
  /** @returns {Json} */
2529
3368
  declare function Json(): Json;
2530
3369
  type Json = {
3370
+ /**
3371
+ * - Name data type of custom field
3372
+ */
2531
3373
  name?: string;
3374
+ /**
3375
+ * - Flag for listing enabled or not
3376
+ */
2532
3377
  list_enabled?: boolean;
3378
+ /**
3379
+ * - Category of custom field
3380
+ */
2533
3381
  category?: string;
3382
+ /**
3383
+ * - Type of custom field
3384
+ */
2534
3385
  type?: string;
3386
+ /**
3387
+ * - List of
3388
+ * validations available for the field
3389
+ */
2535
3390
  supported_validations?: SupportedValidationsSchema[];
2536
3391
  };
2537
3392
  /** @returns {File} */
2538
3393
  declare function File(): File;
2539
3394
  type File = {
3395
+ /**
3396
+ * - Name data type of custom field
3397
+ */
2540
3398
  name?: string;
3399
+ /**
3400
+ * - Category of custom field
3401
+ */
2541
3402
  category?: string;
3403
+ /**
3404
+ * - Flag for listing enabled or not
3405
+ */
2542
3406
  list_enabled?: boolean;
3407
+ /**
3408
+ * - Type of custom field
3409
+ */
2543
3410
  type?: string;
2544
3411
  supported_validations?: SupportedValidationsSchema[];
2545
3412
  };
2546
3413
  /** @returns {Url} */
2547
3414
  declare function Url(): Url;
2548
3415
  type Url = {
3416
+ /**
3417
+ * - Name data type of custom field
3418
+ */
2549
3419
  name?: string;
3420
+ /**
3421
+ * - Flag for listing enabled or not
3422
+ */
2550
3423
  list_enabled?: boolean;
3424
+ /**
3425
+ * - Type of custom field
3426
+ */
2551
3427
  type?: string;
3428
+ /**
3429
+ * - List of
3430
+ * validations available for the field
3431
+ */
2552
3432
  supported_validations?: SupportedValidationsSchema[];
2553
3433
  };
2554
3434
  /** @returns {Metaobject} */
2555
3435
  declare function Metaobject(): Metaobject;
2556
3436
  type Metaobject = {
3437
+ /**
3438
+ * - Name of Custom Object
3439
+ */
2557
3440
  name?: string;
3441
+ /**
3442
+ * - Whether the field is allowed to have
3443
+ * multiple list items
3444
+ */
2558
3445
  list_enabled?: boolean;
3446
+ /**
3447
+ * - Category of Custom Object Definition that
3448
+ * Custom Object belongs to
3449
+ */
2559
3450
  category?: string;
3451
+ /**
3452
+ * - Type of Custom Object Definition
3453
+ */
2560
3454
  type?: string;
2561
3455
  supported_validations?: SupportedValidationsSchema[];
2562
3456
  };
2563
3457
  /** @returns {Product} */
2564
3458
  declare function Product(): Product;
2565
3459
  type Product = {
3460
+ /**
3461
+ * - Name of Product
3462
+ */
2566
3463
  name?: string;
3464
+ /**
3465
+ * - Whether the field is allowed to have
3466
+ * multiple list items
3467
+ */
2567
3468
  list_enabled?: boolean;
3469
+ /**
3470
+ * - Category of Custom Object Definition that
3471
+ * Product is associated with
3472
+ */
2568
3473
  category?: string;
3474
+ /**
3475
+ * - Custom Object Definition that Product is associated with
3476
+ */
2569
3477
  type?: string;
2570
3478
  supported_validations?: SupportedValidationsSchema[];
2571
3479
  };
2572
3480
  /** @returns {CustomObjectEntry} */
2573
3481
  declare function CustomObjectEntry(): CustomObjectEntry;
2574
3482
  type CustomObjectEntry = {
2575
- _id?: string;
3483
+ /**
3484
+ * - Unique system generated id
3485
+ */
3486
+ id?: string;
3487
+ /**
3488
+ * - Name of Custom Object definition
3489
+ */
2576
3490
  name?: string;
3491
+ /**
3492
+ * - Type of Custom Object Definition
3493
+ */
2577
3494
  type?: string;
3495
+ /**
3496
+ * - Updation time of a Custom Object
3497
+ */
2578
3498
  updated_at?: string;
3499
+ /**
3500
+ * - Number of entries against the Custom
3501
+ * Object definition
3502
+ */
2579
3503
  entries_count?: number;
3504
+ /**
3505
+ * - Number of fields against a Custom Object definition
3506
+ */
2580
3507
  fields_count?: number;
2581
3508
  };
2582
3509
  /** @returns {CustomObjectDefinitionsSchema} */
@@ -2588,20 +3515,65 @@ type CustomObjectDefinitionsSchema = {
2588
3515
  /** @returns {CustomObjectEntryFieldSchema} */
2589
3516
  declare function CustomObjectEntryFieldSchema(): CustomObjectEntryFieldSchema;
2590
3517
  type CustomObjectEntryFieldSchema = {
2591
- definition_id?: string;
2592
- value?: any[];
3518
+ /**
3519
+ * - This is namespace for a custom field definition
3520
+ */
3521
+ namespace?: string;
3522
+ /**
3523
+ * - This is slug for a custom field definition
3524
+ */
3525
+ slug?: string;
3526
+ };
3527
+ /** @returns {CustomObjectEntryFieldSchemaWithoutID} */
3528
+ declare function CustomObjectEntryFieldSchemaWithoutID(): CustomObjectEntryFieldSchemaWithoutID;
3529
+ type CustomObjectEntryFieldSchemaWithoutID = {
3530
+ /**
3531
+ * - Custom fields belonging to a custom object
3532
+ */
3533
+ slug?: string;
3534
+ /**
3535
+ * - Value of custom field inside a custom object
3536
+ */
3537
+ value?: any;
2593
3538
  };
2594
3539
  /** @returns {CustomObjectRequestSchema} */
2595
3540
  declare function CustomObjectRequestSchema(): CustomObjectRequestSchema;
2596
3541
  type CustomObjectRequestSchema = {
3542
+ /**
3543
+ * - Flag to denote status of Custom Object
3544
+ */
2597
3545
  status?: string;
2598
- definition_id?: string;
3546
+ /**
3547
+ * - This is slug for a custom field definition
3548
+ */
3549
+ slug?: string;
3550
+ /**
3551
+ * - List of custom fields
3552
+ */
2599
3553
  fields?: CustomObjectEntryFieldSchema[];
2600
3554
  };
3555
+ /** @returns {CustomObjectRequestSchemaWithoutId} */
3556
+ declare function CustomObjectRequestSchemaWithoutId(): CustomObjectRequestSchemaWithoutId;
3557
+ type CustomObjectRequestSchemaWithoutId = {
3558
+ /**
3559
+ * - Status of the custom object entry.
3560
+ */
3561
+ status?: string;
3562
+ /**
3563
+ * - List of custom fields
3564
+ */
3565
+ fields?: CustomObjectEntryFieldSchemaWithoutID[];
3566
+ };
2601
3567
  /** @returns {CustomObjectBulkSchema} */
2602
3568
  declare function CustomObjectBulkSchema(): CustomObjectBulkSchema;
2603
3569
  type CustomObjectBulkSchema = {
3570
+ /**
3571
+ * - Full URL for the bulk operations data
3572
+ */
2604
3573
  url?: string;
3574
+ /**
3575
+ * - Total records in the upload.
3576
+ */
2605
3577
  total_records?: number;
2606
3578
  };
2607
3579
  /** @returns {ActionPage} */