@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
@@ -57,8 +57,6 @@ export = ContentPlatformModel;
57
57
  * @property {string} [app]
58
58
  * @property {string} [_id]
59
59
  * @property {string} [robots_txt]
60
- * @property {boolean} [sitemap_enabled]
61
- * @property {string} [additional_sitemap]
62
60
  * @property {boolean} [cannonical_enabled]
63
61
  * @property {CustomMetaTag[]} [custom_meta_tags]
64
62
  * @property {Detail} [details]
@@ -245,6 +243,50 @@ export = ContentPlatformModel;
245
243
  * @property {string} [created_on]
246
244
  * @property {string} [modified_on]
247
245
  */
246
+ /**
247
+ * @typedef DefaultSitemapIndividualConfig
248
+ * @property {boolean} [enabled] - Whether sitemap configuration is enabled or
249
+ * not for this sitemap configuration
250
+ */
251
+ /**
252
+ * @typedef DefaultSitemapConfig
253
+ * @property {DefaultSitemapIndividualConfig} [root]
254
+ * @property {DefaultSitemapIndividualConfig} [brand]
255
+ * @property {DefaultSitemapIndividualConfig} [collections]
256
+ * @property {DefaultSitemapIndividualConfig} [category_l1]
257
+ * @property {DefaultSitemapIndividualConfig} [category_l2]
258
+ * @property {DefaultSitemapIndividualConfig} [category_l3]
259
+ * @property {DefaultSitemapIndividualConfig} [pages]
260
+ * @property {DefaultSitemapIndividualConfig} [blog]
261
+ * @property {DefaultSitemapIndividualConfig} [section]
262
+ * @property {DefaultSitemapIndividualConfig} [faq]
263
+ * @property {DefaultSitemapIndividualConfig} [sitemap]
264
+ */
265
+ /**
266
+ * @typedef SitemapConfigCreate
267
+ * @property {string} [name] - Unique identifier for the sitemap configuration
268
+ * @property {boolean} [is_active] - Indicates if the sitemap configuration is active
269
+ * @property {string} [sitemap] - XML string containing sitemap data in base64 encoding
270
+ */
271
+ /**
272
+ * @typedef SitemapConfig
273
+ * @property {string} [name] - Unique identifier for the sitemap configuration
274
+ * @property {boolean} [is_active] - Indicates if the sitemap configuration is
275
+ * active or not in storefront
276
+ * @property {string} [sitemap] - XML string containing sitemap data in base64 encoding
277
+ * @property {string} [created_at] - Timestamp when the configuration was created
278
+ * @property {string} [updated_at] - Timestamp when the configuration was last updated
279
+ */
280
+ /**
281
+ * @typedef SitemapConfigurationList
282
+ * @property {SitemapConfig[]} [items] - List of all Sitemap configurations
283
+ * @property {Page} [page]
284
+ */
285
+ /**
286
+ * @typedef SitemapConfigUpdate
287
+ * @property {boolean} [is_active] - Indicates if the sitemap configuration is active
288
+ * @property {string} [sitemap] - XML string containing sitemap data
289
+ */
248
290
  /**
249
291
  * @typedef BlogPayload
250
292
  * @property {string} [application]
@@ -324,6 +366,22 @@ export = ContentPlatformModel;
324
366
  * @property {string} [start]
325
367
  * @property {string} [end]
326
368
  */
369
+ /**
370
+ * @typedef ConfigurationSchema
371
+ * @property {number} [sleep_time]
372
+ * @property {boolean} [start_on_launch]
373
+ * @property {number} [duration]
374
+ * @property {string} [slide_direction]
375
+ */
376
+ /**
377
+ * @typedef SlideshowMedia
378
+ * @property {string} [type]
379
+ * @property {string} [url]
380
+ * @property {string} [bg_color]
381
+ * @property {number} [duration]
382
+ * @property {boolean} [auto_decide_duration]
383
+ * @property {Action} [action]
384
+ */
327
385
  /**
328
386
  * @typedef UpdateHandpickedSchema
329
387
  * @property {HandpickedTagSchema} [tag]
@@ -628,6 +686,32 @@ export = ContentPlatformModel;
628
686
  * @property {PageSchema[]} [custom_pages]
629
687
  * @property {string} [application_id]
630
688
  */
