@gofynd/fdk-client-javascript 1.4.15 → 1.4.16-beta.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 (95) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +16 -16
  4. package/sdk/application/Cart/CartApplicationClient.js +101 -48
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -16
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +159 -0
  7. package/sdk/application/Common/CommonApplicationClient.js +6 -0
  8. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -0
  9. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +2 -2
  10. package/sdk/application/Configuration/ConfigurationApplicationClient.js +24 -0
  11. package/sdk/application/Content/ContentApplicationClient.d.ts +59 -7
  12. package/sdk/application/Content/ContentApplicationClient.js +290 -0
  13. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
  14. package/sdk/application/FileStorage/FileStorageApplicationClient.js +24 -0
  15. package/sdk/application/Finance/FinanceApplicationClient.js +6 -0
  16. package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
  17. package/sdk/application/Lead/LeadApplicationClient.js +42 -0
  18. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +6 -6
  19. package/sdk/application/Logistic/LogisticApplicationClient.js +69 -2
  20. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
  21. package/sdk/application/Order/OrderApplicationClient.js +117 -0
  22. package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -11
  23. package/sdk/application/Payment/PaymentApplicationClient.js +15 -39
  24. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  25. package/sdk/application/Rewards/RewardsApplicationClient.js +15 -0
  26. package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
  27. package/sdk/application/Share/ShareApplicationClient.js +42 -0
  28. package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
  29. package/sdk/application/Theme/ThemeApplicationClient.js +36 -0
  30. package/sdk/application/User/UserApplicationClient.js +6 -0
  31. package/sdk/application/Webhook/WebhookApplicationClient.js +6 -0
  32. package/sdk/common/Utility.d.ts +1 -1
  33. package/sdk/common/Utility.js +4 -4
  34. package/sdk/common/Validator.d.ts +1 -0
  35. package/sdk/common/Validator.js +20 -0
  36. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +12 -33
  37. package/sdk/partner/Logistics/LogisticsPartnerClient.js +38 -209
  38. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +19 -399
  39. package/sdk/partner/Logistics/LogisticsPartnerModel.js +11 -212
  40. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -3
  41. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -22
  42. package/sdk/partner/OAuthClient.js +1 -0
  43. package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
  44. package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
  45. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
  46. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
  47. package/sdk/platform/Cart/CartPlatformApplicationClient.js +12 -3
  48. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -1
  49. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -1
  50. package/sdk/platform/Cart/CartPlatformModel.d.ts +49 -28
  51. package/sdk/platform/Cart/CartPlatformModel.js +23 -13
  52. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -24
  53. package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -176
  54. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -80
  55. package/sdk/platform/Catalog/CatalogPlatformModel.js +36 -72
  56. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -45
  57. package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -35
  58. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +7 -0
  59. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +3 -0
  60. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +132 -0
  61. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1104 -122
  62. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +159 -1
  63. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +161 -0
  64. package/sdk/platform/Content/ContentPlatformModel.d.ts +220 -5
  65. package/sdk/platform/Content/ContentPlatformModel.js +214 -4
  66. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
  67. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
  68. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  69. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  70. package/sdk/platform/Order/OrderPlatformClient.d.ts +12 -2
  71. package/sdk/platform/Order/OrderPlatformClient.js +99 -8
  72. package/sdk/platform/Order/OrderPlatformModel.d.ts +3 -75
  73. package/sdk/platform/Order/OrderPlatformModel.js +2 -43
  74. package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -23
  75. package/sdk/platform/Order/OrderPlatformValidator.js +20 -10
  76. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -95
  77. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +78 -701
  78. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +23 -598
  79. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +20 -382
  80. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +3 -136
  81. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -110
  82. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
  83. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  84. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
  85. package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
  86. package/sdk/platform/Share/SharePlatformModel.d.ts +10 -2
  87. package/sdk/platform/Share/SharePlatformModel.js +4 -2
  88. package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
  89. package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
  90. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -0
  91. package/sdk/public/Content/ContentPublicClient.d.ts +3 -3
  92. package/sdk/public/Content/ContentPublicClient.js +28 -0
  93. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  94. package/sdk/public/Partner/PartnerPublicClient.js +10 -0
  95. package/sdk/public/Webhook/WebhookPublicClient.js +1 -0
