@gofynd/fdk-client-javascript 3.15.0 → 3.16.1

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 (64) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -1
  4. package/sdk/application/Order/OrderApplicationClient.js +50 -1
  5. package/sdk/application/Payment/PaymentApplicationClient.d.ts +0 -20
  6. package/sdk/application/Payment/PaymentApplicationClient.js +0 -77
  7. package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
  8. package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
  9. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2 -2
  10. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
  11. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
  12. package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
  13. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
  14. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
  15. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +10 -0
  16. package/sdk/platform/Cart/CartPlatformApplicationClient.js +95 -0
  17. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +47 -1
  18. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +29 -0
  19. package/sdk/platform/Cart/CartPlatformModel.d.ts +39 -7
  20. package/sdk/platform/Cart/CartPlatformModel.js +24 -3
  21. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +3 -3
  22. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +13 -16
  23. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +17 -20
  24. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +10 -11
  25. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  26. package/sdk/platform/Catalog/CatalogPlatformClient.js +1 -1
  27. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +58 -37
  28. package/sdk/platform/Catalog/CatalogPlatformModel.js +33 -28
  29. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
  30. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -2
  31. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
  32. package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
  33. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
  34. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
  35. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
  36. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
  37. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +11 -1
  38. package/sdk/platform/Content/ContentPlatformApplicationClient.js +85 -1
  39. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +24 -1
  40. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +15 -0
  41. package/sdk/platform/Content/ContentPlatformModel.d.ts +243 -3
  42. package/sdk/platform/Content/ContentPlatformModel.js +164 -1
  43. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
  44. package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
  45. package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
  46. package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
  47. package/sdk/platform/Order/OrderPlatformModel.d.ts +2 -2
  48. package/sdk/platform/Order/OrderPlatformModel.js +1 -1
  49. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +0 -23
  50. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +0 -161
  51. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -19
  52. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +0 -24
  53. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1 -159
  54. package/sdk/platform/Payment/PaymentPlatformModel.js +0 -112
  55. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
  56. package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
  57. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +67 -49
  58. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +45 -42
  59. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
  60. package/sdk/platform/Share/SharePlatformModel.js +1 -1
  61. package/sdk/platform/User/UserPlatformModel.d.ts +14 -0
  62. package/sdk/platform/User/UserPlatformModel.js +6 -0
  63. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
  64. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
@@ -1696,17 +1696,6 @@ const Joi = require("joi");
1696
1696
  * @property {boolean} [is_visible] - Indicates if the collection is visible.
1697
1697
  */
1698
1698
 
1699
- /**
1700
- * @typedef GetCollectionItemsResponseSchema
1701
- * @property {ProductFilters[]} [filters] - An array of filters applicable to
1702
- * the products in the collection.
1703
- * @property {ApplicationProductsSchema[]} [items] - An array of products that
1704
- * belong to the collection.
1705
- * @property {Page} [page]
1706
- * @property {ProductSortOn[]} [sort_on] - Sorting options available for the
1707
- * products in the collection.
1708
- */
1709
-
1710
1699
  /**
1711
1700
  * @typedef GetCollectionListingResponseSchema
1712
1701
  * @property {CollectionListingFilter} [filters]
@@ -1991,6 +1980,9 @@ const Joi = require("joi");
1991
1980
  * @property {string} [_id] - A unique identifier for the collection, matching `uid`.
1992
1981
  * @property {string[]} [visible_facets_keys] - Keys representing visible facets
1993
1982
  * for filtering.
1983
+ * @property {string[]} [handpicked_collection_item_ids] - Array of item `uid`
1984
+ * that have been manually handpicked for this collection. Will be an empty
1985
+ * array if the collection type is not handpicked.
1994
1986
  */
1995
1987
 
