@gofynd/fdk-client-javascript 1.0.1 → 1.0.2

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 (134) hide show
  1. package/documentation/application/CART.md +251 -251
  2. package/documentation/application/CATALOG.md +414 -414
  3. package/documentation/application/CONTENT.md +15 -1
  4. package/documentation/application/ORDER.md +290 -290
  5. package/documentation/application/PAYMENT.md +255 -255
  6. package/documentation/application/POSCART.md +297 -297
  7. package/documentation/platform/CART.md +499 -499
  8. package/documentation/platform/CATALOG.md +3088 -2702
  9. package/documentation/platform/COMPANYPROFILE.md +201 -201
  10. package/documentation/platform/CONTENT.md +123 -1
  11. package/documentation/platform/ORDER.md +1233 -1158
  12. package/documentation/platform/PARTNER.md +7 -7
  13. package/documentation/platform/PAYMENT.md +83 -83
  14. package/package.json +1 -1
  15. package/sdk/application/ApplicationConfig.js +1 -1
  16. package/sdk/application/Cart/CartApplicationClient.js +619 -108
  17. package/sdk/application/Cart/CartApplicationModel.d.ts +7 -7
  18. package/sdk/application/Cart/CartApplicationModel.js +335 -335
  19. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +1 -1
  20. package/sdk/application/Catalog/CatalogApplicationClient.js +730 -134
  21. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +21 -21
  22. package/sdk/application/Catalog/CatalogApplicationModel.js +547 -547
  23. package/sdk/application/Common/CommonApplicationClient.js +48 -8
  24. package/sdk/application/Communication/CommunicationApplicationClient.js +75 -14
  25. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +1 -1
  26. package/sdk/application/Configuration/ConfigurationApplicationClient.js +392 -66
  27. package/sdk/application/Content/ContentApplicationClient.js +444 -76
  28. package/sdk/application/Content/ContentApplicationModel.d.ts +1 -0
  29. package/sdk/application/Content/ContentApplicationModel.js +11 -1
  30. package/sdk/application/FileStorage/FileStorageApplicationClient.js +74 -12
  31. package/sdk/application/Lead/LeadApplicationClient.js +164 -30
  32. package/sdk/application/Logistic/LogisticApplicationClient.js +98 -16
  33. package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
  34. package/sdk/application/Order/OrderApplicationClient.js +287 -54
  35. package/sdk/application/Order/OrderApplicationModel.d.ts +19 -19
  36. package/sdk/application/Order/OrderApplicationModel.js +357 -357
  37. package/sdk/application/Payment/PaymentApplicationClient.js +961 -186
  38. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3 -3
  39. package/sdk/application/Payment/PaymentApplicationModel.js +352 -352
  40. package/sdk/application/PosCart/PosCartApplicationClient.js +645 -114
  41. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +15 -15
  42. package/sdk/application/PosCart/PosCartApplicationModel.js +389 -389
  43. package/sdk/application/Rewards/RewardsApplicationClient.js +168 -28
  44. package/sdk/application/Share/ShareApplicationClient.js +157 -32
  45. package/sdk/application/Theme/ThemeApplicationClient.js +94 -16
  46. package/sdk/application/User/UserApplicationClient.js +806 -148
  47. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +16 -8
  48. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +191 -34
  49. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  50. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
  51. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  52. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +103 -16
  53. package/sdk/platform/Billing/BillingPlatformClient.d.ts +24 -12
  54. package/sdk/platform/Billing/BillingPlatformClient.js +299 -54
  55. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -17
  56. package/sdk/platform/Cart/CartPlatformApplicationClient.js +409 -72
  57. package/sdk/platform/Cart/CartPlatformModel.d.ts +35 -35
  58. package/sdk/platform/Cart/CartPlatformModel.js +617 -617
  59. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +167 -114
  60. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1562 -453
  61. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +8 -8
  62. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +39 -39
  63. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +314 -196
  64. package/sdk/platform/Catalog/CatalogPlatformClient.js +2459 -718
  65. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +103 -94
  66. package/sdk/platform/Catalog/CatalogPlatformModel.js +2063 -1797
  67. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +17 -15
  68. package/sdk/platform/Catalog/CatalogPlatformValidator.js +95 -76
  69. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -2
  70. package/sdk/platform/Common/CommonPlatformClient.js +51 -8
  71. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -40
  72. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1000 -168
  73. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  74. package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
  75. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +27 -14
  76. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +335 -54
  77. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +10 -10
  78. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +278 -278
  79. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +56 -28
  80. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +702 -118
  81. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  82. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +457 -82
  83. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +148 -67
  84. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1724 -284
  85. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -0
  86. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +7 -0
  87. package/sdk/platform/Content/ContentPlatformModel.d.ts +4 -0
  88. package/sdk/platform/Content/ContentPlatformModel.js +43 -1
  89. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +21 -10
  90. package/sdk/platform/Discount/DiscountPlatformClient.js +270 -44
  91. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +8 -4
  92. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +102 -16
  93. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -6
  94. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +150 -24
  95. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +27 -14
  96. package/sdk/platform/Inventory/InventoryPlatformClient.js +316 -52
  97. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +26 -13
  98. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +311 -52
  99. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -11
  100. package/sdk/platform/Lead/LeadPlatformClient.js +266 -44
  101. package/sdk/platform/OAuthClient.js +8 -8
  102. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -3
  103. package/sdk/platform/Order/OrderPlatformApplicationClient.js +78 -14
  104. package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -43
  105. package/sdk/platform/Order/OrderPlatformClient.js +1062 -180
  106. package/sdk/platform/Order/OrderPlatformModel.d.ts +64 -60
  107. package/sdk/platform/Order/OrderPlatformModel.js +1481 -1425
  108. package/sdk/platform/Order/OrderPlatformValidator.js +5 -0
  109. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  110. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
  111. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  112. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  113. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +22 -11
  114. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +287 -56
  115. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +21 -11
  116. package/sdk/platform/Payment/PaymentPlatformClient.js +263 -48
  117. package/sdk/platform/Payment/PaymentPlatformModel.js +122 -122
  118. package/sdk/platform/PlatformApplicationClient.d.ts +2959 -2787
  119. package/sdk/platform/PlatformApplicationClient.js +3420 -3212
  120. package/sdk/platform/PlatformClient.d.ts +2959 -2787
  121. package/sdk/platform/PlatformClient.js +3420 -3212
  122. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +26 -13
  123. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +308 -54
  124. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +8 -4
  125. package/sdk/platform/Share/SharePlatformApplicationClient.js +94 -16
  126. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +47 -23
  127. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +571 -96
  128. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +24 -12
  129. package/sdk/platform/User/UserPlatformApplicationClient.js +296 -48
  130. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +12 -6
  131. package/sdk/platform/Webhook/WebhookPlatformClient.js +157 -30
  132. package/sdk/public/Configuration/ConfigurationPublicClient.js +51 -8
  133. package/sdk/public/Inventory/InventoryPublicClient.js +149 -26
  134. package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