@@ -62,6 +62,14 @@ export = ContentPlatformApplicationValidator;
62
62
  * @typedef CreateSEOMarkupSchemaParam
63
63
  * @property {ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody} body
64
64
  */
65
+ /**
66
+ * @typedef CreateSitemapParam
67
+ * @property {ContentPlatformModel.SitemapConfigCreate} body
68
+ */
69
+ /**
70
+ * @typedef CreateSlideshowParam
71
+ * @property {ContentPlatformModel.SlideshowPayload} body
72
+ */
65
73
  /**
66
74
  * @typedef DeleteAnnouncementParam
67
75
  * @property {string} announcementId - ID allotted to the announcement.
@@ -119,6 +127,14 @@ export = ContentPlatformApplicationValidator;
119
127
  * @property {string} id - Alphanumeric ID allotted to a SEO Markup Schema
120
128
  * Template created within a business.
121
129
  */
130
+ /**
131
+ * @typedef DeleteSitemapParam
132
+ * @property {string} name
133
+ */
134
+ /**
135
+ * @typedef DeleteSlideshowParam
136
+ * @property {string} id - ID allotted to the slideshow.
137
+ */
122
138
  /**
123
139
  * @typedef EditDataLoaderParam
124
140
  * @property {string} dataLoaderId - ID allotted to the data loader.
@@ -245,6 +261,7 @@ export = ContentPlatformApplicationValidator;
245
261
  * @property {string} [pageType] - The type of page against which schema
246
262
  * template was created
247
263
  */
264
+ /** @typedef GetDefaultSitemapConfigParam */
248
265
  /**
249
266
  * @typedef GetFaqByIdOrSlugParam
250
267
  * @property {string} idOrSlug - ID or the slug allotted to an FAQ category.
@@ -332,6 +349,34 @@ export = ContentPlatformApplicationValidator;
332
349
  * @property {number} [pageSize] - The number of items to retrieve in each page.
333
350
  * Default value is 10.
334
351
  */
352
+ /**
353
+ * @typedef GetSitemapParam
354
+ * @property {string} name
355
+ */
356
+ /**
357
+ * @typedef GetSitemapsParam
358
+ * @property {string} pageNo
359
+ * @property {string} pageSize
360
+ * @property {boolean} [isActive] - Boolean flag for checking if sitemap is
361
+ * active or not in storefront
362
+ * @property {string} [name] - Query parameter to search sitemaps with name
363
+ */
364
+ /**
365
+ * @typedef GetSlideshowBySlugParam
366
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
367
+ * a slideshow. You can get slug value of a page from `getSlideshows` API.
368
+ * @property {string} devicePlatform - Filter slideshows by platform. Acceptable
369
+ * values are: web, android, ios and all
370
+ */
371
+ /**
372
+ * @typedef GetSlideshowsParam
373
+ * @property {string} devicePlatform - Filter slideshows by platform. Acceptable
374
+ * values are: web, android, ios and all
375
+ * @property {number} [pageNo] - The page number to navigate through the given
376
+ * set of results. Default value is 1.
377
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
378
+ * Default value is 10.
379
+ */
335
380
  /** @typedef GetSupportInformationParam */
336
381
  /**
337
382
  * @typedef ImportAppCustomObjectEntriesBySlugParam
@@ -394,6 +439,10 @@ export = ContentPlatformApplicationValidator;
394
439
  * @property {string} id - ID allotted to the blog.
395
440
  * @property {ContentPlatformModel.BlogPayload} body
396
441
  */
442
+ /**
443
+ * @typedef UpdateDefaultSitemapConfigParam
444
+ * @property {ContentPlatformModel.DefaultSitemapConfig} body
445
+ */
397
446
  /**
398
447
  * @typedef UpdateFaqParam
399
448
  * @property {string} categoryId - ID allotted to an FAQ category.
@@ -443,6 +492,16 @@ export = ContentPlatformApplicationValidator;
443
492
  * @typedef UpdateSEOConfigurationParam
444
493
  * @property {ContentPlatformModel.SeoComponent} body
445
494
  */
