@gofynd/fdk-client-javascript 1.4.10 → 1.4.12-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +2 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +8 -19
- package/sdk/application/Cart/CartApplicationClient.js +8 -89
- package/sdk/application/Cart/CartApplicationModel.d.ts +1 -178
- package/sdk/application/Cart/CartApplicationModel.js +0 -92
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -20
- package/sdk/application/Cart/CartApplicationValidator.js +0 -16
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +5 -0
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +2 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +3 -2
- package/sdk/application/Content/ContentApplicationModel.js +5 -2
- package/sdk/application/Logistic/LogisticApplicationModel.js +3 -3
- package/sdk/application/Order/OrderApplicationModel.js +1 -1
- package/sdk/application/Payment/PaymentApplicationModel.js +2 -2
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +3 -2
- package/sdk/application/Theme/ThemeApplicationModel.js +5 -2
- package/sdk/common/Clickstream.js +46 -15
- package/sdk/common/Constant.d.ts +5 -0
- package/sdk/common/Constant.js +5 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -2
- package/sdk/partner/Theme/ThemePartnerModel.js +5 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +8 -20
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +8 -92
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -15
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +0 -14
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1 -87
- package/sdk/platform/Cart/CartPlatformModel.js +0 -88
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +14 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +14 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
- package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8 -242
- package/sdk/platform/Catalog/CatalogPlatformModel.js +8 -171
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +5 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +3 -2
- package/sdk/platform/Content/ContentPlatformModel.js +5 -2
- package/sdk/platform/Finance/FinancePlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformModel.d.ts +120 -39
- package/sdk/platform/Order/OrderPlatformModel.js +88 -38
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +38 -4
- package/sdk/platform/Payment/PaymentPlatformModel.js +17 -7
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -2
- package/sdk/platform/Theme/ThemePlatformModel.js +5 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
|
@@ -491,11 +491,6 @@ export = CatalogPlatformModel;
|
|
|
491
491
|
* @property {string[]} [tryouts] - It is the list of tryouts.
|
|
492
492
|
* @property {number} [uid] - It is the unique identifier of the category.
|
|
493
493
|
*/
|
|
494
|
-
/**
|
|
495
|
-
* @typedef CategoryCreateResponse
|
|
496
|
-
* @property {string} [message] - It is the message of the response from the category.
|
|
497
|
-
* @property {number} [uid] - It is the unique identifier of the category.
|
|
498
|
-
*/
|
|
499
494
|
/**
|
|
500
495
|
* @typedef CategoryItems
|
|
501
496
|
* @property {Action} [action]
|
|
@@ -525,33 +520,11 @@ export = CatalogPlatformModel;
|
|
|
525
520
|
* respective platform with Fynd Platform.
|
|
526
521
|
* @property {string} name - It is the name of the Category in the respective platform.
|
|
527
522
|
*/
|
|
528
|
-
/**
|
|
529
|
-
* @typedef CategoryRequestBody
|
|
530
|
-
* @property {number[]} departments - It is the list of unique department the
|
|
531
|
-
* category belongs to.
|
|
532
|
-
* @property {Hierarchy[]} [hierarchy] - It is the list of category hierarchies
|
|
533
|
-
* for each department of an L3 category.
|
|
534
|
-
* @property {boolean} is_active - It is the flag indicating if the category is active.
|
|
535
|
-
* @property {number} level - It is the level of category
|
|
536
|
-
* @property {CategoryMapping} [marketplaces] - It is the mapping of the
|
|
537
|
-
* category in different marketplaces.
|
|
538
|
-
* @property {Media1} [media] - It is the details of the media such as banner and logo..
|
|
539
|
-
* @property {string} name - It is the name of the category
|
|
540
|
-
* @property {number} [priority] - It is the priority of the category.
|
|
541
|
-
* @property {string} [slug] - It is the slug of the category.
|
|
542
|
-
* @property {string[]} [synonyms] - It is the list of synonyms.
|
|
543
|
-
* @property {string[]} [tryouts] - It is the list of tryouts.
|
|
544
|
-
*/
|
|
545
523
|
/**
|
|
546
524
|
* @typedef CategoryResponse
|
|
547
525
|
* @property {Category[]} [items]
|
|
548
526
|
* @property {Page} [page]
|
|
549
527
|
*/
|
|
550
|
-
/**
|
|
551
|
-
* @typedef CategoryUpdateResponse
|
|
552
|
-
* @property {string} [message] - It is the message of the response from the category.
|
|
553
|
-
* @property {boolean} [success] - It is the flag indication the success response.
|
|
554
|
-
*/
|
|
555
528
|
/**
|
|
556
529
|
* @typedef Child
|
|
557
530
|
* @property {Object} [_custom_json]
|
|
@@ -923,29 +896,6 @@ export = CatalogPlatformModel;
|
|
|
923
896
|
* @property {string} [department]
|
|
924
897
|
* @property {CategoryItems[]} [items]
|
|
925
898
|
*/
|
|
926
|
-
/**
|
|
927
|
-
* @typedef DepartmentCreateErrorResponse
|
|
928
|
-
* @property {string} [error]
|
|
929
|
-
*/
|
|
930
|
-
/**
|
|
931
|
-
* @typedef DepartmentCreateResponse
|
|
932
|
-
* @property {string} message
|
|
933
|
-
* @property {number} uid
|
|
934
|
-
*/
|
|
935
|
-
/**
|
|
936
|
-
* @typedef DepartmentCreateUpdate
|
|
937
|
-
* @property {string} [_cls]
|
|
938
|
-
* @property {Object} [_custom_json]
|
|
939
|
-
* @property {boolean} [is_active]
|
|
940
|
-
* @property {string} logo
|
|
941
|
-
* @property {string} name
|
|
942
|
-
* @property {Object} [platforms]
|
|
943
|
-
* @property {number} priority_order
|
|
944
|
-
* @property {string} [slug]
|
|
945
|
-
* @property {string[]} [synonyms]
|
|
946
|
-
* @property {string[]} [tags]
|
|
947
|
-
* @property {number} [uid]
|
|
948
|
-
*/
|
|
949
899
|
/**
|
|
950
900
|
* @typedef DepartmentErrorResponse
|
|
951
901
|
* @property {string} [code]
|
|
@@ -959,28 +909,6 @@ export = CatalogPlatformModel;
|
|
|
959
909
|
* @property {string} [slug]
|
|
960
910
|
* @property {number} [uid]
|
|
961
911
|
*/
|
|
962
|
-
/**
|
|
963
|
-
* @typedef DepartmentModel
|
|
964
|
-
* @property {string} [_cls]
|
|
965
|
-
* @property {Object} [_custom_json]
|
|
966
|
-
* @property {string} [_id]
|
|
967
|
-
* @property {UserDetail} [created_by] - User details of the creator of the document
|
|
968
|
-
* @property {string} created_on - Timestamp of the creation of the document
|
|
969
|
-
* @property {boolean} [is_active] - Whether the department is currently active
|
|
970
|
-
* @property {string} logo - The URL of the department's logo
|
|
971
|
-
* @property {UserDetail} [modified_by] - User details of the last modifier of
|
|
972
|
-
* the document
|
|
973
|
-
* @property {string} modified_on - Timestamp of the last modification of the document
|
|
974
|
-
* @property {string} name - The name of the department
|
|
975
|
-
* @property {number} priority_order - The priority order of the department
|
|
976
|
-
* @property {string} slug - The unique slug identifier for the department
|
|
977
|
-
* @property {string[]} [synonyms] - A list of synonyms for the department name
|
|
978
|
-
* @property {number} uid - The unique ID for the department
|
|
979
|
-
* @property {UserDetail} [verified_by] - User details of the verifier of the
|
|
980
|
-
* document, if applicable
|
|
981
|
-
* @property {string} [verified_on] - Timestamp of when the document was
|
|
982
|
-
* verified, if applicable
|
|
983
|
-
*/
|
|
984
912
|
/**
|
|
985
913
|
* @typedef DepartmentResponse
|
|
986
914
|
* @property {Department[]} [items]
|
|
@@ -1113,7 +1041,7 @@ export = CatalogPlatformModel;
|
|
|
1113
1041
|
* @property {boolean} [primary]
|
|
1114
1042
|
*/
|
|
1115
1043
|
/**
|
|
1116
|
-
* @typedef
|
|
1044
|
+
* @typedef AttributeDetail
|
|
1117
1045
|
* @property {string[]} [departments]
|
|
1118
1046
|
* @property {string} [description]
|
|
1119
1047
|
* @property {AttributeMasterDetails} [details]
|
|
@@ -3337,12 +3265,13 @@ export = CatalogPlatformModel;
|
|
|
3337
3265
|
* | "register"
|
|
3338
3266
|
* | "shipping-policy"
|
|
3339
3267
|
* | "return-policy"
|
|
3340
|
-
* | "order-status"
|
|
3268
|
+
* | "order-status"
|
|
3269
|
+
* | "locate-us"} PageType
|
|
3341
3270
|
*/
|
|
3342
3271
|
declare class CatalogPlatformModel {
|
|
3343
3272
|
}
|
|
3344
3273
|
declare namespace CatalogPlatformModel {
|
|
3345
|
-
export { Action, AllSizes, AllowSingleRequest, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponse, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponse, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductListingResponse, ApplicationStoreJson, AppReturnConfigResponse, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponse, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSerializer, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponse, Brand, BrandItem, BrandListingResponse, BrandMeta, BrandMeta1, BulkAssetResponse, BulkHsnResponse, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkProductJob, BulkJob, BulkProductRequest, BulkResponse, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponse, CategoriesResponse, Category,
|
|
3274
|
+
export { Action, AllSizes, AllowSingleRequest, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponse, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponse, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductListingResponse, ApplicationStoreJson, AppReturnConfigResponse, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponse, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSerializer, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponse, Brand, BrandItem, BrandListingResponse, BrandMeta, BrandMeta1, BulkAssetResponse, BulkHsnResponse, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkProductJob, BulkJob, BulkProductRequest, BulkResponse, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponse, CategoriesResponse, Category, CategoryItems, CategoryListingResponse, CategoryMapping, CategoryMappingValues, CategoryResponse, Child, CollectionBadge, CollectionBanner, CollectionCreateResponse, CollectionDetailResponse, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, CompanyMeta1, CompanyOptIn, ConfigErrorResponse, ConfigSuccessResponse, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponse, CreateCollection, CreateSearchConfigurationRequest, CreateSearchConfigurationResponse, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponse, CustomOrder, DateMeta, DefaultKeyRequest, DeleteAppCategoryReturnConfig, DeleteResponse, DeleteSearchConfigurationResponse, Department, DepartmentCategoryTree, DepartmentErrorResponse, DepartmentIdentifier, DepartmentResponse, DepartmentsResponse, DimensionResponse, DimensionResponse1, Document, EntityConfiguration, ErrorResponse, FilerList, RawProduct, RawProductListingResponse, GTIN, AttributeDetail, GetAddressSerializer, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponse, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponse, GetCollectionListingResponse, GetCollectionQueryOptionResponse, GetCompanySerializer, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponse, GetConfigMetadataValues, GetConfigResponse, GetDepartment, GetInventories, GetInventoriesResponse, GetLocationSerializer, GetOptInPlatform, GetProductBundleCreateResponse, GetProductBundleListingResponse, GetProductBundleResponse, GetProducts, GetCollectionDetailResponse, CommonResponseSchemaCollection, GetQueryFiltersKeysResponse, GetQueryFiltersResponse, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponse, GetSearchWordsData, GetSearchWordsDetailResponse, GetSearchWordsResponse, GlobalValidation, Guide, HSNCodesResponse, HSNData, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequest, InventoryConfig, InventoryCreateRequest, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponse, InventoryExportQuantityFilter, InventoryExportRequest, InventoryExportResponse, InventoryFailedReason, InventoryJobDetailResponse, InventoryJobFilters, InventoryJobPayload, InventoryPage, InventoryPayload, InventoryRequest, InventoryRequestSchemaV2, InventoryResponse, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, InventorySellerResponse, InventorySet, InventoryStockResponse, InventoryUpdateResponse, InventoryValidationResponse, InvoiceCredSerializer, InvoiceDetailsSerializer, ItemQuery, Items, LimitedProductData, ListSizeGuide, LocationDayWiseSerializer, LocationIntegrationType, LocationListSerializer, LocationManagerSerializer, LocationTimingSerializer, Logo, MOQData, ManufacturerResponse, ManufacturerResponse1, Media, Media1, Media2, Meta, MetaDataListingFilterMetaResponse, MetaDataListingFilterResponse, MetaDataListingResponse, MetaDataListingSortMetaResponse, MetaDataListingSortResponse, MetaFields, NetQuantity, NetQuantityResponse, NextSchedule, OptInPostRequest, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponse, PTErrorResponse, Page, PageResponse, PageResponse1, PageResponseType, Price, Price1, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponse, Product, ProductAttributesResponse, ProductBrand, ProductBulkAssets, ProductBulkRequest, ProductBulkRequestList, ProductBundleItem, ProductBundleRequest, ProductBundleUpdateRequest, ProductConfigurationDownloads, ProductCreateUpdateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponse, ProductFilters, GetQueryFiltersValuesResponse, ProductFiltersKeysOnly, ProductFiltersKey, ProductFiltersValue, ProductListingDetail, ProductListingPrice, ProductListingResponse, ProductListingResponseV2, ProductPublish, ProductPublish1, ProductPublished, ProductReturnConfigSerializer, ProductReturnConfigBaseSerializer, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponse, ProductSizeDeleteResponse, ProductSortOn, ProductTagsViewResponse, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequest, ProductTemplateExportResponse, ProductVariants, ProductVariantsResponse, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, ReturnConfig1, ReturnConfig2, ReturnConfigResponse, Sitemap, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, SeoDetail, SetSize, SingleCategoryResponse, SingleProductResponse, Size, SizeDistribution, SizeGuideResponse, StoreAssignResponse, StoreDetail, StoreMeta, SuccessResponse, SuccessResponse1, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateValidationData, TemplatesResponse, TemplatesValidationResponse, ThirdLevelChild, Trader, Trader1, Trader2, UpdateCollection, UpdateSearchConfigurationRequest, UpdateSearchConfigurationResponse, CreateMarketplaceOptinResponse, UserCommon, UserDetail, UserDetail1, UserInfo, UserInfo1, UserSerializer, UserSerializer1, UserSerializer2, UserSerializer3, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponse, WeightResponse1, CreatedBy, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequest, UpdateMarketplaceOptinResponse, ActionPage, PageType };
|
|
3346
3275
|
}
|
|
3347
3276
|
/** @returns {Action} */
|
|
3348
3277
|
declare function Action(): Action;
|
|
@@ -4075,18 +4004,6 @@ type Category = {
|
|
|
4075
4004
|
*/
|
|
4076
4005
|
uid?: number;
|
|
4077
4006
|
};
|
|
4078
|
-
/** @returns {CategoryCreateResponse} */
|
|
4079
|
-
declare function CategoryCreateResponse(): CategoryCreateResponse;
|
|
4080
|
-
type CategoryCreateResponse = {
|
|
4081
|
-
/**
|
|
4082
|
-
* - It is the message of the response from the category.
|
|
4083
|
-
*/
|
|
4084
|
-
message?: string;
|
|
4085
|
-
/**
|
|
4086
|
-
* - It is the unique identifier of the category.
|
|
4087
|
-
*/
|
|
4088
|
-
uid?: number;
|
|
4089
|
-
};
|
|
4090
4007
|
/** @returns {CategoryItems} */
|
|
4091
4008
|
declare function CategoryItems(): CategoryItems;
|
|
4092
4009
|
type CategoryItems = {
|
|
@@ -4135,75 +4052,12 @@ type CategoryMappingValues = {
|
|
|
4135
4052
|
*/
|
|
4136
4053
|
name: string;
|
|
4137
4054
|
};
|
|
4138
|
-
/** @returns {CategoryRequestBody} */
|
|
4139
|
-
declare function CategoryRequestBody(): CategoryRequestBody;
|
|
4140
|
-
type CategoryRequestBody = {
|
|
4141
|
-
/**
|
|
4142
|
-
* - It is the list of unique department the
|
|
4143
|
-
* category belongs to.
|
|
4144
|
-
*/
|
|
4145
|
-
departments: number[];
|
|
4146
|
-
/**
|
|
4147
|
-
* - It is the list of category hierarchies
|
|
4148
|
-
* for each department of an L3 category.
|
|
4149
|
-
*/
|
|
4150
|
-
hierarchy?: Hierarchy[];
|
|
4151
|
-
/**
|
|
4152
|
-
* - It is the flag indicating if the category is active.
|
|
4153
|
-
*/
|
|
4154
|
-
is_active: boolean;
|
|
4155
|
-
/**
|
|
4156
|
-
* - It is the level of category
|
|
4157
|
-
*/
|
|
4158
|
-
level: number;
|
|
4159
|
-
/**
|
|
4160
|
-
* - It is the mapping of the
|
|
4161
|
-
* category in different marketplaces.
|
|
4162
|
-
*/
|
|
4163
|
-
marketplaces?: CategoryMapping;
|
|
4164
|
-
/**
|
|
4165
|
-
* - It is the details of the media such as banner and logo..
|
|
4166
|
-
*/
|
|
4167
|
-
media?: Media1;
|
|
4168
|
-
/**
|
|
4169
|
-
* - It is the name of the category
|
|
4170
|
-
*/
|
|
4171
|
-
name: string;
|
|
4172
|
-
/**
|
|
4173
|
-
* - It is the priority of the category.
|
|
4174
|
-
*/
|
|
4175
|
-
priority?: number;
|
|
4176
|
-
/**
|
|
4177
|
-
* - It is the slug of the category.
|
|
4178
|
-
*/
|
|
4179
|
-
slug?: string;
|
|
4180
|
-
/**
|
|
4181
|
-
* - It is the list of synonyms.
|
|
4182
|
-
*/
|
|
4183
|
-
synonyms?: string[];
|
|
4184
|
-
/**
|
|
4185
|
-
* - It is the list of tryouts.
|
|
4186
|
-
*/
|
|
4187
|
-
tryouts?: string[];
|
|
4188
|
-
};
|
|
4189
4055
|
/** @returns {CategoryResponse} */
|
|
4190
4056
|
declare function CategoryResponse(): CategoryResponse;
|
|
4191
4057
|
type CategoryResponse = {
|
|
4192
4058
|
items?: Category[];
|
|
4193
4059
|
page?: Page;
|
|
4194
4060
|
};
|
|
4195
|
-
/** @returns {CategoryUpdateResponse} */
|
|
4196
|
-
declare function CategoryUpdateResponse(): CategoryUpdateResponse;
|
|
4197
|
-
type CategoryUpdateResponse = {
|
|
4198
|
-
/**
|
|
4199
|
-
* - It is the message of the response from the category.
|
|
4200
|
-
*/
|
|
4201
|
-
message?: string;
|
|
4202
|
-
/**
|
|
4203
|
-
* - It is the flag indication the success response.
|
|
4204
|
-
*/
|
|
4205
|
-
success?: boolean;
|
|
4206
|
-
};
|
|
4207
4061
|
/** @returns {Child} */
|
|
4208
4062
|
declare function Child(): Child;
|
|
4209
4063
|
type Child = {
|
|
@@ -4677,32 +4531,6 @@ type DepartmentCategoryTree = {
|
|
|
4677
4531
|
department?: string;
|
|
4678
4532
|
items?: CategoryItems[];
|
|
4679
4533
|
};
|
|
4680
|
-
/** @returns {DepartmentCreateErrorResponse} */
|
|
4681
|
-
declare function DepartmentCreateErrorResponse(): DepartmentCreateErrorResponse;
|
|
4682
|
-
type DepartmentCreateErrorResponse = {
|
|
4683
|
-
error?: string;
|
|
4684
|
-
};
|
|
4685
|
-
/** @returns {DepartmentCreateResponse} */
|
|
4686
|
-
declare function DepartmentCreateResponse(): DepartmentCreateResponse;
|
|
4687
|
-
type DepartmentCreateResponse = {
|
|
4688
|
-
message: string;
|
|
4689
|
-
uid: number;
|
|
4690
|
-
};
|
|
4691
|
-
/** @returns {DepartmentCreateUpdate} */
|
|
4692
|
-
declare function DepartmentCreateUpdate(): DepartmentCreateUpdate;
|
|
4693
|
-
type DepartmentCreateUpdate = {
|
|
4694
|
-
_cls?: string;
|
|
4695
|
-
_custom_json?: any;
|
|
4696
|
-
is_active?: boolean;
|
|
4697
|
-
logo: string;
|
|
4698
|
-
name: string;
|
|
4699
|
-
platforms?: any;
|
|
4700
|
-
priority_order: number;
|
|
4701
|
-
slug?: string;
|
|
4702
|
-
synonyms?: string[];
|
|
4703
|
-
tags?: string[];
|
|
4704
|
-
uid?: number;
|
|
4705
|
-
};
|
|
4706
4534
|
/** @returns {DepartmentErrorResponse} */
|
|
4707
4535
|
declare function DepartmentErrorResponse(): DepartmentErrorResponse;
|
|
4708
4536
|
type DepartmentErrorResponse = {
|
|
@@ -4718,68 +4546,6 @@ type DepartmentIdentifier = {
|
|
|
4718
4546
|
slug?: string;
|
|
4719
4547
|
uid?: number;
|
|
4720
4548
|
};
|
|
4721
|
-
/** @returns {DepartmentModel} */
|
|
4722
|
-
declare function DepartmentModel(): DepartmentModel;
|
|
4723
|
-
type DepartmentModel = {
|
|
4724
|
-
_cls?: string;
|
|
4725
|
-
_custom_json?: any;
|
|
4726
|
-
_id?: string;
|
|
4727
|
-
/**
|
|
4728
|
-
* - User details of the creator of the document
|
|
4729
|
-
*/
|
|
4730
|
-
created_by?: UserDetail;
|
|
4731
|
-
/**
|
|
4732
|
-
* - Timestamp of the creation of the document
|
|
4733
|
-
*/
|
|
4734
|
-
created_on: string;
|
|
4735
|
-
/**
|
|
4736
|
-
* - Whether the department is currently active
|
|
4737
|
-
*/
|
|
4738
|
-
is_active?: boolean;
|
|
4739
|
-
/**
|
|
4740
|
-
* - The URL of the department's logo
|
|
4741
|
-
*/
|
|
4742
|
-
logo: string;
|
|
4743
|
-
/**
|
|
4744
|
-
* - User details of the last modifier of
|
|
4745
|
-
* the document
|
|
4746
|
-
*/
|
|
4747
|
-
modified_by?: UserDetail;
|
|
4748
|
-
/**
|
|
4749
|
-
* - Timestamp of the last modification of the document
|
|
4750
|
-
*/
|
|
4751
|
-
modified_on: string;
|
|
4752
|
-
/**
|
|
4753
|
-
* - The name of the department
|
|
4754
|
-
*/
|
|
4755
|
-
name: string;
|
|
4756
|
-
/**
|
|
4757
|
-
* - The priority order of the department
|
|
4758
|
-
*/
|
|
4759
|
-
priority_order: number;
|
|
4760
|
-
/**
|
|
4761
|
-
* - The unique slug identifier for the department
|
|
4762
|
-
*/
|
|
4763
|
-
slug: string;
|
|
4764
|
-
/**
|
|
4765
|
-
* - A list of synonyms for the department name
|
|
4766
|
-
*/
|
|
4767
|
-
synonyms?: string[];
|
|
4768
|
-
/**
|
|
4769
|
-
* - The unique ID for the department
|
|
4770
|
-
*/
|
|
4771
|
-
uid: number;
|
|
4772
|
-
/**
|
|
4773
|
-
* - User details of the verifier of the
|
|
4774
|
-
* document, if applicable
|
|
4775
|
-
*/
|
|
4776
|
-
verified_by?: UserDetail;
|
|
4777
|
-
/**
|
|
4778
|
-
* - Timestamp of when the document was
|
|
4779
|
-
* verified, if applicable
|
|
4780
|
-
*/
|
|
4781
|
-
verified_on?: string;
|
|
4782
|
-
};
|
|
4783
4549
|
/** @returns {DepartmentResponse} */
|
|
4784
4550
|
declare function DepartmentResponse(): DepartmentResponse;
|
|
4785
4551
|
type DepartmentResponse = {
|
|
@@ -4937,9 +4703,9 @@ type GTIN = {
|
|
|
4937
4703
|
gtin_value: string;
|
|
4938
4704
|
primary?: boolean;
|
|
4939
4705
|
};
|
|
4940
|
-
/** @returns {
|
|
4941
|
-
declare function
|
|
4942
|
-
type
|
|
4706
|
+
/** @returns {AttributeDetail} */
|
|
4707
|
+
declare function AttributeDetail(): AttributeDetail;
|
|
4708
|
+
type AttributeDetail = {
|
|
4943
4709
|
departments?: string[];
|
|
4944
4710
|
description?: string;
|
|
4945
4711
|
details?: AttributeMasterDetails;
|
|
@@ -8110,4 +7876,4 @@ type ActionPage = {
|
|
|
8110
7876
|
* @returns {PageType}
|
|
8111
7877
|
*/
|
|
8112
7878
|
declare function PageType(): PageType;
|
|
8113
|
-
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";
|
|
7879
|
+
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";
|
|
@@ -554,12 +554,6 @@ const Joi = require("joi");
|
|
|
554
554
|
* @property {number} [uid] - It is the unique identifier of the category.
|
|
555
555
|
*/
|
|
556
556
|
|
|
557
|
-
/**
|
|
558
|
-
* @typedef CategoryCreateResponse
|
|
559
|
-
* @property {string} [message] - It is the message of the response from the category.
|
|
560
|
-
* @property {number} [uid] - It is the unique identifier of the category.
|
|
561
|
-
*/
|
|
562
|
-
|
|
563
557
|
/**
|
|
564
558
|
* @typedef CategoryItems
|
|
565
559
|
* @property {Action} [action]
|
|
@@ -593,36 +587,12 @@ const Joi = require("joi");
|
|
|
593
587
|
* @property {string} name - It is the name of the Category in the respective platform.
|
|
594
588
|
*/
|
|
595
589
|
|
|
596
|
-
/**
|
|
597
|
-
* @typedef CategoryRequestBody
|
|
598
|
-
* @property {number[]} departments - It is the list of unique department the
|
|
599
|
-
* category belongs to.
|
|
600
|
-
* @property {Hierarchy[]} [hierarchy] - It is the list of category hierarchies
|
|
601
|
-
* for each department of an L3 category.
|
|
602
|
-
* @property {boolean} is_active - It is the flag indicating if the category is active.
|
|
603
|
-
* @property {number} level - It is the level of category
|
|
604
|
-
* @property {CategoryMapping} [marketplaces] - It is the mapping of the
|
|
605
|
-
* category in different marketplaces.
|
|
606
|
-
* @property {Media1} [media] - It is the details of the media such as banner and logo..
|
|
607
|
-
* @property {string} name - It is the name of the category
|
|
608
|
-
* @property {number} [priority] - It is the priority of the category.
|
|
609
|
-
* @property {string} [slug] - It is the slug of the category.
|
|
610
|
-
* @property {string[]} [synonyms] - It is the list of synonyms.
|
|
611
|
-
* @property {string[]} [tryouts] - It is the list of tryouts.
|
|
612
|
-
*/
|
|
613
|
-
|
|
614
590
|
/**
|
|
615
591
|
* @typedef CategoryResponse
|
|
616
592
|
* @property {Category[]} [items]
|
|
617
593
|
* @property {Page} [page]
|
|
618
594
|
*/
|
|
619
595
|
|
|
620
|
-
/**
|
|
621
|
-
* @typedef CategoryUpdateResponse
|
|
622
|
-
* @property {string} [message] - It is the message of the response from the category.
|
|
623
|
-
* @property {boolean} [success] - It is the flag indication the success response.
|
|
624
|
-
*/
|
|
625
|
-
|
|
626
596
|
/**
|
|
627
597
|
* @typedef Child
|
|
628
598
|
* @property {Object} [_custom_json]
|
|
@@ -1042,32 +1012,6 @@ const Joi = require("joi");
|
|
|
1042
1012
|
* @property {CategoryItems[]} [items]
|
|
1043
1013
|
*/
|
|
1044
1014
|
|
|
1045
|
-
/**
|
|
1046
|
-
* @typedef DepartmentCreateErrorResponse
|
|
1047
|
-
* @property {string} [error]
|
|
1048
|
-
*/
|
|
1049
|
-
|
|
1050
|
-
/**
|
|
1051
|
-
* @typedef DepartmentCreateResponse
|
|
1052
|
-
* @property {string} message
|
|
1053
|
-
* @property {number} uid
|
|
1054
|
-
*/
|
|
1055
|
-
|
|
1056
|
-
/**
|
|
1057
|
-
* @typedef DepartmentCreateUpdate
|
|
1058
|
-
* @property {string} [_cls]
|
|
1059
|
-
* @property {Object} [_custom_json]
|
|
1060
|
-
* @property {boolean} [is_active]
|
|
1061
|
-
* @property {string} logo
|
|
1062
|
-
* @property {string} name
|
|
1063
|
-
* @property {Object} [platforms]
|
|
1064
|
-
* @property {number} priority_order
|
|
1065
|
-
* @property {string} [slug]
|
|
1066
|
-
* @property {string[]} [synonyms]
|
|
1067
|
-
* @property {string[]} [tags]
|
|
1068
|
-
* @property {number} [uid]
|
|
1069
|
-
*/
|
|
1070
|
-
|
|
1071
1015
|
/**
|
|
1072
1016
|
* @typedef DepartmentErrorResponse
|
|
1073
1017
|
* @property {string} [code]
|
|
@@ -1083,29 +1027,6 @@ const Joi = require("joi");
|
|
|
1083
1027
|
* @property {number} [uid]
|
|
1084
1028
|
*/
|
|
1085
1029
|
|
|
1086
|
-
/**
|
|
1087
|
-
* @typedef DepartmentModel
|
|
1088
|
-
* @property {string} [_cls]
|
|
1089
|
-
* @property {Object} [_custom_json]
|
|
1090
|
-
* @property {string} [_id]
|
|
1091
|
-
* @property {UserDetail} [created_by] - User details of the creator of the document
|
|
1092
|
-
* @property {string} created_on - Timestamp of the creation of the document
|
|
1093
|
-
* @property {boolean} [is_active] - Whether the department is currently active
|
|
1094
|
-
* @property {string} logo - The URL of the department's logo
|
|
1095
|
-
* @property {UserDetail} [modified_by] - User details of the last modifier of
|
|
1096
|
-
* the document
|
|
1097
|
-
* @property {string} modified_on - Timestamp of the last modification of the document
|
|
1098
|
-
* @property {string} name - The name of the department
|
|
1099
|
-
* @property {number} priority_order - The priority order of the department
|
|
1100
|
-
* @property {string} slug - The unique slug identifier for the department
|
|
1101
|
-
* @property {string[]} [synonyms] - A list of synonyms for the department name
|
|
1102
|
-
* @property {number} uid - The unique ID for the department
|
|
1103
|
-
* @property {UserDetail} [verified_by] - User details of the verifier of the
|
|
1104
|
-
* document, if applicable
|
|
1105
|
-
* @property {string} [verified_on] - Timestamp of when the document was
|
|
1106
|
-
* verified, if applicable
|
|
1107
|
-
*/
|
|
1108
|
-
|
|
1109
1030
|
/**
|
|
1110
1031
|
* @typedef DepartmentResponse
|
|
1111
1032
|
* @property {Department[]} [items]
|
|
@@ -1249,7 +1170,7 @@ const Joi = require("joi");
|
|
|
1249
1170
|
*/
|
|
1250
1171
|
|
|
1251
1172
|
/**
|
|
1252
|
-
* @typedef
|
|
1173
|
+
* @typedef AttributeDetail
|
|
1253
1174
|
* @property {string[]} [departments]
|
|
1254
1175
|
* @property {string} [description]
|
|
1255
1176
|
* @property {AttributeMasterDetails} [details]
|
|
@@ -3712,7 +3633,8 @@ const Joi = require("joi");
|
|
|
3712
3633
|
* | "register"
|
|
3713
3634
|
* | "shipping-policy"
|
|
3714
3635
|
* | "return-policy"
|
|
3715
|
-
* | "order-status"
|
|
3636
|
+
* | "order-status"
|
|
3637
|
+
* | "locate-us"} PageType
|
|
3716
3638
|
*/
|
|
3717
3639
|
|
|
3718
3640
|
class CatalogPlatformModel {
|
|
@@ -4392,14 +4314,6 @@ class CatalogPlatformModel {
|
|
|
4392
4314
|
});
|
|
4393
4315
|
}
|
|
4394
4316
|
|
|
4395
|
-
/** @returns {CategoryCreateResponse} */
|
|
4396
|
-
static CategoryCreateResponse() {
|
|
4397
|
-
return Joi.object({
|
|
4398
|
-
message: Joi.string().allow(""),
|
|
4399
|
-
uid: Joi.number(),
|
|
4400
|
-
});
|
|
4401
|
-
}
|
|
4402
|
-
|
|
4403
4317
|
/** @returns {CategoryItems} */
|
|
4404
4318
|
static CategoryItems() {
|
|
4405
4319
|
return Joi.object({
|
|
@@ -4439,23 +4353,6 @@ class CatalogPlatformModel {
|
|
|
4439
4353
|
});
|
|
4440
4354
|
}
|
|
4441
4355
|
|
|
4442
|
-
/** @returns {CategoryRequestBody} */
|
|
4443
|
-
static CategoryRequestBody() {
|
|
4444
|
-
return Joi.object({
|
|
4445
|
-
departments: Joi.array().items(Joi.number()).required(),
|
|
4446
|
-
hierarchy: Joi.array().items(CatalogPlatformModel.Hierarchy()),
|
|
4447
|
-
is_active: Joi.boolean().required(),
|
|
4448
|
-
level: Joi.number().required(),
|
|
4449
|
-
marketplaces: CatalogPlatformModel.CategoryMapping(),
|
|
4450
|
-
media: CatalogPlatformModel.Media1(),
|
|
4451
|
-
name: Joi.string().allow("").required(),
|
|
4452
|
-
priority: Joi.number(),
|
|
4453
|
-
slug: Joi.string().allow(""),
|
|
4454
|
-
synonyms: Joi.array().items(Joi.string().allow("")),
|
|
4455
|
-
tryouts: Joi.array().items(Joi.string().allow("")),
|
|
4456
|
-
});
|
|
4457
|
-
}
|
|
4458
|
-
|
|
4459
4356
|
/** @returns {CategoryResponse} */
|
|
4460
4357
|
static CategoryResponse() {
|
|
4461
4358
|
return Joi.object({
|
|
@@ -4464,14 +4361,6 @@ class CatalogPlatformModel {
|
|
|
4464
4361
|
});
|
|
4465
4362
|
}
|
|
4466
4363
|
|
|
4467
|
-
/** @returns {CategoryUpdateResponse} */
|
|
4468
|
-
static CategoryUpdateResponse() {
|
|
4469
|
-
return Joi.object({
|
|
4470
|
-
message: Joi.string().allow(""),
|
|
4471
|
-
success: Joi.boolean(),
|
|
4472
|
-
});
|
|
4473
|
-
}
|
|
4474
|
-
|
|
4475
4364
|
/** @returns {Child} */
|
|
4476
4365
|
static Child() {
|
|
4477
4366
|
return Joi.object({
|
|
@@ -4994,38 +4883,6 @@ class CatalogPlatformModel {
|
|
|
4994
4883
|
});
|
|
4995
4884
|
}
|
|
4996
4885
|
|
|
4997
|
-
/** @returns {DepartmentCreateErrorResponse} */
|
|
4998
|
-
static DepartmentCreateErrorResponse() {
|
|
4999
|
-
return Joi.object({
|
|
5000
|
-
error: Joi.string().allow(""),
|
|
5001
|
-
});
|
|
5002
|
-
}
|
|
5003
|
-
|
|
5004
|
-
/** @returns {DepartmentCreateResponse} */
|
|
5005
|
-
static DepartmentCreateResponse() {
|
|
5006
|
-
return Joi.object({
|
|
5007
|
-
message: Joi.string().allow("").required(),
|
|
5008
|
-
uid: Joi.number().required(),
|
|
5009
|
-
});
|
|
5010
|
-
}
|
|
5011
|
-
|
|
5012
|
-
/** @returns {DepartmentCreateUpdate} */
|
|
5013
|
-
static DepartmentCreateUpdate() {
|
|
5014
|
-
return Joi.object({
|
|
5015
|
-
_cls: Joi.string().allow(""),
|
|
5016
|
-
_custom_json: Joi.any(),
|
|
5017
|
-
is_active: Joi.boolean(),
|
|
5018
|
-
logo: Joi.string().allow("").required(),
|
|
5019
|
-
name: Joi.string().allow("").required(),
|
|
5020
|
-
platforms: Joi.any(),
|
|
5021
|
-
priority_order: Joi.number().required(),
|
|
5022
|
-
slug: Joi.string().allow(""),
|
|
5023
|
-
synonyms: Joi.array().items(Joi.string().allow("")),
|
|
5024
|
-
tags: Joi.array().items(Joi.string().allow("")),
|
|
5025
|
-
uid: Joi.number(),
|
|
5026
|
-
});
|
|
5027
|
-
}
|
|
5028
|
-
|
|
5029
4886
|
/** @returns {DepartmentErrorResponse} */
|
|
5030
4887
|
static DepartmentErrorResponse() {
|
|
5031
4888
|
return Joi.object({
|
|
@@ -5045,28 +4902,6 @@ class CatalogPlatformModel {
|
|
|
5045
4902
|
});
|
|
5046
4903
|
}
|
|
5047
4904
|
|
|
5048
|
-
/** @returns {DepartmentModel} */
|
|
5049
|
-
static DepartmentModel() {
|
|
5050
|
-
return Joi.object({
|
|
5051
|
-
_cls: Joi.string().allow(""),
|
|
5052
|
-
_custom_json: Joi.any(),
|
|
5053
|
-
_id: Joi.string().allow(""),
|
|
5054
|
-
created_by: CatalogPlatformModel.UserDetail(),
|
|
5055
|
-
created_on: Joi.string().allow("").required(),
|
|
5056
|
-
is_active: Joi.boolean(),
|
|
5057
|
-
logo: Joi.string().allow("").required(),
|
|
5058
|
-
modified_by: CatalogPlatformModel.UserDetail(),
|
|
5059
|
-
modified_on: Joi.string().allow("").required(),
|
|
5060
|
-
name: Joi.string().allow("").required(),
|
|
5061
|
-
priority_order: Joi.number().required(),
|
|
5062
|
-
slug: Joi.string().allow("").required(),
|
|
5063
|
-
synonyms: Joi.array().items(Joi.string().allow("")),
|
|
5064
|
-
uid: Joi.number().required(),
|
|
5065
|
-
verified_by: CatalogPlatformModel.UserDetail(),
|
|
5066
|
-
verified_on: Joi.string().allow(""),
|
|
5067
|
-
});
|
|
5068
|
-
}
|
|
5069
|
-
|
|
5070
4905
|
/** @returns {DepartmentResponse} */
|
|
5071
4906
|
static DepartmentResponse() {
|
|
5072
4907
|
return Joi.object({
|
|
@@ -5231,8 +5066,8 @@ class CatalogPlatformModel {
|
|
|
5231
5066
|
});
|
|
5232
5067
|
}
|
|
5233
5068
|
|
|
5234
|
-
/** @returns {
|
|
5235
|
-
static
|
|
5069
|
+
/** @returns {AttributeDetail} */
|
|
5070
|
+
static AttributeDetail() {
|
|
5236
5071
|
return Joi.object({
|
|
5237
5072
|
departments: Joi.array().items(Joi.string().allow("")),
|
|
5238
5073
|
description: Joi.string().allow(""),
|
|
@@ -8221,7 +8056,9 @@ class CatalogPlatformModel {
|
|
|
8221
8056
|
|
|
8222
8057
|
"return-policy",
|
|
8223
8058
|
|
|
8224
|
-
"order-status"
|
|
8059
|
+
"order-status",
|
|
8060
|
+
|
|
8061
|
+
"locate-us"
|
|
8225
8062
|
);
|
|
8226
8063
|
}
|
|
8227
8064
|
}
|