@@ -9,13 +9,14 @@ declare class Content {
9
9
  * given set of results. Default value is 1.
10
10
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
11
11
  * page. Default value is 10.
12
+ * @returns {Promise<GetAnnouncementListSchema>} - Success response
12
13
  * @summary: Get a list of announcements
13
14
  * @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements.
14
15
  */
15
16
  getAnnouncementsList({ pageNo, pageSize }?: {
16
17
  pageNo?: number;
17
18
  pageSize?: number;
18
- }): Promise<any>;
19
+ }): Promise<GetAnnouncementListSchema>;
19
20
  /**
20
21
  * @param {Object} arg - Arg object.
21
22
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -35,74 +36,81 @@ declare class Content {
35
36
  /**
36
37
  * @param {Object} arg - Arg object.
37
38
  * @param {AdminAnnouncementSchema} arg.body
39
+ * @returns {Promise<CreateAnnouncementSchema>} - Success response
38
40
  * @summary: Create an announcement
39
41
  * @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to create an announcement.
40
42
  */
41
43
  createAnnouncement({ body }?: {
42
44
  body: AdminAnnouncementSchema;
43
- }): Promise<any>;
45
+ }): Promise<CreateAnnouncementSchema>;
44
46
  /**
45
47
  * @param {Object} arg - Arg object.
46
48
  * @param {string} arg.announcementId - ID allotted to the announcement.
49
+ * @returns {Promise<AdminAnnouncementSchema>} - Success response
47
50
  * @summary: Get announcement by ID
48
51
  * @description: Use this API to retrieve an announcement and its details such as the target platform and pages on which it's applicable
49
52
  */
50
53
  getAnnouncementById({ announcementId }?: {
51
54
  announcementId: string;
52
- }): Promise<any>;
55
+ }): Promise<AdminAnnouncementSchema>;
53
56
  /**
54
57
  * @param {Object} arg - Arg object.
55
58
  * @param {string} arg.announcementId - ID allotted to the announcement.
56
59
  * @param {AdminAnnouncementSchema} arg.body
60
+ * @returns {Promise<CreateAnnouncementSchema>} - Success response
57
61
  * @summary: Update an announcement
58
62
  * @description: Use this API to edit an existing announcement and its details such as the target platform and pages on which it's applicable
59
63
  */
60
64
  updateAnnouncement({ announcementId, body }?: {
61
65
  announcementId: string;
62
66
  body: AdminAnnouncementSchema;
63
- }): Promise<any>;
67
+ }): Promise<CreateAnnouncementSchema>;
64
68
  /**
65
69
  * @param {Object} arg - Arg object.
66
70
  * @param {string} arg.announcementId - ID allotted to the announcement.
67
71
  * @param {ScheduleSchema} arg.body
72
+ * @returns {Promise<CreateAnnouncementSchema>} - Success response
68
73
  * @summary: Update the schedule and the publish status of an announcement
69
74
  * @description: Use this API to edit the duration, i.e. start date-time and end date-time of an announcement. Moreover, you can enable/disable an announcement using this API.
70
75
  */
71
76
  updateAnnouncementSchedule({ announcementId, body }?: {
72
77
  announcementId: string;
73
78
  body: ScheduleSchema;
74
- }): Promise<any>;
79
+ }): Promise<CreateAnnouncementSchema>;
75
80
  /**
76
81
  * @param {Object} arg - Arg object.
77
82
  * @param {string} arg.announcementId - ID allotted to the announcement.
83
+ * @returns {Promise<CreateAnnouncementSchema>} - Success response
78
84
  * @summary: Delete announcement by id
79
85
  * @description: Use this API to delete an existing announcement.
80
86
  */
81
87
  deleteAnnouncement({ announcementId }?: {
82
88
  announcementId: string;
83
- }): Promise<any>;
89
+ }): Promise<CreateAnnouncementSchema>;
84
90
  /**
85
91
  * @param {Object} arg - Arg object.
86
92
  * @param {BlogRequest} arg.body
93
+ * @returns {Promise<BlogSchema>} - Success response
87
94
  * @summary: Create a blog
88
95
  * @description: Use this API to create a blog.
89
96
  */
90
97
  createBlog({ body }?: {
91
98
  body: BlogRequest;
92
- }): Promise<any>;
99
+ }): Promise<BlogSchema>;
93
100
  /**
94
101
  * @param {Object} arg - Arg object.
95
102
  * @param {number} [arg.pageNo] - The page number to navigate through the
96
103
  * given set of results. Default value is 1.
97
104
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
98
105
  * page. Default value is 10.
106
+ * @returns {Promise<BlogGetResponse>} - Success response
99
107
  * @summary: Get blogs
100
108
  * @description: Use this API to get a list of blogs along with their details, such as the title, reading time, publish status, feature image, tags, author, etc.
101
109
  */