495
+ /**
496
+ * @typedef UpdateSitemapParam
497
+ * @property {string} name
498
+ * @property {ContentPlatformModel.SitemapConfigUpdate} body
499
+ */
500
+ /**
501
+ * @typedef UpdateSlideshowParam
502
+ * @property {string} id - ID allotted to the slideshow.
503
+ * @property {ContentPlatformModel.SlideshowPayload} body
504
+ */
446
505
  /**
447
506
  * @typedef UpdateSupportInformationParam
448
507
  * @property {ContentPlatformModel.Support} body
@@ -478,6 +537,10 @@ declare class ContentPlatformApplicationValidator {
478
537
  static createPagePreview(): CreatePagePreviewParam;
479
538
  /** @returns {CreateSEOMarkupSchemaParam} */
480
539
  static createSEOMarkupSchema(): CreateSEOMarkupSchemaParam;
540
+ /** @returns {CreateSitemapParam} */
541
+ static createSitemap(): CreateSitemapParam;
542
+ /** @returns {CreateSlideshowParam} */
543
+ static createSlideshow(): CreateSlideshowParam;
481
544
  /** @returns {DeleteAnnouncementParam} */
482
545
  static deleteAnnouncement(): DeleteAnnouncementParam;
483
546
  /** @returns {DeleteAppCustomFieldDefinitionBySlugParam} */