1996
1988
  /**
@@ -2020,8 +2012,19 @@ const Joi = require("joi");
2020
2012
 
2021
2013
  /**
2022
2014
  * @typedef GetCollectionItemsResponseSchemaV2
2023
- * @property {ProductDetailV2[]} [items]
2024
- * @property {Page1} [page]
2015
+ * @property {CollectionItemV2[]} [items]
2016
+ * @property {Page} [page]
2017
+ */
2018
+
2019
+ /**
2020
+ * @typedef CollectionItemV2
2021
+ * @property {string} name - The name of the product
2022
+ * @property {string} [short_description] - A brief description of the product
2023
+ * @property {Media[]} [medias] - Media items (images, videos) associated with the product
2024
+ * @property {string} slug - URL-friendly identifier for the product
2025
+ * @property {number} uid - Unique identifier for the product
2026
+ * @property {string} item_code - Item code or SKU of the product
2027
+ * @property {string} item_type - Type of the product
2025
2028
  */
2026
2029
 
2027
2030
  /**
@@ -3018,7 +3021,7 @@ const Joi = require("joi");
3018
3021
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
3019
3022
  * @property {boolean} [has_next] - Indicates whether there is a next page.
3020
3023
  * @property {number} [current] - The current page number.
3021
- * @property {string} type - The type of the page, such as 'PageType'.
3024
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
3022
3025
  * @property {number} [size] - The number of items per page.
3023
3026
  * @property {number} [page_size] - The number of items per page.
3024
3027
  */
@@ -6868,18 +6871,6 @@ class CatalogPlatformModel {
6868
6871
  });
6869
6872
  }
6870
6873
 
6871
- /** @returns {GetCollectionItemsResponseSchema} */
6872
- static GetCollectionItemsResponseSchema() {
6873
- return Joi.object({
6874
- filters: Joi.array().items(CatalogPlatformModel.ProductFilters()),
6875
- items: Joi.array().items(
6876
- CatalogPlatformModel.ApplicationProductsSchema()
6877
- ),
6878
- page: CatalogPlatformModel.Page(),
6879
- sort_on: Joi.array().items(CatalogPlatformModel.ProductSortOn()),
6880
- });
6881
- }
6882
-
6883
6874
  /** @returns {GetCollectionListingResponseSchema} */