102
110
  getBlogs({ pageNo, pageSize }?: {
103
111
  pageNo?: number;
104
112
  pageSize?: number;
105
- }): Promise<any>;
113
+ }): Promise<BlogGetResponse>;
106
114
  /**
107
115
  * @param {Object} arg - Arg object.
108
116
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -123,162 +131,179 @@ declare class Content {
123
131
  * @param {Object} arg - Arg object.
124
132
  * @param {string} arg.id - ID allotted to the blog.
125
133
  * @param {BlogRequest} arg.body
134
+ * @returns {Promise<BlogSchema>} - Success response
126
135
  * @summary: Update a blog
127
136
  * @description: Use this API to update the details of an existing blog which includes title, feature image, content, SEO details, expiry, etc.
128
137
  */
129
138
  updateBlog({ id, body }?: {
130
139
  id: string;
131
140
  body: BlogRequest;
132
- }): Promise<any>;
141
+ }): Promise<BlogSchema>;
133
142
  /**
134
143
  * @param {Object} arg - Arg object.
135
144
  * @param {string} arg.id - ID allotted to the blog.
145
+ * @returns {Promise<BlogSchema>} - Success response
136
146
  * @summary: Delete blogs
137
147
  * @description: Use this API to delete a blog.
138
148
  */
139
149
  deleteBlog({ id }?: {
140
150
  id: string;
141
- }): Promise<any>;
151
+ }): Promise<BlogSchema>;
142
152
  /**
143
153
  * @param {Object} arg - Arg object.
144
154
  * @param {string} arg.slug - A short, human-readable, URL-friendly
145
155
  * identifier of a blog page. You can get slug value of a blog from `getBlogs` API.
156
+ * @returns {Promise<BlogSchema>} - Success response
146
157
  * @summary: Get components of a blog
147
158
  * @description: Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc.
148
159
  */
149
160
  getComponentById({ slug }?: {
150
161
  slug: string;
151
- }): Promise<any>;
162
+ }): Promise<BlogSchema>;
152
163
  /**
153
164
  * @param {Object} arg - Arg object.
154
165
  * @param {DataLoaderSchema} arg.body
166
+ * @returns {Promise<DataLoaderResponseSchema>} - Success response
155
167
  * @summary: Adds a data loader
156
168
  * @description: Use this API to add data loader. This includes the data loader name, operationId, service name and its type (url/function) with corresponding value.
157
169
  */
158
170
  addDataLoader({ body }?: {
159
171
  body: DataLoaderSchema;
160
- }): Promise<any>;
172
+ }): Promise<DataLoaderResponseSchema>;
161
173
  /**
162
174
  * @param {Object} arg - Arg object.
175
+ * @returns {Promise<DataLoadersSchema>} - Success response
163
176
  * @summary: Get all the data loaders in an application
164
177
  * @description: Use this to get all data loaders of an application
165
178
  */
166
- getDataLoaders({}?: any): Promise<any>;
179
+ getDataLoaders({}?: any): Promise<DataLoadersSchema>;
167
180
  /**
168
181
  * @param {Object} arg - Arg object.
169
182
  * @param {string} arg.dataLoaderId - ID allotted to the data loader.
183
+ * @returns {Promise<DataLoaderResponseSchema>} - Success response
170
184
  * @summary: Delete data loader in application
171
185
  * @description: Use this API to delete data loader.
172
186
  */
173
187
  deleteDataLoader({ dataLoaderId }?: {
174
188
  dataLoaderId: string;
175
- }): Promise<any>;
189
+ }): Promise<DataLoaderResponseSchema>;
176
190
  /**
177
191
  * @param {Object} arg - Arg object.
178
192
  * @param {string} arg.dataLoaderId - ID allotted to the data loader.
179
193
  * @param {DataLoaderSchema} arg.body
194
+ * @returns {Promise<DataLoaderResponseSchema>} - Success response
180
195
  * @summary: Edit a data loader by id
181
196
  * @description: Use this API to edit the details of an existing data loader by its ID.
182
197
  */
183
198
  editDataLoader({ dataLoaderId, body }?: {
184
199
  dataLoaderId: string;
185
200
  body: DataLoaderSchema;
186
- }): Promise<any>;
201
+ }): Promise<DataLoaderResponseSchema>;
187
202
  /**
188
203
  * @param {Object} arg - Arg object.
189
204
  * @param {string} arg.dataLoaderId - ID allotted to the data loader.
205
+ * @returns {Promise<DataLoaderResponseSchema>} - Success response
190
206
  * @summary: Select a data loader by id
191
207
  * @description: Use this API to select a data loader to be used in applications.
192
208
  */
193
209
  selectDataLoader({ dataLoaderId }?: {
194
210
  dataLoaderId: string;
195
- }): Promise<any>;
211
+ }): Promise<DataLoaderResponseSchema>;
196
212
  /**
197
213
  * @param {Object} arg - Arg object.
198
214
  * @param {string} arg.service - Name of service.
199
215
  * @param {string} arg.operationId - Name of operation id of the service.
216
+ * @returns {Promise<DataLoaderResetResponseSchema>} - Success response
200
217
  * @summary: Reset a data loader by serive name and operation Id
201
218
  * @description: Use this API to reselect a data loader.
202
219
  */
203
220
  resetDataLoader({ service, operationId }?: {
204
221
  service: string;
205
222
  operationId: string;
206
- }): Promise<any>;
223
+ }): Promise<DataLoaderResetResponseSchema>;
207
224
  /**
208
225
  * @param {Object} arg - Arg object.
226
+ * @returns {Promise<GetFaqCategoriesSchema>} - Success response
209
227
  * @summary: Get a list of FAQ categories
210
228
  * @description: FAQs can be divided into categories. Use this API to get a list of FAQ categories.
211
229
  */
212
- getFaqCategories({}?: any): Promise<any>;
230
+ getFaqCategories({}?: any): Promise<GetFaqCategoriesSchema>;
213
231
  /**
214
232
  * @param {Object} arg - Arg object.
215
233
  * @param {string} arg.idOrSlug - ID or the slug allotted to an FAQ
216
234
  * category. Slug is a short, human-readable, URL-friendly identifier of
217
235
  * an object. You can get slug value of an FAQ category from
218
236
  * `getFaqCategories` API.
237
+ * @returns {Promise<GetFaqCategoryBySlugSchema>} - Success response
219
238
  * @summary: Get an FAQ category by slug or id
220
239
  * @description: FAQs can be divided into categories. Use this API to get an FAQ categories using its slug or ID.
221
240
  */
