@gofynd/fdk-client-javascript 0.1.35

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 (277) hide show
  1. package/.github/workflows/on_create_release.yml +23 -0
  2. package/.github/workflows/on_merge_main.yml +38 -0
  3. package/.github/workflows/on_pull_request.yml +35 -0
  4. package/.prettierrc +5 -0
  5. package/LICENSE +21 -0
  6. package/README.md +118 -0
  7. package/application.d.ts +3 -0
  8. package/application.js +6 -0
  9. package/common.d.ts +4 -0
  10. package/common.js +9 -0
  11. package/documentation/application/CART.md +7290 -0
  12. package/documentation/application/CATALOG.md +9570 -0
  13. package/documentation/application/COMMON.md +448 -0
  14. package/documentation/application/COMMUNICATION.md +463 -0
  15. package/documentation/application/CONFIGURATION.md +2902 -0
  16. package/documentation/application/CONTENT.md +3350 -0
  17. package/documentation/application/FILESTORAGE.md +491 -0
  18. package/documentation/application/LEAD.md +1891 -0
  19. package/documentation/application/LOGISTIC.md +439 -0
  20. package/documentation/application/ORDER.md +3428 -0
  21. package/documentation/application/PAYMENT.md +5035 -0
  22. package/documentation/application/POSCART.md +7889 -0
  23. package/documentation/application/README.md +21 -0
  24. package/documentation/application/REWARDS.md +714 -0
  25. package/documentation/application/SHARE.md +729 -0
  26. package/documentation/application/THEME.md +5796 -0
  27. package/documentation/application/USER.md +4326 -0
  28. package/documentation/platform/ANALYTICS.md +1150 -0
  29. package/documentation/platform/AUDITTRAIL.md +572 -0
  30. package/documentation/platform/BILLING.md +2396 -0
  31. package/documentation/platform/CART.md +5539 -0
  32. package/documentation/platform/CATALOG.md +21624 -0
  33. package/documentation/platform/COMMON.md +448 -0
  34. package/documentation/platform/COMMUNICATION.md +5714 -0
  35. package/documentation/platform/COMPANYPROFILE.md +2141 -0
  36. package/documentation/platform/CONFIGURATION.md +7335 -0
  37. package/documentation/platform/CONTENT.md +8989 -0
  38. package/documentation/platform/DISCOUNT.md +773 -0
  39. package/documentation/platform/FILESTORAGE.md +994 -0
  40. package/documentation/platform/INVENTORY.md +1775 -0
  41. package/documentation/platform/LEAD.md +4736 -0
  42. package/documentation/platform/ORDER.md +3764 -0
  43. package/documentation/platform/PARTNER.md +216 -0
  44. package/documentation/platform/PAYMENT.md +3444 -0
  45. package/documentation/platform/README.md +27 -0
  46. package/documentation/platform/REWARDS.md +871 -0
  47. package/documentation/platform/SHARE.md +602 -0
  48. package/documentation/platform/THEME.md +35725 -0
  49. package/documentation/platform/USER.md +2305 -0
  50. package/documentation/platform/WEBHOOK.md +587 -0
  51. package/documentation/public/CONFIGURATION.md +448 -0
  52. package/documentation/public/INVENTORY.md +686 -0
  53. package/documentation/public/WEBHOOK.md +348 -0
  54. package/index.d.ts +10 -0
  55. package/index.js +18 -0
  56. package/jest.config.d.ts +4 -0
  57. package/jest.config.js +6 -0
  58. package/package.json +35 -0
  59. package/platform.d.ts +3 -0
  60. package/platform.js +6 -0
  61. package/public.d.ts +3 -0
  62. package/public.js +6 -0
  63. package/sdk/application/ApplicationAPIClient.d.ts +11 -0
  64. package/sdk/application/ApplicationAPIClient.js +44 -0
  65. package/sdk/application/ApplicationClient.d.ts +40 -0
  66. package/sdk/application/ApplicationClient.js +84 -0
  67. package/sdk/application/ApplicationConfig.d.ts +19 -0
  68. package/sdk/application/ApplicationConfig.js +55 -0
  69. package/sdk/application/ApplicationModels.d.ts +826 -0
  70. package/sdk/application/ApplicationModels.js +10474 -0
  71. package/sdk/application/client/CartApplicationClient.d.ts +432 -0
  72. package/sdk/application/client/CartApplicationClient.js +1066 -0
  73. package/sdk/application/client/CatalogApplicationClient.d.ts +694 -0
  74. package/sdk/application/client/CatalogApplicationClient.js +1629 -0
  75. package/sdk/application/client/CommonApplicationClient.d.ts +38 -0
  76. package/sdk/application/client/CommonApplicationClient.js +105 -0
  77. package/sdk/application/client/CommunicationApplicationClient.d.ts +39 -0
  78. package/sdk/application/client/CommunicationApplicationClient.js +131 -0
  79. package/sdk/application/client/ConfigurationApplicationClient.d.ts +210 -0
  80. package/sdk/application/client/ConfigurationApplicationClient.js +649 -0
  81. package/sdk/application/client/ContentApplicationClient.d.ts +256 -0
  82. package/sdk/application/client/ContentApplicationClient.js +785 -0
  83. package/sdk/application/client/FileStorageApplicationClient.d.ts +88 -0
  84. package/sdk/application/client/FileStorageApplicationClient.js +214 -0
  85. package/sdk/application/client/LeadApplicationClient.d.ts +90 -0
  86. package/sdk/application/client/LeadApplicationClient.js +264 -0
  87. package/sdk/application/client/LogisticApplicationClient.d.ts +42 -0
  88. package/sdk/application/client/LogisticApplicationClient.js +128 -0
  89. package/sdk/application/client/OrderApplicationClient.d.ts +190 -0
  90. package/sdk/application/client/OrderApplicationClient.js +479 -0
  91. package/sdk/application/client/PaymentApplicationClient.d.ts +454 -0
  92. package/sdk/application/client/PaymentApplicationClient.js +1378 -0
  93. package/sdk/application/client/PosCartApplicationClient.d.ts +449 -0
  94. package/sdk/application/client/PosCartApplicationClient.js +1123 -0
  95. package/sdk/application/client/RewardsApplicationClient.d.ts +93 -0
  96. package/sdk/application/client/RewardsApplicationClient.js +293 -0
  97. package/sdk/application/client/ShareApplicationClient.d.ts +87 -0
  98. package/sdk/application/client/ShareApplicationClient.js +268 -0
  99. package/sdk/application/client/ThemeApplicationClient.d.ts +52 -0
  100. package/sdk/application/client/ThemeApplicationClient.js +161 -0
  101. package/sdk/application/client/UserApplicationClient.d.ts +446 -0
  102. package/sdk/application/client/UserApplicationClient.js +1275 -0
  103. package/sdk/application/constructUrl.d.ts +5 -0
  104. package/sdk/application/constructUrl.js +13 -0
  105. package/sdk/application/index.d.ts +2 -0
  106. package/sdk/application/index.js +4 -0
  107. package/sdk/application/models/CartValidator.d.ts +29 -0
  108. package/sdk/application/models/CartValidator.js +223 -0
  109. package/sdk/application/models/CatalogValidator.d.ts +33 -0
  110. package/sdk/application/models/CatalogValidator.js +233 -0
  111. package/sdk/application/models/CommonValidator.d.ts +5 -0
  112. package/sdk/application/models/CommonValidator.js +18 -0
  113. package/sdk/application/models/CommunicationValidator.d.ts +6 -0
  114. package/sdk/application/models/CommunicationValidator.js +20 -0
  115. package/sdk/application/models/ConfigurationValidator.d.ts +19 -0
  116. package/sdk/application/models/ConfigurationValidator.js +88 -0
  117. package/sdk/application/models/ContentValidator.d.ts +22 -0
  118. package/sdk/application/models/ContentValidator.js +106 -0
  119. package/sdk/application/models/FileStorageValidator.d.ts +6 -0
  120. package/sdk/application/models/FileStorageValidator.js +24 -0
  121. package/sdk/application/models/LeadValidator.d.ts +10 -0
  122. package/sdk/application/models/LeadValidator.js +48 -0
  123. package/sdk/application/models/LogisticValidator.d.ts +6 -0
  124. package/sdk/application/models/LogisticValidator.js +22 -0
  125. package/sdk/application/models/OrderValidator.d.ts +15 -0
  126. package/sdk/application/models/OrderValidator.js +87 -0
  127. package/sdk/application/models/PaymentValidator.d.ts +40 -0
  128. package/sdk/application/models/PaymentValidator.js +235 -0
  129. package/sdk/application/models/PosCartValidator.d.ts +30 -0
  130. package/sdk/application/models/PosCartValidator.js +232 -0
  131. package/sdk/application/models/RewardsValidator.d.ts +10 -0
  132. package/sdk/application/models/RewardsValidator.js +43 -0
  133. package/sdk/application/models/ShareValidator.d.ts +10 -0
  134. package/sdk/application/models/ShareValidator.js +44 -0
  135. package/sdk/application/models/ThemeValidator.d.ts +7 -0
  136. package/sdk/application/models/ThemeValidator.js +27 -0
  137. package/sdk/application/models/UserValidator.d.ts +38 -0
  138. package/sdk/application/models/UserValidator.js +233 -0
  139. package/sdk/common/AxiosHelper.d.ts +1 -0
  140. package/sdk/common/AxiosHelper.js +141 -0
  141. package/sdk/common/Constant.d.ts +294 -0
  142. package/sdk/common/Constant.js +332 -0
  143. package/sdk/common/FDKError.d.ts +26 -0
  144. package/sdk/common/FDKError.js +51 -0
  145. package/sdk/common/Logger.d.ts +2 -0
  146. package/sdk/common/Logger.js +85 -0
  147. package/sdk/common/Paginator.d.ts +16 -0
  148. package/sdk/common/Paginator.js +26 -0
  149. package/sdk/common/RequestSigner.d.ts +1 -0
  150. package/sdk/common/RequestSigner.js +306 -0
  151. package/sdk/common/Utility.d.ts +9 -0
  152. package/sdk/common/Utility.js +86 -0
  153. package/sdk/common/utils.d.ts +14 -0
  154. package/sdk/common/utils.js +165 -0
  155. package/sdk/platform/OAuthClient.d.ts +26 -0
  156. package/sdk/platform/OAuthClient.js +221 -0
  157. package/sdk/platform/PlatformAPIClient.d.ts +12 -0
  158. package/sdk/platform/PlatformAPIClient.js +43 -0
  159. package/sdk/platform/PlatformApplicationClient.d.ts +24398 -0
  160. package/sdk/platform/PlatformApplicationClient.js +23185 -0
  161. package/sdk/platform/PlatformApplicationModels.d.ts +333 -0
  162. package/sdk/platform/PlatformApplicationModels.js +21262 -0
  163. package/sdk/platform/PlatformClient.d.ts +9535 -0
  164. package/sdk/platform/PlatformClient.js +12336 -0
  165. package/sdk/platform/PlatformConfig.d.ts +29 -0
  166. package/sdk/platform/PlatformConfig.js +36 -0
  167. package/sdk/platform/PlatformModels.d.ts +1396 -0
  168. package/sdk/platform/PlatformModels.js +19222 -0
  169. package/sdk/platform/client/AnalyticsPlatformClient.d.ts +84 -0
  170. package/sdk/platform/client/AnalyticsPlatformClient.js +215 -0
  171. package/sdk/platform/client/AuditTrailPlatformClient.d.ts +38 -0
  172. package/sdk/platform/client/AuditTrailPlatformClient.js +133 -0
  173. package/sdk/platform/client/BillingPlatformClient.d.ts +109 -0
  174. package/sdk/platform/client/BillingPlatformClient.js +381 -0
  175. package/sdk/platform/client/CatalogPlatformClient.d.ts +806 -0
  176. package/sdk/platform/client/CatalogPlatformClient.js +2462 -0
  177. package/sdk/platform/client/CommonPlatformClient.d.ts +30 -0
  178. package/sdk/platform/client/CommonPlatformClient.js +84 -0
  179. package/sdk/platform/client/CommunicationPlatformClient.d.ts +26 -0
  180. package/sdk/platform/client/CommunicationPlatformClient.js +72 -0
  181. package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +182 -0
  182. package/sdk/platform/client/CompanyProfilePlatformClient.js +540 -0
  183. package/sdk/platform/client/ConfigurationPlatformClient.d.ts +277 -0
  184. package/sdk/platform/client/ConfigurationPlatformClient.js +806 -0
  185. package/sdk/platform/client/DiscountPlatformClient.d.ts +118 -0
  186. package/sdk/platform/client/DiscountPlatformClient.js +364 -0
  187. package/sdk/platform/client/FileStoragePlatformClient.d.ts +111 -0
  188. package/sdk/platform/client/FileStoragePlatformClient.js +268 -0
  189. package/sdk/platform/client/InventoryPlatformClient.d.ts +125 -0
  190. package/sdk/platform/client/InventoryPlatformClient.js +409 -0
  191. package/sdk/platform/client/LeadPlatformClient.d.ts +150 -0
  192. package/sdk/platform/client/LeadPlatformClient.js +439 -0
  193. package/sdk/platform/client/OrderPlatformClient.d.ts +190 -0
  194. package/sdk/platform/client/OrderPlatformClient.js +521 -0
  195. package/sdk/platform/client/PaymentPlatformClient.d.ts +98 -0
  196. package/sdk/platform/client/PaymentPlatformClient.js +331 -0
  197. package/sdk/platform/client/WebhookPlatformClient.d.ts +64 -0
  198. package/sdk/platform/client/WebhookPlatformClient.js +207 -0
  199. package/sdk/platform/index.d.ts +2 -0
  200. package/sdk/platform/index.js +4 -0
  201. package/sdk/platform/models/AnalyticsValidator.d.ts +7 -0
  202. package/sdk/platform/models/AnalyticsValidator.js +36 -0
  203. package/sdk/platform/models/AuditTrailValidator.d.ts +7 -0
  204. package/sdk/platform/models/AuditTrailValidator.js +26 -0
  205. package/sdk/platform/models/BillingValidator.d.ts +15 -0
  206. package/sdk/platform/models/BillingValidator.js +72 -0
  207. package/sdk/platform/models/CartValidator.d.ts +0 -0
  208. package/sdk/platform/models/CartValidator.js +0 -0
  209. package/sdk/platform/models/CatalogValidator.d.ts +74 -0
  210. package/sdk/platform/models/CatalogValidator.js +484 -0
  211. package/sdk/platform/models/CommonValidator.d.ts +5 -0
  212. package/sdk/platform/models/CommonValidator.js +18 -0
  213. package/sdk/platform/models/CommunicationValidator.d.ts +4 -0
  214. package/sdk/platform/models/CommunicationValidator.js +11 -0
  215. package/sdk/platform/models/CompanyProfileValidator.d.ts +17 -0
  216. package/sdk/platform/models/CompanyProfileValidator.js +93 -0
  217. package/sdk/platform/models/ConfigurationValidator.d.ts +21 -0
  218. package/sdk/platform/models/ConfigurationValidator.js +134 -0
  219. package/sdk/platform/models/ContentValidator.d.ts +0 -0
  220. package/sdk/platform/models/ContentValidator.js +0 -0
  221. package/sdk/platform/models/DiscountValidator.d.ts +13 -0
  222. package/sdk/platform/models/DiscountValidator.js +75 -0
  223. package/sdk/platform/models/FileStorageValidator.d.ts +9 -0
  224. package/sdk/platform/models/FileStorageValidator.js +44 -0
  225. package/sdk/platform/models/InventoryValidator.d.ts +15 -0
  226. package/sdk/platform/models/InventoryValidator.js +81 -0
  227. package/sdk/platform/models/LeadValidator.d.ts +14 -0
  228. package/sdk/platform/models/LeadValidator.js +78 -0
  229. package/sdk/platform/models/OrderValidator.d.ts +14 -0
  230. package/sdk/platform/models/OrderValidator.js +110 -0
  231. package/sdk/platform/models/PartnerValidator.d.ts +0 -0
  232. package/sdk/platform/models/PartnerValidator.js +0 -0
  233. package/sdk/platform/models/PaymentValidator.d.ts +13 -0
  234. package/sdk/platform/models/PaymentValidator.js +65 -0
  235. package/sdk/platform/models/RewardsValidator.d.ts +0 -0
  236. package/sdk/platform/models/RewardsValidator.js +0 -0
  237. package/sdk/platform/models/ShareValidator.d.ts +0 -0
  238. package/sdk/platform/models/ShareValidator.js +0 -0
  239. package/sdk/platform/models/ThemeValidator.d.ts +0 -0
  240. package/sdk/platform/models/ThemeValidator.js +0 -0
  241. package/sdk/platform/models/UserValidator.d.ts +0 -0
  242. package/sdk/platform/models/UserValidator.js +0 -0
  243. package/sdk/platform/models/WebhookValidator.d.ts +9 -0
  244. package/sdk/platform/models/WebhookValidator.js +42 -0
  245. package/sdk/public/PublicAPIClient.d.ts +11 -0
  246. package/sdk/public/PublicAPIClient.js +38 -0
  247. package/sdk/public/PublicClient.d.ts +12 -0
  248. package/sdk/public/PublicClient.js +24 -0
  249. package/sdk/public/PublicConfig.d.ts +10 -0
  250. package/sdk/public/PublicConfig.js +12 -0
  251. package/sdk/public/PublicModels.d.ts +50 -0
  252. package/sdk/public/PublicModels.js +712 -0
  253. package/sdk/public/client/ConfigurationPublicClient.d.ts +38 -0
  254. package/sdk/public/client/ConfigurationPublicClient.js +102 -0
  255. package/sdk/public/client/InventoryPublicClient.d.ts +81 -0
  256. package/sdk/public/client/InventoryPublicClient.js +239 -0
  257. package/sdk/public/client/WebhookPublicClient.d.ts +28 -0
  258. package/sdk/public/client/WebhookPublicClient.js +92 -0
  259. package/sdk/public/constructUrl.d.ts +5 -0
  260. package/sdk/public/constructUrl.js +13 -0
  261. package/sdk/public/index.d.ts +2 -0
  262. package/sdk/public/index.js +4 -0
  263. package/sdk/public/models/ConfigurationValidator.d.ts +5 -0
  264. package/sdk/public/models/ConfigurationValidator.js +18 -0
  265. package/sdk/public/models/InventoryValidator.d.ts +9 -0
  266. package/sdk/public/models/InventoryValidator.js +43 -0
  267. package/sdk/public/models/WebhookValidator.d.ts +5 -0
  268. package/sdk/public/models/WebhookValidator.js +14 -0
  269. package/tests/application/catalog.spec.js +47 -0
  270. package/tests/common/action-url.spec.js +35 -0
  271. package/tests/common/schema/action-url.json +163 -0
  272. package/tests/common/schema/url-action.json +667 -0
  273. package/tests/common/url-action.spec.js +48 -0
  274. package/tests/helpers/cookie.helper.js +31 -0
  275. package/tests/helpers/oauth.helper.js +43 -0
  276. package/tests/platform/catalog.spec.js +49 -0
  277. package/tests/public/location.spec.js +39 -0