6884
6875
  static GetCollectionListingResponseSchema() {
6885
6876
  return Joi.object({
@@ -7167,6 +7158,7 @@ class CatalogPlatformModel {
7167
7158
  uid: Joi.string().allow(""),
7168
7159
  _id: Joi.string().allow(""),
7169
7160
  visible_facets_keys: Joi.array().items(Joi.string().allow("")),
7161
+ handpicked_collection_item_ids: Joi.array().items(Joi.string().allow("")),
7170
7162
  });
7171
7163
  }
7172
7164
 
@@ -7202,8 +7194,21 @@ class CatalogPlatformModel {
7202
7194
  /** @returns {GetCollectionItemsResponseSchemaV2} */
7203
7195
  static GetCollectionItemsResponseSchemaV2() {
7204
7196
  return Joi.object({
7205
- items: Joi.array().items(CatalogPlatformModel.ProductDetailV2()),
7206
- page: CatalogPlatformModel.Page1(),
7197
+ items: Joi.array().items(CatalogPlatformModel.CollectionItemV2()),
7198
+ page: CatalogPlatformModel.Page(),
7199
+ });
7200
+ }
7201
+
7202
+ /** @returns {CollectionItemV2} */
7203
+ static CollectionItemV2() {
7204
+ return Joi.object({
7205
+ name: Joi.string().allow("").required(),
7206
+ short_description: Joi.string().allow(""),
7207
+ medias: Joi.array().items(CatalogPlatformModel.Media()),
7208
+ slug: Joi.string().allow("").required(),
7209
+ uid: Joi.number().required(),
7210
+ item_code: Joi.string().allow("").required(),
7211
+ item_type: Joi.string().allow("").required(),
7207
7212
  });
7208
7213
  }
7209
7214
 
@@ -384,7 +384,7 @@ export = CatalogPlatformValidator;
384
384
  */
385
385
  /**
386
386
  * @typedef ListCategoriesParam
387
- * @property {string} [level] - Get category for multiple levels
387
+ * @property {number[]} [level] - Get category for multiple levels
388
388
  * @property {number} [department] - Get category for multiple departments filtered
389
389
  * @property {string} [q] - Get multiple categories filtered by search string
390
390
  * @property {number} [pageNo] - The page number to navigate through the given
@@ -1438,7 +1438,7 @@ type ListCategoriesParam = {
1438
1438
  /**
1439
1439
  * - Get category for multiple levels
1440
1440
  */
1441
- level?: string;
1441
+ level?: number[];
1442
1442
  /**
1443
1443
  * - Get category for multiple departments filtered
1444
1444
  */
@@ -451,7 +451,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
451
451
 
452
452
  /**
453
453
  * @typedef ListCategoriesParam
454
- * @property {string} [level] - Get category for multiple levels
454
+ * @property {number[]} [level] - Get category for multiple levels
455
455
  * @property {number} [department] - Get category for multiple departments filtered
456
456
  * @property {string} [q] - Get multiple categories filtered by search string
457
457
  * @property {number} [pageNo] - The page number to navigate through the given
@@ -1154,7 +1154,7 @@ class CatalogPlatformValidator {
1154
1154
  /** @returns {ListCategoriesParam} */
1155
1155
  static listCategories() {
1156
1156
  return Joi.object({
1157
- level: Joi.string().allow(""),
1157
+ level: Joi.array().items(Joi.number()),
1158
1158
  department: Joi.number(),
1159
1159
  q: Joi.string().allow(""),
1160
1160
  pageNo: Joi.number(),
@@ -836,7 +836,7 @@ export = CommunicationPlatformModel;
836
836
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
837
837
  * @property {boolean} [has_next] - Indicates whether there is a next page.
838
838
  * @property {number} [current] - The current page number.
839
- * @property {string} type - The type of the page, such as 'PageType'.
839
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
840
840
  * @property {number} [size] - The number of items per page.
841
841
  * @property {number} [page_size] - The number of items per page.
842
842
  */
@@ -1926,7 +1926,7 @@ type Page = {
1926
1926
  */
1927
1927
  current?: number;
1928
1928
  /**
1929
- * - The type of the page, such as 'PageType'.
1929
+ * - The type of the page, can be 'cursor' or 'number'.
1930
1930
  */
1931
1931
  type: string;
1932
1932
  /**
@@ -948,7 +948,7 @@ const Joi = require("joi");
948
948
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
949
949
  * @property {boolean} [has_next] - Indicates whether there is a next page.
950
950
  * @property {number} [current] - The current page number.
951
- * @property {string} type - The type of the page, such as 'PageType'.
951
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
952
952
  * @property {number} [size] - The number of items per page.
953
953
  * @property {number} [page_size] - The number of items per page.
954
954
  */
@@ -264,7 +264,7 @@ export = CompanyProfilePlatformModel;
264
264
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
265
265
  * @property {boolean} [has_next] - Indicates whether there is a next page.
266
266
  * @property {number} [current] - The current page number.
267
- * @property {string} type - The type of the page, such as 'PageType'.
267
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
268
268
  * @property {number} [size] - The number of items per page.
269
269
  * @property {number} [page_size] - The number of items per page.
270
270
  */
@@ -765,7 +765,7 @@ type Page = {
765
765
  */
766
766
  current?: number;
767
767
  /**
768
- * - The type of the page, such as 'PageType'.
768
+ * - The type of the page, can be 'cursor' or 'number'.
769
769
  */
770
770
  type: string;
771
771
  /**
@@ -291,7 +291,7 @@ const Joi = require("joi");
291
291
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
292
292
  * @property {boolean} [has_next] - Indicates whether there is a next page.
293
293
  * @property {number} [current] - The current page number.
294
- * @property {string} type - The type of the page, such as 'PageType'.
294
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
295
295
  * @property {number} [size] - The number of items per page.
296
296
  * @property {number} [page_size] - The number of items per page.
297
297
  */
@@ -1183,7 +1183,7 @@ export = ConfigurationPlatformModel;
1183
1183
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
1184
1184
  * @property {boolean} [has_next] - Indicates whether there is a next page.
1185
1185
  * @property {number} [current] - The current page number.
1186
- * @property {string} type - The type of the page, such as 'PageType'.
1186
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
1187
1187
  * @property {number} [size] - The number of items per page.
1188
1188
  * @property {number} [page_size] - The number of items per page.
1189
1189
  */
@@ -3795,7 +3795,7 @@ type Page = {
3795
3795
  */
3796
3796
  current?: number;
3797
3797
  /**
3798
- * - The type of the page, such as 'PageType'.
3798
+ * - The type of the page, can be 'cursor' or 'number'.
3799
3799
  */
3800
3800
  type: string;
3801
3801
  /**
@@ -1335,7 +1335,7 @@ const Joi = require("joi");
1335
1335
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
1336
1336
  * @property {boolean} [has_next] - Indicates whether there is a next page.
1337
1337
  * @property {number} [current] - The current page number.
1338
- * @property {string} type - The type of the page, such as 'PageType'.
1338
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
1339
1339
  * @property {number} [size] - The number of items per page.
1340
1340
  * @property {number} [page_size] - The number of items per page.
1341
1341
  */
@@ -757,7 +757,7 @@ declare class Content {
757
757
  * @summary: Get all HTML tags
758
758
  * @description: Retrieve a list of injectable tags. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getInjectableTags/).
759
759
  */
760
- getInjectableTags({ all, requestHeaders }?: ContentPlatformApplicationValidator.GetInjectableTagsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
760
+ getInjectableTags({ all, pageNo, pageSize, search, requestHeaders }?: ContentPlatformApplicationValidator.GetInjectableTagsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
761
761
  /**
762
762
  * @param {ContentPlatformApplicationValidator.GetLandingPagesParam} arg - Arg object
763
763
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -914,6 +914,16 @@ declare class Content {
914
914
  * @description: Retrieve information related to customer support. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getSupportInformation/).
915
915
  */
916
916
  getSupportInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.Support>;
917
+ /**
918
+ * @param {ContentPlatformApplicationValidator.GetTagsTemplateParam} arg - Arg object
919
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
920
+ * @param {import("../PlatformAPIClient").Options} - Options
921
+ * @returns {Promise<ContentPlatformModel.TagsTemplateSchema>} - Success response
922
+ * @name getTagsTemplate
923
+ * @summary: Get Script Tags Templates
924
+ * @description: Retrieve the available script tag templates - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getTagsTemplate/).
925
+ */
926
+ getTagsTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsTemplateSchema>;
917
927
  /**
918
928
  * @param {ContentPlatformApplicationValidator.GetTranslateUILabelsParam} arg
919
929
  * - Arg object
@@ -5207,7 +5207,7 @@ class Content {
5207
5207
  * @description: Retrieve a list of injectable tags. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getInjectableTags/).
5208
5208
  */
5209
5209
  async getInjectableTags(
5210
- { all, requestHeaders } = { requestHeaders: {} },
5210
+ { all, pageNo, pageSize, search, requestHeaders } = { requestHeaders: {} },
5211
5211
  { responseHeaders } = { responseHeaders: false }
5212
5212
  ) {
5213
5213
  const {
@@ -5215,6 +5215,9 @@ class Content {
5215
5215
  } = ContentPlatformApplicationValidator.getInjectableTags().validate(
5216
5216
  {
5217
5217
  all,
5218
+ pageNo,
5219
+ pageSize,
5220
+ search,
5218
5221
  },
5219
5222
  { abortEarly: false, allowUnknown: true }
5220
5223
  );
@@ -5228,6 +5231,9 @@ class Content {
5228
5231
  } = ContentPlatformApplicationValidator.getInjectableTags().validate(
5229
5232
  {
5230
5233
  all,
5234
+ pageNo,
5235
+ pageSize,
5236
+ search,
5231
5237
  },
5232
5238
  { abortEarly: false, allowUnknown: false }
5233
5239
  );
@@ -5240,6 +5246,9 @@ class Content {
5240
5246
 
5241
5247
  const query_params = {};
5242
5248
  query_params["all"] = all;
5249
+ query_params["page_no"] = pageNo;
5250
+ query_params["page_size"] = pageSize;
5251
+ query_params["search"] = search;
5243
5252
 
5244
5253
  const response = await PlatformAPIClient.execute(
5245
5254
  this.config,
@@ -6413,6 +6422,81 @@ class Content {
6413
6422
  return response;
6414
6423
  }
6415
6424
 
6425
+ /**
6426
+ * @param {ContentPlatformApplicationValidator.GetTagsTemplateParam} arg - Arg object
6427
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
6428
+ * @param {import("../PlatformAPIClient").Options} - Options
6429
+ * @returns {Promise<ContentPlatformModel.TagsTemplateSchema>} - Success response
6430
+ * @name getTagsTemplate
6431
+ * @summary: Get Script Tags Templates
6432
+ * @description: Retrieve the available script tag templates - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getTagsTemplate/).
6433
+ */
6434
+ async getTagsTemplate(
6435
+ { requestHeaders } = { requestHeaders: {} },
6436
+ { responseHeaders } = { responseHeaders: false }
6437
+ ) {
6438
+ const {
6439
+ error,
6440
+ } = ContentPlatformApplicationValidator.getTagsTemplate().validate(
6441
+ {},
6442
+ { abortEarly: false, allowUnknown: true }
6443
+ );
6444
+ if (error) {
6445
+ return Promise.reject(new FDKClientValidationError(error));
6446
+ }
6447
+
6448
+ // Showing warrnings if extra unknown parameters are found
6449
+ const {
6450
+ error: warrning,
6451
+ } = ContentPlatformApplicationValidator.getTagsTemplate().validate(
6452
+ {},
6453
+ { abortEarly: false, allowUnknown: false }
6454
+ );
6455
+ if (warrning) {
6456
+ Logger({
6457
+ level: "WARN",
6458
+ message: `Parameter Validation warrnings for platform > Content > getTagsTemplate \n ${warrning}`,
6459
+ });
6460
+ }
6461
+
6462
+ const query_params = {};
6463
+
6464
+ const response = await PlatformAPIClient.execute(
6465
+ this.config,
6466
+ "get",
6467
+ `/service/platform/content/v1.0/company/${this.config.companyId}/application/${this.applicationId}/tags/templates`,
6468
+ query_params,
6469
+ undefined,
6470
+ requestHeaders,
6471
+ { responseHeaders }
6472
+ );
6473
+
6474
+ let responseData = response;
6475
+ if (responseHeaders) {
6476
+ responseData = response[0];
6477
+ }
6478
+
6479
+ const {
6480
+ error: res_error,
6481
+ } = ContentPlatformModel.TagsTemplateSchema().validate(responseData, {
6482
+ abortEarly: false,
6483
+ allowUnknown: true,
6484
+ });
6485
+
6486
+ if (res_error) {
6487
+ if (this.config.options.strictResponseCheck === true) {
6488
+ return Promise.reject(new FDKResponseValidationError(res_error));
6489
+ } else {
6490
+ Logger({
6491
+ level: "WARN",
6492
+ message: `Response Validation Warnings for platform > Content > getTagsTemplate \n ${res_error}`,
6493
+ });
6494
+ }
6495
+ }
6496
+
6497
+ return response;
6498
+ }
6499
+
6416
6500
  /**
6417
6501
  * @param {ContentPlatformApplicationValidator.GetTranslateUILabelsParam} arg
6418
6502
  * - Arg object
@@ -294,6 +294,11 @@ export = ContentPlatformApplicationValidator;
294
294
  /**
295
295
  * @typedef GetInjectableTagsParam
296
296
  * @property {boolean} [all] - Get all tags irrespective of the creator of tags
297
+ * @property {number} [pageNo] - The page number to navigate through the given
298
+ * set of results. Default value is 1.
299
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
300
+ * Default value is 10.
301
+ * @property {string} [search] - Keyword to filter and find tags by name.
297
302
  */
298
303
  /**
299
304
  * @typedef GetLandingPagesParam
@@ -360,6 +365,7 @@ export = ContentPlatformApplicationValidator;
360
365
  * Default value is 10.
361
366
  */
362
367
  /** @typedef GetSupportInformationParam */
368
+ /** @typedef GetTagsTemplateParam */
363
369
  /**
364
370
  * @typedef GetTranslateUILabelsParam
365
371
  * @property {string} [templateThemeId] - Unique id of template theme
@@ -661,6 +667,8 @@ declare class ContentPlatformApplicationValidator {
661
667
  static getSEOMarkupSchemas(): GetSEOMarkupSchemasParam;
662
668
  /** @returns {GetSupportInformationParam} */
663
669
  static getSupportInformation(): any;
670
+ /** @returns {GetTagsTemplateParam} */
671
+ static getTagsTemplate(): any;
664
672
  /** @returns {GetTranslateUILabelsParam} */
665
673
  static getTranslateUILabels(): GetTranslateUILabelsParam;
666
674
  /** @returns {GetTranslateUILabelsByIdParam} */
@@ -721,7 +729,7 @@ declare class ContentPlatformApplicationValidator {
721
729
  static upsertApplicationResourceTranslationInBulk(): UpsertApplicationResourceTranslationInBulkParam;
722
730
  }
723
731
  declare namespace ContentPlatformApplicationValidator {
724
- export { AddApplicationLanguageParam, AddDataLoaderParam, AddFaqParam, AddInjectableTagParam, AddPathRedirectionRulesParam, BulkUnPublishApplicationLanguageParam, CreateAnnouncementParam, CreateAppCustomFieldDefinitionParam, CreateAppCustomObjectBySlugParam, CreateAppCustomObjectDefinitionParam, CreateApplicationResourceTranslationParam, CreateBlogParam, CreateFaqCategoryParam, CreateLandingPageParam, CreateNavigationParam, CreatePageParam, CreateSEOMarkupSchemaParam, CreateTranslateUILabelsParam, DeleteAnnouncementParam, DeleteAppCustomFieldDefinitionBySlugParam, DeleteAppCustomObjectBySlugParam, DeleteAppCustomObjectDefinitionBySlugParam, DeleteApplicationLanguageParam, DeleteApplicationResourceTranslationParam, DeleteBlogParam, DeleteDataLoaderParam, DeleteFaqParam, DeleteFaqCategoryParam, DeleteLandingPageParam, DeleteNavigationParam, DeletePageParam, DeletePathRedirectionRulesParam, DeleteSEOMarkupSchemaParam, EditDataLoaderParam, EditInjectableTagParam, EditSEOMarkupSchemaParam, ExportAppCustomObjectEntriesBySlugParam, GenerateSEOTitleParam, GetAnnouncementByIdParam, GetAnnouncementsListParam, GetAppCustomFieldDefinitionByResourceParam, GetAppCustomFieldDefinitionBySlugParam, GetAppCustomFieldDefinitionsParam, GetAppCustomFieldTypesParam, GetAppCustomFieldsByResourceSlugParam, GetAppCustomObjectBySlugParam, GetAppCustomObjectDefinitionBySlugParam, GetAppCustomObjectDefinitionsParam, GetAppCustomObjectsBySlugParam, GetAppJobsParam, GetAppResourcesParam, GetApplicationLanguagesParam, GetApplicationResourceTranslationsParam, GetBlogBySlugParam, GetBlogsParam, GetDataLoadersParam, GetDataLoadersByServiceParam, GetDefaultNavigationsParam, GetDefaultSEOMarkupSchemaParam, GetFaqByIdOrSlugParam, GetFaqCategoriesParam, GetFaqCategoryBySlugOrIdParam, GetFaqsByCategoryIdOrSlugParam, GetInjectableTagsParam, GetLandingPagesParam, GetLegalInformationParam, GetNavigationBySlugParam, GetNavigationsParam, GetPageBySlugParam, GetPageMetaParam, GetPageSpecParam, GetPagesParam, GetPathRedirectionRuleParam, GetPathRedirectionRulesParam, GetSEOConfigurationParam, GetSEOMarkupSchemaParam, GetSEOMarkupSchemasParam, GetSupportInformationParam, GetTranslateUILabelsParam, GetTranslateUILabelsByIdParam, ImportAppCustomObjectEntriesBySlugParam, RemoveInjectableTagParam, ResetDataLoaderParam, SampleAppCustomObjectBulkEntryBySlugParam, SelectDataLoaderParam, UpdateAnnouncementParam, UpdateAnnouncementScheduleParam, UpdateAppCustomFieldByResourceSlugParam, UpdateAppCustomFieldDefinitionBySlugParam, UpdateAppCustomObjectBySlugParam, UpdateAppCustomObjectDefinitionBySlugParam, UpdateApplicationLanguageStatusParam, UpdateApplicationResourceTranslationParam, UpdateBlogParam, UpdateFaqParam, UpdateFaqCategoryParam, UpdateInjectableTagParam, UpdateLandingPageParam, UpdateLegalInformationParam, UpdateNavigationParam, UpdatePageParam, UpdatePagePreviewParam, UpdatePathRedirectionRulesParam, UpdateSEOConfigurationParam, UpdateSupportInformationParam, UpdateTranslateUILabelsParam, UpsertApplicationResourceTranslationInBulkParam };
732
+ export { AddApplicationLanguageParam, AddDataLoaderParam, AddFaqParam, AddInjectableTagParam, AddPathRedirectionRulesParam, BulkUnPublishApplicationLanguageParam, CreateAnnouncementParam, CreateAppCustomFieldDefinitionParam, CreateAppCustomObjectBySlugParam, CreateAppCustomObjectDefinitionParam, CreateApplicationResourceTranslationParam, CreateBlogParam, CreateFaqCategoryParam, CreateLandingPageParam, CreateNavigationParam, CreatePageParam, CreateSEOMarkupSchemaParam, CreateTranslateUILabelsParam, DeleteAnnouncementParam, DeleteAppCustomFieldDefinitionBySlugParam, DeleteAppCustomObjectBySlugParam, DeleteAppCustomObjectDefinitionBySlugParam, DeleteApplicationLanguageParam, DeleteApplicationResourceTranslationParam, DeleteBlogParam, DeleteDataLoaderParam, DeleteFaqParam, DeleteFaqCategoryParam, DeleteLandingPageParam, DeleteNavigationParam, DeletePageParam, DeletePathRedirectionRulesParam, DeleteSEOMarkupSchemaParam, EditDataLoaderParam, EditInjectableTagParam, EditSEOMarkupSchemaParam, ExportAppCustomObjectEntriesBySlugParam, GenerateSEOTitleParam, GetAnnouncementByIdParam, GetAnnouncementsListParam, GetAppCustomFieldDefinitionByResourceParam, GetAppCustomFieldDefinitionBySlugParam, GetAppCustomFieldDefinitionsParam, GetAppCustomFieldTypesParam, GetAppCustomFieldsByResourceSlugParam, GetAppCustomObjectBySlugParam, GetAppCustomObjectDefinitionBySlugParam, GetAppCustomObjectDefinitionsParam, GetAppCustomObjectsBySlugParam, GetAppJobsParam, GetAppResourcesParam, GetApplicationLanguagesParam, GetApplicationResourceTranslationsParam, GetBlogBySlugParam, GetBlogsParam, GetDataLoadersParam, GetDataLoadersByServiceParam, GetDefaultNavigationsParam, GetDefaultSEOMarkupSchemaParam, GetFaqByIdOrSlugParam, GetFaqCategoriesParam, GetFaqCategoryBySlugOrIdParam, GetFaqsByCategoryIdOrSlugParam, GetInjectableTagsParam, GetLandingPagesParam, GetLegalInformationParam, GetNavigationBySlugParam, GetNavigationsParam, GetPageBySlugParam, GetPageMetaParam, GetPageSpecParam, GetPagesParam, GetPathRedirectionRuleParam, GetPathRedirectionRulesParam, GetSEOConfigurationParam, GetSEOMarkupSchemaParam, GetSEOMarkupSchemasParam, GetSupportInformationParam, GetTagsTemplateParam, GetTranslateUILabelsParam, GetTranslateUILabelsByIdParam, ImportAppCustomObjectEntriesBySlugParam, RemoveInjectableTagParam, ResetDataLoaderParam, SampleAppCustomObjectBulkEntryBySlugParam, SelectDataLoaderParam, UpdateAnnouncementParam, UpdateAnnouncementScheduleParam, UpdateAppCustomFieldByResourceSlugParam, UpdateAppCustomFieldDefinitionBySlugParam, UpdateAppCustomObjectBySlugParam, UpdateAppCustomObjectDefinitionBySlugParam, UpdateApplicationLanguageStatusParam, UpdateApplicationResourceTranslationParam, UpdateBlogParam, UpdateFaqParam, UpdateFaqCategoryParam, UpdateInjectableTagParam, UpdateLandingPageParam, UpdateLegalInformationParam, UpdateNavigationParam, UpdatePageParam, UpdatePagePreviewParam, UpdatePathRedirectionRulesParam, UpdateSEOConfigurationParam, UpdateSupportInformationParam, UpdateTranslateUILabelsParam, UpsertApplicationResourceTranslationInBulkParam };
725
733
  }
726
734
  type AddApplicationLanguageParam = {
727
735
  body: ContentPlatformModel.ApplicationLanguageCreate;
@@ -1053,6 +1061,20 @@ type GetInjectableTagsParam = {
1053
1061
  * - Get all tags irrespective of the creator of tags
1054
1062
  */
1055
1063
  all?: boolean;
1064
+ /**
1065
+ * - The page number to navigate through the given
1066
+ * set of results. Default value is 1.
1067
+ */
1068
+ pageNo?: number;
1069
+ /**
1070
+ * - The number of items to retrieve in each page.
1071
+ * Default value is 10.
1072
+ */
1073
+ pageSize?: number;
1074
+ /**
1075
+ * - Keyword to filter and find tags by name.
1076
+ */
1077
+ search?: string;
1056
1078
  };
1057
1079
  type GetLandingPagesParam = {
1058
1080
  /**
@@ -1345,4 +1367,5 @@ type GetPageMetaParam = any;
1345
1367
  type GetPageSpecParam = any;
1346
1368
  type GetSEOConfigurationParam = any;
1347
1369
  type GetSupportInformationParam = any;
1370
+ type GetTagsTemplateParam = any;
1348
1371
  import ContentPlatformModel = require("./ContentPlatformModel");
@@ -360,6 +360,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
360
360
  /**
361
361
  * @typedef GetInjectableTagsParam
362
362
  * @property {boolean} [all] - Get all tags irrespective of the creator of tags
363
+ * @property {number} [pageNo] - The page number to navigate through the given
364
+ * set of results. Default value is 1.
365
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
366
+ * Default value is 10.
367
+ * @property {string} [search] - Keyword to filter and find tags by name.
363
368
  */
364
369
 
365
370
  /**
@@ -441,6 +446,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
441
446
 
442
447
  /** @typedef GetSupportInformationParam */
443
448
 
449
+ /** @typedef GetTagsTemplateParam */
450
+
444
451
  /**
445
452
  * @typedef GetTranslateUILabelsParam
446
453
  * @property {string} [templateThemeId] - Unique id of template theme
@@ -1090,6 +1097,9 @@ class ContentPlatformApplicationValidator {
1090
1097
  static getInjectableTags() {
1091
1098
  return Joi.object({
1092
1099
  all: Joi.boolean(),
1100
+ pageNo: Joi.number(),
1101
+ pageSize: Joi.number(),
1102
+ search: Joi.string().allow(""),
1093
1103
  }).required();
1094
1104
  }
1095
1105
 
@@ -1190,6 +1200,11 @@ class ContentPlatformApplicationValidator {
1190
1200
  return Joi.object({}).required();
1191
1201
  }
1192
1202
 
1203
+ /** @returns {GetTagsTemplateParam} */
1204
+ static getTagsTemplate() {
1205
+ return Joi.object({}).required();
1206
+ }
1207
+
1193
1208
  /** @returns {GetTranslateUILabelsParam} */
1194
1209
  static getTranslateUILabels() {
1195
1210
  return Joi.object({