222
241
  getFaqCategoryBySlugOrId({ idOrSlug }?: {
223
242
  idOrSlug: string;
224
- }): Promise<any>;
243
+ }): Promise<GetFaqCategoryBySlugSchema>;
225
244
  /**
226
245
  * @param {Object} arg - Arg object.
227
246
  * @param {CreateFaqCategoryRequestSchema} arg.body
247
+ * @returns {Promise<CreateFaqCategorySchema>} - Success response
228
248
  * @summary: Create an FAQ category
229
249
  * @description: FAQs help users to solve an issue or know more about a process. FAQs can be categorized separately, for e.g. some questions can be related to payment, some could be related to purchase, shipping, navigating, etc. Use this API to create an FAQ category.
230
250
  */
231
251
  createFaqCategory({ body }?: {
232
252
  body: CreateFaqCategoryRequestSchema;
233
- }): Promise<any>;
253
+ }): Promise<CreateFaqCategorySchema>;
234
254
  /**
235
255
  * @param {Object} arg - Arg object.
236
256
  * @param {string} arg.id - ID allotted to an FAQ category.
237
257
  * @param {UpdateFaqCategoryRequestSchema} arg.body
258
+ * @returns {Promise<CreateFaqCategorySchema>} - Success response
238
259
  * @summary: Update an FAQ category
239
260
  * @description: Use this API to edit an existing FAQ category.
240
261
  */
241
262
  updateFaqCategory({ id, body }?: {
242
263
  id: string;
243
264
  body: UpdateFaqCategoryRequestSchema;
244
- }): Promise<any>;
265
+ }): Promise<CreateFaqCategorySchema>;
245
266
  /**
246
267
  * @param {Object} arg - Arg object.
247
268
  * @param {string} arg.id - ID allotted to an FAQ category.
269
+ * @returns {Promise<FaqSchema>} - Success response
248
270
  * @summary: Delete an FAQ category
249
271
  * @description: Use this API to delete an FAQ category.
250
272
  */
251
273
  deleteFaqCategory({ id }?: {
252
274
  id: string;
253
- }): Promise<any>;
275
+ }): Promise<FaqSchema>;
254
276
  /**
255
277
  * @param {Object} arg - Arg object.
256
278
  * @param {string} arg.idOrSlug - ID or the slug allotted to an FAQ
257
279
  * category. Slug is a short, human-readable, URL-friendly identifier of
258
280
  * an object. You can get slug value of an FAQ category from
259
281
  * `getFaqCategories` API.
282
+ * @returns {Promise<GetFaqSchema>} - Success response
260
283
  * @summary: Get question and answers within an FAQ category
261
284
  * @description: Use this API to retrieve all the commonly asked question and answers belonging to an FAQ category.
262
285
  */
263
286
  getFaqsByCategoryIdOrSlug({ idOrSlug }?: {
264
287
  idOrSlug: string;
265
- }): Promise<any>;
288
+ }): Promise<GetFaqSchema>;
266
289
  /**
267
290
  * @param {Object} arg - Arg object.
268
291
  * @param {string} arg.categoryId - ID allotted to an FAQ category.
269
292
  * @param {CreateFaqSchema} arg.body
293
+ * @returns {Promise<CreateFaqResponseSchema>} - Success response
270
294
  * @summary: Create an FAQ
271
295
  * @description: FAQs help users to solve an issue or know more about a process. Use this API to create an FAQ for a given FAQ category.
272
296
  */
273
297
  addFaq({ categoryId, body }?: {
274
298
  categoryId: string;
275
299
  body: CreateFaqSchema;
276
- }): Promise<any>;
300
+ }): Promise<CreateFaqResponseSchema>;
277
301
  /**
278
302
  * @param {Object} arg - Arg object.
279
303
  * @param {string} arg.categoryId - ID allotted to an FAQ category.
280
304
  * @param {string} arg.faqId - ID allotted to an FAQ.
281
305
  * @param {CreateFaqSchema} arg.body
306
+ * @returns {Promise<CreateFaqResponseSchema>} - Success response
282
307
  * @summary: Update an FAQ
283
308
  * @description: Use this API to edit an existing FAQ.
284
309
  */
@@ -286,43 +311,59 @@ declare class Content {
286
311
  categoryId: string;
287
312
  faqId: string;
288
313
  body: CreateFaqSchema;
289
- }): Promise<any>;
314
+ }): Promise<CreateFaqResponseSchema>;
290
315
  /**
291
316
  * @param {Object} arg - Arg object.
292
317
  * @param {string} arg.categoryId - ID allotted to an FAQ category.
293
318
  * @param {string} arg.faqId - ID allotted to an FAQ.
319
+ * @returns {Promise<CreateFaqResponseSchema>} - Success response
294
320
  * @summary: Delete an FAQ
295
321
  * @description: Use this API to delete an existing FAQ.
296
322
  */
297
323
  deleteFaq({ categoryId, faqId }?: {
298
324
  categoryId: string;
299
325
  faqId: string;
300
- }): Promise<any>;
326
+ }): Promise<CreateFaqResponseSchema>;
301
327
  /**
302
328
  * @param {Object} arg - Arg object.
303
329
  * @param {string} arg.idOrSlug - ID or the slug allotted to an FAQ
304
330
  * category. Slug is a short, human-readable, URL-friendly identifier of
305
331
  * an object. You can get slug value of an FAQ category from
306
332
  * `getFaqCategories` API.
333
+ * @returns {Promise<CreateFaqResponseSchema>} - Success response
307
334
  * @summary: Get an FAQ
308
335
  * @description: Use this API to retrieve a specific FAQ. You will get the question and answer of that FAQ.
309
336
  */