689
+ /**
690
+ * @typedef SlideshowGetDetails
691
+ * @property {SlideshowSchema[]} [items]
692
+ * @property {Page} [page]
693
+ */
694
+ /**
695
+ * @typedef SlideshowSchema
696
+ * @property {string} [_id]
697
+ * @property {string} [slug]
698
+ * @property {DateMeta} [date_meta]
699
+ * @property {string} [application]
700
+ * @property {string} [platform]
701
+ * @property {ConfigurationSchema} [configuration]
702
+ * @property {SlideshowMedia[]} [media]
703
+ * @property {boolean} [active]
704
+ * @property {boolean} [archived]
705
+ * @property {Object} [_custom_json]
706
+ */
707
+ /**
708
+ * @typedef SlideshowPayload
709
+ * @property {string} [slug]
710
+ * @property {string} [platform]
711
+ * @property {ConfigurationSchema} [configuration]
712
+ * @property {SlideshowMedia} [media]
713
+ * @property {boolean} [active]
714
+ */
631
715
  /**
632
716
  * @typedef Support
633
717
  * @property {boolean} [created]
@@ -1256,7 +1340,7 @@ export = ContentPlatformModel;
1256
1340
  declare class ContentPlatformModel {
1257
1341
  }
1258
1342
  declare namespace ContentPlatformModel {
1259
- export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
1343
+ export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, DefaultSitemapIndividualConfig, DefaultSitemapConfig, SitemapConfigCreate, SitemapConfig, SitemapConfigurationList, SitemapConfigUpdate, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, SlideshowGetDetails, SlideshowSchema, SlideshowPayload, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
1260
1344
  }
1261
1345
  /** @returns {ValidationError} */
1262
1346
  declare function ValidationError(): ValidationError;