@@ -504,6 +567,10 @@ declare class ContentPlatformApplicationValidator {
504
567
  static deletePathRedirectionRules(): DeletePathRedirectionRulesParam;
505
568
  /** @returns {DeleteSEOMarkupSchemaParam} */
506
569
  static deleteSEOMarkupSchema(): DeleteSEOMarkupSchemaParam;
570
+ /** @returns {DeleteSitemapParam} */
571
+ static deleteSitemap(): DeleteSitemapParam;
572
+ /** @returns {DeleteSlideshowParam} */
573
+ static deleteSlideshow(): DeleteSlideshowParam;
507
574
  /** @returns {EditDataLoaderParam} */
508
575
  static editDataLoader(): EditDataLoaderParam;
509
576
  /** @returns {EditInjectableTagParam} */
@@ -552,6 +619,8 @@ declare class ContentPlatformApplicationValidator {
552
619
  static getDefaultNavigations(): any;
553
620
  /** @returns {GetDefaultSEOMarkupSchemaParam} */
554
621
  static getDefaultSEOMarkupSchema(): GetDefaultSEOMarkupSchemaParam;
622
+ /** @returns {GetDefaultSitemapConfigParam} */
623
+ static getDefaultSitemapConfig(): any;
555
624
  /** @returns {GetFaqByIdOrSlugParam} */
556
625
  static getFaqByIdOrSlug(): GetFaqByIdOrSlugParam;
557
626
  /** @returns {GetFaqCategoriesParam} */
@@ -588,6 +657,14 @@ declare class ContentPlatformApplicationValidator {
588
657
  static getSEOMarkupSchema(): GetSEOMarkupSchemaParam;
589
658
  /** @returns {GetSEOMarkupSchemasParam} */
590
659
  static getSEOMarkupSchemas(): GetSEOMarkupSchemasParam;
660
+ /** @returns {GetSitemapParam} */
661
+ static getSitemap(): GetSitemapParam;
662
+ /** @returns {GetSitemapsParam} */
663
+ static getSitemaps(): GetSitemapsParam;
664
+ /** @returns {GetSlideshowBySlugParam} */
665
+ static getSlideshowBySlug(): GetSlideshowBySlugParam;
666
+ /** @returns {GetSlideshowsParam} */
667
+ static getSlideshows(): GetSlideshowsParam;
591
668
  /** @returns {GetSupportInformationParam} */
592
669
  static getSupportInformation(): any;
593
670
  /** @returns {ImportAppCustomObjectEntriesBySlugParam} */
@@ -614,6 +691,8 @@ declare class ContentPlatformApplicationValidator {
614
691
  static updateAppCustomObjectDefinitionBySlug(): UpdateAppCustomObjectDefinitionBySlugParam;
615
692
  /** @returns {UpdateBlogParam} */
616
693
  static updateBlog(): UpdateBlogParam;
694
+ /** @returns {UpdateDefaultSitemapConfigParam} */
695
+ static updateDefaultSitemapConfig(): UpdateDefaultSitemapConfigParam;
617
696
  /** @returns {UpdateFaqParam} */
618
697
  static updateFaq(): UpdateFaqParam;
619
698
  /** @returns {UpdateFaqCategoryParam} */
@@ -634,11 +713,15 @@ declare class ContentPlatformApplicationValidator {
634
713
  static updatePathRedirectionRules(): UpdatePathRedirectionRulesParam;
635
714
  /** @returns {UpdateSEOConfigurationParam} */
636
715
  static updateSEOConfiguration(): UpdateSEOConfigurationParam;
716
+ /** @returns {UpdateSitemapParam} */
717
+ static updateSitemap(): UpdateSitemapParam;
718
+ /** @returns {UpdateSlideshowParam} */
719
+ static updateSlideshow(): UpdateSlideshowParam;
637
720
  /** @returns {UpdateSupportInformationParam} */
638
721
  static updateSupportInformation(): UpdateSupportInformationParam;
639
722
  }
640
723
  declare namespace ContentPlatformApplicationValidator {
641
- export { AddDataLoaderParam, AddFaqParam, AddInjectableTagParam, AddPathRedirectionRulesParam, CreateAnnouncementParam, CreateAppCustomFieldDefinitionParam, CreateAppCustomObjectBySlugParam, CreateAppCustomObjectDefinitionParam, CreateBlogParam, CreateFaqCategoryParam, CreateLandingPageParam, CreateNavigationParam, CreatePageParam, CreatePagePreviewParam, CreateSEOMarkupSchemaParam, DeleteAnnouncementParam, DeleteAppCustomFieldDefinitionBySlugParam, DeleteAppCustomObjectBySlugParam, DeleteAppCustomObjectDefinitionBySlugParam, 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, 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, ImportAppCustomObjectEntriesBySlugParam, RemoveInjectableTagParam, ResetDataLoaderParam, SampleAppCustomObjectBulkEntryBySlugParam, SelectDataLoaderParam, UpdateAnnouncementParam, UpdateAnnouncementScheduleParam, UpdateAppCustomFieldByResourceSlugParam, UpdateAppCustomFieldDefinitionBySlugParam, UpdateAppCustomObjectBySlugParam, UpdateAppCustomObjectDefinitionBySlugParam, UpdateBlogParam, UpdateFaqParam, UpdateFaqCategoryParam, UpdateInjectableTagParam, UpdateLandingPageParam, UpdateLegalInformationParam, UpdateNavigationParam, UpdatePageParam, UpdatePagePreviewParam, UpdatePathRedirectionRulesParam, UpdateSEOConfigurationParam, UpdateSupportInformationParam };
724
+ export { AddDataLoaderParam, AddFaqParam, AddInjectableTagParam, AddPathRedirectionRulesParam, CreateAnnouncementParam, CreateAppCustomFieldDefinitionParam, CreateAppCustomObjectBySlugParam, CreateAppCustomObjectDefinitionParam, CreateBlogParam, CreateFaqCategoryParam, CreateLandingPageParam, CreateNavigationParam, CreatePageParam, CreatePagePreviewParam, CreateSEOMarkupSchemaParam, CreateSitemapParam, CreateSlideshowParam, DeleteAnnouncementParam, DeleteAppCustomFieldDefinitionBySlugParam, DeleteAppCustomObjectBySlugParam, DeleteAppCustomObjectDefinitionBySlugParam, DeleteBlogParam, DeleteDataLoaderParam, DeleteFaqParam, DeleteFaqCategoryParam, DeleteLandingPageParam, DeleteNavigationParam, DeletePageParam, DeletePathRedirectionRulesParam, DeleteSEOMarkupSchemaParam, DeleteSitemapParam, DeleteSlideshowParam, EditDataLoaderParam, EditInjectableTagParam, EditSEOMarkupSchemaParam, ExportAppCustomObjectEntriesBySlugParam, GenerateSEOTitleParam, GetAnnouncementByIdParam, GetAnnouncementsListParam, GetAppCustomFieldDefinitionByResourceParam, GetAppCustomFieldDefinitionBySlugParam, GetAppCustomFieldDefinitionsParam, GetAppCustomFieldTypesParam, GetAppCustomFieldsByResourceSlugParam, GetAppCustomObjectBySlugParam, GetAppCustomObjectDefinitionBySlugParam, GetAppCustomObjectDefinitionsParam, GetAppCustomObjectsBySlugParam, GetAppJobsParam, GetAppResourcesParam, GetBlogBySlugParam, GetBlogsParam, GetDataLoadersParam, GetDataLoadersByServiceParam, GetDefaultNavigationsParam, GetDefaultSEOMarkupSchemaParam, GetDefaultSitemapConfigParam, GetFaqByIdOrSlugParam, GetFaqCategoriesParam, GetFaqCategoryBySlugOrIdParam, GetFaqsByCategoryIdOrSlugParam, GetInjectableTagsParam, GetLandingPagesParam, GetLegalInformationParam, GetNavigationBySlugParam, GetNavigationsParam, GetPageBySlugParam, GetPageMetaParam, GetPageSpecParam, GetPagesParam, GetPathRedirectionRuleParam, GetPathRedirectionRulesParam, GetSEOConfigurationParam, GetSEOMarkupSchemaParam, GetSEOMarkupSchemasParam, GetSitemapParam, GetSitemapsParam, GetSlideshowBySlugParam, GetSlideshowsParam, GetSupportInformationParam, ImportAppCustomObjectEntriesBySlugParam, RemoveInjectableTagParam, ResetDataLoaderParam, SampleAppCustomObjectBulkEntryBySlugParam, SelectDataLoaderParam, UpdateAnnouncementParam, UpdateAnnouncementScheduleParam, UpdateAppCustomFieldByResourceSlugParam, UpdateAppCustomFieldDefinitionBySlugParam, UpdateAppCustomObjectBySlugParam, UpdateAppCustomObjectDefinitionBySlugParam, UpdateBlogParam, UpdateDefaultSitemapConfigParam, UpdateFaqParam, UpdateFaqCategoryParam, UpdateInjectableTagParam, UpdateLandingPageParam, UpdateLegalInformationParam, UpdateNavigationParam, UpdatePageParam, UpdatePagePreviewParam, UpdatePathRedirectionRulesParam, UpdateSEOConfigurationParam, UpdateSitemapParam, UpdateSlideshowParam, UpdateSupportInformationParam };
642
725
  }
643
726
  type AddDataLoaderParam = {
644
727
  body: ContentPlatformModel.DataLoaderSchema;
@@ -691,6 +774,12 @@ type CreatePagePreviewParam = {
691
774
  type CreateSEOMarkupSchemaParam = {
692
775
  body: ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody;
693
776
  };
777
+ type CreateSitemapParam = {
778
+ body: ContentPlatformModel.SitemapConfigCreate;
779
+ };
780
+ type CreateSlideshowParam = {
781
+ body: ContentPlatformModel.SlideshowPayload;
782
+ };
694
783
  type DeleteAnnouncementParam = {
695
784
  /**
696
785
  * - ID allotted to the announcement.
@@ -768,6 +857,15 @@ type DeleteSEOMarkupSchemaParam = {
768
857
  */
769
858
  id: string;
770
859
  };
860
+ type DeleteSitemapParam = {
861
+ name: string;
862
+ };
863
+ type DeleteSlideshowParam = {
864
+ /**
865
+ * - ID allotted to the slideshow.
866
+ */
867
+ id: string;
868
+ };
771
869
  type EditDataLoaderParam = {
772
870
  /**
773
871
  * - ID allotted to the data loader.
@@ -1056,6 +1154,51 @@ type GetSEOMarkupSchemasParam = {
1056
1154
  */
1057
1155
  pageSize?: number;
1058
1156
  };
1157
+ type GetSitemapParam = {
1158
+ name: string;
1159
+ };
1160
+ type GetSitemapsParam = {
1161
+ pageNo: string;
1162
+ pageSize: string;
1163
+ /**
1164
+ * - Boolean flag for checking if sitemap is
1165
+ * active or not in storefront
1166
+ */
1167
+ isActive?: boolean;
1168
+ /**
1169
+ * - Query parameter to search sitemaps with name
1170
+ */
1171
+ name?: string;
1172
+ };
1173
+ type GetSlideshowBySlugParam = {
1174
+ /**
1175
+ * - A short, human-readable, URL-friendly identifier of
1176
+ * a slideshow. You can get slug value of a page from `getSlideshows` API.
1177
+ */
1178
+ slug: string;
1179
+ /**
1180
+ * - Filter slideshows by platform. Acceptable
1181
+ * values are: web, android, ios and all
1182
+ */
1183
+ devicePlatform: string;
1184
+ };
1185
+ type GetSlideshowsParam = {
1186
+ /**
1187
+ * - Filter slideshows by platform. Acceptable
1188
+ * values are: web, android, ios and all
1189
+ */
1190
+ devicePlatform: string;
1191
+ /**
1192
+ * - The page number to navigate through the given
1193
+ * set of results. Default value is 1.
1194
+ */
1195
+ pageNo?: number;
1196
+ /**
1197
+ * - The number of items to retrieve in each page.
1198
+ * Default value is 10.
1199
+ */
1200
+ pageSize?: number;
1201
+ };
1059
1202
  type ImportAppCustomObjectEntriesBySlugParam = {
1060
1203
  slug: string;
1061
1204
  body: ContentPlatformModel.CustomObjectBulkSchema;
@@ -1123,6 +1266,9 @@ type UpdateBlogParam = {
1123
1266
  id: string;
1124
1267
  body: ContentPlatformModel.BlogPayload;
1125
1268
  };
1269
+ type UpdateDefaultSitemapConfigParam = {
1270
+ body: ContentPlatformModel.DefaultSitemapConfig;
1271
+ };
1126
1272
  type UpdateFaqParam = {
1127
1273
  /**
1128
1274
  * - ID allotted to an FAQ category.
@@ -1186,6 +1332,17 @@ type UpdatePathRedirectionRulesParam = {
1186
1332
  type UpdateSEOConfigurationParam = {
1187
1333
  body: ContentPlatformModel.SeoComponent;
1188
1334
  };
1335
+ type UpdateSitemapParam = {
1336
+ name: string;
1337
+ body: ContentPlatformModel.SitemapConfigUpdate;
1338
+ };
1339
+ type UpdateSlideshowParam = {
1340
+ /**
1341
+ * - ID allotted to the slideshow.
1342
+ */
1343
+ id: string;
1344
+ body: ContentPlatformModel.SlideshowPayload;
1345
+ };
1189
1346
  type UpdateSupportInformationParam = {
1190
1347
  body: ContentPlatformModel.Support;
1191
1348
  };
@@ -1193,6 +1350,7 @@ type GetAppCustomFieldTypesParam = any;
1193
1350
  type GetAppResourcesParam = any;
1194
1351
  type GetDataLoadersParam = any;
1195
1352
  type GetDefaultNavigationsParam = any;
1353
+ type GetDefaultSitemapConfigParam = any;
1196
1354
  type GetFaqCategoriesParam = any;
1197
1355
  type GetLegalInformationParam = any;
1198
1356
  type GetPageMetaParam = any;
@@ -80,6 +80,16 @@ const ContentPlatformModel = require("./ContentPlatformModel");
80
80
  * @property {ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody} body
81
81
  */
82
82
 
83
+ /**
84
+ * @typedef CreateSitemapParam
85
+ * @property {ContentPlatformModel.SitemapConfigCreate} body
86
+ */
87
+
88
+ /**
89
+ * @typedef CreateSlideshowParam
90
+ * @property {ContentPlatformModel.SlideshowPayload} body
91
+ */
92
+
83
93
  /**
84
94
  * @typedef DeleteAnnouncementParam
85
95
  * @property {string} announcementId - ID allotted to the announcement.
@@ -150,6 +160,16 @@ const ContentPlatformModel = require("./ContentPlatformModel");
150
160
  * Template created within a business.
151
161
  */
152
162
 
163
+ /**
164
+ * @typedef DeleteSitemapParam
165
+ * @property {string} name
166
+ */
167
+
168
+ /**
169
+ * @typedef DeleteSlideshowParam
170
+ * @property {string} id - ID allotted to the slideshow.
171
+ */
172
+
153
173
  /**
154
174
  * @typedef EditDataLoaderParam
155
175
  * @property {string} dataLoaderId - ID allotted to the data loader.
@@ -300,6 +320,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
300
320
  * template was created
301
321
  */
302
322
 
323
+ /** @typedef GetDefaultSitemapConfigParam */
324
+
303
325
  /**
304
326
  * @typedef GetFaqByIdOrSlugParam
305
327
  * @property {string} idOrSlug - ID or the slug allotted to an FAQ category.
@@ -405,6 +427,38 @@ const ContentPlatformModel = require("./ContentPlatformModel");
405
427
  * Default value is 10.
406
428
  */
407
429
 
430
+ /**
431
+ * @typedef GetSitemapParam
432
+ * @property {string} name
433
+ */
434
+
435
+ /**
436
+ * @typedef GetSitemapsParam
437
+ * @property {string} pageNo
438
+ * @property {string} pageSize
439
+ * @property {boolean} [isActive] - Boolean flag for checking if sitemap is
440
+ * active or not in storefront
441
+ * @property {string} [name] - Query parameter to search sitemaps with name
442
+ */
443
+
444
+ /**
445
+ * @typedef GetSlideshowBySlugParam
446
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
447
+ * a slideshow. You can get slug value of a page from `getSlideshows` API.
448
+ * @property {string} devicePlatform - Filter slideshows by platform. Acceptable
449
+ * values are: web, android, ios and all
450
+ */
451
+
452
+ /**
453
+ * @typedef GetSlideshowsParam
454
+ * @property {string} devicePlatform - Filter slideshows by platform. Acceptable
455
+ * values are: web, android, ios and all
456
+ * @property {number} [pageNo] - The page number to navigate through the given
457
+ * set of results. Default value is 1.
458
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
459
+ * Default value is 10.
460
+ */
461
+
408
462
  /** @typedef GetSupportInformationParam */
409
463
 
410
464
  /**
@@ -480,6 +534,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
480
534
  * @property {ContentPlatformModel.BlogPayload} body
481
535
  */
482
536
 
537
+ /**
538
+ * @typedef UpdateDefaultSitemapConfigParam
539
+ * @property {ContentPlatformModel.DefaultSitemapConfig} body
540
+ */
541
+
483
542
  /**
484
543
  * @typedef UpdateFaqParam
485
544
  * @property {string} categoryId - ID allotted to an FAQ category.
@@ -539,6 +598,18 @@ const ContentPlatformModel = require("./ContentPlatformModel");
539
598
  * @property {ContentPlatformModel.SeoComponent} body
540
599
  */
541
600
 
601
+ /**
602
+ * @typedef UpdateSitemapParam
603
+ * @property {string} name
604
+ * @property {ContentPlatformModel.SitemapConfigUpdate} body
605
+ */
606
+
607
+ /**
608
+ * @typedef UpdateSlideshowParam
609
+ * @property {string} id - ID allotted to the slideshow.
610
+ * @property {ContentPlatformModel.SlideshowPayload} body
611
+ */
612
+
542
613
  /**
543
614
  * @typedef UpdateSupportInformationParam
544
615
  * @property {ContentPlatformModel.Support} body
@@ -653,6 +724,20 @@ class ContentPlatformApplicationValidator {
653
724
  }).required();
654
725
  }
655
726
 
727
+ /** @returns {CreateSitemapParam} */
728
+ static createSitemap() {
729
+ return Joi.object({
730
+ body: ContentPlatformModel.SitemapConfigCreate().required(),
731
+ }).required();
732
+ }
733
+
734
+ /** @returns {CreateSlideshowParam} */
735
+ static createSlideshow() {
736
+ return Joi.object({
737
+ body: ContentPlatformModel.SlideshowPayload().required(),
738
+ }).required();
739
+ }
740
+
656
741
  /** @returns {DeleteAnnouncementParam} */
657
742
  static deleteAnnouncement() {
658
743
  return Joi.object({
@@ -748,6 +833,20 @@ class ContentPlatformApplicationValidator {
748
833
  }).required();
749
834
  }
750
835
 
836
+ /** @returns {DeleteSitemapParam} */
837
+ static deleteSitemap() {
838
+ return Joi.object({
839
+ name: Joi.string().allow("").required(),
840
+ }).required();
841
+ }
842
+
843
+ /** @returns {DeleteSlideshowParam} */
844
+ static deleteSlideshow() {
845
+ return Joi.object({
846
+ id: Joi.string().allow("").required(),
847
+ }).required();
848
+ }
849
+
751
850
  /** @returns {EditDataLoaderParam} */
752
851
  static editDataLoader() {
753
852
  return Joi.object({
@@ -941,6 +1040,11 @@ class ContentPlatformApplicationValidator {
941
1040
  }).required();
942
1041
  }
943
1042
 
1043
+ /** @returns {GetDefaultSitemapConfigParam} */
1044
+ static getDefaultSitemapConfig() {
1045
+ return Joi.object({}).required();
1046
+ }
1047
+
944
1048
  /** @returns {GetFaqByIdOrSlugParam} */
945
1049
  static getFaqByIdOrSlug() {
946
1050
  return Joi.object({
@@ -1066,6 +1170,40 @@ class ContentPlatformApplicationValidator {
1066
1170
  }).required();
1067
1171
  }
1068
1172
 
1173
+ /** @returns {GetSitemapParam} */
1174
+ static getSitemap() {
1175
+ return Joi.object({
1176
+ name: Joi.string().allow("").required(),
1177
+ }).required();
1178
+ }
1179
+
1180
+ /** @returns {GetSitemapsParam} */
1181
+ static getSitemaps() {
1182
+ return Joi.object({
1183
+ pageNo: Joi.string().allow("").required(),
1184
+ pageSize: Joi.string().allow("").required(),
1185
+ isActive: Joi.boolean(),
1186
+ name: Joi.string().allow(""),
1187
+ }).required();
1188
+ }
1189
+
1190
+ /** @returns {GetSlideshowBySlugParam} */
1191
+ static getSlideshowBySlug() {
1192
+ return Joi.object({
1193
+ slug: Joi.string().allow("").required(),
1194
+ devicePlatform: Joi.string().allow("").required(),
1195
+ }).required();
1196
+ }
1197
+
1198
+ /** @returns {GetSlideshowsParam} */
1199
+ static getSlideshows() {
1200
+ return Joi.object({
1201
+ devicePlatform: Joi.string().allow("").required(),
1202
+ pageNo: Joi.number(),
1203
+ pageSize: Joi.number(),
1204
+ }).required();
1205
+ }
1206
+
1069
1207
  /** @returns {GetSupportInformationParam} */
1070
1208
  static getSupportInformation() {
1071
1209
  return Joi.object({}).required();
@@ -1168,6 +1306,13 @@ class ContentPlatformApplicationValidator {
1168
1306
  }).required();
1169
1307
  }
1170
1308
 
1309
+ /** @returns {UpdateDefaultSitemapConfigParam} */
1310
+ static updateDefaultSitemapConfig() {
1311
+ return Joi.object({
1312
+ body: ContentPlatformModel.DefaultSitemapConfig().required(),
1313
+ }).required();
1314
+ }
1315
+
1171
1316
  /** @returns {UpdateFaqParam} */
1172
1317
  static updateFaq() {
1173
1318
  return Joi.object({
@@ -1246,6 +1391,22 @@ class ContentPlatformApplicationValidator {
1246
1391
  }).required();
1247
1392
  }
1248
1393
 
1394
+ /** @returns {UpdateSitemapParam} */
1395
+ static updateSitemap() {
1396
+ return Joi.object({
1397
+ name: Joi.string().allow("").required(),
1398
+ body: ContentPlatformModel.SitemapConfigUpdate().required(),
1399
+ }).required();
1400
+ }
1401
+
1402
+ /** @returns {UpdateSlideshowParam} */
1403
+ static updateSlideshow() {
1404
+ return Joi.object({
1405
+ id: Joi.string().allow("").required(),
1406
+ body: ContentPlatformModel.SlideshowPayload().required(),
1407
+ }).required();
1408
+ }
1409
+
1249
1410
  /** @returns {UpdateSupportInformationParam} */
1250
1411
  static updateSupportInformation() {
1251
1412
  return Joi.object({