@gofynd/fdk-client-javascript 1.4.16-beta.1 → 1.4.16-beta.3
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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +6 -6
- package/sdk/application/Cart/CartApplicationClient.js +30 -269
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -16
- package/sdk/application/Catalog/CatalogApplicationClient.js +90 -339
- package/sdk/application/Common/CommonApplicationClient.js +1 -16
- package/sdk/application/Communication/CommunicationApplicationClient.js +1 -24
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +11 -134
- package/sdk/application/Content/ContentApplicationClient.d.ts +40 -8
- package/sdk/application/Content/ContentApplicationClient.js +174 -211
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.js +1 -16
- package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
- package/sdk/application/Lead/LeadApplicationClient.js +21 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.js +40 -153
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
- package/sdk/application/Order/OrderApplicationClient.js +68 -153
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -1
- package/sdk/application/Payment/PaymentApplicationClient.js +6 -437
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -59
- package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationClient.js +21 -75
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +19 -47
- package/sdk/application/User/UserApplicationClient.js +1 -407
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -8
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +4 -4
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +35 -0
- package/sdk/platform/Cart/CartPlatformModel.js +16 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +4 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +80 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +571 -0
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +75 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +88 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +131 -5
- package/sdk/platform/Content/ContentPlatformModel.js +110 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformClient.js +99 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +0 -118
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -53
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +0 -29
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +10 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +119 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +58 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -0
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +10 -2
- package/sdk/platform/Share/SharePlatformModel.js +4 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -16
- package/sdk/public/Content/ContentPublicClient.d.ts +3 -3
- package/sdk/public/Content/ContentPublicClient.js +16 -104
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +1 -40
|
@@ -62,6 +62,10 @@ export = ContentPlatformApplicationValidator;
|
|
|
62
62
|
* @typedef CreateSEOMarkupSchemaParam
|
|
63
63
|
* @property {ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody} body
|
|
64
64
|
*/
|
|
65
|
+
/**
|
|
66
|
+
* @typedef CreateSitemapParam
|
|
67
|
+
* @property {ContentPlatformModel.SitemapConfigCreate} body
|
|
68
|
+
*/
|
|
65
69
|
/**
|
|
66
70
|
* @typedef CreateSlideshowParam
|
|
67
71
|
* @property {ContentPlatformModel.SlideshowPayload} body
|
|
@@ -123,6 +127,10 @@ export = ContentPlatformApplicationValidator;
|
|
|
123
127
|
* @property {string} id - Alphanumeric ID allotted to a SEO Markup Schema
|
|
124
128
|
* Template created within a business.
|
|
125
129
|
*/
|
|
130
|
+
/**
|
|
131
|
+
* @typedef DeleteSitemapParam
|
|
132
|
+
* @property {string} name
|
|
133
|
+
*/
|
|
126
134
|
/**
|
|
127
135
|
* @typedef DeleteSlideshowParam
|
|
128
136
|
* @property {string} id - ID allotted to the slideshow.
|
|
@@ -253,6 +261,7 @@ export = ContentPlatformApplicationValidator;
|
|
|
253
261
|
* @property {string} [pageType] - The type of page against which schema
|
|
254
262
|
* template was created
|
|
255
263
|
*/
|
|
264
|
+
/** @typedef GetDefaultSitemapConfigParam */
|
|
256
265
|
/**
|
|
257
266
|
* @typedef GetFaqByIdOrSlugParam
|
|
258
267
|
* @property {string} idOrSlug - ID or the slug allotted to an FAQ category.
|
|
@@ -340,6 +349,18 @@ export = ContentPlatformApplicationValidator;
|
|
|
340
349
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
341
350
|
* Default value is 10.
|
|
342
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
|
+
*/
|
|
343
364
|
/**
|
|
344
365
|
* @typedef GetSlideshowBySlugParam
|
|
345
366
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
@@ -418,6 +439,10 @@ export = ContentPlatformApplicationValidator;
|
|
|
418
439
|
* @property {string} id - ID allotted to the blog.
|
|
419
440
|
* @property {ContentPlatformModel.BlogPayload} body
|
|
420
441
|
*/
|
|
442
|
+
/**
|
|
443
|
+
* @typedef UpdateDefaultSitemapConfigParam
|
|
444
|
+
* @property {ContentPlatformModel.DefaultSitemapConfig} body
|
|
445
|
+
*/
|
|
421
446
|
/**
|
|
422
447
|
* @typedef UpdateFaqParam
|
|
423
448
|
* @property {string} categoryId - ID allotted to an FAQ category.
|
|
@@ -467,6 +492,11 @@ export = ContentPlatformApplicationValidator;
|
|
|
467
492
|
* @typedef UpdateSEOConfigurationParam
|
|
468
493
|
* @property {ContentPlatformModel.SeoComponent} body
|
|
469
494
|
*/
|
|
495
|
+
/**
|
|
496
|
+
* @typedef UpdateSitemapParam
|
|
497
|
+
* @property {string} name
|
|
498
|
+
* @property {ContentPlatformModel.SitemapConfigUpdate} body
|
|
499
|
+
*/
|
|
470
500
|
/**
|
|
471
501
|
* @typedef UpdateSlideshowParam
|
|
472
502
|
* @property {string} id - ID allotted to the slideshow.
|
|
@@ -507,6 +537,8 @@ declare class ContentPlatformApplicationValidator {
|
|
|
507
537
|
static createPagePreview(): CreatePagePreviewParam;
|
|
508
538
|
/** @returns {CreateSEOMarkupSchemaParam} */
|
|
509
539
|
static createSEOMarkupSchema(): CreateSEOMarkupSchemaParam;
|
|
540
|
+
/** @returns {CreateSitemapParam} */
|
|
541
|
+
static createSitemap(): CreateSitemapParam;
|
|
510
542
|
/** @returns {CreateSlideshowParam} */
|
|
511
543
|
static createSlideshow(): CreateSlideshowParam;
|
|
512
544
|
/** @returns {DeleteAnnouncementParam} */
|
|
@@ -535,6 +567,8 @@ declare class ContentPlatformApplicationValidator {
|
|
|
535
567
|
static deletePathRedirectionRules(): DeletePathRedirectionRulesParam;
|
|
536
568
|
/** @returns {DeleteSEOMarkupSchemaParam} */
|
|
537
569
|
static deleteSEOMarkupSchema(): DeleteSEOMarkupSchemaParam;
|
|
570
|
+
/** @returns {DeleteSitemapParam} */
|
|
571
|
+
static deleteSitemap(): DeleteSitemapParam;
|
|
538
572
|
/** @returns {DeleteSlideshowParam} */
|
|
539
573
|
static deleteSlideshow(): DeleteSlideshowParam;
|
|
540
574
|
/** @returns {EditDataLoaderParam} */
|
|
@@ -585,6 +619,8 @@ declare class ContentPlatformApplicationValidator {
|
|
|
585
619
|
static getDefaultNavigations(): any;
|
|
586
620
|
/** @returns {GetDefaultSEOMarkupSchemaParam} */
|
|
587
621
|
static getDefaultSEOMarkupSchema(): GetDefaultSEOMarkupSchemaParam;
|
|
622
|
+
/** @returns {GetDefaultSitemapConfigParam} */
|
|
623
|
+
static getDefaultSitemapConfig(): any;
|
|
588
624
|
/** @returns {GetFaqByIdOrSlugParam} */
|
|
589
625
|
static getFaqByIdOrSlug(): GetFaqByIdOrSlugParam;
|
|
590
626
|
/** @returns {GetFaqCategoriesParam} */
|
|
@@ -621,6 +657,10 @@ declare class ContentPlatformApplicationValidator {
|
|
|
621
657
|
static getSEOMarkupSchema(): GetSEOMarkupSchemaParam;
|
|
622
658
|
/** @returns {GetSEOMarkupSchemasParam} */
|
|
623
659
|
static getSEOMarkupSchemas(): GetSEOMarkupSchemasParam;
|
|
660
|
+
/** @returns {GetSitemapParam} */
|
|
661
|
+
static getSitemap(): GetSitemapParam;
|
|
662
|
+
/** @returns {GetSitemapsParam} */
|
|
663
|
+
static getSitemaps(): GetSitemapsParam;
|
|
624
664
|
/** @returns {GetSlideshowBySlugParam} */
|
|
625
665
|
static getSlideshowBySlug(): GetSlideshowBySlugParam;
|
|
626
666
|
/** @returns {GetSlideshowsParam} */
|
|
@@ -651,6 +691,8 @@ declare class ContentPlatformApplicationValidator {
|
|
|
651
691
|
static updateAppCustomObjectDefinitionBySlug(): UpdateAppCustomObjectDefinitionBySlugParam;
|
|
652
692
|
/** @returns {UpdateBlogParam} */
|
|
653
693
|
static updateBlog(): UpdateBlogParam;
|
|
694
|
+
/** @returns {UpdateDefaultSitemapConfigParam} */
|
|
695
|
+
static updateDefaultSitemapConfig(): UpdateDefaultSitemapConfigParam;
|
|
654
696
|
/** @returns {UpdateFaqParam} */
|
|
655
697
|
static updateFaq(): UpdateFaqParam;
|
|
656
698
|
/** @returns {UpdateFaqCategoryParam} */
|
|
@@ -671,13 +713,15 @@ declare class ContentPlatformApplicationValidator {
|
|
|
671
713
|
static updatePathRedirectionRules(): UpdatePathRedirectionRulesParam;
|
|
672
714
|
/** @returns {UpdateSEOConfigurationParam} */
|
|
673
715
|
static updateSEOConfiguration(): UpdateSEOConfigurationParam;
|
|
716
|
+
/** @returns {UpdateSitemapParam} */
|
|
717
|
+
static updateSitemap(): UpdateSitemapParam;
|
|
674
718
|
/** @returns {UpdateSlideshowParam} */
|
|
675
719
|
static updateSlideshow(): UpdateSlideshowParam;
|
|
676
720
|
/** @returns {UpdateSupportInformationParam} */
|
|
677
721
|
static updateSupportInformation(): UpdateSupportInformationParam;
|
|
678
722
|
}
|
|
679
723
|
declare namespace ContentPlatformApplicationValidator {
|
|
680
|
-
export { AddDataLoaderParam, AddFaqParam, AddInjectableTagParam, AddPathRedirectionRulesParam, CreateAnnouncementParam, CreateAppCustomFieldDefinitionParam, CreateAppCustomObjectBySlugParam, CreateAppCustomObjectDefinitionParam, CreateBlogParam, CreateFaqCategoryParam, CreateLandingPageParam, CreateNavigationParam, CreatePageParam, CreatePagePreviewParam, CreateSEOMarkupSchemaParam, CreateSlideshowParam, DeleteAnnouncementParam, DeleteAppCustomFieldDefinitionBySlugParam, DeleteAppCustomObjectBySlugParam, DeleteAppCustomObjectDefinitionBySlugParam, DeleteBlogParam, DeleteDataLoaderParam, DeleteFaqParam, DeleteFaqCategoryParam, DeleteLandingPageParam, DeleteNavigationParam, DeletePageParam, DeletePathRedirectionRulesParam, DeleteSEOMarkupSchemaParam, 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, GetFaqByIdOrSlugParam, GetFaqCategoriesParam, GetFaqCategoryBySlugOrIdParam, GetFaqsByCategoryIdOrSlugParam, GetInjectableTagsParam, GetLandingPagesParam, GetLegalInformationParam, GetNavigationBySlugParam, GetNavigationsParam, GetPageBySlugParam, GetPageMetaParam, GetPageSpecParam, GetPagesParam, GetPathRedirectionRuleParam, GetPathRedirectionRulesParam, GetSEOConfigurationParam, GetSEOMarkupSchemaParam, GetSEOMarkupSchemasParam, GetSlideshowBySlugParam, GetSlideshowsParam, GetSupportInformationParam, ImportAppCustomObjectEntriesBySlugParam, RemoveInjectableTagParam, ResetDataLoaderParam, SampleAppCustomObjectBulkEntryBySlugParam, SelectDataLoaderParam, UpdateAnnouncementParam, UpdateAnnouncementScheduleParam, UpdateAppCustomFieldByResourceSlugParam, UpdateAppCustomFieldDefinitionBySlugParam, UpdateAppCustomObjectBySlugParam, UpdateAppCustomObjectDefinitionBySlugParam, UpdateBlogParam, UpdateFaqParam, UpdateFaqCategoryParam, UpdateInjectableTagParam, UpdateLandingPageParam, UpdateLegalInformationParam, UpdateNavigationParam, UpdatePageParam, UpdatePagePreviewParam, UpdatePathRedirectionRulesParam, UpdateSEOConfigurationParam, UpdateSlideshowParam, 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 };
|
|
681
725
|
}
|
|
682
726
|
type AddDataLoaderParam = {
|
|
683
727
|
body: ContentPlatformModel.DataLoaderSchema;
|
|
@@ -730,6 +774,9 @@ type CreatePagePreviewParam = {
|
|
|
730
774
|
type CreateSEOMarkupSchemaParam = {
|
|
731
775
|
body: ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody;
|
|
732
776
|
};
|
|
777
|
+
type CreateSitemapParam = {
|
|
778
|
+
body: ContentPlatformModel.SitemapConfigCreate;
|
|
779
|
+
};
|
|
733
780
|
type CreateSlideshowParam = {
|
|
734
781
|
body: ContentPlatformModel.SlideshowPayload;
|
|
735
782
|
};
|
|
@@ -810,6 +857,9 @@ type DeleteSEOMarkupSchemaParam = {
|
|
|
810
857
|
*/
|
|
811
858
|
id: string;
|
|
812
859
|
};
|
|
860
|
+
type DeleteSitemapParam = {
|
|
861
|
+
name: string;
|
|
862
|
+
};
|
|
813
863
|
type DeleteSlideshowParam = {
|
|
814
864
|
/**
|
|
815
865
|
* - ID allotted to the slideshow.
|
|
@@ -1104,6 +1154,22 @@ type GetSEOMarkupSchemasParam = {
|
|
|
1104
1154
|
*/
|
|
1105
1155
|
pageSize?: number;
|
|
1106
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
|
+
};
|
|
1107
1173
|
type GetSlideshowBySlugParam = {
|
|
1108
1174
|
/**
|
|
1109
1175
|
* - A short, human-readable, URL-friendly identifier of
|
|
@@ -1200,6 +1266,9 @@ type UpdateBlogParam = {
|
|
|
1200
1266
|
id: string;
|
|
1201
1267
|
body: ContentPlatformModel.BlogPayload;
|
|
1202
1268
|
};
|
|
1269
|
+
type UpdateDefaultSitemapConfigParam = {
|
|
1270
|
+
body: ContentPlatformModel.DefaultSitemapConfig;
|
|
1271
|
+
};
|
|
1203
1272
|
type UpdateFaqParam = {
|
|
1204
1273
|
/**
|
|
1205
1274
|
* - ID allotted to an FAQ category.
|
|
@@ -1263,6 +1332,10 @@ type UpdatePathRedirectionRulesParam = {
|
|
|
1263
1332
|
type UpdateSEOConfigurationParam = {
|
|
1264
1333
|
body: ContentPlatformModel.SeoComponent;
|
|
1265
1334
|
};
|
|
1335
|
+
type UpdateSitemapParam = {
|
|
1336
|
+
name: string;
|
|
1337
|
+
body: ContentPlatformModel.SitemapConfigUpdate;
|
|
1338
|
+
};
|
|
1266
1339
|
type UpdateSlideshowParam = {
|
|
1267
1340
|
/**
|
|
1268
1341
|
* - ID allotted to the slideshow.
|
|
@@ -1277,6 +1350,7 @@ type GetAppCustomFieldTypesParam = any;
|
|
|
1277
1350
|
type GetAppResourcesParam = any;
|
|
1278
1351
|
type GetDataLoadersParam = any;
|
|
1279
1352
|
type GetDefaultNavigationsParam = any;
|
|
1353
|
+
type GetDefaultSitemapConfigParam = any;
|
|
1280
1354
|
type GetFaqCategoriesParam = any;
|
|
1281
1355
|
type GetLegalInformationParam = any;
|
|
1282
1356
|
type GetPageMetaParam = any;
|
|
@@ -80,6 +80,11 @@ 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
|
+
|
|
83
88
|
/**
|
|
84
89
|
* @typedef CreateSlideshowParam
|
|
85
90
|
* @property {ContentPlatformModel.SlideshowPayload} body
|
|
@@ -155,6 +160,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
155
160
|
* Template created within a business.
|
|
156
161
|
*/
|
|
157
162
|
|
|
163
|
+
/**
|
|
164
|
+
* @typedef DeleteSitemapParam
|
|
165
|
+
* @property {string} name
|
|
166
|
+
*/
|
|
167
|
+
|
|
158
168
|
/**
|
|
159
169
|
* @typedef DeleteSlideshowParam
|
|
160
170
|
* @property {string} id - ID allotted to the slideshow.
|
|
@@ -310,6 +320,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
310
320
|
* template was created
|
|
311
321
|
*/
|
|
312
322
|
|
|
323
|
+
/** @typedef GetDefaultSitemapConfigParam */
|
|
324
|
+
|
|
313
325
|
/**
|
|
314
326
|
* @typedef GetFaqByIdOrSlugParam
|
|
315
327
|
* @property {string} idOrSlug - ID or the slug allotted to an FAQ category.
|
|
@@ -415,6 +427,20 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
415
427
|
* Default value is 10.
|
|
416
428
|
*/
|
|
417
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
|
+
|
|
418
444
|
/**
|
|
419
445
|
* @typedef GetSlideshowBySlugParam
|
|
420
446
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
@@ -508,6 +534,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
508
534
|
* @property {ContentPlatformModel.BlogPayload} body
|
|
509
535
|
*/
|
|
510
536
|
|
|
537
|
+
/**
|
|
538
|
+
* @typedef UpdateDefaultSitemapConfigParam
|
|
539
|
+
* @property {ContentPlatformModel.DefaultSitemapConfig} body
|
|
540
|
+
*/
|
|
541
|
+
|
|
511
542
|
/**
|
|
512
543
|
* @typedef UpdateFaqParam
|
|
513
544
|
* @property {string} categoryId - ID allotted to an FAQ category.
|
|
@@ -567,6 +598,12 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
567
598
|
* @property {ContentPlatformModel.SeoComponent} body
|
|
568
599
|
*/
|
|
569
600
|
|
|
601
|
+
/**
|
|
602
|
+
* @typedef UpdateSitemapParam
|
|
603
|
+
* @property {string} name
|
|
604
|
+
* @property {ContentPlatformModel.SitemapConfigUpdate} body
|
|
605
|
+
*/
|
|
606
|
+
|
|
570
607
|
/**
|
|
571
608
|
* @typedef UpdateSlideshowParam
|
|
572
609
|
* @property {string} id - ID allotted to the slideshow.
|
|
@@ -687,6 +724,13 @@ class ContentPlatformApplicationValidator {
|
|
|
687
724
|
}).required();
|
|
688
725
|
}
|
|
689
726
|
|
|
727
|
+
/** @returns {CreateSitemapParam} */
|
|
728
|
+
static createSitemap() {
|
|
729
|
+
return Joi.object({
|
|
730
|
+
body: ContentPlatformModel.SitemapConfigCreate().required(),
|
|
731
|
+
}).required();
|
|
732
|
+
}
|
|
733
|
+
|
|
690
734
|
/** @returns {CreateSlideshowParam} */
|
|
691
735
|
static createSlideshow() {
|
|
692
736
|
return Joi.object({
|
|
@@ -789,6 +833,13 @@ class ContentPlatformApplicationValidator {
|
|
|
789
833
|
}).required();
|
|
790
834
|
}
|
|
791
835
|
|
|
836
|
+
/** @returns {DeleteSitemapParam} */
|
|
837
|
+
static deleteSitemap() {
|
|
838
|
+
return Joi.object({
|
|
839
|
+
name: Joi.string().allow("").required(),
|
|
840
|
+
}).required();
|
|
841
|
+
}
|
|
842
|
+
|
|
792
843
|
/** @returns {DeleteSlideshowParam} */
|
|
793
844
|
static deleteSlideshow() {
|
|
794
845
|
return Joi.object({
|
|
@@ -989,6 +1040,11 @@ class ContentPlatformApplicationValidator {
|
|
|
989
1040
|
}).required();
|
|
990
1041
|
}
|
|
991
1042
|
|
|
1043
|
+
/** @returns {GetDefaultSitemapConfigParam} */
|
|
1044
|
+
static getDefaultSitemapConfig() {
|
|
1045
|
+
return Joi.object({}).required();
|
|
1046
|
+
}
|
|
1047
|
+
|
|
992
1048
|
/** @returns {GetFaqByIdOrSlugParam} */
|
|
993
1049
|
static getFaqByIdOrSlug() {
|
|
994
1050
|
return Joi.object({
|
|
@@ -1114,6 +1170,23 @@ class ContentPlatformApplicationValidator {
|
|
|
1114
1170
|
}).required();
|
|
1115
1171
|
}
|
|
1116
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
|
+
|
|
1117
1190
|
/** @returns {GetSlideshowBySlugParam} */
|
|
1118
1191
|
static getSlideshowBySlug() {
|
|
1119
1192
|
return Joi.object({
|
|
@@ -1233,6 +1306,13 @@ class ContentPlatformApplicationValidator {
|
|
|
1233
1306
|
}).required();
|
|
1234
1307
|
}
|
|
1235
1308
|
|
|
1309
|
+
/** @returns {UpdateDefaultSitemapConfigParam} */
|
|
1310
|
+
static updateDefaultSitemapConfig() {
|
|
1311
|
+
return Joi.object({
|
|
1312
|
+
body: ContentPlatformModel.DefaultSitemapConfig().required(),
|
|
1313
|
+
}).required();
|
|
1314
|
+
}
|
|
1315
|
+
|
|
1236
1316
|
/** @returns {UpdateFaqParam} */
|
|
1237
1317
|
static updateFaq() {
|
|
1238
1318
|
return Joi.object({
|
|
@@ -1311,6 +1391,14 @@ class ContentPlatformApplicationValidator {
|
|
|
1311
1391
|
}).required();
|
|
1312
1392
|
}
|
|
1313
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
|
+
|
|
1314
1402
|
/** @returns {UpdateSlideshowParam} */
|
|
1315
1403
|
static updateSlideshow() {
|
|
1316
1404
|
return Joi.object({
|
|
@@ -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]
|
|
@@ -1298,7 +1340,7 @@ export = ContentPlatformModel;
|
|
|
1298
1340
|
declare class ContentPlatformModel {
|
|
1299
1341
|
}
|
|
1300
1342
|
declare namespace ContentPlatformModel {
|
|
1301
|
-
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, 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 };
|
|
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 };
|
|
1302
1344
|
}
|
|
1303
1345
|
/** @returns {ValidationError} */
|
|
1304
1346
|
declare function ValidationError(): ValidationError;
|
|
@@ -1373,8 +1415,6 @@ type SeoSchema = {
|
|
|
1373
1415
|
app?: string;
|
|
1374
1416
|
_id?: string;
|
|
1375
1417
|
robots_txt?: string;
|
|
1376
|
-
sitemap_enabled?: boolean;
|
|
1377
|
-
additional_sitemap?: string;
|
|
1378
1418
|
cannonical_enabled?: boolean;
|
|
1379
1419
|
custom_meta_tags?: CustomMetaTag[];
|
|
1380
1420
|
details?: Detail;
|
|
@@ -1587,6 +1627,92 @@ type DateMeta = {
|
|
|
1587
1627
|
created_on?: string;
|
|
1588
1628
|
modified_on?: string;
|
|
1589
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
|
+
};
|
|
1590
1716
|
/** @returns {BlogPayload} */
|
|
1591
1717
|
declare function BlogPayload(): BlogPayload;
|
|
1592
1718
|
type BlogPayload = {
|