@@ -0,0 +1,3350 @@
1
+
2
+
3
+
4
+
5
+ ##### [Back to Application docs](./README.md)
6
+
7
+ ## Content Methods
8
+ Content System
9
+ * [getAnnouncements](#getannouncements)
10
+ * [getBlog](#getblog)
11
+ * [getBlogs](#getblogs)
12
+ * [getDataLoaders](#getdataloaders)
13
+ * [getFaqs](#getfaqs)
14
+ * [getFaqCategories](#getfaqcategories)
15
+ * [getFaqBySlug](#getfaqbyslug)
16
+ * [getFaqCategoryBySlug](#getfaqcategorybyslug)
17
+ * [getFaqsByCategorySlug](#getfaqsbycategoryslug)
18
+ * [getLandingPage](#getlandingpage)
19
+ * [getLegalInformation](#getlegalinformation)
20
+ * [getNavigations](#getnavigations)
21
+ * [getSEOConfiguration](#getseoconfiguration)
22
+ * [getSlideshows](#getslideshows)
23
+ * [getSlideshow](#getslideshow)
24
+ * [getSupportInformation](#getsupportinformation)
25
+ * [getTags](#gettags)
26
+ * [getPage](#getpage)
27
+ * [getPages](#getpages)
28
+
29
+
30
+
31
+ ## Methods with example and description
32
+
33
+
34
+ ### getAnnouncements
35
+ Get live announcements
36
+
37
+
38
+
39
+ ```javascript
40
+ // Promise
41
+ const promise = content.getAnnouncements();
42
+
43
+ // Async/Await
44
+ const data = await content.getAnnouncements();
45
+ ```
46
+
47
+
48
+
49
+
50
+
51
+
52
+ Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve live announcements. Get announcements on individual pages or for all pages.
53
+
54
+ *Returned Response:*
55
+
56
+
57
+
58
+
59
+ [AnnouncementsResponseSchema](#AnnouncementsResponseSchema)
60
+
61
+ Success. Returns a JSON object with the details of the announcement shown on an individual page. `$all` is a special slug to indicate that an announcement is being shown on all the pages. Check the example shown below or refer `AnnouncementsResponseSchema` for more details.
62
+
63
+
64
+
65
+
66
+ <details>
67
+ <summary><i>&nbsp; Examples:</i></summary>
68
+
69
+
70
+ <details>
71
+ <summary><i>&nbsp; Announcements enabled</i></summary>
72
+
73
+ ```json
74
+ {
75
+ "value": {
76
+ "announcements": {
77
+ "$all": [
78
+ {
79
+ "announcement": "<link rel=\"stylesheet\" type=\"text/css\" href=\"https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/2.9.0/github-markdown.min.css\" /> <div class=\"markdown-body\" style='padding: 12px; color: #000; background-color: #fff;'><p>test Announcement</p>\n</div>",
80
+ "schedule": {
81
+ "start": "2021-03-31T11:22:08.167Z"
82
+ }
83
+ }
84
+ ]
85
+ },
86
+ "refresh_rate": 900,
87
+ "refresh_pages": []
88
+ }
89
+ }
90
+ ```
91
+ </details>
92
+
93
+ <details>
94
+ <summary><i>&nbsp; No Announcement enabled</i></summary>
95
+
96
+ ```json
97
+ {
98
+ "value": {
99
+ "announcements": {},
100
+ "refresh_rate": 900,
101
+ "refresh_pages": []
102
+ }
103
+ }
104
+ ```
105
+ </details>
106
+
107
+ </details>
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+ ---
118
+
119
+
120
+ ### getBlog
121
+ Get a blog
122
+
123
+
124
+
125
+ ```javascript
126
+ // Promise
127
+ const promise = content.getBlog({ slug : value,
128
+ rootId : value });
129
+
130
+ // Async/Await
131
+ const data = await content.getBlog({ slug : value,
132
+ rootId : value });
133
+ ```
134
+
135
+
136
+
137
+
138
+
139
+ | Argument | Type | Required | Description |
140
+ | --------- | ----- | -------- | ----------- |
141
+ | slug | string | yes | A short, human-readable, URL-friendly identifier of a blog. You can get slug value from the endpoint /service/application/content/v1.0/blogs/. |
142
+ | rootId | string | no | ID given to the HTML element |
143
+
144
+
145
+
146
+ Use this API to get the details of a blog using its slug. Details include the title, reading time, publish status, feature image, tags, author, etc.
147
+
148
+ *Returned Response:*
149
+
150
+
151
+
152
+
153
+ [BlogSchema](#BlogSchema)
154
+
155
+ Success. Returns a JSON object with blog details. Check the example shown below or refer `BlogSchema` for more details.
156
+
157
+
158
+
159
+
160
+ <details>
161
+ <summary><i>&nbsp; Examples:</i></summary>
162
+
163
+
164
+ <details>
165
+ <summary><i>&nbsp; default</i></summary>
166
+
167
+ ```json
168
+ {
169
+ "value": {
170
+ "_id": "5eaa451a21a4dd75f0fd96c5",
171
+ "application": "5d3ebd89f540e7506b8b3548",
172
+ "tags": [
173
+ "abhinav"
174
+ ],
175
+ "title": "my first blog",
176
+ "slug": "1st_blog",
177
+ "feature_image": {
178
+ "secure_url": "https://google.com"
179
+ },
180
+ "content": [
181
+ {
182
+ "type": "html",
183
+ "value": "<p>hey there!</p>"
184
+ }
185
+ ],
186
+ "_schedule": {
187
+ "cron": "* 10 * * *",
188
+ "start": "2021-03-31T23:30:00.000Z",
189
+ "end": "2021-03-31T23:55:00.000Z",
190
+ "duration": 1000,
191
+ "next_schedule": [
192
+ {
193
+ "start": "2021-03-17T04:30:00.000Z",
194
+ "end": "2021-03-17T04:46:40.000Z"
195
+ }
196
+ ]
197
+ },
198
+ "published": true,
199
+ "author": {
200
+ "name": "Fynd App"
201
+ },
202
+ "date_meta": {
203
+ "created_on": "2021-03-14T06:49:03.945Z",
204
+ "modified_on": "2021-03-14T06:49:03.945Z"
205
+ }
206
+ }
207
+ }
208
+ ```
209
+ </details>
210
+
211
+ </details>
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+ ---
222
+
223
+
224
+ ### getBlogs
225
+ Get a list of blogs
226
+
227
+
228
+
229
+ ```javascript
230
+ // Promise
231
+ const promise = content.getBlogs({ pageNo : value,
232
+ pageSize : value });
233
+
234
+ // Async/Await
235
+ const data = await content.getBlogs({ pageNo : value,
236
+ pageSize : value });
237
+ ```
238
+
239
+
240
+
241
+
242
+
243
+ | Argument | Type | Required | Description |
244
+ | --------- | ----- | -------- | ----------- |
245
+ | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
246
+ | pageSize | number | no | The number of items to retrieve in each page. |
247
+
248
+
249
+
250
+ Use this API to get all the blogs.
251
+
252
+ *Returned Response:*
253
+
254
+
255
+
256
+
257
+ [BlogGetResponse](#BlogGetResponse)
258
+
259
+ Success. Check the example shown below or refer `BlogGetResponse` for more details.
260
+
261
+
262
+
263
+
264
+ <details>
265
+ <summary><i>&nbsp; Examples:</i></summary>
266
+
267
+
268
+ <details>
269
+ <summary><i>&nbsp; default</i></summary>
270
+
271
+ ```json
272
+ {
273
+ "value": {
274
+ "items": [
275
+ {
276
+ "date_meta": {
277
+ "created_on": "2021-03-14T06:49:03.945Z",
278
+ "modified_on": "2021-03-14T06:49:03.945Z"
279
+ },
280
+ "tags": [],
281
+ "_id": "604db275b3ae202873964d94",
282
+ "content": [
283
+ {
284
+ "type": "html",
285
+ "value": "<p>test abhinav</p>"
286
+ }
287
+ ],
288
+ "title": "1st Blog",
289
+ "slug": "1st-blog",
290
+ "published": true,
291
+ "_schedule": {
292
+ "next_schedule": [
293
+ {}
294
+ ],
295
+ "start": "2021-04-08T07:15:13.000Z",
296
+ "end": "2021-04-10T02:00:00.000Z"
297
+ },
298
+ "feature_image": {
299
+ "secure_url": ""
300
+ },
301
+ "application": "000000000000000000000001",
302
+ "author": {
303
+ "name": "Fynd App"
304
+ }
305
+ }
306
+ ],
307
+ "page": {
308
+ "type": "number",
309
+ "current": 1,
310
+ "size": 1,
311
+ "item_total": 2,
312
+ "has_next": true
313
+ }
314
+ }
315
+ }
316
+ ```
317
+ </details>
318
+
319
+ </details>
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+ ---
330
+
331
+
332
+ ### getDataLoaders
333
+ Get the data loaders associated with an application
334
+
335
+
336
+
337
+ ```javascript
338
+ // Promise
339
+ const promise = content.getDataLoaders();
340
+
341
+ // Async/Await
342
+ const data = await content.getDataLoaders();
343
+ ```
344
+
345
+
346
+
347
+
348
+
349
+
350
+ Use this API to get all selected data loaders of the application in the form of tags.
351
+
352
+ *Returned Response:*
353
+
354
+
355
+
356
+
357
+ [DataLoadersSchema](#DataLoadersSchema)
358
+
359
+ Success. Returns a JSON object containing all the data loaders injected in the application. Check the example shown below or refer `DataLoadersSchema` for more details.
360
+
361
+
362
+
363
+
364
+ <details>
365
+ <summary><i>&nbsp; Example:</i></summary>
366
+
367
+ ```json
368
+ {
369
+ "items": [
370
+ {
371
+ "name": "Algolia",
372
+ "is_selected": false,
373
+ "type": "url",
374
+ "_id": "61bc4523a7ffc7504f4de4a5",
375
+ "service": "catalog",
376
+ "operation_id": "fetchSuggestions",
377
+ "url": "/ext/example/url"
378
+ },
379
+ {
380
+ "name": "Algolia v3",
381
+ "is_selected": false,
382
+ "type": "url",
383
+ "_id": "61bc452da7ffc7504f4de4a7",
384
+ "service": "catalog",
385
+ "operation_id": "fetchSuggestions",
386
+ "url": "/ext/example/url"
387
+ }
388
+ ]
389
+ }
390
+ ```
391
+ </details>
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+ ---
402
+
403
+
404
+ ### getFaqs
405
+ Get a list of FAQs
406
+
407
+
408
+
409
+ ```javascript
410
+ // Promise
411
+ const promise = content.getFaqs();
412
+
413
+ // Async/Await
414
+ const data = await content.getFaqs();
415
+ ```
416
+
417
+
418
+
419
+
420
+
421
+
422
+ Use this API to get a list of frequently asked questions. Users will benefit from it when facing any issue with the website.
423
+
424
+ *Returned Response:*
425
+
426
+
427
+
428
+
429
+ [FaqResponseSchema](#FaqResponseSchema)
430
+
431
+ Success. Returns a JSON object with question and answers. Check the example shown below or refer `FaqResponseSchema` for more details.
432
+
433
+
434
+
435
+
436
+ <details>
437
+ <summary><i>&nbsp; Examples:</i></summary>
438
+
439
+
440
+ <details>
441
+ <summary><i>&nbsp; default</i></summary>
442
+
443
+ ```json
444
+ {
445
+ "value": {
446
+ "faqs": [
447
+ {
448
+ "_id": "5eb2db750a8ebf497e315028",
449
+ "question": "how to refer my friend",
450
+ "answer": "1. Click on refer and earn image in fynd app\n2. Click on share the code\n3. Use any method for sharing\n4. Once the user activates the app with your code, both of you will get the refereal credits.",
451
+ "slug": "how to refer",
452
+ "application": "000000000000000000000001"
453
+ }
454
+ ]
455
+ }
456
+ }
457
+ ```
458
+ </details>
459
+
460
+ </details>
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+ ---
471
+
472
+
473
+ ### getFaqCategories
474
+ Get a list of FAQ categories
475
+
476
+
477
+
478
+ ```javascript
479
+ // Promise
480
+ const promise = content.getFaqCategories();
481
+
482
+ // Async/Await
483
+ const data = await content.getFaqCategories();
484
+ ```
485
+
486
+
487
+
488
+
489
+
490
+
491
+ FAQs can be divided into categories. Use this API to get a list of FAQ categories.
492
+
493
+ *Returned Response:*
494
+
495
+
496
+
497
+
498
+ [GetFaqCategoriesSchema](#GetFaqCategoriesSchema)
499
+
500
+ Success. Returns a JSON object with categories of FAQ. Check the example shown below or refer `GetFaqCategoriesSchema` for more details.
501
+
502
+
503
+
504
+
505
+ <details>
506
+ <summary><i>&nbsp; Example:</i></summary>
507
+
508
+ ```json
509
+ {
510
+ "categories": [
511
+ {
512
+ "index": 0,
513
+ "children": [
514
+ "6026426ae507768b168dee4b"
515
+ ],
516
+ "title": "Test",
517
+ "_id": "60263f80c83c1f89f2863a8a",
518
+ "slug": "test",
519
+ "application": "000000000000000000000001"
520
+ }
521
+ ]
522
+ }
523
+ ```
524
+ </details>
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+ ---
535
+
536
+
537
+ ### getFaqBySlug
538
+ Get an FAQ
539
+
540
+
541
+
542
+ ```javascript
543
+ // Promise
544
+ const promise = content.getFaqBySlug({ slug : value });
545
+
546
+ // Async/Await
547
+ const data = await content.getFaqBySlug({ slug : value });
548
+ ```
549
+
550
+
551
+
552
+
553
+
554
+ | Argument | Type | Required | Description |
555
+ | --------- | ----- | -------- | ----------- |
556
+ | slug | string | yes | A short, human-readable, URL-friendly identifier of an FAQ. You can get slug value from the endpoint /service/application/content/v1.0/faq. |
557
+
558
+
559
+
560
+ Use this API to get a particular FAQ by its slug.
561
+
562
+ *Returned Response:*
563
+
564
+
565
+
566
+
567
+ [FaqSchema](#FaqSchema)
568
+
569
+ Success. Returns a question and answer by its slug. Check the example shown below or refer `FaqSchema` for more details.
570
+
571
+
572
+
573
+
574
+ <details>
575
+ <summary><i>&nbsp; Example:</i></summary>
576
+
577
+ ```json
578
+ {
579
+ "_id": "5eb2db750a8ebf497e315028",
580
+ "question": "how to refer my friend",
581
+ "answer": "1. Click on refer and earn image in fynd app\n2. Click on share the code\n3. Use any method for sharing\n4. Once the user activates the app with your code, both of you will get the refereal credits.",
582
+ "slug": "how to refer",
583
+ "application": "000000000000000000000001"
584
+ }
585
+ ```
586
+ </details>
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+ ---
597
+
598
+
599
+ ### getFaqCategoryBySlug
600
+ Get the FAQ category
601
+
602
+
603
+
604
+ ```javascript
605
+ // Promise
606
+ const promise = content.getFaqCategoryBySlug({ slug : value });
607
+
608
+ // Async/Await
609
+ const data = await content.getFaqCategoryBySlug({ slug : value });
610
+ ```
611
+
612
+
613
+
614
+
615
+
616
+ | Argument | Type | Required | Description |
617
+ | --------- | ----- | -------- | ----------- |
618
+ | slug | string | yes | A short, human-readable, URL-friendly identifier of an FAQ category. You can get slug value from the endpoint /service/application/content/v1.0/faq/categories. |
619
+
620
+
621
+
622
+ FAQs can be divided into categories. Use this API to get the category to which an FAQ belongs.
623
+
624
+ *Returned Response:*
625
+
626
+
627
+
628
+
629
+ [GetFaqCategoryBySlugSchema](#GetFaqCategoryBySlugSchema)
630
+
631
+ Success. Returns a FAQ category with its slug. Check the example shown below or refer `GetFaqCategoryBySlugSchema` for more details.
632
+
633
+
634
+
635
+
636
+ <details>
637
+ <summary><i>&nbsp; Example:</i></summary>
638
+
639
+ ```json
640
+ {
641
+ "category": {
642
+ "index": 0,
643
+ "children": [
644
+ {
645
+ "_id": "6026426ae507768b168dee4b",
646
+ "question": "question 1",
647
+ "answer": "answer 1",
648
+ "slug": "question-1",
649
+ "application": "000000000000000000000001"
650
+ }
651
+ ],
652
+ "_id": "60263f80c83c1f89f2863a8a",
653
+ "slug": "test",
654
+ "title": "Test",
655
+ "application": "000000000000000000000001"
656
+ }
657
+ }
658
+ ```
659
+ </details>
660
+
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+
669
+ ---
670
+
671
+
672
+ ### getFaqsByCategorySlug
673
+ Get FAQs using the slug of FAQ category
674
+
675
+
676
+
677
+ ```javascript
678
+ // Promise
679
+ const promise = content.getFaqsByCategorySlug({ slug : value });
680
+
681
+ // Async/Await
682
+ const data = await content.getFaqsByCategorySlug({ slug : value });
683
+ ```
684
+
685
+
686
+
687
+
688
+
689
+ | Argument | Type | Required | Description |
690
+ | --------- | ----- | -------- | ----------- |
691
+ | slug | string | yes | A short, human-readable, URL-friendly identifier of an FAQ category. You can get slug value from the endpoint /service/application/content/v1.0/faq/categories. |
692
+
693
+
694
+
695
+ FAQs can be divided into categories. Use this API to get all the FAQs belonging to a category by using the category slug.
696
+
697
+ *Returned Response:*
698
+
699
+
700
+
701
+
702
+ [GetFaqSchema](#GetFaqSchema)
703
+
704
+ Success. Returns a categorized list of question and answers using its slug. Check the example shown below or refer `GetFaqSchema` for more details.
705
+
706
+
707
+
708
+
709
+ <details>
710
+ <summary><i>&nbsp; Example:</i></summary>
711
+
712
+ ```json
713
+ {
714
+ "faqs": [
715
+ {
716
+ "_id": "60265b64e507768b168dee4d",
717
+ "question": "question 1",
718
+ "answer": "answer 1",
719
+ "slug": "question-1",
720
+ "application": "000000000000000000000001"
721
+ }
722
+ ]
723
+ }
724
+ ```
725
+ </details>
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+ ---
736
+
737
+
738
+ ### getLandingPage
739
+ Get the landing page
740
+
741
+
742
+
743
+ ```javascript
744
+ // Promise
745
+ const promise = content.getLandingPage();
746
+
747
+ // Async/Await
748
+ const data = await content.getLandingPage();
749
+ ```
750
+
751
+
752
+
753
+
754
+
755
+
756
+ Landing page is the first page that a prospect lands upon while visiting a website. Use this API to fetch the details of a landing page.
757
+
758
+ *Returned Response:*
759
+
760
+
761
+
762
+
763
+ [LandingPageSchema](#LandingPageSchema)
764
+
765
+ Success. Returns the landing page details. Check the example shown below or refer `LandingPageSchema` for more details.
766
+
767
+
768
+
769
+
770
+ <details>
771
+ <summary><i>&nbsp; Examples:</i></summary>
772
+
773
+
774
+ <details>
775
+ <summary><i>&nbsp; default</i></summary>
776
+
777
+ ```json
778
+ {
779
+ "value": {
780
+ "_id": "5eaa451a21a4dd75f0fd96c5",
781
+ "application": "5d3ebd89f540e7506b8b3548",
782
+ "_custom_json": null,
783
+ "slug": "pnc-landing",
784
+ "action": {
785
+ "page": {
786
+ "type": "home"
787
+ },
788
+ "popup": {},
789
+ "type": "page"
790
+ },
791
+ "platform": [
792
+ "web"
793
+ ],
794
+ "created_by": {
795
+ "id": "000000000000000000000000"
796
+ },
797
+ "date_meta": {
798
+ "created_on": "2020-04-30T03:25:14.549Z",
799
+ "modified_on": "2020-04-30T03:25:14.549Z"
800
+ },
801
+ "archived": false
802
+ }
803
+ }
804
+ ```
805
+ </details>
806
+
807
+ </details>
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+ ---
818
+
819
+
820
+ ### getLegalInformation
821
+ Get legal information
822
+
823
+
824
+
825
+ ```javascript
826
+ // Promise
827
+ const promise = content.getLegalInformation();
828
+
829
+ // Async/Await
830
+ const data = await content.getLegalInformation();
831
+ ```
832
+
833
+
834
+
835
+
836
+
837
+
838
+ Use this API to get the legal information of an application, which includes Privacy Policy, Terms and Conditions, Shipping Policy and FAQs regarding the usage of the application.
839
+
840
+ *Returned Response:*
841
+
842
+
843
+
844
+
845
+ [ApplicationLegal](#ApplicationLegal)
846
+
847
+ Success. Returns the T&C, Shipping Policy, Privacy Policy and Return Policy. Check the example shown below or refer `ApplicationLegal` for more details.
848
+
849
+
850
+
851
+
852
+ <details>
853
+ <summary><i>&nbsp; Examples:</i></summary>
854
+
855
+
856
+ <details>
857
+ <summary><i>&nbsp; Success</i></summary>
858
+
859
+ ```json
860
+ {
861
+ "value": {
862
+ "tnc": "**Terms and Conditions test**",
863
+ "policy": "**Privacy policy test**",
864
+ "shipping": "**Shipping term and conditions**",
865
+ "returns": "**Terms & conditions for returns **",
866
+ "_id": "5e8b2b96abe7dc94c02c9ac9",
867
+ "application": "000000000000000000000001",
868
+ "faq": [
869
+ {
870
+ "question": "New Question",
871
+ "answer": "New Answer"
872
+ },
873
+ {
874
+ "question": "New",
875
+ "answer": "sdfghjhg"
876
+ },
877
+ {
878
+ "question": "test",
879
+ "answer": "test"
880
+ },
881
+ {
882
+ "question": "New Test",
883
+ "answer": "New Test answer"
884
+ },
885
+ {
886
+ "question": "test",
887
+ "answer": "test"
888
+ }
889
+ ],
890
+ "created_at": "2020-04-06T13:16:06.818Z",
891
+ "updated_at": "2020-07-16T09:47:40.751Z",
892
+ "__v": 260
893
+ }
894
+ }
895
+ ```
896
+ </details>
897
+
898
+ </details>
899
+
900
+
901
+
902
+
903
+
904
+
905
+
906
+
907
+
908
+ ---
909
+
910
+
911
+ ### getNavigations
912
+ Get the navigation
913
+
914
+
915
+
916
+ ```javascript
917
+ // Promise
918
+ const promise = content.getNavigations({ pageNo : value,
919
+ pageSize : value });
920
+
921
+ // Async/Await
922
+ const data = await content.getNavigations({ pageNo : value,
923
+ pageSize : value });
924
+ ```
925
+
926
+
927
+
928
+
929
+
930
+ | Argument | Type | Required | Description |
931
+ | --------- | ----- | -------- | ----------- |
932
+ | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
933
+ | pageSize | number | no | The number of items to retrieve in each page. |
934
+
935
+
936
+
937
+ Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the links and sub-navigations.
938
+
939
+ *Returned Response:*
940
+
941
+
942
+
943
+
944
+ [NavigationGetResponse](#NavigationGetResponse)
945
+
946
+ Success. Returns a JSON object with navigation details. Check the example shown below or refer `NavigationGetResponse` for more details.
947
+
948
+
949
+
950
+
951
+ <details>
952
+ <summary><i>&nbsp; Examples:</i></summary>
953
+
954
+
955
+ <details>
956
+ <summary><i>&nbsp; default</i></summary>
957
+
958
+ ```json
959
+ {
960
+ "value": {
961
+ "items": [
962
+ {
963
+ "_id": "5ffbd9b90ac98678ae0458d7",
964
+ "application": "000000000000000000000001",
965
+ "_custom_json": null,
966
+ "name": "temp",
967
+ "slug": "temp",
968
+ "platform": "web",
969
+ "position": "top",
970
+ "orientation": "landscape",
971
+ "navigation": [
972
+ {
973
+ "display": "Home",
974
+ "image": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/mystore-tab_y0dqzt.png",
975
+ "sort_order": 1,
976
+ "type": "",
977
+ "action": {
978
+ "page": {
979
+ "url": "/",
980
+ "type": "home"
981
+ },
982
+ "popup": {},
983
+ "type": "page"
984
+ },
985
+ "active": true,
986
+ "tags": {
987
+ "type": "array",
988
+ "items": {
989
+ "type": "string"
990
+ }
991
+ },
992
+ "acl": [
993
+ "all"
994
+ ],
995
+ "_locale_language": {
996
+ "hi": {
997
+ "display": ""
998
+ },
999
+ "ar": {
1000
+ "display": ""
1001
+ },
1002
+ "en_us": {
1003
+ "display": ""
1004
+ }
1005
+ },
1006
+ "sub_navigation": [
1007
+ {
1008
+ "display": "Brands",
1009
+ "image": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png",
1010
+ "sort_order": 1,
1011
+ "type": "",
1012
+ "action": {
1013
+ "page": {
1014
+ "url": "/brands/",
1015
+ "type": "brands"
1016
+ },
1017
+ "popup": {},
1018
+ "type": "page"
1019
+ },
1020
+ "active": true,
1021
+ "tags": null,
1022
+ "acl": [
1023
+ "all"
1024
+ ],
1025
+ "_locale_language": {
1026
+ "hi": {
1027
+ "display": ""
1028
+ },
1029
+ "ar": {
1030
+ "display": ""
1031
+ },
1032
+ "en_us": {
1033
+ "display": ""
1034
+ }
1035
+ }
1036
+ }
1037
+ ]
1038
+ },
1039
+ {
1040
+ "display": "Collections",
1041
+ "image": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/collections-tab_a0tg9c.png",
1042
+ "sort_order": 2,
1043
+ "type": "",
1044
+ "action": {
1045
+ "page": {
1046
+ "url": "/collections/",
1047
+ "type": "collections"
1048
+ },
1049
+ "popup": {},
1050
+ "type": "page"
1051
+ },
1052
+ "active": true,
1053
+ "tags": null,
1054
+ "acl": [
1055
+ "all"
1056
+ ],
1057
+ "_locale_language": {
1058
+ "hi": {
1059
+ "display": ""
1060
+ },
1061
+ "ar": {
1062
+ "display": ""
1063
+ },
1064
+ "en_us": {
1065
+ "display": ""
1066
+ }
1067
+ },
1068
+ "sub_navigation": [
1069
+ {
1070
+ "display": "Categories",
1071
+ "image": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148154/production/system/icons/categories-tab_ss8e0q.png",
1072
+ "sort_order": 1,
1073
+ "type": "",
1074
+ "action": {
1075
+ "page": {
1076
+ "url": "/categories/",
1077
+ "type": "categories"
1078
+ },
1079
+ "popup": {},
1080
+ "type": "page"
1081
+ },
1082
+ "active": true,
1083
+ "tags": null,
1084
+ "acl": [
1085
+ "all"
1086
+ ],
1087
+ "_locale_language": {
1088
+ "hi": {
1089
+ "display": ""
1090
+ },
1091
+ "ar": {
1092
+ "display": ""
1093
+ },
1094
+ "en_us": {
1095
+ "display": ""
1096
+ }
1097
+ }
1098
+ }
1099
+ ]
1100
+ },
1101
+ {
1102
+ "display": "Primary Menu",
1103
+ "image": "",
1104
+ "sort_order": 3,
1105
+ "type": "",
1106
+ "action": {
1107
+ "page": {
1108
+ "type": "home"
1109
+ },
1110
+ "popup": {},
1111
+ "type": "page"
1112
+ },
1113
+ "active": true,
1114
+ "tags": null,
1115
+ "acl": [
1116
+ "all"
1117
+ ],
1118
+ "_locale_language": {
1119
+ "hi": {
1120
+ "display": ""
1121
+ },
1122
+ "ar": {
1123
+ "display": ""
1124
+ },
1125
+ "en_us": {
1126
+ "display": ""
1127
+ }
1128
+ }
1129
+ }
1130
+ ],
1131
+ "created_by": {
1132
+ "id": "000000000000000000000000"
1133
+ },
1134
+ "date_meta": {
1135
+ "created_on": "2021-01-11T04:53:13.585Z",
1136
+ "modified_on": "2021-01-14T10:24:34.485Z"
1137
+ }
1138
+ }
1139
+ ],
1140
+ "page": {
1141
+ "type": "number",
1142
+ "current": 1,
1143
+ "size": 1,
1144
+ "item_total": 2,
1145
+ "has_next": true
1146
+ }
1147
+ }
1148
+ }
1149
+ ```
1150
+ </details>
1151
+
1152
+ </details>
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+
1162
+ ---
1163
+
1164
+
1165
+ ### getSEOConfiguration
1166
+ Get the SEO of an application
1167
+
1168
+
1169
+
1170
+ ```javascript
1171
+ // Promise
1172
+ const promise = content.getSEOConfiguration();
1173
+
1174
+ // Async/Await
1175
+ const data = await content.getSEOConfiguration();
1176
+ ```
1177
+
1178
+
1179
+
1180
+
1181
+
1182
+
1183
+ Use this API to get the SEO details of an application, which includes a robot.txt, meta-tags and sitemap.
1184
+
1185
+ *Returned Response:*
1186
+
1187
+
1188
+
1189
+
1190
+ [SeoComponent](#SeoComponent)
1191
+
1192
+ Success. Returns a JSON object SEO details such as robots.txt, meta-tags, and sitemap. Check the example shown below or refer `SeoComponent` for more details.
1193
+
1194
+
1195
+
1196
+
1197
+ <details>
1198
+ <summary><i>&nbsp; Examples:</i></summary>
1199
+
1200
+
1201
+ <details>
1202
+ <summary><i>&nbsp; Success</i></summary>
1203
+
1204
+ ```json
1205
+ {
1206
+ "value": {
1207
+ "seo": {
1208
+ "details": {
1209
+ "title": "Zyosa Zyosa"
1210
+ },
1211
+ "robots_txt": "User-agent: * \nAllow: / \nsancisciasn xwsaixjowqnxwsiwjs",
1212
+ "sitemap_enabled": false,
1213
+ "_id": "6009819ee463ad40de397eb2",
1214
+ "app": "000000000000000000000001",
1215
+ "created_at": "2021-01-21T13:29:02.543Z",
1216
+ "updated_at": "2021-02-05T06:36:16.048Z",
1217
+ "__v": 11,
1218
+ "custom_meta_tags": [
1219
+ {
1220
+ "name": "test 0000",
1221
+ "content": "<meta name=\"test\" content=\"0000 cn dcje dcj rejre cjrenurenc \">",
1222
+ "_id": "6017c301bde3c21dbb13b284"
1223
+ },
1224
+ {
1225
+ "name": "cwdcdc",
1226
+ "content": "<meta content=\"wdcewdewc\">",
1227
+ "_id": "6017c675bde3c22cfb13b290"
1228
+ }
1229
+ ]
1230
+ }
1231
+ }
1232
+ }
1233
+ ```
1234
+ </details>
1235
+
1236
+ </details>
1237
+
1238
+
1239
+
1240
+
1241
+
1242
+
1243
+
1244
+
1245
+
1246
+ ---
1247
+
1248
+
1249
+ ### getSlideshows
1250
+ Get the slideshows
1251
+
1252
+
1253
+
1254
+ ```javascript
1255
+ // Promise
1256
+ const promise = content.getSlideshows({ pageNo : value,
1257
+ pageSize : value });
1258
+
1259
+ // Async/Await
1260
+ const data = await content.getSlideshows({ pageNo : value,
1261
+ pageSize : value });
1262
+ ```
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+ | Argument | Type | Required | Description |
1269
+ | --------- | ----- | -------- | ----------- |
1270
+ | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
1271
+ | pageSize | number | no | The number of items to retrieve in each page. |
1272
+
1273
+
1274
+
1275
+ Use this API to get a list of slideshows along with their details.
1276
+
1277
+ *Returned Response:*
1278
+
1279
+
1280
+
1281
+
1282
+ [SlideshowGetResponse](#SlideshowGetResponse)
1283
+
1284
+ Success. Check the example shown below or refer `SlideshowGetResponse` for more details.
1285
+
1286
+
1287
+
1288
+
1289
+ <details>
1290
+ <summary><i>&nbsp; Examples:</i></summary>
1291
+
1292
+
1293
+ <details>
1294
+ <summary><i>&nbsp; default</i></summary>
1295
+
1296
+ ```json
1297
+ {
1298
+ "value": {
1299
+ "items": [
1300
+ {
1301
+ "date_meta": {
1302
+ "created_on": "2021-03-14T05:27:12.319Z",
1303
+ "modified_on": "2021-03-14T05:27:12.319Z"
1304
+ },
1305
+ "archived": false,
1306
+ "_id": "604d9eb975e9d136bb1b8b83",
1307
+ "configuration": {
1308
+ "start_on_launch": false,
1309
+ "duration": 50,
1310
+ "sleep_time": 100,
1311
+ "slide_direction": "horizontal"
1312
+ },
1313
+ "slug": "ss-sfsd-updated",
1314
+ "platform": "ios",
1315
+ "media": [
1316
+ {
1317
+ "auto_decide_duration": false,
1318
+ "type": "image",
1319
+ "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png",
1320
+ "bg_color": "#ffffff",
1321
+ "duration": 10,
1322
+ "action": {
1323
+ "type": ""
1324
+ }
1325
+ },
1326
+ {
1327
+ "auto_decide_duration": true,
1328
+ "type": "youtube",
1329
+ "url": "https://www.youtube.com/embed/9vJRopau0g0",
1330
+ "bg_color": "#ffffff",
1331
+ "duration": 909,
1332
+ "action": {
1333
+ "type": ""
1334
+ }
1335
+ }
1336
+ ],
1337
+ "application": "5cd3db5e9d692cfe5302a7bb",
1338
+ "active": true,
1339
+ "__v": 0
1340
+ }
1341
+ ],
1342
+ "page": {
1343
+ "type": "number",
1344
+ "current": 1,
1345
+ "size": 1,
1346
+ "item_total": 2,
1347
+ "has_next": true
1348
+ }
1349
+ }
1350
+ }
1351
+ ```
1352
+ </details>
1353
+
1354
+ </details>
1355
+
1356
+
1357
+
1358
+
1359
+
1360
+
1361
+
1362
+
1363
+
1364
+ ---
1365
+
1366
+
1367
+ ### getSlideshow
1368
+ Get a slideshow
1369
+
1370
+
1371
+
1372
+ ```javascript
1373
+ // Promise
1374
+ const promise = content.getSlideshow({ slug : value });
1375
+
1376
+ // Async/Await
1377
+ const data = await content.getSlideshow({ slug : value });
1378
+ ```
1379
+
1380
+
1381
+
1382
+
1383
+
1384
+ | Argument | Type | Required | Description |
1385
+ | --------- | ----- | -------- | ----------- |
1386
+ | slug | string | yes | A short, human-readable, URL-friendly identifier of a slideshow. You can get slug value from the endpoint /service/application/content/v1.0/slideshow/. |
1387
+
1388
+
1389
+
1390
+ A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a slideshow using its `slug`.
1391
+
1392
+ *Returned Response:*
1393
+
1394
+
1395
+
1396
+
1397
+ [SlideshowSchema](#SlideshowSchema)
1398
+
1399
+ Success. Returns the details of how a slideshow is configured. Check the example shown below or refer `SlideshowSchema` for more details.
1400
+
1401
+
1402
+
1403
+
1404
+ <details>
1405
+ <summary><i>&nbsp; Examples:</i></summary>
1406
+
1407
+
1408
+ <details>
1409
+ <summary><i>&nbsp; default</i></summary>
1410
+
1411
+ ```json
1412
+ {
1413
+ "value": {
1414
+ "date_meta": {
1415
+ "created_on": "2021-03-14T05:27:12.319Z",
1416
+ "modified_on": "2021-03-14T05:27:12.319Z"
1417
+ },
1418
+ "archived": false,
1419
+ "_id": "604d9eb975e9d136bb1b8b83",
1420
+ "configuration": {
1421
+ "start_on_launch": false,
1422
+ "duration": 50,
1423
+ "sleep_time": 100,
1424
+ "slide_direction": "horizontal"
1425
+ },
1426
+ "slug": "ss-sfsd-updated",
1427
+ "platform": "ios",
1428
+ "media": [
1429
+ {
1430
+ "auto_decide_duration": false,
1431
+ "type": "image",
1432
+ "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png",
1433
+ "bg_color": "#ffffff",
1434
+ "duration": 10,
1435
+ "action": {
1436
+ "type": ""
1437
+ }
1438
+ },
1439
+ {
1440
+ "auto_decide_duration": true,
1441
+ "type": "youtube",
1442
+ "url": "https://www.youtube.com/embed/9vJRopau0g0",
1443
+ "bg_color": "#ffffff",
1444
+ "duration": 909,
1445
+ "action": {
1446
+ "type": ""
1447
+ }
1448
+ }
1449
+ ],
1450
+ "application": "5cd3db5e9d692cfe5302a7bb",
1451
+ "active": true
1452
+ }
1453
+ }
1454
+ ```
1455
+ </details>
1456
+
1457
+ </details>
1458
+
1459
+
1460
+
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+ ---
1468
+
1469
+
1470
+ ### getSupportInformation
1471
+ Get the support information
1472
+
1473
+
1474
+
1475
+ ```javascript
1476
+ // Promise
1477
+ const promise = content.getSupportInformation();
1478
+
1479
+ // Async/Await
1480
+ const data = await content.getSupportInformation();
1481
+ ```
1482
+
1483
+
1484
+
1485
+
1486
+
1487
+
1488
+ Use this API to get contact details for customer support including emails and phone numbers.
1489
+
1490
+ *Returned Response:*
1491
+
1492
+
1493
+
1494
+
1495
+ [Support](#Support)
1496
+
1497
+ Success. Returns all support information including email and phone number. Check the example shown below or refer `Support` for more details.
1498
+
1499
+
1500
+
1501
+
1502
+ <details>
1503
+ <summary><i>&nbsp; Examples:</i></summary>
1504
+
1505
+
1506
+ <details>
1507
+ <summary><i>&nbsp; default</i></summary>
1508
+
1509
+ ```json
1510
+ {
1511
+ "value": {
1512
+ "_id": "5ea4980b87a7944094216193",
1513
+ "config_type": "app",
1514
+ "application": "000000000000000000000001",
1515
+ "created_at": "2020-04-25T20:05:31.300Z",
1516
+ "updated_at": "2020-12-04T10:48:12.194Z",
1517
+ "contact": {
1518
+ "phone": {
1519
+ "active": true,
1520
+ "phone": [
1521
+ {
1522
+ "key": "Jane Doe",
1523
+ "code": "91",
1524
+ "number": "9988776655"
1525
+ }
1526
+ ]
1527
+ },
1528
+ "email": {
1529
+ "active": false,
1530
+ "email": []
1531
+ }
1532
+ },
1533
+ "created": true
1534
+ }
1535
+ }
1536
+ ```
1537
+ </details>
1538
+
1539
+ </details>
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+
1547
+
1548
+
1549
+ ---
1550
+
1551
+
1552
+ ### getTags
1553
+ Get the tags associated with an application
1554
+
1555
+
1556
+
1557
+ ```javascript
1558
+ // Promise
1559
+ const promise = content.getTags();
1560
+
1561
+ // Async/Await
1562
+ const data = await content.getTags();
1563
+ ```
1564
+
1565
+
1566
+
1567
+
1568
+
1569
+
1570
+ Use this API to get all the CSS and JS injected in the application in the form of tags.
1571
+
1572
+ *Returned Response:*
1573
+
1574
+
1575
+
1576
+
1577
+ [TagsSchema](#TagsSchema)
1578
+
1579
+ Success. Returns a JSON object containing all the tags injected in the application. Check the example shown below or refer `TagsSchema` for more details.
1580
+
1581
+
1582
+
1583
+
1584
+ <details>
1585
+ <summary><i>&nbsp; Example:</i></summary>
1586
+
1587
+ ```json
1588
+ {
1589
+ "application": "000000000000000000000001",
1590
+ "_id": "5f7c37b2dd0144bb3a353c5f",
1591
+ "tags": [
1592
+ {
1593
+ "name": "Tapfiliate JS",
1594
+ "sub_type": "external",
1595
+ "_id": "5f7c37b2dd0144f1f8353c60",
1596
+ "type": "js",
1597
+ "url": "https://script.tapfiliate.com/tapfiliate.js",
1598
+ "position": "body-bottom",
1599
+ "attributes": {
1600
+ "async": true
1601
+ }
1602
+ }
1603
+ ]
1604
+ }
1605
+ ```
1606
+ </details>
1607
+
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+
1615
+
1616
+ ---
1617
+
1618
+
1619
+ ### getPage
1620
+ Get a page
1621
+
1622
+
1623
+
1624
+ ```javascript
1625
+ // Promise
1626
+ const promise = content.getPage({ slug : value,
1627
+ rootId : value });
1628
+
1629
+ // Async/Await
1630
+ const data = await content.getPage({ slug : value,
1631
+ rootId : value });
1632
+ ```
1633
+
1634
+
1635
+
1636
+
1637
+
1638
+ | Argument | Type | Required | Description |
1639
+ | --------- | ----- | -------- | ----------- |
1640
+ | slug | string | yes | A short, human-readable, URL-friendly identifier of a page. You can get slug value from the endpoint /service/application/content/v2.0/pages/. |
1641
+ | rootId | string | no | ID given to the HTML element |
1642
+
1643
+
1644
+
1645
+ Use this API to get the details of a page using its slug. Details include the title, seo, publish status, feature image, tags, meta, etc.
1646
+
1647
+ *Returned Response:*
1648
+
1649
+
1650
+
1651
+
1652
+ [PageSchema](#PageSchema)
1653
+
1654
+ Success. Returns a JSON object with page details. Check the example shown below or refer `CustomPageSchema` for more details.
1655
+
1656
+
1657
+
1658
+
1659
+ <details>
1660
+ <summary><i>&nbsp; Examples:</i></summary>
1661
+
1662
+
1663
+ <details>
1664
+ <summary><i>&nbsp; default</i></summary>
1665
+
1666
+ ```json
1667
+ {
1668
+ "value": {
1669
+ "date_meta": {
1670
+ "created_on": "2021-03-16T08:24:19.197Z",
1671
+ "modified_on": "2021-03-16T08:24:19.197Z"
1672
+ },
1673
+ "tags": [
1674
+ "my first page"
1675
+ ],
1676
+ "published": true,
1677
+ "component_ids": [],
1678
+ "archived": false,
1679
+ "_id": "60506dcad18cb33946026862",
1680
+ "title": "my first page",
1681
+ "slug": "1st_page",
1682
+ "feature_image": {
1683
+ "secure_url": "https://google.com/some-image"
1684
+ },
1685
+ "content_path": "https://hdn-1.fynd.com/company/1526/applications/61012f6a9250ccd1b9ef8a1d/pages/content/page_slug.html",
1686
+ "platform": "web",
1687
+ "description": "hey this is my first page",
1688
+ "visibility": {
1689
+ "test": true
1690
+ },
1691
+ "_schedule": {
1692
+ "start": "2021-04-23T23:50:00.000Z",
1693
+ "next_schedule": [
1694
+ {}
1695
+ ]
1696
+ },
1697
+ "seo": {
1698
+ "title": "my first page",
1699
+ "description": "hey this is my first page",
1700
+ "image": {
1701
+ "url": ""
1702
+ }
1703
+ },
1704
+ "type": "rawhtml",
1705
+ "application": "000000000000000000000001",
1706
+ "orientation": "portrait",
1707
+ "page_meta": []
1708
+ }
1709
+ }
1710
+ ```
1711
+ </details>
1712
+
1713
+ </details>
1714
+
1715
+
1716
+
1717
+
1718
+
1719
+
1720
+
1721
+
1722
+
1723
+ ---
1724
+
1725
+
1726
+ ### getPages
1727
+ Get all pages
1728
+
1729
+
1730
+
1731
+ ```javascript
1732
+ // Promise
1733
+ const promise = content.getPages({ pageNo : value,
1734
+ pageSize : value });
1735
+
1736
+ // Async/Await
1737
+ const data = await content.getPages({ pageNo : value,
1738
+ pageSize : value });
1739
+ ```
1740
+
1741
+
1742
+
1743
+
1744
+
1745
+ | Argument | Type | Required | Description |
1746
+ | --------- | ----- | -------- | ----------- |
1747
+ | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
1748
+ | pageSize | number | no | The number of items to retrieve in each page. |
1749
+
1750
+
1751
+
1752
+ Use this API to get a list of pages.
1753
+
1754
+ *Returned Response:*
1755
+
1756
+
1757
+
1758
+
1759
+ [PageGetResponse](#PageGetResponse)
1760
+
1761
+ Success. Returns a list of pages along with their details. Check the example shown below or refer `PageGetStorefrontResponse` for more details.
1762
+
1763
+
1764
+
1765
+
1766
+ <details>
1767
+ <summary><i>&nbsp; Examples:</i></summary>
1768
+
1769
+
1770
+ <details>
1771
+ <summary><i>&nbsp; default</i></summary>
1772
+
1773
+ ```json
1774
+ {
1775
+ "value": {
1776
+ "items": [
1777
+ {
1778
+ "date_meta": {
1779
+ "created_on": "2021-03-14T06:49:03.945Z",
1780
+ "modified_on": "2021-03-14T06:49:03.945Z"
1781
+ },
1782
+ "tags": [
1783
+ "my first page"
1784
+ ],
1785
+ "_id": "604db275b3ae202873964d94",
1786
+ "content_path": "https://hdn-1.fynd.com/company/1526/applications/61012f6a9250ccd1b9ef8a1d/pages/content/page_slug.html",
1787
+ "title": "test-page",
1788
+ "slug": "test-page",
1789
+ "published": true,
1790
+ "_schedule": {
1791
+ "next_schedule": [
1792
+ {}
1793
+ ],
1794
+ "start": "2021-04-08T07:15:13.000Z",
1795
+ "end": "2021-04-10T02:00:00.000Z"
1796
+ },
1797
+ "feature_image": {
1798
+ "secure_url": "https://google.com/some-image"
1799
+ },
1800
+ "seo": {
1801
+ "title": "my first page",
1802
+ "description": "hey this is my first page",
1803
+ "image": {
1804
+ "url": ""
1805
+ }
1806
+ },
1807
+ "application": "000000000000000000000001",
1808
+ "author": {
1809
+ "name": "Abhinav Maurya"
1810
+ }
1811
+ }
1812
+ ],
1813
+ "page": {
1814
+ "type": "number",
1815
+ "current": 1,
1816
+ "size": 1,
1817
+ "item_total": 2,
1818
+ "has_next": true
1819
+ }
1820
+ }
1821
+ }
1822
+ ```
1823
+ </details>
1824
+
1825
+ </details>
1826
+
1827
+
1828
+
1829
+
1830
+
1831
+
1832
+
1833
+
1834
+
1835
+ ---
1836
+
1837
+
1838
+
1839
+ ### Schemas
1840
+
1841
+
1842
+
1843
+ #### [ApplicationLegal](#ApplicationLegal)
1844
+
1845
+ | Properties | Type | Nullable | Description |
1846
+ | ---------- | ---- | -------- | ----------- |
1847
+ | application | string | no | |
1848
+ | tnc | string | no | |
1849
+ | policy | string | no | |
1850
+ | shipping | string | no | |
1851
+ | returns | string | no | |
1852
+ | faq | [[ApplicationLegalFAQ](#ApplicationLegalFAQ)] | no | |
1853
+ | _id | string | no | |
1854
+ | updated_at | string | no | |
1855
+ | created_at | string | no | |
1856
+
1857
+ ---
1858
+
1859
+
1860
+
1861
+
1862
+ #### [ApplicationLegalFAQ](#ApplicationLegalFAQ)
1863
+
1864
+ | Properties | Type | Nullable | Description |
1865
+ | ---------- | ---- | -------- | ----------- |
1866
+ | question | string | no | |
1867
+ | answer | string | no | |
1868
+
1869
+ ---
1870
+
1871
+
1872
+
1873
+
1874
+ #### [PathMappingSchema](#PathMappingSchema)
1875
+
1876
+ | Properties | Type | Nullable | Description |
1877
+ | ---------- | ---- | -------- | ----------- |
1878
+ | application | string | no | |
1879
+ | _id | string | no | |
1880
+ | redirect_from | string | no | |
1881
+ | redirect_to | string | no | |
1882
+ | updated_at | string | no | |
1883
+ | created_at | string | no | |
1884
+ | __source | [TagSourceSchema](#TagSourceSchema) | no | |
1885
+
1886
+ ---
1887
+
1888
+
1889
+
1890
+
1891
+ #### [SeoComponent](#SeoComponent)
1892
+
1893
+ | Properties | Type | Nullable | Description |
1894
+ | ---------- | ---- | -------- | ----------- |
1895
+ | seo | [SeoSchema](#SeoSchema) | no | |
1896
+
1897
+ ---
1898
+
1899
+
1900
+
1901
+
1902
+ #### [SeoSchema](#SeoSchema)
1903
+
1904
+ | Properties | Type | Nullable | Description |
1905
+ | ---------- | ---- | -------- | ----------- |
1906
+ | app | string | no | |
1907
+ | _id | string | no | |
1908
+ | robots_txt | string | no | |
1909
+ | sitemap_enabled | boolean | no | |
1910
+ | custom_meta_tags | [[CustomMetaTag](#CustomMetaTag)] | no | |
1911
+ | details | [Detail](#Detail) | no | |
1912
+ | created_at | string | no | |
1913
+ | updated_at | string | no | |
1914
+
1915
+ ---
1916
+
1917
+
1918
+
1919
+
1920
+ #### [CustomMetaTag](#CustomMetaTag)
1921
+
1922
+ | Properties | Type | Nullable | Description |
1923
+ | ---------- | ---- | -------- | ----------- |
1924
+ | name | string | no | |
1925
+ | content | string | no | |
1926
+ | _id | string | no | |
1927
+
1928
+ ---
1929
+
1930
+
1931
+
1932
+
1933
+ #### [Detail](#Detail)
1934
+
1935
+ | Properties | Type | Nullable | Description |
1936
+ | ---------- | ---- | -------- | ----------- |
1937
+ | title | string | no | |
1938
+ | description | string | no | |
1939
+
1940
+ ---
1941
+
1942
+
1943
+
1944
+
1945
+ #### [AnnouncementPageSchema](#AnnouncementPageSchema)
1946
+
1947
+ | Properties | Type | Nullable | Description |
1948
+ | ---------- | ---- | -------- | ----------- |
1949
+ | page_slug | string | no | |
1950
+ | type | string | no | |
1951
+
1952
+ ---
1953
+
1954
+
1955
+
1956
+
1957
+ #### [EditorMeta](#EditorMeta)
1958
+
1959
+ | Properties | Type | Nullable | Description |
1960
+ | ---------- | ---- | -------- | ----------- |
1961
+ | foreground_color | string | no | |
1962
+ | background_color | string | no | |
1963
+ | content_type | string | no | |
1964
+ | content | string | no | |
1965
+
1966
+ ---
1967
+
1968
+
1969
+
1970
+
1971
+ #### [AnnouncementAuthorSchema](#AnnouncementAuthorSchema)
1972
+
1973
+ | Properties | Type | Nullable | Description |
1974
+ | ---------- | ---- | -------- | ----------- |
1975
+ | created_by | string | no | |
1976
+ | modified_by | string | no | |
1977
+
1978
+ ---
1979
+
1980
+
1981
+
1982
+
1983
+ #### [AdminAnnouncementSchema](#AdminAnnouncementSchema)
1984
+
1985
+ | Properties | Type | Nullable | Description |
1986
+ | ---------- | ---- | -------- | ----------- |
1987
+ | _id | string | no | |
1988
+ | platforms | [string] | no | |
1989
+ | title | string | no | |
1990
+ | announcement | string | no | |
1991
+ | pages | [[AnnouncementPageSchema](#AnnouncementPageSchema)] | no | |
1992
+ | editor_meta | [EditorMeta](#EditorMeta) | no | |
1993
+ | author | [AnnouncementAuthorSchema](#AnnouncementAuthorSchema) | no | |
1994
+ | created_at | string | no | |
1995
+ | app | string | no | |
1996
+ | modified_at | string | no | |
1997
+ | _schedule | [ScheduleSchema](#ScheduleSchema) | no | |
1998
+
1999
+ ---
2000
+
2001
+
2002
+
2003
+
2004
+ #### [ScheduleSchema](#ScheduleSchema)
2005
+
2006
+ | Properties | Type | Nullable | Description |
2007
+ | ---------- | ---- | -------- | ----------- |
2008
+ | cron | string | no | |
2009
+ | start | string | no | |
2010
+ | end | string | no | |
2011
+ | duration | number | no | |
2012
+ | next_schedule | [[NextSchedule](#NextSchedule)] | no | |
2013
+
2014
+ ---
2015
+
2016
+
2017
+
2018
+
2019
+ #### [NextSchedule](#NextSchedule)
2020
+
2021
+ | Properties | Type | Nullable | Description |
2022
+ | ---------- | ---- | -------- | ----------- |
2023
+ | start | string | no | |
2024
+ | end | string | no | |
2025
+
2026
+ ---
2027
+
2028
+
2029
+
2030
+
2031
+ #### [AnnouncementSchema](#AnnouncementSchema)
2032
+
2033
+ | Properties | Type | Nullable | Description |
2034
+ | ---------- | ---- | -------- | ----------- |
2035
+ | announcement | string | no | |
2036
+ | schedule | [ScheduleStartSchema](#ScheduleStartSchema) | no | |
2037
+
2038
+ ---
2039
+
2040
+
2041
+
2042
+
2043
+ #### [ScheduleStartSchema](#ScheduleStartSchema)
2044
+
2045
+ | Properties | Type | Nullable | Description |
2046
+ | ---------- | ---- | -------- | ----------- |
2047
+ | start | string | no | |
2048
+ | end | string | no | |
2049
+
2050
+ ---
2051
+
2052
+
2053
+
2054
+
2055
+ #### [BlogGetResponse](#BlogGetResponse)
2056
+
2057
+ | Properties | Type | Nullable | Description |
2058
+ | ---------- | ---- | -------- | ----------- |
2059
+ | items | [[BlogSchema](#BlogSchema)] | no | |
2060
+ | page | [Page](#Page) | no | |
2061
+
2062
+ ---
2063
+
2064
+
2065
+
2066
+
2067
+ #### [ResourceContent](#ResourceContent)
2068
+
2069
+ | Properties | Type | Nullable | Description |
2070
+ | ---------- | ---- | -------- | ----------- |
2071
+ | type | string | no | |
2072
+ | value | string | no | |
2073
+
2074
+ ---
2075
+
2076
+
2077
+
2078
+
2079
+ #### [Asset](#Asset)
2080
+
2081
+ | Properties | Type | Nullable | Description |
2082
+ | ---------- | ---- | -------- | ----------- |
2083
+ | aspect_ratio | string | no | |
2084
+ | id | string | no | |
2085
+ | secure_url | string | no | |
2086
+
2087
+ ---
2088
+
2089
+
2090
+
2091
+
2092
+ #### [Author](#Author)
2093
+
2094
+ | Properties | Type | Nullable | Description |
2095
+ | ---------- | ---- | -------- | ----------- |
2096
+ | designation | string | no | |
2097
+ | id | string | no | |
2098
+ | name | string | no | |
2099
+
2100
+ ---
2101
+
2102
+
2103
+
2104
+
2105
+ #### [BlogSchema](#BlogSchema)
2106
+
2107
+ | Properties | Type | Nullable | Description |
2108
+ | ---------- | ---- | -------- | ----------- |
2109
+ | _id | string | no | |
2110
+ | _custom_json | string | no | |
2111
+ | application | string | no | |
2112
+ | archived | boolean | no | |
2113
+ | author | [Author](#Author) | no | |
2114
+ | content | [[ResourceContent](#ResourceContent)] | no | |
2115
+ | feature_image | [Asset](#Asset) | no | |
2116
+ | published | boolean | no | |
2117
+ | reading_time | string | no | |
2118
+ | slug | string | no | |
2119
+ | tags | [string] | no | |
2120
+ | seo | [SEO](#SEO) | no | |
2121
+ | _schedule | [CronSchedule](#CronSchedule) | no | |
2122
+ | title | string | no | |
2123
+ | date_meta | [DateMeta](#DateMeta) | no | |
2124
+
2125
+ ---
2126
+
2127
+
2128
+
2129
+
2130
+ #### [SEO](#SEO)
2131
+
2132
+ | Properties | Type | Nullable | Description |
2133
+ | ---------- | ---- | -------- | ----------- |
2134
+ | description | string | no | |
2135
+ | image | [SEOImage](#SEOImage) | no | |
2136
+ | title | string | no | |
2137
+
2138
+ ---
2139
+
2140
+
2141
+
2142
+
2143
+ #### [SEOImage](#SEOImage)
2144
+
2145
+ | Properties | Type | Nullable | Description |
2146
+ | ---------- | ---- | -------- | ----------- |
2147
+ | url | string | no | |
2148
+
2149
+ ---
2150
+
2151
+
2152
+
2153
+
2154
+ #### [DateMeta](#DateMeta)
2155
+
2156
+ | Properties | Type | Nullable | Description |
2157
+ | ---------- | ---- | -------- | ----------- |
2158
+ | created_on | string | no | |
2159
+ | modified_on | string | no | |
2160
+
2161
+ ---
2162
+
2163
+
2164
+
2165
+
2166
+ #### [BlogRequest](#BlogRequest)
2167
+
2168
+ | Properties | Type | Nullable | Description |
2169
+ | ---------- | ---- | -------- | ----------- |
2170
+ | application | string | no | |
2171
+ | _custom_json | string | no | |
2172
+ | author | [Author](#Author) | no | |
2173
+ | content | [[ResourceContent](#ResourceContent)] | no | |
2174
+ | feature_image | [Asset](#Asset) | no | |
2175
+ | published | boolean | no | |
2176
+ | reading_time | string | no | |
2177
+ | slug | string | no | |
2178
+ | tags | [string] | no | |
2179
+ | title | string | no | |
2180
+ | seo | [SEO](#SEO) | no | |
2181
+ | _schedule | [CronSchedule](#CronSchedule) | no | |
2182
+
2183
+ ---
2184
+
2185
+
2186
+
2187
+
2188
+ #### [GetAnnouncementListSchema](#GetAnnouncementListSchema)
2189
+
2190
+ | Properties | Type | Nullable | Description |
2191
+ | ---------- | ---- | -------- | ----------- |
2192
+ | items | [[AdminAnnouncementSchema](#AdminAnnouncementSchema)] | no | |
2193
+ | page | [Page](#Page) | no | |
2194
+
2195
+ ---
2196
+
2197
+
2198
+
2199
+
2200
+ #### [CreateAnnouncementSchema](#CreateAnnouncementSchema)
2201
+
2202
+ | Properties | Type | Nullable | Description |
2203
+ | ---------- | ---- | -------- | ----------- |
2204
+ | message | string | no | |
2205
+ | data | [AdminAnnouncementSchema](#AdminAnnouncementSchema) | no | |
2206
+
2207
+ ---
2208
+
2209
+
2210
+
2211
+
2212
+ #### [DataLoaderResponseSchema](#DataLoaderResponseSchema)
2213
+
2214
+ | Properties | Type | Nullable | Description |
2215
+ | ---------- | ---- | -------- | ----------- |
2216
+ | application | string | no | |
2217
+ | company | string | no | |
2218
+ | _id | string | no | |
2219
+ | name | string | no | |
2220
+ | service | string | no | |
2221
+ | operation_id | string | no | |
2222
+ | type | string | no | |
2223
+ | url | string | no | |
2224
+ | content | string | no | |
2225
+ | __source | [DataLoaderSourceSchema](#DataLoaderSourceSchema) | no | |
2226
+
2227
+ ---
2228
+
2229
+
2230
+
2231
+
2232
+ #### [DataLoaderResetResponseSchema](#DataLoaderResetResponseSchema)
2233
+
2234
+ | Properties | Type | Nullable | Description |
2235
+ | ---------- | ---- | -------- | ----------- |
2236
+ | reset | string | no | |
2237
+
2238
+ ---
2239
+
2240
+
2241
+
2242
+
2243
+ #### [Navigation](#Navigation)
2244
+
2245
+ | Properties | Type | Nullable | Description |
2246
+ | ---------- | ---- | -------- | ----------- |
2247
+ | name | string | no | |
2248
+ | slug | string | no | |
2249
+ | orientation | string | no | |
2250
+ | created_by | [CreatedBySchema](#CreatedBySchema) | no | |
2251
+ | date_meta | [DateMeta](#DateMeta) | no | |
2252
+ | _id | string | no | |
2253
+ | position | string | no | |
2254
+ | application | string | no | |
2255
+ | platform | string | no | |
2256
+ | navigation | [NavigationReference](#NavigationReference) | no | |
2257
+
2258
+ ---
2259
+
2260
+
2261
+
2262
+
2263
+ #### [LocaleLanguage](#LocaleLanguage)
2264
+
2265
+ | Properties | Type | Nullable | Description |
2266
+ | ---------- | ---- | -------- | ----------- |
2267
+ | hi | [Language](#Language) | no | |
2268
+ | ar | [Language](#Language) | no | |
2269
+ | en_us | [Language](#Language) | no | |
2270
+
2271
+ ---
2272
+
2273
+
2274
+
2275
+
2276
+ #### [Language](#Language)
2277
+
2278
+ | Properties | Type | Nullable | Description |
2279
+ | ---------- | ---- | -------- | ----------- |
2280
+ | display | string | no | |
2281
+
2282
+ ---
2283
+
2284
+
2285
+
2286
+
2287
+ #### [Action](#Action)
2288
+
2289
+ | Properties | Type | Nullable | Description |
2290
+ | ---------- | ---- | -------- | ----------- |
2291
+ | page | [ActionPage](#ActionPage) | no | |
2292
+ | popup | [ActionPage](#ActionPage) | no | |
2293
+ | type | string | no | |
2294
+
2295
+ ---
2296
+
2297
+
2298
+
2299
+
2300
+ #### [ActionPage](#ActionPage)
2301
+
2302
+ | Properties | Type | Nullable | Description |
2303
+ | ---------- | ---- | -------- | ----------- |
2304
+ | params | [String: [string]] | no | |
2305
+ | query | [String: [string]] | no | |
2306
+ | url | string | no | |
2307
+ | type | string | no | |
2308
+
2309
+ ---
2310
+
2311
+
2312
+
2313
+
2314
+ #### [NavigationReference](#NavigationReference)
2315
+
2316
+ | Properties | Type | Nullable | Description |
2317
+ | ---------- | ---- | -------- | ----------- |
2318
+ | acl | [string] | no | |
2319
+ | tags | [string] | no | |
2320
+ | _locale_language | [LocaleLanguage](#LocaleLanguage) | no | |
2321
+ | image | string | no | |
2322
+ | type | string | no | |
2323
+ | action | [Action](#Action) | no | |
2324
+ | active | boolean | no | |
2325
+ | display | string | no | |
2326
+ | sort_order | number | no | |
2327
+ | sub_navigation | [[SubNavigationReference](#SubNavigationReference)] | no | |
2328
+
2329
+ ---
2330
+
2331
+
2332
+
2333
+
2334
+ #### [SubNavigationReference](#SubNavigationReference)
2335
+
2336
+ | Properties | Type | Nullable | Description |
2337
+ | ---------- | ---- | -------- | ----------- |
2338
+ | acl | [string] | no | |
2339
+ | tags | [string] | no | |
2340
+ | _locale_language | [LocaleLanguage](#LocaleLanguage) | no | |
2341
+ | image | string | no | |
2342
+ | type | string | no | |
2343
+ | action | [Action](#Action) | no | |
2344
+ | active | boolean | no | |
2345
+ | display | string | no | |
2346
+ | sort_order | number | no | |
2347
+ | sub_navigation | [[NavigationReference](#NavigationReference)] | no | |
2348
+
2349
+ ---
2350
+
2351
+
2352
+
2353
+
2354
+ #### [LandingPage](#LandingPage)
2355
+
2356
+ | Properties | Type | Nullable | Description |
2357
+ | ---------- | ---- | -------- | ----------- |
2358
+ | data | [LandingPageSchema](#LandingPageSchema) | no | |
2359
+ | success | boolean | no | |
2360
+
2361
+ ---
2362
+
2363
+
2364
+
2365
+
2366
+ #### [ConfigurationSchema](#ConfigurationSchema)
2367
+
2368
+ | Properties | Type | Nullable | Description |
2369
+ | ---------- | ---- | -------- | ----------- |
2370
+ | sleep_time | number | no | |
2371
+ | start_on_launch | boolean | no | |
2372
+ | duration | number | no | |
2373
+ | slide_direction | string | no | |
2374
+
2375
+ ---
2376
+
2377
+
2378
+
2379
+
2380
+ #### [SlideshowMedia](#SlideshowMedia)
2381
+
2382
+ | Properties | Type | Nullable | Description |
2383
+ | ---------- | ---- | -------- | ----------- |
2384
+ | type | string | no | |
2385
+ | url | string | no | |
2386
+ | bg_color | string | no | |
2387
+ | duration | number | no | |
2388
+ | auto_decide_duration | boolean | no | |
2389
+ | action | [Action](#Action) | no | |
2390
+
2391
+ ---
2392
+
2393
+
2394
+
2395
+
2396
+ #### [Slideshow](#Slideshow)
2397
+
2398
+ | Properties | Type | Nullable | Description |
2399
+ | ---------- | ---- | -------- | ----------- |
2400
+ | data | [SlideshowSchema](#SlideshowSchema) | no | |
2401
+ | success | boolean | no | |
2402
+
2403
+ ---
2404
+
2405
+
2406
+
2407
+
2408
+ #### [AnnouncementsResponseSchema](#AnnouncementsResponseSchema)
2409
+
2410
+ | Properties | Type | Nullable | Description |
2411
+ | ---------- | ---- | -------- | ----------- |
2412
+ | announcements | [String: [[AnnouncementSchema](#AnnouncementSchema)]] | no | |
2413
+ | refresh_rate | number | no | number of seconds after which api should hit again to fetch new announcements |
2414
+ | refresh_pages | [string] | no | list of page slugs on which announcement should be fetched as soon as they are loaded |
2415
+
2416
+ ---
2417
+
2418
+
2419
+
2420
+
2421
+ #### [FaqResponseSchema](#FaqResponseSchema)
2422
+
2423
+ | Properties | Type | Nullable | Description |
2424
+ | ---------- | ---- | -------- | ----------- |
2425
+ | faqs | [[FaqSchema](#FaqSchema)] | no | |
2426
+
2427
+ ---
2428
+
2429
+
2430
+
2431
+
2432
+ #### [UpdateHandpickedSchema](#UpdateHandpickedSchema)
2433
+
2434
+ | Properties | Type | Nullable | Description |
2435
+ | ---------- | ---- | -------- | ----------- |
2436
+ | tag | [HandpickedTagSchema](#HandpickedTagSchema) | no | |
2437
+
2438
+ ---
2439
+
2440
+
2441
+
2442
+
2443
+ #### [HandpickedTagSchema](#HandpickedTagSchema)
2444
+
2445
+ | Properties | Type | Nullable | Description |
2446
+ | ---------- | ---- | -------- | ----------- |
2447
+ | position | string | no | |
2448
+ | attributes | string | no | |
2449
+ | name | string | no | |
2450
+ | url | string | no | |
2451
+ | type | string | no | |
2452
+ | sub_type | string | no | |
2453
+ | content | string | no | |
2454
+
2455
+ ---
2456
+
2457
+
2458
+
2459
+
2460
+ #### [RemoveHandpickedSchema](#RemoveHandpickedSchema)
2461
+
2462
+ | Properties | Type | Nullable | Description |
2463
+ | ---------- | ---- | -------- | ----------- |
2464
+ | tags | [string] | no | |
2465
+
2466
+ ---
2467
+
2468
+
2469
+
2470
+
2471
+ #### [CreateTagSchema](#CreateTagSchema)
2472
+
2473
+ | Properties | Type | Nullable | Description |
2474
+ | ---------- | ---- | -------- | ----------- |
2475
+ | name | string | no | |
2476
+ | sub_type | string | no | |
2477
+ | _id | string | no | |
2478
+ | type | string | no | |
2479
+ | url | string | no | |
2480
+ | position | string | no | |
2481
+ | attributes | string | no | |
2482
+ | content | string | no | |
2483
+
2484
+ ---
2485
+
2486
+
2487
+
2488
+
2489
+ #### [CreateTagRequestSchema](#CreateTagRequestSchema)
2490
+
2491
+ | Properties | Type | Nullable | Description |
2492
+ | ---------- | ---- | -------- | ----------- |
2493
+ | tags | [[CreateTagSchema](#CreateTagSchema)] | no | |
2494
+
2495
+ ---
2496
+
2497
+
2498
+
2499
+
2500
+ #### [DataLoaderSchema](#DataLoaderSchema)
2501
+
2502
+ | Properties | Type | Nullable | Description |
2503
+ | ---------- | ---- | -------- | ----------- |
2504
+ | name | string | no | |
2505
+ | service | string | no | |
2506
+ | operation_id | string | no | |
2507
+ | type | string | no | |
2508
+ | url | string | no | |
2509
+ | content | string | no | |
2510
+ | __source | [DataLoaderSourceSchema](#DataLoaderSourceSchema) | no | |
2511
+ | _id | string | no | |
2512
+
2513
+ ---
2514
+
2515
+
2516
+
2517
+
2518
+ #### [DataLoaderSourceSchema](#DataLoaderSourceSchema)
2519
+
2520
+ | Properties | Type | Nullable | Description |
2521
+ | ---------- | ---- | -------- | ----------- |
2522
+ | type | string | no | |
2523
+ | id | string | no | |
2524
+
2525
+ ---
2526
+
2527
+
2528
+
2529
+
2530
+ #### [DataLoadersSchema](#DataLoadersSchema)
2531
+
2532
+ | Properties | Type | Nullable | Description |
2533
+ | ---------- | ---- | -------- | ----------- |
2534
+ | items | [[DataLoaderSchema](#DataLoaderSchema)] | no | |
2535
+
2536
+ ---
2537
+
2538
+
2539
+
2540
+
2541
+ #### [TagDeleteSuccessResponse](#TagDeleteSuccessResponse)
2542
+
2543
+ | Properties | Type | Nullable | Description |
2544
+ | ---------- | ---- | -------- | ----------- |
2545
+ | success | boolean | no | |
2546
+
2547
+ ---
2548
+
2549
+
2550
+
2551
+
2552
+ #### [ContentAPIError](#ContentAPIError)
2553
+
2554
+ | Properties | Type | Nullable | Description |
2555
+ | ---------- | ---- | -------- | ----------- |
2556
+ | message | string | no | |
2557
+ | status | number | no | |
2558
+ | code | string | no | |
2559
+ | exception | string | no | |
2560
+ | info | string | no | |
2561
+ | request_id | string | no | |
2562
+ | stack_trace | string | no | |
2563
+ | meta | string | no | |
2564
+
2565
+ ---
2566
+
2567
+
2568
+
2569
+
2570
+ #### [CommonError](#CommonError)
2571
+
2572
+ | Properties | Type | Nullable | Description |
2573
+ | ---------- | ---- | -------- | ----------- |
2574
+ | message | string | no | |
2575
+
2576
+ ---
2577
+
2578
+
2579
+
2580
+
2581
+ #### [CategorySchema](#CategorySchema)
2582
+
2583
+ | Properties | Type | Nullable | Description |
2584
+ | ---------- | ---- | -------- | ----------- |
2585
+ | index | number | no | |
2586
+ | title | string | no | |
2587
+ | description | string | no | |
2588
+ | children | [string] | no | |
2589
+ | _id | string | no | |
2590
+ | slug | string | no | |
2591
+ | application | string | no | |
2592
+ | icon_url | string | no | |
2593
+ | _custom_json | string | no | |
2594
+
2595
+ ---
2596
+
2597
+
2598
+
2599
+
2600
+ #### [ChildrenSchema](#ChildrenSchema)
2601
+
2602
+ | Properties | Type | Nullable | Description |
2603
+ | ---------- | ---- | -------- | ----------- |
2604
+ | question | string | no | |
2605
+ | answer | string | no | |
2606
+ | slug | string | no | |
2607
+ | application | string | no | |
2608
+ | _id | string | no | |
2609
+
2610
+ ---
2611
+
2612
+
2613
+
2614
+
2615
+ #### [CategoryRequestSchema](#CategoryRequestSchema)
2616
+
2617
+ | Properties | Type | Nullable | Description |
2618
+ | ---------- | ---- | -------- | ----------- |
2619
+ | slug | string | no | |
2620
+ | title | string | no | |
2621
+
2622
+ ---
2623
+
2624
+
2625
+
2626
+
2627
+ #### [FAQCategorySchema](#FAQCategorySchema)
2628
+
2629
+ | Properties | Type | Nullable | Description |
2630
+ | ---------- | ---- | -------- | ----------- |
2631
+ | index | number | no | |
2632
+ | title | string | no | |
2633
+ | description | string | no | |
2634
+ | children | [[ChildrenSchema](#ChildrenSchema)] | no | |
2635
+ | _id | string | no | |
2636
+ | slug | string | no | |
2637
+ | application | string | no | |
2638
+ | icon_url | string | no | |
2639
+ | _custom_json | string | no | |
2640
+
2641
+ ---
2642
+
2643
+
2644
+
2645
+
2646
+ #### [FaqSchema](#FaqSchema)
2647
+
2648
+ | Properties | Type | Nullable | Description |
2649
+ | ---------- | ---- | -------- | ----------- |
2650
+ | slug | string | no | |
2651
+ | application | string | no | |
2652
+ | _id | string | no | |
2653
+ | question | string | no | |
2654
+ | answer | string | no | |
2655
+ | tags | [string] | no | |
2656
+
2657
+ ---
2658
+
2659
+
2660
+
2661
+
2662
+ #### [FAQ](#FAQ)
2663
+
2664
+ | Properties | Type | Nullable | Description |
2665
+ | ---------- | ---- | -------- | ----------- |
2666
+ | slug | string | no | |
2667
+ | question | string | no | |
2668
+ | answer | string | no | |
2669
+
2670
+ ---
2671
+
2672
+
2673
+
2674
+
2675
+ #### [CreateFaqResponseSchema](#CreateFaqResponseSchema)
2676
+
2677
+ | Properties | Type | Nullable | Description |
2678
+ | ---------- | ---- | -------- | ----------- |
2679
+ | faq | [FaqSchema](#FaqSchema) | no | |
2680
+
2681
+ ---
2682
+
2683
+
2684
+
2685
+
2686
+ #### [CreateFaqSchema](#CreateFaqSchema)
2687
+
2688
+ | Properties | Type | Nullable | Description |
2689
+ | ---------- | ---- | -------- | ----------- |
2690
+ | faq | [FAQ](#FAQ) | no | |
2691
+
2692
+ ---
2693
+
2694
+
2695
+
2696
+
2697
+ #### [GetFaqSchema](#GetFaqSchema)
2698
+
2699
+ | Properties | Type | Nullable | Description |
2700
+ | ---------- | ---- | -------- | ----------- |
2701
+ | faqs | [[FaqSchema](#FaqSchema)] | no | |
2702
+
2703
+ ---
2704
+
2705
+
2706
+
2707
+
2708
+ #### [UpdateFaqCategoryRequestSchema](#UpdateFaqCategoryRequestSchema)
2709
+
2710
+ | Properties | Type | Nullable | Description |
2711
+ | ---------- | ---- | -------- | ----------- |
2712
+ | category | [CategorySchema](#CategorySchema) | no | |
2713
+
2714
+ ---
2715
+
2716
+
2717
+
2718
+
2719
+ #### [CreateFaqCategoryRequestSchema](#CreateFaqCategoryRequestSchema)
2720
+
2721
+ | Properties | Type | Nullable | Description |
2722
+ | ---------- | ---- | -------- | ----------- |
2723
+ | category | [CategoryRequestSchema](#CategoryRequestSchema) | no | |
2724
+
2725
+ ---
2726
+
2727
+
2728
+
2729
+
2730
+ #### [CreateFaqCategorySchema](#CreateFaqCategorySchema)
2731
+
2732
+ | Properties | Type | Nullable | Description |
2733
+ | ---------- | ---- | -------- | ----------- |
2734
+ | category | [CategorySchema](#CategorySchema) | no | |
2735
+
2736
+ ---
2737
+
2738
+
2739
+
2740
+
2741
+ #### [GetFaqCategoriesSchema](#GetFaqCategoriesSchema)
2742
+
2743
+ | Properties | Type | Nullable | Description |
2744
+ | ---------- | ---- | -------- | ----------- |
2745
+ | categories | [[CategorySchema](#CategorySchema)] | no | |
2746
+
2747
+ ---
2748
+
2749
+
2750
+
2751
+
2752
+ #### [GetFaqCategoryBySlugSchema](#GetFaqCategoryBySlugSchema)
2753
+
2754
+ | Properties | Type | Nullable | Description |
2755
+ | ---------- | ---- | -------- | ----------- |
2756
+ | category | [FAQCategorySchema](#FAQCategorySchema) | no | |
2757
+
2758
+ ---
2759
+
2760
+
2761
+
2762
+
2763
+ #### [Page](#Page)
2764
+
2765
+ | Properties | Type | Nullable | Description |
2766
+ | ---------- | ---- | -------- | ----------- |
2767
+ | item_total | number | no | |
2768
+ | next_id | string | no | |
2769
+ | has_previous | boolean | no | |
2770
+ | has_next | boolean | no | |
2771
+ | current | number | no | |
2772
+ | type | string | yes | |
2773
+ | size | number | no | |
2774
+
2775
+ ---
2776
+
2777
+
2778
+
2779
+
2780
+ #### [LandingPageGetResponse](#LandingPageGetResponse)
2781
+
2782
+ | Properties | Type | Nullable | Description |
2783
+ | ---------- | ---- | -------- | ----------- |
2784
+ | items | [[LandingPageSchema](#LandingPageSchema)] | no | |
2785
+ | page | [Page](#Page) | no | |
2786
+
2787
+ ---
2788
+
2789
+
2790
+
2791
+
2792
+ #### [LandingPageSchema](#LandingPageSchema)
2793
+
2794
+ | Properties | Type | Nullable | Description |
2795
+ | ---------- | ---- | -------- | ----------- |
2796
+ | slug | string | no | |
2797
+ | action | [Action](#Action) | no | |
2798
+ | platform | [string] | no | |
2799
+ | created_by | [CreatedBySchema](#CreatedBySchema) | no | |
2800
+ | date_meta | [DateMeta](#DateMeta) | no | |
2801
+ | _id | string | no | |
2802
+ | application | string | no | |
2803
+ | archived | boolean | no | |
2804
+ | _custom_json | string | no | |
2805
+
2806
+ ---
2807
+
2808
+
2809
+
2810
+
2811
+ #### [DefaultNavigationResponse](#DefaultNavigationResponse)
2812
+
2813
+ | Properties | Type | Nullable | Description |
2814
+ | ---------- | ---- | -------- | ----------- |
2815
+ | items | [[NavigationSchema](#NavigationSchema)] | no | |
2816
+
2817
+ ---
2818
+
2819
+
2820
+
2821
+
2822
+ #### [NavigationGetResponse](#NavigationGetResponse)
2823
+
2824
+ | Properties | Type | Nullable | Description |
2825
+ | ---------- | ---- | -------- | ----------- |
2826
+ | items | [[NavigationSchema](#NavigationSchema)] | no | |
2827
+ | page | [Page](#Page) | no | |
2828
+
2829
+ ---
2830
+
2831
+
2832
+
2833
+
2834
+ #### [Orientation](#Orientation)
2835
+
2836
+ | Properties | Type | Nullable | Description |
2837
+ | ---------- | ---- | -------- | ----------- |
2838
+ | portrait | [string] | no | |
2839
+ | landscape | [string] | no | |
2840
+
2841
+ ---
2842
+
2843
+
2844
+
2845
+
2846
+ #### [NavigationSchema](#NavigationSchema)
2847
+
2848
+ | Properties | Type | Nullable | Description |
2849
+ | ---------- | ---- | -------- | ----------- |
2850
+ | _id | string | no | |
2851
+ | application | string | no | |
2852
+ | archived | boolean | no | |
2853
+ | name | string | no | |
2854
+ | slug | string | no | |
2855
+ | platform | [string] | no | |
2856
+ | created_by | [CreatedBySchema](#CreatedBySchema) | no | |
2857
+ | date_meta | [DateMeta](#DateMeta) | no | |
2858
+ | orientation | [Orientation](#Orientation) | no | |
2859
+ | version | number | no | |
2860
+ | navigation | [[NavigationReference](#NavigationReference)] | no | |
2861
+
2862
+ ---
2863
+
2864
+
2865
+
2866
+
2867
+ #### [NavigationRequest](#NavigationRequest)
2868
+
2869
+ | Properties | Type | Nullable | Description |
2870
+ | ---------- | ---- | -------- | ----------- |
2871
+ | name | string | no | |
2872
+ | slug | string | no | |
2873
+ | platform | [string] | no | |
2874
+ | orientation | [Orientation](#Orientation) | no | |
2875
+ | navigation | [[NavigationReference](#NavigationReference)] | no | |
2876
+
2877
+ ---
2878
+
2879
+
2880
+
2881
+
2882
+ #### [CustomPageSchema](#CustomPageSchema)
2883
+
2884
+ | Properties | Type | Nullable | Description |
2885
+ | ---------- | ---- | -------- | ----------- |
2886
+ | _id | string | no | |
2887
+ | platform | string | no | |
2888
+ | title | string | no | |
2889
+ | slug | string | no | |
2890
+ | type | string | no | |
2891
+ | orientation | string | no | |
2892
+ | application | string | no | |
2893
+ | description | string | no | |
2894
+ | published | boolean | no | |
2895
+ | tags | [string] | no | |
2896
+ | content | [string] | no | |
2897
+ | created_by | [CreatedBySchema](#CreatedBySchema) | no | |
2898
+ | date_meta | [DateMeta](#DateMeta) | no | |
2899
+ | _schedule | [ScheduleSchema](#ScheduleSchema) | no | |
2900
+
2901
+ ---
2902
+
2903
+
2904
+
2905
+
2906
+ #### [ContentSchema](#ContentSchema)
2907
+
2908
+ | Properties | Type | Nullable | Description |
2909
+ | ---------- | ---- | -------- | ----------- |
2910
+ | type | string | no | |
2911
+ | value | string | no | |
2912
+
2913
+ ---
2914
+
2915
+
2916
+
2917
+
2918
+ #### [CustomPage](#CustomPage)
2919
+
2920
+ | Properties | Type | Nullable | Description |
2921
+ | ---------- | ---- | -------- | ----------- |
2922
+ | data | [CustomPageSchema](#CustomPageSchema) | no | |
2923
+
2924
+ ---
2925
+
2926
+
2927
+
2928
+
2929
+ #### [FeatureImage](#FeatureImage)
2930
+
2931
+ | Properties | Type | Nullable | Description |
2932
+ | ---------- | ---- | -------- | ----------- |
2933
+ | secure_url | string | no | |
2934
+
2935
+ ---
2936
+
2937
+
2938
+
2939
+
2940
+ #### [PageGetResponse](#PageGetResponse)
2941
+
2942
+ | Properties | Type | Nullable | Description |
2943
+ | ---------- | ---- | -------- | ----------- |
2944
+ | items | [[PageSchema](#PageSchema)] | no | |
2945
+ | page | [Page](#Page) | no | |
2946
+
2947
+ ---
2948
+
2949
+
2950
+
2951
+
2952
+ #### [PageSpec](#PageSpec)
2953
+
2954
+ | Properties | Type | Nullable | Description |
2955
+ | ---------- | ---- | -------- | ----------- |
2956
+ | specifications | [[PageSpecItem](#PageSpecItem)] | no | |
2957
+
2958
+ ---
2959
+
2960
+
2961
+
2962
+
2963
+ #### [PageSpecParam](#PageSpecParam)
2964
+
2965
+ | Properties | Type | Nullable | Description |
2966
+ | ---------- | ---- | -------- | ----------- |
2967
+ | key | string | no | |
2968
+ | required | boolean | no | |
2969
+
2970
+ ---
2971
+
2972
+
2973
+
2974
+
2975
+ #### [PageSpecItem](#PageSpecItem)
2976
+
2977
+ | Properties | Type | Nullable | Description |
2978
+ | ---------- | ---- | -------- | ----------- |
2979
+ | page_type | string | no | |
2980
+ | display_name | string | no | |
2981
+ | params | [[PageSpecParam](#PageSpecParam)] | no | |
2982
+ | query | [[PageSpecParam](#PageSpecParam)] | no | |
2983
+
2984
+ ---
2985
+
2986
+
2987
+
2988
+
2989
+ #### [PageSchema](#PageSchema)
2990
+
2991
+ | Properties | Type | Nullable | Description |
2992
+ | ---------- | ---- | -------- | ----------- |
2993
+ | _id | string | no | |
2994
+ | application | string | no | |
2995
+ | component_ids | [string] | no | Components can be used to store multiple components |
2996
+ | content | [string] | no | |
2997
+ | content_path | string | no | |
2998
+ | created_by | [CreatedBySchema](#CreatedBySchema) | no | |
2999
+ | date_meta | [DateMeta](#DateMeta) | no | |
3000
+ | description | string | no | |
3001
+ | feature_image | [Asset](#Asset) | no | |
3002
+ | page_meta | [string] | no | |
3003
+ | _schedule | [ScheduleSchema](#ScheduleSchema) | no | |
3004
+ | _custom_json | string | no | |
3005
+ | orientation | string | no | |
3006
+ | platform | string | no | |
3007
+ | published | boolean | no | |
3008
+ | slug | string | no | |
3009
+ | tags | [string] | no | |
3010
+ | title | string | no | |
3011
+ | type | string | no | |
3012
+ | seo | [SEO](#SEO) | no | |
3013
+ | visibility | string | no | |
3014
+ | archived | boolean | no | |
3015
+
3016
+ ---
3017
+
3018
+
3019
+
3020
+
3021
+ #### [CreatedBySchema](#CreatedBySchema)
3022
+
3023
+ | Properties | Type | Nullable | Description |
3024
+ | ---------- | ---- | -------- | ----------- |
3025
+ | id | string | no | |
3026
+
3027
+ ---
3028
+
3029
+
3030
+
3031
+
3032
+ #### [PageContent](#PageContent)
3033
+
3034
+ | Properties | Type | Nullable | Description |
3035
+ | ---------- | ---- | -------- | ----------- |
3036
+ | type | string | no | |
3037
+ | value | string | no | |
3038
+
3039
+ ---
3040
+
3041
+
3042
+
3043
+
3044
+ #### [PageMeta](#PageMeta)
3045
+
3046
+ | Properties | Type | Nullable | Description |
3047
+ | ---------- | ---- | -------- | ----------- |
3048
+ | key | string | no | |
3049
+ | value | string | no | |
3050
+
3051
+ ---
3052
+
3053
+
3054
+
3055
+
3056
+ #### [PageRequest](#PageRequest)
3057
+
3058
+ | Properties | Type | Nullable | Description |
3059
+ | ---------- | ---- | -------- | ----------- |
3060
+ | _schedule | [CronSchedule](#CronSchedule) | no | |
3061
+ | application | string | no | |
3062
+ | author | [Author](#Author) | no | |
3063
+ | _custom_json | string | no | |
3064
+ | orientation | string | no | |
3065
+ | content | [string] | no | |
3066
+ | feature_image | [Asset](#Asset) | no | |
3067
+ | published | boolean | no | |
3068
+ | reading_time | string | no | |
3069
+ | slug | string | no | |
3070
+ | tags | [string] | no | |
3071
+ | seo | [SEO](#SEO) | no | |
3072
+ | title | string | no | |
3073
+
3074
+ ---
3075
+
3076
+
3077
+
3078
+
3079
+ #### [CronSchedule](#CronSchedule)
3080
+
3081
+ | Properties | Type | Nullable | Description |
3082
+ | ---------- | ---- | -------- | ----------- |
3083
+ | cron | string | no | |
3084
+ | start | string | no | |
3085
+ | end | string | no | |
3086
+ | duration | number | no | |
3087
+
3088
+ ---
3089
+
3090
+
3091
+
3092
+
3093
+ #### [PagePublishRequest](#PagePublishRequest)
3094
+
3095
+ | Properties | Type | Nullable | Description |
3096
+ | ---------- | ---- | -------- | ----------- |
3097
+ | publish | boolean | no | |
3098
+
3099
+ ---
3100
+
3101
+
3102
+
3103
+
3104
+ #### [PageMetaSchema](#PageMetaSchema)
3105
+
3106
+ | Properties | Type | Nullable | Description |
3107
+ | ---------- | ---- | -------- | ----------- |
3108
+ | system_pages | [[NavigationSchema](#NavigationSchema)] | no | |
3109
+ | custom_pages | [[PageSchema](#PageSchema)] | no | |
3110
+ | application_id | string | no | |
3111
+
3112
+ ---
3113
+
3114
+
3115
+
3116
+
3117
+ #### [SlideshowGetResponse](#SlideshowGetResponse)
3118
+
3119
+ | Properties | Type | Nullable | Description |
3120
+ | ---------- | ---- | -------- | ----------- |
3121
+ | items | [[SlideshowSchema](#SlideshowSchema)] | no | |
3122
+ | page | [Page](#Page) | no | |
3123
+
3124
+ ---
3125
+
3126
+
3127
+
3128
+
3129
+ #### [SlideshowSchema](#SlideshowSchema)
3130
+
3131
+ | Properties | Type | Nullable | Description |
3132
+ | ---------- | ---- | -------- | ----------- |
3133
+ | _id | string | no | |
3134
+ | slug | string | no | |
3135
+ | date_meta | [DateMeta](#DateMeta) | no | |
3136
+ | application | string | no | |
3137
+ | platform | string | no | |
3138
+ | configuration | [ConfigurationSchema](#ConfigurationSchema) | no | |
3139
+ | media | [[SlideshowMedia](#SlideshowMedia)] | no | |
3140
+ | active | boolean | no | |
3141
+ | archived | boolean | no | |
3142
+ | _custom_json | string | no | |
3143
+
3144
+ ---
3145
+
3146
+
3147
+
3148
+
3149
+ #### [SlideshowRequest](#SlideshowRequest)
3150
+
3151
+ | Properties | Type | Nullable | Description |
3152
+ | ---------- | ---- | -------- | ----------- |
3153
+ | slug | string | no | |
3154
+ | platform | string | no | |
3155
+ | configuration | [ConfigurationSchema](#ConfigurationSchema) | no | |
3156
+ | media | [SlideshowMedia](#SlideshowMedia) | no | |
3157
+ | active | boolean | no | |
3158
+
3159
+ ---
3160
+
3161
+
3162
+
3163
+
3164
+ #### [Support](#Support)
3165
+
3166
+ | Properties | Type | Nullable | Description |
3167
+ | ---------- | ---- | -------- | ----------- |
3168
+ | created | boolean | no | |
3169
+ | _id | string | no | |
3170
+ | config_type | string | no | |
3171
+ | application | string | no | |
3172
+ | created_at | string | no | |
3173
+ | updated_at | string | no | |
3174
+ | contact | [ContactSchema](#ContactSchema) | no | |
3175
+
3176
+ ---
3177
+
3178
+
3179
+
3180
+
3181
+ #### [PhoneProperties](#PhoneProperties)
3182
+
3183
+ | Properties | Type | Nullable | Description |
3184
+ | ---------- | ---- | -------- | ----------- |
3185
+ | key | string | no | |
3186
+ | code | string | no | |
3187
+ | number | string | no | |
3188
+
3189
+ ---
3190
+
3191
+
3192
+
3193
+
3194
+ #### [PhoneSchema](#PhoneSchema)
3195
+
3196
+ | Properties | Type | Nullable | Description |
3197
+ | ---------- | ---- | -------- | ----------- |
3198
+ | active | boolean | no | |
3199
+ | phone | [[PhoneProperties](#PhoneProperties)] | no | |
3200
+
3201
+ ---
3202
+
3203
+
3204
+
3205
+
3206
+ #### [EmailProperties](#EmailProperties)
3207
+
3208
+ | Properties | Type | Nullable | Description |
3209
+ | ---------- | ---- | -------- | ----------- |
3210
+ | key | string | no | |
3211
+ | value | string | no | |
3212
+
3213
+ ---
3214
+
3215
+
3216
+
3217
+
3218
+ #### [EmailSchema](#EmailSchema)
3219
+
3220
+ | Properties | Type | Nullable | Description |
3221
+ | ---------- | ---- | -------- | ----------- |
3222
+ | active | boolean | no | |
3223
+ | email | [[EmailProperties](#EmailProperties)] | no | |
3224
+
3225
+ ---
3226
+
3227
+
3228
+
3229
+
3230
+ #### [ContactSchema](#ContactSchema)
3231
+
3232
+ | Properties | Type | Nullable | Description |
3233
+ | ---------- | ---- | -------- | ----------- |
3234
+ | phone | [PhoneSchema](#PhoneSchema) | no | |
3235
+ | email | [EmailSchema](#EmailSchema) | no | |
3236
+
3237
+ ---
3238
+
3239
+
3240
+
3241
+
3242
+ #### [TagsSchema](#TagsSchema)
3243
+
3244
+ | Properties | Type | Nullable | Description |
3245
+ | ---------- | ---- | -------- | ----------- |
3246
+ | application | string | no | |
3247
+ | _id | string | no | |
3248
+ | tags | [[TagSchema](#TagSchema)] | no | |
3249
+
3250
+ ---
3251
+
3252
+
3253
+
3254
+
3255
+ #### [TagSchema](#TagSchema)
3256
+
3257
+ | Properties | Type | Nullable | Description |
3258
+ | ---------- | ---- | -------- | ----------- |
3259
+ | name | string | no | |
3260
+ | url | string | no | |
3261
+ | type | string | no | |
3262
+ | sub_type | string | no | |
3263
+ | _id | string | no | |
3264
+ | position | string | no | |
3265
+ | attributes | string | no | |
3266
+ | content | string | no | |
3267
+ | __source | [TagSourceSchema](#TagSourceSchema) | no | |
3268
+
3269
+ ---
3270
+
3271
+
3272
+
3273
+
3274
+ #### [TagSourceSchema](#TagSourceSchema)
3275
+
3276
+ | Properties | Type | Nullable | Description |
3277
+ | ---------- | ---- | -------- | ----------- |
3278
+ | type | string | no | |
3279
+ | id | string | no | |
3280
+
3281
+ ---
3282
+
3283
+
3284
+
3285
+
3286
+ ### Enums
3287
+
3288
+
3289
+
3290
+
3291
+
3292
+ #### [PageType](#PageType)
3293
+ Type : string
3294
+
3295
+ | Name | Value | Description |
3296
+ | ---- | ----- | ----------- |
3297
+ | aboutUs | about-us | Symbolic link for About Us: /about-us |
3298
+ | addresses | addresses | Symbolic link for Saved Addresses: /profile/address |
3299
+ | blog | blog | Symbolic link for Blog: /blog/:slug |
3300
+ | brands | brands | Symbolic link for Brands: /brands/:department |
3301
+ | cards | cards | Symbolic link for Saved Cards: /profile/my-cards |
3302
+ | cart | cart | Symbolic link for Cart: /cart/bag/ |
3303
+ | categories | categories | Symbolic link for Categories: /categories/:department |
3304
+ | brand | brand | Symbolic link for Brand: /brand/:slug |
3305
+ | category | category | Symbolic link for Category: /category/:slug |
3306
+ | collection | collection | Symbolic link for Collection: /collection/:slug |
3307
+ | collections | collections | Symbolic link for Collections: /collections/ |
3308
+ | contactUs | contact-us | Symbolic link for Contact Us: /contact-us/ |
3309
+ | external | external | Symbolic link for External Link: /external/ |
3310
+ | faq | faq | Symbolic link for FAQ: /faq |
3311
+ | freshchat | freshchat | Symbolic link for Chat by Freshchat: /freshchat |
3312
+ | home | home | Symbolic link for Home: / |
3313
+ | notificationSettings | notification-settings | Symbolic link for Notification Settings: /notification-settings |
3314
+ | orders | orders | Symbolic link for Orders: /profile/orders |
3315
+ | page | page | Symbolic link for Page: /page/:slug |
3316
+ | policy | policy | Symbolic link for Privacy Policy: /privacy-policy |
3317
+ | product | product | Symbolic link for Product: /product/:slug |
3318
+ | productReviews | product-reviews | Symbolic link for Product Reviews: /product/:slug/reviews |
3319
+ | addProductReview | add-product-review | Symbolic link for Add Product review: /product/:slug/add-review |
3320
+ | productRequest | product-request | Symbolic link for Product Request: /product-request/ |
3321
+ | products | products | Symbolic link for Products: /products/ |
3322
+ | profile | profile | Symbolic link for Profile: /profile |
3323
+ | profileBasic | profile-basic | Symbolic link for Basic Profile: /profile/details |
3324
+ | profileCompany | profile-company | Symbolic link for Profile Company: /profile/company |
3325
+ | profileEmails | profile-emails | Symbolic link for Profile Emails: /profile/email |
3326
+ | profilePhones | profile-phones | Symbolic link for Profile Phones: /profile/phone |
3327
+ | rateUs | rate-us | Symbolic link for Rate Us: /rate-us |
3328
+ | referEarn | refer-earn | Symbolic link for Refer & Earn: /profile/refer-earn |
3329
+ | settings | settings | Symbolic link for Settings: /setting/currency |
3330
+ | sharedCart | shared-cart | Symbolic link for Shared Cart: /shared-cart/:token |
3331
+ | tnc | tnc | Symbolic link for Terms and Conditions: /terms-and-conditions |
3332
+ | trackOrder | track-order | Symbolic link for Track Order: /order-tracking/:orderId |
3333
+ | wishlist | wishlist | Symbolic link for Wishlist: /wishlist/ |
3334
+ | sections | sections | Symbolic link for Sections: /sections/:group |
3335
+ | form | form | Symbolic link for Form: /form/:slug |
3336
+ | cartDelivery | cart-delivery | Symbolic link for Cart Delivery: /cart/delivery |
3337
+ | cartPayment | cart-payment | Symbolic link for Cart Payment Information: /cart/payment-info |
3338
+ | cartReview | cart-review | Symbolic link for Cart Order Review: /cart/order-review |
3339
+ | login | login | Symbolic link for Login: /auth/login |
3340
+ | register | register | Symbolic link for Register: /auth/register |
3341
+ | shippingPolicy | shipping-policy | Symbolic link for Shipping policy: /shipping-policy |
3342
+ | returnPolicy | return-policy | Symbolic link for Return policy: /return-policy |
3343
+
3344
+ ---
3345
+
3346
+
3347
+
3348
+
3349
+
3350
+