@@ -1331,8 +1415,6 @@ type SeoSchema = {
1331
1415
  app?: string;
1332
1416
  _id?: string;
1333
1417
  robots_txt?: string;
1334
- sitemap_enabled?: boolean;
1335
- additional_sitemap?: string;
1336
1418
  cannonical_enabled?: boolean;
1337
1419
  custom_meta_tags?: CustomMetaTag[];
1338
1420
  details?: Detail;
@@ -1545,6 +1627,92 @@ type DateMeta = {
1545
1627
  created_on?: string;
1546
1628
  modified_on?: string;
1547
1629
  };
1630
+ /** @returns {DefaultSitemapIndividualConfig} */
1631
+ declare function DefaultSitemapIndividualConfig(): DefaultSitemapIndividualConfig;
1632
+ type DefaultSitemapIndividualConfig = {
1633
+ /**
1634
+ * - Whether sitemap configuration is enabled or
1635
+ * not for this sitemap configuration
1636
+ */
1637
+ enabled?: boolean;
1638
+ };
1639
+ /** @returns {DefaultSitemapConfig} */
1640
+ declare function DefaultSitemapConfig(): DefaultSitemapConfig;
1641
+ type DefaultSitemapConfig = {
1642
+ root?: DefaultSitemapIndividualConfig;
1643
+ brand?: DefaultSitemapIndividualConfig;
1644
+ collections?: DefaultSitemapIndividualConfig;
1645
+ category_l1?: DefaultSitemapIndividualConfig;
1646
+ category_l2?: DefaultSitemapIndividualConfig;
1647
+ category_l3?: DefaultSitemapIndividualConfig;
1648
+ pages?: DefaultSitemapIndividualConfig;
1649
+ blog?: DefaultSitemapIndividualConfig;
1650
+ section?: DefaultSitemapIndividualConfig;
1651
+ faq?: DefaultSitemapIndividualConfig;
1652
+ sitemap?: DefaultSitemapIndividualConfig;
1653
+ };
1654
+ /** @returns {SitemapConfigCreate} */
1655
+ declare function SitemapConfigCreate(): SitemapConfigCreate;
1656
+ type SitemapConfigCreate = {
1657
+ /**
1658
+ * - Unique identifier for the sitemap configuration
1659
+ */
1660
+ name?: string;
1661
+ /**
1662
+ * - Indicates if the sitemap configuration is active
1663
+ */
1664
+ is_active?: boolean;
1665
+ /**
1666
+ * - XML string containing sitemap data in base64 encoding
1667
+ */
1668
+ sitemap?: string;
1669
+ };
1670
+ /** @returns {SitemapConfig} */
1671
+ declare function SitemapConfig(): SitemapConfig;
1672
+ type SitemapConfig = {
1673
+ /**
1674
+ * - Unique identifier for the sitemap configuration
1675
+ */
1676
+ name?: string;
1677
+ /**
1678
+ * - Indicates if the sitemap configuration is
1679
+ * active or not in storefront
1680
+ */
1681
+ is_active?: boolean;
1682
+ /**
1683
+ * - XML string containing sitemap data in base64 encoding
1684
+ */
1685
+ sitemap?: string;
1686
+ /**
1687
+ * - Timestamp when the configuration was created
1688
+ */
1689
+ created_at?: string;
1690
+ /**
1691
+ * - Timestamp when the configuration was last updated
1692
+ */
1693
+ updated_at?: string;
1694
+ };
1695
+ /** @returns {SitemapConfigurationList} */
1696
+ declare function SitemapConfigurationList(): SitemapConfigurationList;
1697
+ type SitemapConfigurationList = {
1698
+ /**
1699
+ * - List of all Sitemap configurations
1700
+ */
1701
+ items?: SitemapConfig[];
1702
+ page?: Page;
1703
+ };
1704
+ /** @returns {SitemapConfigUpdate} */
1705
+ declare function SitemapConfigUpdate(): SitemapConfigUpdate;
1706
+ type SitemapConfigUpdate = {
1707
+ /**
1708
+ * - Indicates if the sitemap configuration is active
1709
+ */
1710
+ is_active?: boolean;
1711
+ /**
1712
+ * - XML string containing sitemap data
1713
+ */
1714
+ sitemap?: string;
1715
+ };
1548
1716
  /** @returns {BlogPayload} */
1549
1717
  declare function BlogPayload(): BlogPayload;
1550
1718
  type BlogPayload = {
@@ -1637,6 +1805,24 @@ type CronBasedScheduleSchema = {
1637
1805
  start?: string;
1638
1806
  end?: string;
1639
1807
  };
1808
+ /** @returns {ConfigurationSchema} */
1809
+ declare function ConfigurationSchema(): ConfigurationSchema;
1810
+ type ConfigurationSchema = {
1811
+ sleep_time?: number;
1812
+ start_on_launch?: boolean;
1813
+ duration?: number;
1814
+ slide_direction?: string;
1815
+ };
1816
+ /** @returns {SlideshowMedia} */
1817
+ declare function SlideshowMedia(): SlideshowMedia;
1818
+ type SlideshowMedia = {
1819
+ type?: string;
1820
+ url?: string;
1821
+ bg_color?: string;
1822
+ duration?: number;
1823
+ auto_decide_duration?: boolean;
1824
+ action?: Action;
1825
+ };
1640
1826
  /** @returns {UpdateHandpickedSchema} */
1641
1827
  declare function UpdateHandpickedSchema(): UpdateHandpickedSchema;
1642
1828
  type UpdateHandpickedSchema = {
@@ -2008,6 +2194,35 @@ type PageMetaSchema = {
2008
2194
  custom_pages?: PageSchema[];
2009
2195
  application_id?: string;
2010
2196
  };
2197
+ /** @returns {SlideshowGetDetails} */
2198
+ declare function SlideshowGetDetails(): SlideshowGetDetails;
2199
+ type SlideshowGetDetails = {
2200
+ items?: SlideshowSchema[];
2201
+ page?: Page;
2202
+ };
2203
+ /** @returns {SlideshowSchema} */
2204
+ declare function SlideshowSchema(): SlideshowSchema;
2205
+ type SlideshowSchema = {
2206
+ _id?: string;
2207
+ slug?: string;
2208
+ date_meta?: DateMeta;
2209
+ application?: string;
2210
+ platform?: string;
2211
+ configuration?: ConfigurationSchema;
2212
+ media?: SlideshowMedia[];
2213
+ active?: boolean;
2214
+ archived?: boolean;
2215
+ _custom_json?: any;
2216
+ };
2217
+ /** @returns {SlideshowPayload} */
2218
+ declare function SlideshowPayload(): SlideshowPayload;
2219
+ type SlideshowPayload = {
2220
+ slug?: string;
2221
+ platform?: string;
2222
+ configuration?: ConfigurationSchema;
2223
+ media?: SlideshowMedia;
2224
+ active?: boolean;
2225
+ };
2011
2226
  /** @returns {Support} */
2012
2227
  declare function Support(): Support;
2013
2228
  type Support = {
@@ -66,8 +66,6 @@ const Joi = require("joi");
66
66
  * @property {string} [app]
67
67
  * @property {string} [_id]
68
68
  * @property {string} [robots_txt]
69
- * @property {boolean} [sitemap_enabled]
70
- * @property {string} [additional_sitemap]
71
69
  * @property {boolean} [cannonical_enabled]
72
70
  * @property {CustomMetaTag[]} [custom_meta_tags]
73
71
  * @property {Detail} [details]
@@ -281,6 +279,56 @@ const Joi = require("joi");
281
279
  * @property {string} [modified_on]
282
280
  */
283
281
 
282
+ /**
283
+ * @typedef DefaultSitemapIndividualConfig
284
+ * @property {boolean} [enabled] - Whether sitemap configuration is enabled or
285
+ * not for this sitemap configuration
286
+ */
287
+
288
+ /**
289
+ * @typedef DefaultSitemapConfig
290
+ * @property {DefaultSitemapIndividualConfig} [root]
291
+ * @property {DefaultSitemapIndividualConfig} [brand]
292
+ * @property {DefaultSitemapIndividualConfig} [collections]
293
+ * @property {DefaultSitemapIndividualConfig} [category_l1]
294
+ * @property {DefaultSitemapIndividualConfig} [category_l2]
295
+ * @property {DefaultSitemapIndividualConfig} [category_l3]
296
+ * @property {DefaultSitemapIndividualConfig} [pages]
297
+ * @property {DefaultSitemapIndividualConfig} [blog]
298
+ * @property {DefaultSitemapIndividualConfig} [section]
299
+ * @property {DefaultSitemapIndividualConfig} [faq]
300
+ * @property {DefaultSitemapIndividualConfig} [sitemap]
301
+ */
302
+
303
+ /**
304
+ * @typedef SitemapConfigCreate
305
+ * @property {string} [name] - Unique identifier for the sitemap configuration
306
+ * @property {boolean} [is_active] - Indicates if the sitemap configuration is active
307
+ * @property {string} [sitemap] - XML string containing sitemap data in base64 encoding
308
+ */
309
+
310
+ /**
311
+ * @typedef SitemapConfig
312
+ * @property {string} [name] - Unique identifier for the sitemap configuration
313
+ * @property {boolean} [is_active] - Indicates if the sitemap configuration is
314
+ * active or not in storefront
315
+ * @property {string} [sitemap] - XML string containing sitemap data in base64 encoding
316
+ * @property {string} [created_at] - Timestamp when the configuration was created
317
+ * @property {string} [updated_at] - Timestamp when the configuration was last updated
318
+ */
319
+
320
+ /**
321
+ * @typedef SitemapConfigurationList
322
+ * @property {SitemapConfig[]} [items] - List of all Sitemap configurations
323
+ * @property {Page} [page]
324
+ */
325
+
326
+ /**
327
+ * @typedef SitemapConfigUpdate
328
+ * @property {boolean} [is_active] - Indicates if the sitemap configuration is active
329
+ * @property {string} [sitemap] - XML string containing sitemap data
330
+ */
331
+
284
332
  /**
285
333
  * @typedef BlogPayload
286
334
  * @property {string} [application]
@@ -370,6 +418,24 @@ const Joi = require("joi");
370
418
  * @property {string} [end]
371
419
  */
372
420
 
421
+ /**
422
+ * @typedef ConfigurationSchema
423
+ * @property {number} [sleep_time]
424
+ * @property {boolean} [start_on_launch]
425
+ * @property {number} [duration]
426
+ * @property {string} [slide_direction]
427
+ */
428
+
429
+ /**
430
+ * @typedef SlideshowMedia
431
+ * @property {string} [type]
432
+ * @property {string} [url]
433
+ * @property {string} [bg_color]
434
+ * @property {number} [duration]
435
+ * @property {boolean} [auto_decide_duration]
436
+ * @property {Action} [action]
437
+ */
438
+
373
439
  /**
374
440
  * @typedef UpdateHandpickedSchema
375
441
  * @property {HandpickedTagSchema} [tag]
@@ -717,6 +783,35 @@ const Joi = require("joi");
717
783
  * @property {string} [application_id]
718
784
  */
719
785
 
786
+ /**
787
+ * @typedef SlideshowGetDetails
788
+ * @property {SlideshowSchema[]} [items]
789
+ * @property {Page} [page]
790
+ */
791
+
792
+ /**
793
+ * @typedef SlideshowSchema
794
+ * @property {string} [_id]
795
+ * @property {string} [slug]
796
+ * @property {DateMeta} [date_meta]
797
+ * @property {string} [application]
798
+ * @property {string} [platform]
799
+ * @property {ConfigurationSchema} [configuration]
800
+ * @property {SlideshowMedia[]} [media]
801
+ * @property {boolean} [active]
802
+ * @property {boolean} [archived]
803
+ * @property {Object} [_custom_json]
804
+ */
805
+
806
+ /**
807
+ * @typedef SlideshowPayload
808
+ * @property {string} [slug]
809
+ * @property {string} [platform]
810
+ * @property {ConfigurationSchema} [configuration]
811
+ * @property {SlideshowMedia} [media]
812
+ * @property {boolean} [active]
813
+ */
814
+
720
815
  /**
721
816
  * @typedef Support
722
817
  * @property {boolean} [created]
@@ -1498,8 +1593,6 @@ class ContentPlatformModel {
1498
1593
  app: Joi.string().allow(""),
1499
1594
  _id: Joi.string().allow(""),
1500
1595
  robots_txt: Joi.string().allow(""),
1501
- sitemap_enabled: Joi.boolean(),
1502
- additional_sitemap: Joi.string().allow(""),
1503
1596
  cannonical_enabled: Joi.boolean(),
1504
1597
  custom_meta_tags: Joi.array().items(ContentPlatformModel.CustomMetaTag()),
1505
1598
  details: ContentPlatformModel.Detail(),
@@ -1768,6 +1861,66 @@ class ContentPlatformModel {
1768
1861
  });
1769
1862
  }
1770
1863
 
1864
+ /** @returns {DefaultSitemapIndividualConfig} */
1865
+ static DefaultSitemapIndividualConfig() {
1866
+ return Joi.object({
1867
+ enabled: Joi.boolean(),
1868
+ });
1869
+ }
1870
+
1871
+ /** @returns {DefaultSitemapConfig} */
1872
+ static DefaultSitemapConfig() {
1873
+ return Joi.object({
1874
+ root: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1875
+ brand: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1876
+ collections: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1877
+ category_l1: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1878
+ category_l2: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1879
+ category_l3: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1880
+ pages: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1881
+ blog: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1882
+ section: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1883
+ faq: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1884
+ sitemap: ContentPlatformModel.DefaultSitemapIndividualConfig(),
1885
+ });
1886
+ }
1887
+
1888
+ /** @returns {SitemapConfigCreate} */
1889
+ static SitemapConfigCreate() {
1890
+ return Joi.object({
1891
+ name: Joi.string().allow(""),
1892
+ is_active: Joi.boolean(),
1893
+ sitemap: Joi.string().allow(""),
1894
+ });
1895
+ }
1896
+
1897
+ /** @returns {SitemapConfig} */
1898
+ static SitemapConfig() {
1899
+ return Joi.object({
1900
+ name: Joi.string().allow(""),
1901
+ is_active: Joi.boolean(),
1902
+ sitemap: Joi.string().allow(""),
1903
+ created_at: Joi.string().allow(""),
1904
+ updated_at: Joi.string().allow(""),
1905
+ });
1906
+ }
1907
+
1908
+ /** @returns {SitemapConfigurationList} */
1909
+ static SitemapConfigurationList() {
1910
+ return Joi.object({
1911
+ items: Joi.array().items(ContentPlatformModel.SitemapConfig()),
1912
+ page: ContentPlatformModel.Page(),
1913
+ });
1914
+ }
1915
+
1916
+ /** @returns {SitemapConfigUpdate} */
1917
+ static SitemapConfigUpdate() {
1918
+ return Joi.object({
1919
+ is_active: Joi.boolean(),
1920
+ sitemap: Joi.string().allow(""),
1921
+ });
1922
+ }
1923
+
1771
1924
  /** @returns {BlogPayload} */
1772
1925
  static BlogPayload() {
1773
1926
  return Joi.object({
@@ -1877,6 +2030,28 @@ class ContentPlatformModel {
1877
2030
  });
1878
2031
  }
1879
2032
 
2033
+ /** @returns {ConfigurationSchema} */
2034
+ static ConfigurationSchema() {
2035
+ return Joi.object({
2036
+ sleep_time: Joi.number(),
2037
+ start_on_launch: Joi.boolean(),
2038
+ duration: Joi.number(),
2039
+ slide_direction: Joi.string().allow(""),
2040
+ });
2041
+ }
2042
+
2043
+ /** @returns {SlideshowMedia} */
2044
+ static SlideshowMedia() {
2045
+ return Joi.object({
2046
+ type: Joi.string().allow(""),
2047
+ url: Joi.string().allow(""),
2048
+ bg_color: Joi.string().allow(""),
2049
+ duration: Joi.number(),
2050
+ auto_decide_duration: Joi.boolean(),
2051
+ action: ContentPlatformModel.Action(),
2052
+ });
2053
+ }
2054
+
1880
2055
  /** @returns {UpdateHandpickedSchema} */
1881
2056
  static UpdateHandpickedSchema() {
1882
2057
  return Joi.object({
@@ -2309,6 +2484,41 @@ class ContentPlatformModel {
2309
2484
  });
2310
2485
  }
2311
2486
 
2487
+ /** @returns {SlideshowGetDetails} */
2488
+ static SlideshowGetDetails() {
2489
+ return Joi.object({
2490
+ items: Joi.array().items(ContentPlatformModel.SlideshowSchema()),
2491
+ page: ContentPlatformModel.Page(),
2492
+ });
2493
+ }
2494
+
2495
+ /** @returns {SlideshowSchema} */
2496
+ static SlideshowSchema() {
2497
+ return Joi.object({
2498
+ _id: Joi.string().allow(""),
2499
+ slug: Joi.string().allow(""),
2500
+ date_meta: ContentPlatformModel.DateMeta(),
2501
+ application: Joi.string().allow(""),
2502
+ platform: Joi.string().allow(""),
2503
+ configuration: ContentPlatformModel.ConfigurationSchema(),
2504
+ media: Joi.array().items(ContentPlatformModel.SlideshowMedia()),
2505
+ active: Joi.boolean(),
2506
+ archived: Joi.boolean(),
2507
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
2508
+ });
2509
+ }
2510
+
2511
+ /** @returns {SlideshowPayload} */
2512
+ static SlideshowPayload() {
2513
+ return Joi.object({
2514
+ slug: Joi.string().allow(""),
2515
+ platform: Joi.string().allow(""),
2516
+ configuration: ContentPlatformModel.ConfigurationSchema(),
2517
+ media: ContentPlatformModel.SlideshowMedia(),
2518
+ active: Joi.boolean(),
2519
+ });
2520
+ }
2521
+
2312
2522
  /** @returns {Support} */
2313
2523
  static Support() {
2314
2524
  return Joi.object({
@@ -3,16 +3,6 @@ declare class Order {
3
3
  constructor(config: any, applicationId: any);
4
4
  config: any;
5
5
  applicationId: any;
6
- /**
7
- * @param {OrderPlatformApplicationValidator.FailedOrderLogsParam} arg - Arg object
8
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
9
- * @param {import("../PlatformAPIClient").Options} - Options
10
- * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
11
- * @name failedOrderLogs
12
- * @summary: List failed order logs
13
- * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
14
- */
15
- failedOrderLogs({ pageNo, pageSize, searchType, searchValue, requestHeaders }?: OrderPlatformApplicationValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
16
6
  /**
17
7
  * @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
18
8
  * - Arg object
@@ -15,98 +15,6 @@ class Order {
15
15
  this.applicationId = applicationId;
16
16
  }
17
17
 
18
- /**
19
- * @param {OrderPlatformApplicationValidator.FailedOrderLogsParam} arg - Arg object
20
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
21
- * @param {import("../PlatformAPIClient").Options} - Options
22
- * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
23
- * @name failedOrderLogs
24
- * @summary: List failed order logs
25
- * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
26
- */
27
- async failedOrderLogs(
28
- { pageNo, pageSize, searchType, searchValue, requestHeaders } = {
29
- requestHeaders: {},
30
- },
31
- { responseHeaders } = { responseHeaders: false }
32
- ) {
33
- const {
34
- error,
35
- } = OrderPlatformApplicationValidator.failedOrderLogs().validate(
36
- {
37
- pageNo,
38
- pageSize,
39
- searchType,
40
- searchValue,
41
- },
42
- { abortEarly: false, allowUnknown: true }
43
- );
44
- if (error) {
45
- return Promise.reject(new FDKClientValidationError(error));
46
- }
47
-
48
- // Showing warrnings if extra unknown parameters are found
49
- const {
50
- error: warrning,
51
- } = OrderPlatformApplicationValidator.failedOrderLogs().validate(
52
- {
53
- pageNo,
54
- pageSize,
55
- searchType,
56
- searchValue,
57
- },
58
- { abortEarly: false, allowUnknown: false }
59
- );
60
- if (warrning) {
61
- Logger({
62
- level: "WARN",
63
- message: `Parameter Validation warrnings for platform > Order > failedOrderLogs \n ${warrning}`,
64
- });
65
- }
66
-
67
- const query_params = {};
68
- query_params["application_id"] = applicationId;
69
- query_params["page_no"] = pageNo;
70
- query_params["page_size"] = pageSize;
71
- query_params["search_type"] = searchType;
72
- query_params["search_value"] = searchValue;
73
-
74
- const response = await PlatformAPIClient.execute(
75
- this.config,
76
- "get",
77
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/orders/failed`,
78
- query_params,
79
- undefined,
80
- requestHeaders,
81
- { responseHeaders }
82
- );
83
-
84
- let responseData = response;
85
- if (responseHeaders) {
86
- responseData = response[0];
87
- }
88
-
89
- const {
90
- error: res_error,
91
- } = OrderPlatformModel.FailedOrderLogs().validate(responseData, {
92
- abortEarly: false,
93
- allowUnknown: true,
94
- });
95
-
96
- if (res_error) {
97
- if (this.config.options.strictResponseCheck === true) {
98
- return Promise.reject(new FDKResponseValidationError(res_error));
99
- } else {
100
- Logger({
101
- level: "WARN",
102
- message: `Response Validation Warnings for platform > Order > failedOrderLogs \n ${res_error}`,
103
- });
104
- }
105
- }
106
-
107
- return response;
108
- }
109
-
110
18
  /**
111
19
  * @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
112
20
  * - Arg object