310
337
  getFaqByIdOrSlug({ idOrSlug }?: {
311
338
  idOrSlug: string;
312
- }): Promise<any>;
339
+ }): Promise<CreateFaqResponseSchema>;
340
+ /**
341
+ * @param {Object} arg - Arg object.
342
+ * @param {GenerationEntityType} arg.type - String representing the type of
343
+ * SEO content to be generated. Possible values are: title, description
344
+ * @param {GenerateSEOContent} arg.body
345
+ * @returns {Promise<GeneratedSEOContent>} - Success response
346
+ * @summary: Get SEO meta tag title for content
347
+ * @description: Use this API to get GPT3 generated SEO meta tag title for content
348
+ */
349
+ generateSEOTitle({ type, body }?: {
350
+ type: GenerationEntityType;
351
+ body: GenerateSEOContent;
352
+ }): Promise<GeneratedSEOContent>;
313
353
  /**
314
354
  * @param {Object} arg - Arg object.
315
355
  * @param {number} [arg.pageNo] - The page number to navigate through the
316
356
  * given set of results. Default value is 1.
317
357
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
318
358
  * page. Default value is 10.
359
+ * @returns {Promise<LandingPageGetResponse>} - Success response
319
360
  * @summary: Get landing pages
320
361
  * @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to fetch a list of landing pages.
321
362
  */
322
363
  getLandingPages({ pageNo, pageSize }?: {
323
364
  pageNo?: number;
324
365
  pageSize?: number;
325
- }): Promise<any>;
366
+ }): Promise<LandingPageGetResponse>;
326
367
  /**
327
368
  * @param {Object} arg - Arg object.
328
369
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -342,47 +383,52 @@ declare class Content {
342
383
  /**
343
384
  * @param {Object} arg - Arg object.
344
385
  * @param {LandingPageSchema} arg.body
386
+ * @returns {Promise<LandingPageSchema>} - Success response
345
387
  * @summary: Create a landing page
346
388
  * @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to create a landing page.
347
389
  */
348
390
  createLandingPage({ body }?: {
349
391
  body: LandingPageSchema;
350
- }): Promise<any>;
392
+ }): Promise<LandingPageSchema>;
351
393
  /**
352
394
  * @param {Object} arg - Arg object.
353
395
  * @param {string} arg.id - ID allotted to a landing page.
354
396
  * @param {LandingPageSchema} arg.body
397
+ * @returns {Promise<LandingPageSchema>} - Success response
355
398
  * @summary: Update a landing page
356
399
  * @description: Use this API to edit the details of an existing landing page.
357
400
  */
358
401
  updateLandingPage({ id, body }?: {
359
402
  id: string;
360
403
  body: LandingPageSchema;
361
- }): Promise<any>;
404
+ }): Promise<LandingPageSchema>;
362
405
  /**
363
406
  * @param {Object} arg - Arg object.
364
407
  * @param {string} arg.id - ID allotted to a landing page.
408
+ * @returns {Promise<LandingPageSchema>} - Success response
365
409
  * @summary: Delete a landing page
366
410
  * @description: Use this API to delete an existing landing page.
367
411
  */
368
412
  deleteLandingPage({ id }?: {
369
413
  id: string;
370
- }): Promise<any>;
414
+ }): Promise<LandingPageSchema>;
371
415
  /**
372
416
  * @param {Object} arg - Arg object.
417
+ * @returns {Promise<ApplicationLegal>} - Success response
373
418
  * @summary: Get legal information
374
419
  * @description: Use this API to get the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application.
375
420
  */
376
- getLegalInformation({}?: any): Promise<any>;
421
+ getLegalInformation({}?: any): Promise<ApplicationLegal>;
377
422
  /**
378
423
  * @param {Object} arg - Arg object.
379
424
  * @param {ApplicationLegal} arg.body
425
+ * @returns {Promise<ApplicationLegal>} - Success response
380
426
  * @summary: Save legal information
381
427
  * @description: Use this API to edit, update and save the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application.
382
428
  */
383
429
  updateLegalInformation({ body }?: {
384
430
  body: ApplicationLegal;
385
- }): Promise<any>;
431
+ }): Promise<ApplicationLegal>;
386
432
  /**
387
433
  * @param {Object} arg - Arg object.
388
434
  * @param {string} arg.devicePlatform - Filter navigations by platform.
@@ -391,6 +437,7 @@ declare class Content {
391
437
  * given set of results. Default value is 1.
392
438
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
393
439
  * page. Default value is 10.
440
+ * @returns {Promise<NavigationGetResponse>} - Success response
394
441
  * @summary: Get navigations
395
442
  * @description: Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the orientation, links, sub-navigations, etc.
396
443
  */
@@ -398,7 +445,7 @@ declare class Content {
398
445
  devicePlatform: string;
399
446
  pageNo?: number;
400
447
  pageSize?: number;
401
- }): Promise<any>;
448
+ }): Promise<NavigationGetResponse>;
402
449
  /**
403
450
  * @param {Object} arg - Arg object.
404
451
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -421,18 +468,20 @@ declare class Content {
421
468
  /**
422
469
  * @param {Object} arg - Arg object.
423
470
  * @param {NavigationRequest} arg.body
471
+ * @returns {Promise<NavigationSchema>} - Success response
424
472
  * @summary: Create a navigation
425
473
  * @description: Navigation is the arrangement of navigational items to ease the accessibility of resources for users on a website. Use this API to create a navigation.
426
474
  */
427
475
  createNavigation({ body }?: {
428
476
  body: NavigationRequest;
429
- }): Promise<any>;
477
+ }): Promise<NavigationSchema>;
430
478
  /**
431
479
  * @param {Object} arg - Arg object.
480
+ * @returns {Promise<DefaultNavigationResponse>} - Success response
432
481
  * @summary: Get default navigations
433
482
  * @description: On any website (application), there are navigations that are present by default. Use this API to retrieve those default navigations.
434
483
  */
