@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-beta.5

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