@gofynd/fdk-client-javascript 3.3.3 → 3.3.6
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 +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +57 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +62 -3
- package/sdk/platform/Cart/CartPlatformModel.js +33 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +89 -82
- package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +85 -3
- package/sdk/platform/Payment/PaymentPlatformModel.js +49 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -589,6 +589,14 @@ export = CatalogPlatformModel;
|
|
|
589
589
|
* @property {string} [stage]
|
|
590
590
|
* @property {number} [succeed]
|
|
591
591
|
* @property {number} [total]
|
|
592
|
+
* @property {BulkMeta} [meta]
|
|
593
|
+
*/
|
|
594
|
+
/**
|
|
595
|
+
* @typedef BulkMeta
|
|
596
|
+
* @property {string} [comment] - Additional remarks or notes explaining the
|
|
597
|
+
* context or reason for the bulk inventory action.
|
|
598
|
+
* @property {string[]} [image_urls] - A list of image URLs providing visual
|
|
599
|
+
* evidence or supporting context for the comment.
|
|
592
600
|
*/
|
|
593
601
|
/**
|
|
594
602
|
* @typedef BulkProductJob
|
|
@@ -614,6 +622,7 @@ export = CatalogPlatformModel;
|
|
|
614
622
|
* @property {number} [failed]
|
|
615
623
|
* @property {Object[]} [failed_records]
|
|
616
624
|
* @property {string} [file_path]
|
|
625
|
+
* @property {string} [file_type] - Type of inventory File
|
|
617
626
|
* @property {boolean} [is_active] - Whether the item is active or not.
|
|
618
627
|
* @property {string} [modified_by] - The user who last modified the item.
|
|
619
628
|
* @property {string} [modified_on] - The date and time when the item was last modified.
|
|
@@ -2678,7 +2687,7 @@ export = CatalogPlatformModel;
|
|
|
2678
2687
|
*/
|
|
2679
2688
|
/**
|
|
2680
2689
|
* @typedef Page
|
|
2681
|
-
* @property {number} [item_total] - The total number of items
|
|
2690
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
2682
2691
|
* @property {string} [next_id] - The identifier for the next page.
|
|
2683
2692
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
2684
2693
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -4228,6 +4237,16 @@ export = CatalogPlatformModel;
|
|
|
4228
4237
|
* @property {number} [shipping]
|
|
4229
4238
|
* @property {string} [unit]
|
|
4230
4239
|
*/
|
|
4240
|
+
/**
|
|
4241
|
+
* @typedef BulkInventoryJob
|
|
4242
|
+
* @property {string} company_id - Unique identifier of the company for which
|
|
4243
|
+
* the inventory update is being performed.
|
|
4244
|
+
* @property {string} file_type - Type of inventory update file being processed,
|
|
4245
|
+
* either price or quantity.
|
|
4246
|
+
* @property {string} file_path - URL of the uploaded file containing inventory
|
|
4247
|
+
* update data.
|
|
4248
|
+
* @property {BulkMeta} [meta]
|
|
4249
|
+
*/
|
|
4231
4250
|
/**
|
|
4232
4251
|
* @typedef Marketplaces
|
|
4233
4252
|
* @property {number[]} [brand_ids]
|
|
@@ -4375,7 +4394,7 @@ export = CatalogPlatformModel;
|
|
|
4375
4394
|
declare class CatalogPlatformModel {
|
|
4376
4395
|
}
|
|
4377
4396
|
declare namespace CatalogPlatformModel {
|
|
4378
|
-
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType };
|
|
4397
|
+
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkMeta, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType };
|
|
4379
4398
|
}
|
|
4380
4399
|
/** @returns {Action} */
|
|
4381
4400
|
declare function Action(): Action;
|
|
@@ -5626,6 +5645,21 @@ type BulkInventoryGetItems = {
|
|
|
5626
5645
|
stage?: string;
|
|
5627
5646
|
succeed?: number;
|
|
5628
5647
|
total?: number;
|
|
5648
|
+
meta?: BulkMeta;
|
|
5649
|
+
};
|
|
5650
|
+
/** @returns {BulkMeta} */
|
|
5651
|
+
declare function BulkMeta(): BulkMeta;
|
|
5652
|
+
type BulkMeta = {
|
|
5653
|
+
/**
|
|
5654
|
+
* - Additional remarks or notes explaining the
|
|
5655
|
+
* context or reason for the bulk inventory action.
|
|
5656
|
+
*/
|
|
5657
|
+
comment?: string;
|
|
5658
|
+
/**
|
|
5659
|
+
* - A list of image URLs providing visual
|
|
5660
|
+
* evidence or supporting context for the comment.
|
|
5661
|
+
*/
|
|
5662
|
+
image_urls?: string[];
|
|
5629
5663
|
};
|
|
5630
5664
|
/** @returns {BulkProductJob} */
|
|
5631
5665
|
declare function BulkProductJob(): BulkProductJob;
|
|
@@ -5674,6 +5708,10 @@ type BulkJob = {
|
|
|
5674
5708
|
failed?: number;
|
|
5675
5709
|
failed_records?: any[];
|
|
5676
5710
|
file_path?: string;
|
|
5711
|
+
/**
|
|
5712
|
+
* - Type of inventory File
|
|
5713
|
+
*/
|
|
5714
|
+
file_type?: string;
|
|
5677
5715
|
/**
|
|
5678
5716
|
* - Whether the item is active or not.
|
|
5679
5717
|
*/
|
|
@@ -10072,7 +10110,7 @@ type PTErrorResponseSchema = {
|
|
|
10072
10110
|
declare function Page(): Page;
|
|
10073
10111
|
type Page = {
|
|
10074
10112
|
/**
|
|
10075
|
-
* - The total number of items
|
|
10113
|
+
* - The total number of all items across all pages.
|
|
10076
10114
|
*/
|
|
10077
10115
|
item_total?: number;
|
|
10078
10116
|
/**
|
|
@@ -13582,6 +13620,26 @@ type InventoryWeightResponseSchema = {
|
|
|
13582
13620
|
shipping?: number;
|
|
13583
13621
|
unit?: string;
|
|
13584
13622
|
};
|
|
13623
|
+
/** @returns {BulkInventoryJob} */
|
|
13624
|
+
declare function BulkInventoryJob(): BulkInventoryJob;
|
|
13625
|
+
type BulkInventoryJob = {
|
|
13626
|
+
/**
|
|
13627
|
+
* - Unique identifier of the company for which
|
|
13628
|
+
* the inventory update is being performed.
|
|
13629
|
+
*/
|
|
13630
|
+
company_id: string;
|
|
13631
|
+
/**
|
|
13632
|
+
* - Type of inventory update file being processed,
|
|
13633
|
+
* either price or quantity.
|
|
13634
|
+
*/
|
|
13635
|
+
file_type: string;
|
|
13636
|
+
/**
|
|
13637
|
+
* - URL of the uploaded file containing inventory
|
|
13638
|
+
* update data.
|
|
13639
|
+
*/
|
|
13640
|
+
file_path: string;
|
|
13641
|
+
meta?: BulkMeta;
|
|
13642
|
+
};
|
|
13585
13643
|
/** @returns {Marketplaces} */
|
|
13586
13644
|
declare function Marketplaces(): Marketplaces;
|
|
13587
13645
|
type Marketplaces = {
|
|
@@ -648,6 +648,15 @@ const Joi = require("joi");
|
|
|
648
648
|
* @property {string} [stage]
|
|
649
649
|
* @property {number} [succeed]
|
|
650
650
|
* @property {number} [total]
|
|
651
|
+
* @property {BulkMeta} [meta]
|
|
652
|
+
*/
|
|
653
|
+
|
|
654
|
+
/**
|
|
655
|
+
* @typedef BulkMeta
|
|
656
|
+
* @property {string} [comment] - Additional remarks or notes explaining the
|
|
657
|
+
* context or reason for the bulk inventory action.
|
|
658
|
+
* @property {string[]} [image_urls] - A list of image URLs providing visual
|
|
659
|
+
* evidence or supporting context for the comment.
|
|
651
660
|
*/
|
|
652
661
|
|
|
653
662
|
/**
|
|
@@ -675,6 +684,7 @@ const Joi = require("joi");
|
|
|
675
684
|
* @property {number} [failed]
|
|
676
685
|
* @property {Object[]} [failed_records]
|
|
677
686
|
* @property {string} [file_path]
|
|
687
|
+
* @property {string} [file_type] - Type of inventory File
|
|
678
688
|
* @property {boolean} [is_active] - Whether the item is active or not.
|
|
679
689
|
* @property {string} [modified_by] - The user who last modified the item.
|
|
680
690
|
* @property {string} [modified_on] - The date and time when the item was last modified.
|
|
@@ -2948,7 +2958,7 @@ const Joi = require("joi");
|
|
|
2948
2958
|
|
|
2949
2959
|
/**
|
|
2950
2960
|
* @typedef Page
|
|
2951
|
-
* @property {number} [item_total] - The total number of items
|
|
2961
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
2952
2962
|
* @property {string} [next_id] - The identifier for the next page.
|
|
2953
2963
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
2954
2964
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -4633,6 +4643,17 @@ const Joi = require("joi");
|
|
|
4633
4643
|
* @property {string} [unit]
|
|
4634
4644
|
*/
|
|
4635
4645
|
|
|
4646
|
+
/**
|
|
4647
|
+
* @typedef BulkInventoryJob
|
|
4648
|
+
* @property {string} company_id - Unique identifier of the company for which
|
|
4649
|
+
* the inventory update is being performed.
|
|
4650
|
+
* @property {string} file_type - Type of inventory update file being processed,
|
|
4651
|
+
* either price or quantity.
|
|
4652
|
+
* @property {string} file_path - URL of the uploaded file containing inventory
|
|
4653
|
+
* update data.
|
|
4654
|
+
* @property {BulkMeta} [meta]
|
|
4655
|
+
*/
|
|
4656
|
+
|
|
4636
4657
|
/**
|
|
4637
4658
|
* @typedef Marketplaces
|
|
4638
4659
|
* @property {number[]} [brand_ids]
|
|
@@ -5486,6 +5507,15 @@ class CatalogPlatformModel {
|
|
|
5486
5507
|
stage: Joi.string().allow(""),
|
|
5487
5508
|
succeed: Joi.number(),
|
|
5488
5509
|
total: Joi.number(),
|
|
5510
|
+
meta: CatalogPlatformModel.BulkMeta(),
|
|
5511
|
+
});
|
|
5512
|
+
}
|
|
5513
|
+
|
|
5514
|
+
/** @returns {BulkMeta} */
|
|
5515
|
+
static BulkMeta() {
|
|
5516
|
+
return Joi.object({
|
|
5517
|
+
comment: Joi.string().allow(""),
|
|
5518
|
+
image_urls: Joi.array().items(Joi.string().allow("")),
|
|
5489
5519
|
});
|
|
5490
5520
|
}
|
|
5491
5521
|
|
|
@@ -5514,6 +5544,7 @@ class CatalogPlatformModel {
|
|
|
5514
5544
|
failed: Joi.number(),
|
|
5515
5545
|
failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
5516
5546
|
file_path: Joi.string().allow(""),
|
|
5547
|
+
file_type: Joi.string().allow(""),
|
|
5517
5548
|
is_active: Joi.boolean(),
|
|
5518
5549
|
modified_by: Joi.string().allow("").allow(null),
|
|
5519
5550
|
modified_on: Joi.string().allow(""),
|
|
@@ -9737,6 +9768,16 @@ class CatalogPlatformModel {
|
|
|
9737
9768
|
});
|
|
9738
9769
|
}
|
|
9739
9770
|
|
|
9771
|
+
/** @returns {BulkInventoryJob} */
|
|
9772
|
+
static BulkInventoryJob() {
|
|
9773
|
+
return Joi.object({
|
|
9774
|
+
company_id: Joi.string().allow("").required(),
|
|
9775
|
+
file_type: Joi.string().allow("").required(),
|
|
9776
|
+
file_path: Joi.string().allow("").required(),
|
|
9777
|
+
meta: CatalogPlatformModel.BulkMeta(),
|
|
9778
|
+
});
|
|
9779
|
+
}
|
|
9780
|
+
|
|
9740
9781
|
/** @returns {Marketplaces} */
|
|
9741
9782
|
static Marketplaces() {
|
|
9742
9783
|
return Joi.object({
|
|
@@ -20,7 +20,7 @@ export = CatalogPlatformValidator;
|
|
|
20
20
|
*/
|
|
21
21
|
/**
|
|
22
22
|
* @typedef CreateBulkInventoryJobParam
|
|
23
|
-
* @property {CatalogPlatformModel.
|
|
23
|
+
* @property {CatalogPlatformModel.BulkInventoryJob} body
|
|
24
24
|
*/
|
|
25
25
|
/**
|
|
26
26
|
* @typedef CreateBulkProductUploadJobParam
|
|
@@ -91,7 +91,9 @@ export = CatalogPlatformValidator;
|
|
|
91
91
|
*/
|
|
92
92
|
/**
|
|
93
93
|
* @typedef DownloadInventoryTemplateViewParam
|
|
94
|
-
* @property {string}
|
|
94
|
+
* @property {string} schemaType - Specifies the type of template to download.
|
|
95
|
+
* Either quantity or price
|
|
96
|
+
* @property {string} type - File extension type
|
|
95
97
|
*/
|
|
96
98
|
/**
|
|
97
99
|
* @typedef DownloadProductTemplateViewsParam
|
|
@@ -183,6 +185,9 @@ export = CatalogPlatformValidator;
|
|
|
183
185
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
184
186
|
* Default is 12.
|
|
185
187
|
* @property {string} [search] - Search string to filter the results by batch id
|
|
188
|
+
* @property {string} [startDate] - Filter results by the job's start date.
|
|
189
|
+
* @property {string} [endDate] - Filter results by the job's end date.
|
|
190
|
+
* @property {string} [stage] - Filter results by the current stage of the import job.
|
|
186
191
|
*/
|
|
187
192
|
/**
|
|
188
193
|
* @typedef GetInventoryBySizeParam
|
|
@@ -387,6 +392,10 @@ export = CatalogPlatformValidator;
|
|
|
387
392
|
/**
|
|
388
393
|
* @typedef ListProductTemplateParam
|
|
389
394
|
* @property {string} department - A `department` is the name of a particular department.
|
|
395
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
396
|
+
* set of results
|
|
397
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
398
|
+
* Default is 12.
|
|
390
399
|
*/
|
|
391
400
|
/**
|
|
392
401
|
* @typedef ListProductTemplateCategoriesParam
|
|
@@ -482,6 +491,7 @@ export = CatalogPlatformValidator;
|
|
|
482
491
|
* @typedef ValidateProductTemplateSchemaParam
|
|
483
492
|
* @property {string} itemType - An `item_type` defines the type of item. The
|
|
484
493
|
* default value is standard.
|
|
494
|
+
* @property {string} [schemaType] - Schema of price or quantity template
|
|
485
495
|
*/
|
|
486
496
|
declare class CatalogPlatformValidator {
|
|
487
497
|
/** @returns {AddInventoryParam} */
|
|
@@ -670,7 +680,7 @@ type CreateBulkInventoryParam = {
|
|
|
670
680
|
body: CatalogPlatformModel.InventoryBulkRequestSchema;
|
|
671
681
|
};
|
|
672
682
|
type CreateBulkInventoryJobParam = {
|
|
673
|
-
body: CatalogPlatformModel.
|
|
683
|
+
body: CatalogPlatformModel.BulkInventoryJob;
|
|
674
684
|
};
|
|
675
685
|
type CreateBulkProductUploadJobParam = {
|
|
676
686
|
body: CatalogPlatformModel.BulkJob;
|
|
@@ -753,9 +763,14 @@ type DeleteSizeParam = {
|
|
|
753
763
|
};
|
|
754
764
|
type DownloadInventoryTemplateViewParam = {
|
|
755
765
|
/**
|
|
756
|
-
* -
|
|
766
|
+
* - Specifies the type of template to download.
|
|
767
|
+
* Either quantity or price
|
|
757
768
|
*/
|
|
758
|
-
|
|
769
|
+
schemaType: string;
|
|
770
|
+
/**
|
|
771
|
+
* - File extension type
|
|
772
|
+
*/
|
|
773
|
+
type: string;
|
|
759
774
|
};
|
|
760
775
|
type DownloadProductTemplateViewsParam = {
|
|
761
776
|
/**
|
|
@@ -948,6 +963,18 @@ type GetInventoryBulkUploadHistoryParam = {
|
|
|
948
963
|
* - Search string to filter the results by batch id
|
|
949
964
|
*/
|
|
950
965
|
search?: string;
|
|
966
|
+
/**
|
|
967
|
+
* - Filter results by the job's start date.
|
|
968
|
+
*/
|
|
969
|
+
startDate?: string;
|
|
970
|
+
/**
|
|
971
|
+
* - Filter results by the job's end date.
|
|
972
|
+
*/
|
|
973
|
+
endDate?: string;
|
|
974
|
+
/**
|
|
975
|
+
* - Filter results by the current stage of the import job.
|
|
976
|
+
*/
|
|
977
|
+
stage?: string;
|
|
951
978
|
};
|
|
952
979
|
type GetInventoryBySizeParam = {
|
|
953
980
|
/**
|
|
@@ -1391,6 +1418,16 @@ type ListProductTemplateParam = {
|
|
|
1391
1418
|
* - A `department` is the name of a particular department.
|
|
1392
1419
|
*/
|
|
1393
1420
|
department: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* - The page number to navigate through the given
|
|
1423
|
+
* set of results
|
|
1424
|
+
*/
|
|
1425
|
+
pageNo?: number;
|
|
1426
|
+
/**
|
|
1427
|
+
* - Number of items to retrieve in each page.
|
|
1428
|
+
* Default is 12.
|
|
1429
|
+
*/
|
|
1430
|
+
pageSize?: number;
|
|
1394
1431
|
};
|
|
1395
1432
|
type ListProductTemplateCategoriesParam = {
|
|
1396
1433
|
/**
|
|
@@ -1540,6 +1577,10 @@ type ValidateProductTemplateSchemaParam = {
|
|
|
1540
1577
|
* default value is standard.
|
|
1541
1578
|
*/
|
|
1542
1579
|
itemType: string;
|
|
1580
|
+
/**
|
|
1581
|
+
* - Schema of price or quantity template
|
|
1582
|
+
*/
|
|
1583
|
+
schemaType?: string;
|
|
1543
1584
|
};
|
|
1544
1585
|
type GetCompanyDetailParam = any;
|
|
1545
1586
|
type GetCompanyMetricsParam = any;
|
|
@@ -27,7 +27,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
29
|
* @typedef CreateBulkInventoryJobParam
|
|
30
|
-
* @property {CatalogPlatformModel.
|
|
30
|
+
* @property {CatalogPlatformModel.BulkInventoryJob} body
|
|
31
31
|
*/
|
|
32
32
|
|
|
33
33
|
/**
|
|
@@ -114,7 +114,9 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
114
114
|
|
|
115
115
|
/**
|
|
116
116
|
* @typedef DownloadInventoryTemplateViewParam
|
|
117
|
-
* @property {string}
|
|
117
|
+
* @property {string} schemaType - Specifies the type of template to download.
|
|
118
|
+
* Either quantity or price
|
|
119
|
+
* @property {string} type - File extension type
|
|
118
120
|
*/
|
|
119
121
|
|
|
120
122
|
/**
|
|
@@ -219,6 +221,9 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
219
221
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
220
222
|
* Default is 12.
|
|
221
223
|
* @property {string} [search] - Search string to filter the results by batch id
|
|
224
|
+
* @property {string} [startDate] - Filter results by the job's start date.
|
|
225
|
+
* @property {string} [endDate] - Filter results by the job's end date.
|
|
226
|
+
* @property {string} [stage] - Filter results by the current stage of the import job.
|
|
222
227
|
*/
|
|
223
228
|
|
|
224
229
|
/**
|
|
@@ -451,6 +456,10 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
451
456
|
/**
|
|
452
457
|
* @typedef ListProductTemplateParam
|
|
453
458
|
* @property {string} department - A `department` is the name of a particular department.
|
|
459
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
460
|
+
* set of results
|
|
461
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
462
|
+
* Default is 12.
|
|
454
463
|
*/
|
|
455
464
|
|
|
456
465
|
/**
|
|
@@ -561,6 +570,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
561
570
|
* @typedef ValidateProductTemplateSchemaParam
|
|
562
571
|
* @property {string} itemType - An `item_type` defines the type of item. The
|
|
563
572
|
* default value is standard.
|
|
573
|
+
* @property {string} [schemaType] - Schema of price or quantity template
|
|
564
574
|
*/
|
|
565
575
|
|
|
566
576
|
class CatalogPlatformValidator {
|
|
@@ -598,7 +608,7 @@ class CatalogPlatformValidator {
|
|
|
598
608
|
/** @returns {CreateBulkInventoryJobParam} */
|
|
599
609
|
static createBulkInventoryJob() {
|
|
600
610
|
return Joi.object({
|
|
601
|
-
body: CatalogPlatformModel.
|
|
611
|
+
body: CatalogPlatformModel.BulkInventoryJob().required(),
|
|
602
612
|
}).required();
|
|
603
613
|
}
|
|
604
614
|
|
|
@@ -715,7 +725,8 @@ class CatalogPlatformValidator {
|
|
|
715
725
|
/** @returns {DownloadInventoryTemplateViewParam} */
|
|
716
726
|
static downloadInventoryTemplateView() {
|
|
717
727
|
return Joi.object({
|
|
718
|
-
|
|
728
|
+
schemaType: Joi.string().allow("").required(),
|
|
729
|
+
type: Joi.string().allow("").required(),
|
|
719
730
|
}).required();
|
|
720
731
|
}
|
|
721
732
|
|
|
@@ -831,6 +842,9 @@ class CatalogPlatformValidator {
|
|
|
831
842
|
pageNo: Joi.number(),
|
|
832
843
|
pageSize: Joi.number(),
|
|
833
844
|
search: Joi.string().allow(""),
|
|
845
|
+
startDate: Joi.string().allow(""),
|
|
846
|
+
endDate: Joi.string().allow(""),
|
|
847
|
+
stage: Joi.string().allow(""),
|
|
834
848
|
}).required();
|
|
835
849
|
}
|
|
836
850
|
|
|
@@ -1083,6 +1097,8 @@ class CatalogPlatformValidator {
|
|
|
1083
1097
|
static listProductTemplate() {
|
|
1084
1098
|
return Joi.object({
|
|
1085
1099
|
department: Joi.string().allow("").required(),
|
|
1100
|
+
pageNo: Joi.number(),
|
|
1101
|
+
pageSize: Joi.number(),
|
|
1086
1102
|
}).required();
|
|
1087
1103
|
}
|
|
1088
1104
|
|
|
@@ -1204,6 +1220,7 @@ class CatalogPlatformValidator {
|
|
|
1204
1220
|
static validateProductTemplateSchema() {
|
|
1205
1221
|
return Joi.object({
|
|
1206
1222
|
itemType: Joi.string().allow("").required(),
|
|
1223
|
+
schemaType: Joi.string().allow(""),
|
|
1207
1224
|
}).required();
|
|
1208
1225
|
}
|
|
1209
1226
|
}
|
|
@@ -9,7 +9,7 @@ declare class Common {
|
|
|
9
9
|
* @returns {Promise<CommonPlatformModel.Locations>} - Success response
|
|
10
10
|
* @name getLocations
|
|
11
11
|
* @summary: Get company locations
|
|
12
|
-
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://
|
|
12
|
+
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/common/getLocations/).
|
|
13
13
|
*/
|
|
14
14
|
getLocations({ locationType, id, requestHeaders }?: CommonPlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CommonPlatformModel.Locations>;
|
|
15
15
|
/**
|
|
@@ -20,7 +20,7 @@ declare class Common {
|
|
|
20
20
|
* Success response
|
|
21
21
|
* @name searchApplication
|
|
22
22
|
* @summary: List sales channel categories
|
|
23
|
-
* @description: This API retrieves details for a specific sales channel based on the provided search criteria. The search can be performed using the name of the sales channel - Check out [method documentation](https://
|
|
23
|
+
* @description: This API retrieves details for a specific sales channel based on the provided search criteria. The search can be performed using the name of the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/common/searchApplication/).
|
|
24
24
|
*/
|
|
25
25
|
searchApplication({ authorization, query, requestHeaders }?: CommonPlatformValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<CommonPlatformModel.ApplicationResponseSchema>;
|
|
26
26
|
}
|
|
@@ -21,7 +21,7 @@ class Common {
|
|
|
21
21
|
* @returns {Promise<CommonPlatformModel.Locations>} - Success response
|
|
22
22
|
* @name getLocations
|
|
23
23
|
* @summary: Get company locations
|
|
24
|
-
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://
|
|
24
|
+
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/common/getLocations/).
|
|
25
25
|
*/
|
|
26
26
|
async getLocations(
|
|
27
27
|
{ locationType, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -97,7 +97,7 @@ class Common {
|
|
|
97
97
|
* Success response
|
|
98
98
|
* @name searchApplication
|
|
99
99
|
* @summary: List sales channel categories
|
|
100
|
-
* @description: This API retrieves details for a specific sales channel based on the provided search criteria. The search can be performed using the name of the sales channel - Check out [method documentation](https://
|
|
100
|
+
* @description: This API retrieves details for a specific sales channel based on the provided search criteria. The search can be performed using the name of the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/common/searchApplication/).
|
|
101
101
|
*/
|
|
102
102
|
async searchApplication(
|
|
103
103
|
{ authorization, query, requestHeaders } = { requestHeaders: {} },
|