435
- getDefaultNavigations({}?: any): Promise<any>;
484
+ getDefaultNavigations({}?: any): Promise<DefaultNavigationResponse>;
436
485
  /**
437
486
  * @param {Object} arg - Arg object.
438
487
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -440,120 +489,133 @@ declare class Content {
440
489
  * `getNavigations` API.
441
490
  * @param {string} arg.devicePlatform - Filter navigations by platform.
442
491
  * Acceptable values are: web, android, ios, all
492
+ * @returns {Promise<NavigationSchema>} - Success response
443
493
  * @summary: Get a navigation by slug
444
494
  * @description: Use this API to retrieve a navigation by its slug.
445
495
  */
446
496
  getNavigationBySlug({ slug, devicePlatform }?: {
447
497
  slug: string;
448
498
  devicePlatform: string;
449
- }): Promise<any>;
499
+ }): Promise<NavigationSchema>;
450
500
  /**
451
501
  * @param {Object} arg - Arg object.
452
502
  * @param {string} arg.id - ID allotted to the navigation.
453
503
  * @param {NavigationRequest} arg.body
504
+ * @returns {Promise<NavigationSchema>} - Success response
454
505
  * @summary: Update a navigation
455
506
  * @description: Use this API to edit the details of an existing navigation.
456
507
  */
457
508
  updateNavigation({ id, body }?: {
458
509
  id: string;
459
510
  body: NavigationRequest;
460
- }): Promise<any>;
511
+ }): Promise<NavigationSchema>;
461
512
  /**
462
513
  * @param {Object} arg - Arg object.
463
514
  * @param {string} arg.id - ID allotted to the navigation.
515
+ * @returns {Promise<NavigationSchema>} - Success response
464
516
  * @summary: Delete a navigation
465
517
  * @description: Use this API to delete an existing navigation.
466
518
  */
467
519
  deleteNavigation({ id }?: {
468
520
  id: string;
469
- }): Promise<any>;
521
+ }): Promise<NavigationSchema>;
470
522
  /**
471
523
  * @param {Object} arg - Arg object.
524
+ * @returns {Promise<PageMetaSchema>} - Success response
472
525
  * @summary: Get page meta
473
526
  * @description: Use this API to get the meta of custom pages (blog, page) and default system pages (e.g. home/brand/category/collection).
474
527
  */
475
- getPageMeta({}?: any): Promise<any>;
528
+ getPageMeta({}?: any): Promise<PageMetaSchema>;
476
529
  /**
477
530
  * @param {Object} arg - Arg object.
531
+ * @returns {Promise<PageSpec>} - Success response
478
532
  * @summary: Get page spec
479
533
  * @description: Use this API to get the specifications of a page, such as page type, display name, params and query.
480
534
  */
481
- getPageSpec({}?: any): Promise<any>;
535
+ getPageSpec({}?: any): Promise<PageSpec>;
482
536
  /**
483
537
  * @param {Object} arg - Arg object.
484
538
  * @param {PageRequest} arg.body
539
+ * @returns {Promise<PageSchema>} - Success response
485
540
  * @summary: Create a page preview
486
541
  * @description: Use this API to create a page preview to check the appearance of a custom page.
487
542
  */
488
543
  createPagePreview({ body }?: {
489
544
  body: PageRequest;
490
- }): Promise<any>;
545
+ }): Promise<PageSchema>;
491
546
  /**
492
547
  * @param {Object} arg - Arg object.
493
548
  * @param {string} arg.slug - A short, human-readable, URL-friendly
494
549
  * identifier of a page. You can get slug value of a page from `getPages` API.
495
550
  * @param {PagePublishRequest} arg.body
551
+ * @returns {Promise<PageSchema>} - Success response
496
552
  * @summary: Change the publish status of a page
497
553
  * @description: Use this API to change the publish status of an existing page. Allows you to publish and unpublish the page.
498
554
  */
499
555
  updatePagePreview({ slug, body }?: {
500
556
  slug: string;
501
557
  body: PagePublishRequest;
502
- }): Promise<any>;
558
+ }): Promise<PageSchema>;
503
559
  /**
504
560
  * @param {Object} arg - Arg object.
505
561
  * @param {string} arg.id - ID allotted to the page.
562
+ * @returns {Promise<PageSchema>} - Success response
506
563
  * @summary: Delete a page
507
564
  * @description: Use this API to delete an existing page.
508
565
  */
509
566
  deletePage({ id }?: {
510
567
  id: string;
511
- }): Promise<any>;
568
+ }): Promise<PageSchema>;
512
569
  /**
513
570
  * @param {Object} arg - Arg object.
514
571
  * @param {PathMappingSchema} arg.body
572
+ * @returns {Promise<PathMappingSchema>} - Success response
515
573
  * @summary: Save path based redirection rules
516
574
  * @description: Use this API to add redirection rules
517
575
  */
518
576
  addPathRedirectionRules({ body }?: {
519
577
  body: PathMappingSchema;
520
- }): Promise<any>;
578
+ }): Promise<PathMappingSchema>;
521
579
  /**
522
580
  * @param {Object} arg - Arg object.
523
581
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
524
582
  * page. Default value is 5.
525
583
  * @param {number} [arg.pageNo] - The page number to navigate through the
526
584
  * given set of results. Default value is 1.
585
+ * @returns {Promise<PathMappingSchema>} - Success response
527
586
  * @summary: Get path based redirection rules
528
587
  * @description: Use this API to get path based redirection rules.
529
588
  */
530
589
  getPathRedirectionRules({ pageSize, pageNo }?: {
531
590
  pageSize?: number;
532
591
  pageNo?: number;
533
- }): Promise<any>;
592
+ }): Promise<PathMappingSchema>;
534
593
  /**
535
594
  * @param {Object} arg - Arg object.
536
595
  * @param {string} arg.pathId - ID allotted to the path redirection rule.
596
+ * @returns {Promise<PathMappingSchema>} - Success response
537
597
  * @summary: Get path based redirection rule
538
598
  * @description: Use this API to get path based redirection rule.
539
599
  */
