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

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