540
600
  getPathRedirectionRule({ pathId }?: {
541
601
  pathId: string;
542
- }): Promise<any>;
602
+ }): Promise<PathMappingSchema>;
543
603
  /**
544
604
  * @param {Object} arg - Arg object.
545
605
  * @param {string} arg.pathId - ID allotted to the path redirection rule.
546
606
  * @param {PathMappingSchema} arg.body
607
+ * @returns {Promise<PathMappingSchema>} - Success response
547
608
  * @summary: Update path based redirection rules
548
609
  * @description: Use this API to update redirection rules
549
610
  */
550
611
  updatePathRedirectionRules({ pathId, body }?: {
551
612
  pathId: string;
552
613
  body: PathMappingSchema;
553
- }): Promise<any>;
614
+ }): Promise<PathMappingSchema>;
554
615
  /**
555
616
  * @param {Object} arg - Arg object.
556
617
  * @param {string} arg.pathId - ID allotted to the path redirection rule.
618
+ * @returns {Promise<Object>} - Success response
557
619
  * @summary: Delete path based redirection rules
558
620
  * @description: Use this API to delete redirection rules
559
621
  */
@@ -562,19 +624,21 @@ declare class Content {
562
624
  }): Promise<any>;
563
625
  /**
564
626
  * @param {Object} arg - Arg object.
627
+ * @returns {Promise<SeoComponent>} - Success response
565
628
  * @summary: Get SEO configuration of an application
566
629
  * @description: Use this API to know how the SEO is configured in the application. This includes the sitemap, robot.txt, custom meta tags, etc.
567
630
  */
568
- getSEOConfiguration({}?: any): Promise<any>;
631
+ getSEOConfiguration({}?: any): Promise<SeoComponent>;
569
632
  /**
570
633
  * @param {Object} arg - Arg object.
571
634
  * @param {SeoComponent} arg.body
635
+ * @returns {Promise<SeoSchema>} - Success response
572
636
  * @summary: Update SEO of application
573
637
  * @description: Use this API to edit the SEO details of an application. This includes the sitemap, robot.txt, custom meta tags, etc.
574
638
  */
575
639
  updateSEOConfiguration({ body }?: {
576
640
  body: SeoComponent;
577
- }): Promise<any>;
641
+ }): Promise<SeoSchema>;
578
642
  /**
579
643
  * @param {Object} arg - Arg object.
580
644
  * @param {string} arg.devicePlatform - Filter slideshows by platform.
@@ -583,6 +647,7 @@ declare class Content {
583
647
  * given set of results. Default value is 1.
584
648
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
585
649
  * page. Default value is 10.
650
+ * @returns {Promise<SlideshowGetResponse>} - Success response
586
651
  * @summary: Get slideshows
587
652
  * @description: 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 list of slideshows.
588
653
  */
@@ -590,7 +655,7 @@ declare class Content {
590
655
  devicePlatform: string;
591
656
  pageNo?: number;
592
657
  pageSize?: number;
593
- }): Promise<any>;
658
+ }): Promise<SlideshowGetResponse>;
594
659
  /**
595
660
  * @param {Object} arg - Arg object.
596
661
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -613,12 +678,13 @@ declare class Content {
613
678
  /**
614
679
  * @param {Object} arg - Arg object.
615
680
  * @param {SlideshowRequest} arg.body
681
+ * @returns {Promise<SlideshowSchema>} - Success response
616
682
  * @summary: Create a slideshow
617
683
  * @description: 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 create a slideshow.
618
684
  */
619
685
  createSlideshow({ body }?: {
620
686
  body: SlideshowRequest;
621
- }): Promise<any>;
687
+ }): Promise<SlideshowSchema>;
622
688
  /**
623
689
  * @param {Object} arg - Arg object.
624
690
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -626,120 +692,133 @@ declare class Content {
626
692
  * `getSlideshows` API.
627
693
  * @param {string} arg.devicePlatform - Filter slideshows by platform.
628
694
  * Acceptable values are: web, android, ios and all
695
+ * @returns {Promise<SlideshowSchema>} - Success response
629
696
  * @summary: Get slideshow by slug
630
697
  * @description: Use this API to retrieve the details of a slideshow by its slug.
631
698
  */
632
699
  getSlideshowBySlug({ slug, devicePlatform }?: {
633
700
  slug: string;
634
701
  devicePlatform: string;
635
- }): Promise<any>;
702
+ }): Promise<SlideshowSchema>;
636
703
  /**
637
704
  * @param {Object} arg - Arg object.
638
705
  * @param {string} arg.id - ID allotted to the slideshow.
639
706
  * @param {SlideshowRequest} arg.body
707
+ * @returns {Promise<SlideshowSchema>} - Success response
640
708
  * @summary: Update a slideshow
641
709
  * @description: Use this API to edit the details of an existing slideshow.
642
710
  */
643
711
  updateSlideshow({ id, body }?: {
644
712
  id: string;
645
713
  body: SlideshowRequest;
646
- }): Promise<any>;
714
+ }): Promise<SlideshowSchema>;
647
715
  /**
648
716
  * @param {Object} arg - Arg object.
649
717
  * @param {string} arg.id - ID allotted to the slideshow.
718
+ * @returns {Promise<SlideshowSchema>} - Success response
650
719
  * @summary: Delete a slideshow
651
720
  * @description: Use this API to delete an existing slideshow.
652
721
  */
653
722
  deleteSlideshow({ id }?: {
654
723
  id: string;
655
- }): Promise<any>;
724
+ }): Promise<SlideshowSchema>;
656
725
  /**
657
726
  * @param {Object} arg - Arg object.
727
+ * @returns {Promise<Support>} - Success response
658
728
  * @summary: Get support information
659
729
  * @description: Use this API to get the contact details for customer support, including emails and phone numbers.
660
730
  */
661
- getSupportInformation({}?: any): Promise<any>;
731
+ getSupportInformation({}?: any): Promise<Support>;
662
732
  /**
663
733
  * @param {Object} arg - Arg object.
664
734
  * @param {Support} arg.body
735
+ * @returns {Promise<Support>} - Success response
665
736
  * @summary: Update the support data of an application
666
737
  * @description: Use this API to edit the existing contact details for customer support, including emails and phone numbers.
667
738
  */
668
739
  updateSupportInformation({ body }?: {
669
740
  body: Support;
670
- }): Promise<any>;
741
+ }): Promise<Support>;
671
742
  /**
672
743
  * @param {Object} arg - Arg object.
673
744
  * @param {CreateTagRequestSchema} arg.body
745
+ * @returns {Promise<TagsSchema>} - Success response
674
746
  * @summary: Update a tag
675
747
  * @description: Use this API to edit the details of an existing tag. This includes the tag name, tag type (css/js), url and position of the tag.
676
748
  */
677
749
  updateInjectableTag({ body }?: {
678
750
  body: CreateTagRequestSchema;
679
- }): Promise<any>;
751
+ }): Promise<TagsSchema>;
680
752
  /**
681
753
  * @param {Object} arg - Arg object.
754
+ * @returns {Promise<TagsSchema>} - Success response
682
755
  * @summary: Delete tags in application
683
756
  * @description: Use this API to delete all the existing tags at once.
684
757
  */
685
- deleteAllInjectableTags({}?: any): Promise<any>;
758
+ deleteAllInjectableTags({}?: any): Promise<TagsSchema>;
686
759
  /**
687
760
  * @param {Object} arg - Arg object.
761
+ * @returns {Promise<TagsSchema>} - Success response
688
762
  * @summary: Get all the tags in an application
689
763
  * @description: Use this API to get all the CSS and JS injected in the application in the form of tags.
690
764
  */
691
- getInjectableTags({}?: any): Promise<any>;
765
+ getInjectableTags({}?: any): Promise<TagsSchema>;
692
766
  /**
693
767
  * @param {Object} arg - Arg object.
694
768
  * @param {CreateTagRequestSchema} arg.body
769
+ * @returns {Promise<TagsSchema>} - Success response
695
770
  * @summary: Add a tag
696
771
  * @description: CSS and JS can be injected in the application (website) with the help of tags. Use this API to create such tags by entering the tag name, tag type (css/js), url and position of the tag.
697
772
  */
698
773
  addInjectableTag({ body }?: {
699
774
  body: CreateTagRequestSchema;
700
- }): Promise<any>;
775
+ }): Promise<TagsSchema>;
701
776
  /**
702
777
  * @param {Object} arg - Arg object.
703
778
  * @param {RemoveHandpickedSchema} arg.body
779
+ * @returns {Promise<TagDeleteSuccessResponse>} - Success response
704
780
  * @summary: Remove a tag
705
781
  * @description: Use this API to delete an existing tag.
706
782
  */
707
783
  removeInjectableTag({ body }?: {
708
784
  body: RemoveHandpickedSchema;
709
- }): Promise<any>;
785
+ }): Promise<TagDeleteSuccessResponse>;
710
786
  /**
711
787
  * @param {Object} arg - Arg object.
712
788
  * @param {string} arg.tagId - ID allotted to the tag.
713
789
  * @param {UpdateHandpickedSchema} arg.body
790
+ * @returns {Promise<TagsSchema>} - Success response
714
791
  * @summary: Edit a tag by id
715
792
  * @description: Use this API to edit the details of an existing tag by its ID.
716
793
  */
717
794
  editInjectableTag({ tagId, body }?: {
718
795
  tagId: string;
719
796
  body: UpdateHandpickedSchema;
720
- }): Promise<any>;
797
+ }): Promise<TagsSchema>;
721
798
  /**
722
799
  * @param {Object} arg - Arg object.
723
800
  * @param {PageRequest} arg.body
801
+ * @returns {Promise<PageSchema>} - Success response
724
802
  * @summary: Create a page
725
803
  * @description: Use this API to create a custom page using a title, seo, publish status, feature image, tags, meta, etc.
726
804
  */
727
805
  createPage({ body }?: {
728
806
  body: PageRequest;
729
- }): Promise<any>;
807
+ }): Promise<PageSchema>;
730
808
  /**
731
809
  * @param {Object} arg - Arg object.
732
810
  * @param {number} [arg.pageNo] - The page number to navigate through the
733
811
  * given set of results. Default value is 1.
734
812
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
735
813
  * page. Default value is 10.
814
+ * @returns {Promise<PageGetResponse>} - Success response
736
815
  * @summary: Get a list of pages
737
816
  * @description: Use this API to retrieve a list of pages.
738
817
  */
739
818
  getPages({ pageNo, pageSize }?: {
740
819
  pageNo?: number;
741
820
  pageSize?: number;
742
- }): Promise<any>;
821
+ }): Promise<PageGetResponse>;
743
822
  /**
744
823
  * @param {Object} arg - Arg object.
745
824
  * @param {string} arg.companyId - Numeric ID allotted to a business account
@@ -760,22 +839,24 @@ declare class Content {
760
839
  * @param {Object} arg - Arg object.
761
840
  * @param {string} arg.id - ID allotted to the page.
762
841
  * @param {PageSchema} arg.body
842
+ * @returns {Promise<PageSchema>} - Success response
763
843
  * @summary: Update a page
764
844
  * @description: Use this API to edit the details of an existing page, such as its title, seo, publish status, feature image, tags, schedule, etc.
765
845
  */
766
846
  updatePage({ id, body }?: {
767
847
  id: string;
768
848
  body: PageSchema;
769
- }): Promise<any>;
849
+ }): Promise<PageSchema>;
770
850
  /**
771
851
  * @param {Object} arg - Arg object.
772
852
  * @param {string} arg.slug - A short, human-readable, URL-friendly
773
853
  * identifier of a page. You can get slug value of a page from `getPages` API.
854
+ * @returns {Promise<PageSchema>} - Success response
774
855
  * @summary: Get pages by component Id
775
856
  * @description: Use this API to retrieve the components of a page, such as its title, seo, publish status, feature image, tags, schedule, etc.
776
857
  */
777
858
  getPageBySlug({ slug }?: {
778
859
  slug: string;
779
- }): Promise<any>;
860
+ }): Promise<PageSchema>;
780
861
  }
781
862
  import Paginator = require("../../common/Paginator");