@gofynd/fdk-client-javascript 1.6.3 → 2.0.0
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 +5 -5
- package/sdk/application/Cart/CartApplicationClient.js +26 -268
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +20 -20
- package/sdk/application/Catalog/CatalogApplicationClient.js +98 -347
- package/sdk/application/Common/CommonApplicationClient.js +1 -16
- package/sdk/application/Communication/CommunicationApplicationClient.js +1 -24
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +24 -2
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +58 -137
- package/sdk/application/Content/ContentApplicationClient.d.ts +47 -7
- package/sdk/application/Content/ContentApplicationClient.js +222 -191
- 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 +16 -56
- package/sdk/application/Logistic/LogisticApplicationClient.js +57 -332
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
- package/sdk/application/Order/OrderApplicationClient.js +68 -153
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -12
- package/sdk/application/Payment/PaymentApplicationClient.js +7 -487
- 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/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -55
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +1 -408
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -37
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +2 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +29 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +65 -42
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1008 -794
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +573 -460
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +10 -5
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +64 -1
- package/sdk/partner/Webhook/WebhookPartnerModel.js +36 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +67 -9
- package/sdk/platform/Cart/CartPlatformModel.js +38 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.js +4 -4
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +47 -13
- package/sdk/platform/Catalog/CatalogPlatformModel.js +29 -7
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +7 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +71 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +70 -6
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +0 -27
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +8 -60
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -3
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +13 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +68 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +49 -7
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +169 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1279 -132
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +156 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +180 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +162 -0
- package/sdk/platform/Content/ContentPlatformClient.js +1697 -497
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1053 -35
- package/sdk/platform/Content/ContentPlatformModel.js +717 -34
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +127 -1
- package/sdk/platform/Content/ContentPlatformValidator.js +171 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +34 -0
- package/sdk/platform/Discount/DiscountPlatformClient.js +59 -0
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +365 -93
- package/sdk/platform/Discount/DiscountPlatformModel.js +98 -93
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +54 -34
- package/sdk/platform/Discount/DiscountPlatformValidator.js +27 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +0 -156
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +0 -1072
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -137
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -173
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +1 -1105
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +0 -1125
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -0
- package/sdk/platform/Lead/LeadPlatformModel.js +2 -0
- 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 +212 -0
- package/sdk/platform/Order/OrderPlatformClient.js +397 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +66 -10
- package/sdk/platform/Order/OrderPlatformModel.js +39 -7
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +58 -10
- package/sdk/platform/Partner/PartnerPlatformModel.js +19 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +8 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +5 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.js +2 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +240 -24
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +1753 -277
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +320 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +269 -19
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -104
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +201 -629
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +5720 -2891
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3414 -2181
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +138 -216
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +81 -148
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +73 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +543 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +129 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +97 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +269 -6
- package/sdk/platform/User/UserPlatformModel.js +187 -5
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +64 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +36 -0
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +6 -11
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -16
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -3
- package/sdk/public/Content/ContentPublicClient.js +261 -104
- package/sdk/public/Content/ContentPublicModel.d.ts +155 -1
- package/sdk/public/Content/ContentPublicModel.js +102 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -1
- package/sdk/public/Content/ContentPublicValidator.js +26 -0
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.js +1 -40
|
@@ -64,7 +64,7 @@ class Catalog {
|
|
|
64
64
|
const response = await PlatformAPIClient.execute(
|
|
65
65
|
this.config,
|
|
66
66
|
"post",
|
|
67
|
-
`/service/platform/catalog/
|
|
67
|
+
`/service/platform/catalog/v2.0/company/${this.config.companyId}/products/${itemId}/sizes/${size}`,
|
|
68
68
|
query_params,
|
|
69
69
|
body,
|
|
70
70
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -2346,7 +2346,7 @@ class Catalog {
|
|
|
2346
2346
|
const response = await PlatformAPIClient.execute(
|
|
2347
2347
|
this.config,
|
|
2348
2348
|
"get",
|
|
2349
|
-
`/service/platform/catalog/
|
|
2349
|
+
`/service/platform/catalog/v2.0/company/${this.config.companyId}/marketplaces/company-details/`,
|
|
2350
2350
|
query_params,
|
|
2351
2351
|
undefined,
|
|
2352
2352
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -3023,7 +3023,7 @@ class Catalog {
|
|
|
3023
3023
|
const response = await PlatformAPIClient.execute(
|
|
3024
3024
|
this.config,
|
|
3025
3025
|
"get",
|
|
3026
|
-
`/service/platform/catalog/
|
|
3026
|
+
`/service/platform/catalog/v2.0/company/${this.config.companyId}/products/${itemId}/sizes/${size}`,
|
|
3027
3027
|
query_params,
|
|
3028
3028
|
undefined,
|
|
3029
3029
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -5057,7 +5057,7 @@ class Catalog {
|
|
|
5057
5057
|
const response = await PlatformAPIClient.execute(
|
|
5058
5058
|
this.config,
|
|
5059
5059
|
"get",
|
|
5060
|
-
`/service/platform/catalog/
|
|
5060
|
+
`/service/platform/catalog/v2.0/company/${this.config.companyId}/marketplaces/location-details/`,
|
|
5061
5061
|
query_params,
|
|
5062
5062
|
undefined,
|
|
5063
5063
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -219,8 +219,7 @@ export = CatalogPlatformModel;
|
|
|
219
219
|
* with the product.
|
|
220
220
|
* @property {number} category_uid - The unique identifier for the category to
|
|
221
221
|
* which the product belongs.
|
|
222
|
-
* @property {
|
|
223
|
-
* product, typically represented as an integer.
|
|
222
|
+
* @property {string} [verification_status] - Verification status of the product.
|
|
224
223
|
* @property {string} [channel_identifier] - The identifier for the sales
|
|
225
224
|
* channel through which the product is sold.
|
|
226
225
|
* @property {string} [category_slug] - A URL-friendly string representing the
|
|
@@ -257,7 +256,7 @@ export = CatalogPlatformModel;
|
|
|
257
256
|
* variants of one another.
|
|
258
257
|
* @property {MultiCategoriesSchema[]} [multi_categories]
|
|
259
258
|
* @property {string} [template_tag] - Tag used for categorizing or templating purposes.
|
|
260
|
-
* @property {
|
|
259
|
+
* @property {NetQuantitySchema} [net_quantity]
|
|
261
260
|
* @property {CustomOrder} [custom_order]
|
|
262
261
|
* @property {string} country_of_origin - Country where the product is
|
|
263
262
|
* manufactured or sourced from.
|
|
@@ -267,6 +266,9 @@ export = CatalogPlatformModel;
|
|
|
267
266
|
* @property {CustomMeta[]} [_custom_meta] - Custom meta associated with the product.
|
|
268
267
|
* @property {number} [discount_percentage] - The discount applied to the
|
|
269
268
|
* product in percentage.
|
|
269
|
+
* @property {number} [no_of_boxes] - Number of boxes containing the product.
|
|
270
|
+
* @property {string} [created_on] - The date and time when the product was created
|
|
271
|
+
* @property {string} [modified_on] - The date and time when the product was last modified
|
|
270
272
|
*/
|
|
271
273
|
/**
|
|
272
274
|
* @typedef ApplicationProductListingResponseSchema
|
|
@@ -1380,7 +1382,7 @@ export = CatalogPlatformModel;
|
|
|
1380
1382
|
* for geolocation purposes.
|
|
1381
1383
|
* @property {number} [longitude] - The longitude coordinate of the address,
|
|
1382
1384
|
* used for geolocation purposes.
|
|
1383
|
-
* @property {
|
|
1385
|
+
* @property {string} [pincode] - The postal code or ZIP code associated with the address.
|
|
1384
1386
|
* @property {string} [state] - The state or region where the address is located.
|
|
1385
1387
|
*/
|
|
1386
1388
|
/**
|
|
@@ -2691,6 +2693,7 @@ export = CatalogPlatformModel;
|
|
|
2691
2693
|
* @property {number} [current] - The current page number.
|
|
2692
2694
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
2693
2695
|
* @property {number} [size] - The number of items per page.
|
|
2696
|
+
* @property {number} [page_size] - The number of items per page.
|
|
2694
2697
|
*/
|
|
2695
2698
|
/**
|
|
2696
2699
|
* @typedef PageResponseSchema
|
|
@@ -4258,6 +4261,12 @@ export = CatalogPlatformModel;
|
|
|
4258
4261
|
* @property {number} [department] - The department associated with the L3
|
|
4259
4262
|
* category of the product.
|
|
4260
4263
|
*/
|
|
4264
|
+
/**
|
|
4265
|
+
* @typedef NetQuantitySchema
|
|
4266
|
+
* @property {string} [unit] - Specifies the unit of measurement for the net quantity.
|
|
4267
|
+
* @property {number} [value] - The numerical value representing the net
|
|
4268
|
+
* quantity of the product.
|
|
4269
|
+
*/
|
|
4261
4270
|
/**
|
|
4262
4271
|
* @typedef CustomMeta
|
|
4263
4272
|
* @property {string} key - The key of the metadata. Should be a non-empty
|
|
@@ -4319,7 +4328,7 @@ export = CatalogPlatformModel;
|
|
|
4319
4328
|
declare class CatalogPlatformModel {
|
|
4320
4329
|
}
|
|
4321
4330
|
declare namespace CatalogPlatformModel {
|
|
4322
|
-
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, DeleteProductRequestBody, 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, ProductCreateUpdateSchemaV2, 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, CustomMeta, PageType, CurrencyCodeEnum };
|
|
4331
|
+
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, DeleteProductRequestBody, 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, ProductCreateUpdateSchemaV2, 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, CurrencyCodeEnum };
|
|
4323
4332
|
}
|
|
4324
4333
|
/** @returns {Action} */
|
|
4325
4334
|
declare function Action(): Action;
|
|
@@ -4799,10 +4808,9 @@ type ApplicationProductsSchema = {
|
|
|
4799
4808
|
*/
|
|
4800
4809
|
category_uid: number;
|
|
4801
4810
|
/**
|
|
4802
|
-
* -
|
|
4803
|
-
* product, typically represented as an integer.
|
|
4811
|
+
* - Verification status of the product.
|
|
4804
4812
|
*/
|
|
4805
|
-
verification_status?:
|
|
4813
|
+
verification_status?: string;
|
|
4806
4814
|
/**
|
|
4807
4815
|
* - The identifier for the sales
|
|
4808
4816
|
* channel through which the product is sold.
|
|
@@ -4899,10 +4907,7 @@ type ApplicationProductsSchema = {
|
|
|
4899
4907
|
* - Tag used for categorizing or templating purposes.
|
|
4900
4908
|
*/
|
|
4901
4909
|
template_tag?: string;
|
|
4902
|
-
|
|
4903
|
-
* - Net quantity details for the product.
|
|
4904
|
-
*/
|
|
4905
|
-
net_quantity?: any;
|
|
4910
|
+
net_quantity?: NetQuantitySchema;
|
|
4906
4911
|
custom_order?: CustomOrder;
|
|
4907
4912
|
/**
|
|
4908
4913
|
* - Country where the product is
|
|
@@ -4930,6 +4935,18 @@ type ApplicationProductsSchema = {
|
|
|
4930
4935
|
* product in percentage.
|
|
4931
4936
|
*/
|
|
4932
4937
|
discount_percentage?: number;
|
|
4938
|
+
/**
|
|
4939
|
+
* - Number of boxes containing the product.
|
|
4940
|
+
*/
|
|
4941
|
+
no_of_boxes?: number;
|
|
4942
|
+
/**
|
|
4943
|
+
* - The date and time when the product was created
|
|
4944
|
+
*/
|
|
4945
|
+
created_on?: string;
|
|
4946
|
+
/**
|
|
4947
|
+
* - The date and time when the product was last modified
|
|
4948
|
+
*/
|
|
4949
|
+
modified_on?: string;
|
|
4933
4950
|
};
|
|
4934
4951
|
/** @returns {ApplicationProductListingResponseSchema} */
|
|
4935
4952
|
declare function ApplicationProductListingResponseSchema(): ApplicationProductListingResponseSchema;
|
|
@@ -7185,7 +7202,7 @@ type GetAddressSchema = {
|
|
|
7185
7202
|
/**
|
|
7186
7203
|
* - The postal code or ZIP code associated with the address.
|
|
7187
7204
|
*/
|
|
7188
|
-
pincode?:
|
|
7205
|
+
pincode?: string;
|
|
7189
7206
|
/**
|
|
7190
7207
|
* - The state or region where the address is located.
|
|
7191
7208
|
*/
|
|
@@ -10053,6 +10070,10 @@ type Page = {
|
|
|
10053
10070
|
* - The number of items per page.
|
|
10054
10071
|
*/
|
|
10055
10072
|
size?: number;
|
|
10073
|
+
/**
|
|
10074
|
+
* - The number of items per page.
|
|
10075
|
+
*/
|
|
10076
|
+
page_size?: number;
|
|
10056
10077
|
};
|
|
10057
10078
|
/** @returns {PageResponseSchema} */
|
|
10058
10079
|
declare function PageResponseSchema(): PageResponseSchema;
|
|
@@ -13505,6 +13526,19 @@ type MultiCategoriesSchema = {
|
|
|
13505
13526
|
*/
|
|
13506
13527
|
department?: number;
|
|
13507
13528
|
};
|
|
13529
|
+
/** @returns {NetQuantitySchema} */
|
|
13530
|
+
declare function NetQuantitySchema(): NetQuantitySchema;
|
|
13531
|
+
type NetQuantitySchema = {
|
|
13532
|
+
/**
|
|
13533
|
+
* - Specifies the unit of measurement for the net quantity.
|
|
13534
|
+
*/
|
|
13535
|
+
unit?: string;
|
|
13536
|
+
/**
|
|
13537
|
+
* - The numerical value representing the net
|
|
13538
|
+
* quantity of the product.
|
|
13539
|
+
*/
|
|
13540
|
+
value?: number;
|
|
13541
|
+
};
|
|
13508
13542
|
/** @returns {CustomMeta} */
|
|
13509
13543
|
declare function CustomMeta(): CustomMeta;
|
|
13510
13544
|
type CustomMeta = {
|
|
@@ -239,8 +239,7 @@ const Joi = require("joi");
|
|
|
239
239
|
* with the product.
|
|
240
240
|
* @property {number} category_uid - The unique identifier for the category to
|
|
241
241
|
* which the product belongs.
|
|
242
|
-
* @property {
|
|
243
|
-
* product, typically represented as an integer.
|
|
242
|
+
* @property {string} [verification_status] - Verification status of the product.
|
|
244
243
|
* @property {string} [channel_identifier] - The identifier for the sales
|
|
245
244
|
* channel through which the product is sold.
|
|
246
245
|
* @property {string} [category_slug] - A URL-friendly string representing the
|
|
@@ -277,7 +276,7 @@ const Joi = require("joi");
|
|
|
277
276
|
* variants of one another.
|
|
278
277
|
* @property {MultiCategoriesSchema[]} [multi_categories]
|
|
279
278
|
* @property {string} [template_tag] - Tag used for categorizing or templating purposes.
|
|
280
|
-
* @property {
|
|
279
|
+
* @property {NetQuantitySchema} [net_quantity]
|
|
281
280
|
* @property {CustomOrder} [custom_order]
|
|
282
281
|
* @property {string} country_of_origin - Country where the product is
|
|
283
282
|
* manufactured or sourced from.
|
|
@@ -287,6 +286,9 @@ const Joi = require("joi");
|
|
|
287
286
|
* @property {CustomMeta[]} [_custom_meta] - Custom meta associated with the product.
|
|
288
287
|
* @property {number} [discount_percentage] - The discount applied to the
|
|
289
288
|
* product in percentage.
|
|
289
|
+
* @property {number} [no_of_boxes] - Number of boxes containing the product.
|
|
290
|
+
* @property {string} [created_on] - The date and time when the product was created
|
|
291
|
+
* @property {string} [modified_on] - The date and time when the product was last modified
|
|
290
292
|
*/
|
|
291
293
|
|
|
292
294
|
/**
|
|
@@ -1519,7 +1521,7 @@ const Joi = require("joi");
|
|
|
1519
1521
|
* for geolocation purposes.
|
|
1520
1522
|
* @property {number} [longitude] - The longitude coordinate of the address,
|
|
1521
1523
|
* used for geolocation purposes.
|
|
1522
|
-
* @property {
|
|
1524
|
+
* @property {string} [pincode] - The postal code or ZIP code associated with the address.
|
|
1523
1525
|
* @property {string} [state] - The state or region where the address is located.
|
|
1524
1526
|
*/
|
|
1525
1527
|
|
|
@@ -2962,6 +2964,7 @@ const Joi = require("joi");
|
|
|
2962
2964
|
* @property {number} [current] - The current page number.
|
|
2963
2965
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
2964
2966
|
* @property {number} [size] - The number of items per page.
|
|
2967
|
+
* @property {number} [page_size] - The number of items per page.
|
|
2965
2968
|
*/
|
|
2966
2969
|
|
|
2967
2970
|
/**
|
|
@@ -4672,6 +4675,13 @@ const Joi = require("joi");
|
|
|
4672
4675
|
* category of the product.
|
|
4673
4676
|
*/
|
|
4674
4677
|
|
|
4678
|
+
/**
|
|
4679
|
+
* @typedef NetQuantitySchema
|
|
4680
|
+
* @property {string} [unit] - Specifies the unit of measurement for the net quantity.
|
|
4681
|
+
* @property {number} [value] - The numerical value representing the net
|
|
4682
|
+
* quantity of the product.
|
|
4683
|
+
*/
|
|
4684
|
+
|
|
4675
4685
|
/**
|
|
4676
4686
|
* @typedef CustomMeta
|
|
4677
4687
|
* @property {string} key - The key of the metadata. Should be a non-empty
|
|
@@ -4975,7 +4985,7 @@ class CatalogPlatformModel {
|
|
|
4975
4985
|
popularity: Joi.number(),
|
|
4976
4986
|
brand_uid: Joi.number().required(),
|
|
4977
4987
|
category_uid: Joi.number().required(),
|
|
4978
|
-
verification_status: Joi.
|
|
4988
|
+
verification_status: Joi.string().allow(""),
|
|
4979
4989
|
channel_identifier: Joi.string().allow(""),
|
|
4980
4990
|
category_slug: Joi.string().allow(""),
|
|
4981
4991
|
size_guide: Joi.string().allow(""),
|
|
@@ -5001,7 +5011,7 @@ class CatalogPlatformModel {
|
|
|
5001
5011
|
CatalogPlatformModel.MultiCategoriesSchema()
|
|
5002
5012
|
),
|
|
5003
5013
|
template_tag: Joi.string().allow(""),
|
|
5004
|
-
net_quantity:
|
|
5014
|
+
net_quantity: CatalogPlatformModel.NetQuantitySchema(),
|
|
5005
5015
|
custom_order: CatalogPlatformModel.CustomOrder(),
|
|
5006
5016
|
country_of_origin: Joi.string().allow("").required(),
|
|
5007
5017
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
@@ -5009,6 +5019,9 @@ class CatalogPlatformModel {
|
|
|
5009
5019
|
item_id: Joi.number(),
|
|
5010
5020
|
_custom_meta: Joi.array().items(CatalogPlatformModel.CustomMeta()),
|
|
5011
5021
|
discount_percentage: Joi.number(),
|
|
5022
|
+
no_of_boxes: Joi.number(),
|
|
5023
|
+
created_on: Joi.string().allow(""),
|
|
5024
|
+
modified_on: Joi.string().allow(""),
|
|
5012
5025
|
});
|
|
5013
5026
|
}
|
|
5014
5027
|
|
|
@@ -6371,7 +6384,7 @@ class CatalogPlatformModel {
|
|
|
6371
6384
|
landmark: Joi.string().allow(""),
|
|
6372
6385
|
latitude: Joi.number(),
|
|
6373
6386
|
longitude: Joi.number(),
|
|
6374
|
-
pincode: Joi.
|
|
6387
|
+
pincode: Joi.string().allow(""),
|
|
6375
6388
|
state: Joi.string().allow(""),
|
|
6376
6389
|
});
|
|
6377
6390
|
}
|
|
@@ -7946,6 +7959,7 @@ class CatalogPlatformModel {
|
|
|
7946
7959
|
current: Joi.number(),
|
|
7947
7960
|
type: Joi.string().allow("").required(),
|
|
7948
7961
|
size: Joi.number(),
|
|
7962
|
+
page_size: Joi.number(),
|
|
7949
7963
|
});
|
|
7950
7964
|
}
|
|
7951
7965
|
|
|
@@ -9747,6 +9761,14 @@ class CatalogPlatformModel {
|
|
|
9747
9761
|
});
|
|
9748
9762
|
}
|
|
9749
9763
|
|
|
9764
|
+
/** @returns {NetQuantitySchema} */
|
|
9765
|
+
static NetQuantitySchema() {
|
|
9766
|
+
return Joi.object({
|
|
9767
|
+
unit: Joi.string().allow(""),
|
|
9768
|
+
value: Joi.number(),
|
|
9769
|
+
});
|
|
9770
|
+
}
|
|
9771
|
+
|
|
9750
9772
|
/** @returns {CustomMeta} */
|
|
9751
9773
|
static CustomMeta() {
|
|
9752
9774
|
return Joi.object({
|
|
@@ -642,13 +642,13 @@ declare class Communication {
|
|
|
642
642
|
*
|
|
643
643
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
644
644
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
645
|
-
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates
|
|
645
|
+
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates>} -
|
|
646
646
|
* Success response
|
|
647
647
|
* @name getSystemSmsTemplates
|
|
648
648
|
* @summary: Gets all system SMS templates
|
|
649
649
|
* @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
|
|
650
650
|
*/
|
|
651
|
-
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates
|
|
651
|
+
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates>;
|
|
652
652
|
/**
|
|
653
653
|
* @param {CommunicationPlatformApplicationValidator.PostGlobalVariablesParam} arg
|
|
654
654
|
* - Arg object
|
|
@@ -4285,7 +4285,7 @@ class Communication {
|
|
|
4285
4285
|
*
|
|
4286
4286
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4287
4287
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4288
|
-
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates
|
|
4288
|
+
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates>} -
|
|
4289
4289
|
* Success response
|
|
4290
4290
|
* @name getSystemSmsTemplates
|
|
4291
4291
|
* @summary: Gets all system SMS templates
|
|
@@ -4336,9 +4336,12 @@ class Communication {
|
|
|
4336
4336
|
responseData = response[0];
|
|
4337
4337
|
}
|
|
4338
4338
|
|
|
4339
|
-
const {
|
|
4340
|
-
|
|
4341
|
-
|
|
4339
|
+
const {
|
|
4340
|
+
error: res_error,
|
|
4341
|
+
} = CommunicationPlatformModel.SystemSmsTemplates().validate(responseData, {
|
|
4342
|
+
abortEarly: false,
|
|
4343
|
+
allowUnknown: true,
|
|
4344
|
+
});
|
|
4342
4345
|
|
|
4343
4346
|
if (res_error) {
|
|
4344
4347
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -425,12 +425,12 @@ export = CommunicationPlatformModel;
|
|
|
425
425
|
/**
|
|
426
426
|
* @typedef EventSubscriptionTemplateSms
|
|
427
427
|
* @property {boolean} [subscribed]
|
|
428
|
-
* @property {
|
|
428
|
+
* @property {SmsTemplate} [template]
|
|
429
429
|
*/
|
|
430
430
|
/**
|
|
431
431
|
* @typedef EventSubscriptionTemplateEmail
|
|
432
432
|
* @property {boolean} [subscribed]
|
|
433
|
-
* @property {
|
|
433
|
+
* @property {EmailTemplate} [template]
|
|
434
434
|
*/
|
|
435
435
|
/**
|
|
436
436
|
* @typedef EventSubscriptionTemplate
|
|
@@ -443,12 +443,31 @@ export = CommunicationPlatformModel;
|
|
|
443
443
|
* @property {boolean} [is_default]
|
|
444
444
|
* @property {string} [_id]
|
|
445
445
|
* @property {string} [application]
|
|
446
|
-
* @property {
|
|
446
|
+
* @property {EventSubscriptionEvents} [event]
|
|
447
447
|
* @property {string} [slug]
|
|
448
448
|
* @property {string} [created_at]
|
|
449
449
|
* @property {string} [updated_at]
|
|
450
450
|
* @property {number} [__v]
|
|
451
451
|
*/
|
|
452
|
+
/**
|
|
453
|
+
* @typedef EventSubscriptionEvents
|
|
454
|
+
* @property {string} [category]
|
|
455
|
+
* @property {string} [event_name]
|
|
456
|
+
* @property {string} [group]
|
|
457
|
+
* @property {string} [slug]
|
|
458
|
+
* @property {EventTemplate} [template]
|
|
459
|
+
*/
|
|
460
|
+
/**
|
|
461
|
+
* @typedef EventTemplate
|
|
462
|
+
* @property {EventProviderTemplates} [email]
|
|
463
|
+
* @property {EventProviderTemplates} [pushnotification]
|
|
464
|
+
* @property {EventProviderTemplates} [sms]
|
|
465
|
+
*/
|
|
466
|
+
/**
|
|
467
|
+
* @typedef EventProviderTemplates
|
|
468
|
+
* @property {string} [provider_type] - Provider type for the event template
|
|
469
|
+
* @property {string} [template] - This is the unique id of the template
|
|
470
|
+
*/
|
|
452
471
|
/**
|
|
453
472
|
* @typedef EventSubscriptions
|
|
454
473
|
* @property {EventSubscription[]} [items]
|
|
@@ -740,6 +759,10 @@ export = CommunicationPlatformModel;
|
|
|
740
759
|
*/
|
|
741
760
|
/**
|
|
742
761
|
* @typedef SystemSmsTemplates
|
|
762
|
+
* @property {SystemSmsTemplate[]} [items] - An array of system SMS templates
|
|
763
|
+
*/
|
|
764
|
+
/**
|
|
765
|
+
* @typedef SystemSmsTemplate
|
|
743
766
|
* @property {EnabledObj} [url_shorten]
|
|
744
767
|
* @property {string} [_id]
|
|
745
768
|
* @property {boolean} [is_system]
|
|
@@ -813,6 +836,7 @@ export = CommunicationPlatformModel;
|
|
|
813
836
|
* @property {number} [current] - The current page number.
|
|
814
837
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
815
838
|
* @property {number} [size] - The number of items per page.
|
|
839
|
+
* @property {number} [page_size] - The number of items per page.
|
|
816
840
|
*/
|
|
817
841
|
/**
|
|
818
842
|
* @typedef GenericError
|
|
@@ -858,7 +882,7 @@ export = CommunicationPlatformModel;
|
|
|
858
882
|
declare class CommunicationPlatformModel {
|
|
859
883
|
}
|
|
860
884
|
declare namespace CommunicationPlatformModel {
|
|
861
|
-
export { EventSubscriptionsBulkUpdatePayload, EventSubscriptionsBulkUpdateResult, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, BadRequestSchema, NotFound, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, EmailTemplate, SystemEmailTemplate, EmailTemplates, SystemEmailTemplates, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadStructure, MetaStructure, EnginePayload, EngineResult, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptions, TriggerJobResult, TriggerJobPayload, GetGlobalVariablesResult, CreateGlobalVariablesResult, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, VerifyOtpCommsErrorRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfiguration };
|
|
885
|
+
export { EventSubscriptionsBulkUpdatePayload, EventSubscriptionsBulkUpdateResult, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, BadRequestSchema, NotFound, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, EmailTemplate, SystemEmailTemplate, EmailTemplates, SystemEmailTemplates, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadStructure, MetaStructure, EnginePayload, EngineResult, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptionEvents, EventTemplate, EventProviderTemplates, EventSubscriptions, TriggerJobResult, TriggerJobPayload, GetGlobalVariablesResult, CreateGlobalVariablesResult, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, VerifyOtpCommsErrorRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, SystemSmsTemplate, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfiguration };
|
|
862
886
|
}
|
|
863
887
|
/** @returns {EventSubscriptionsBulkUpdatePayload} */
|
|
864
888
|
declare function EventSubscriptionsBulkUpdatePayload(): EventSubscriptionsBulkUpdatePayload;
|
|
@@ -1363,13 +1387,13 @@ type EngineResult = {
|
|
|
1363
1387
|
declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
|
|
1364
1388
|
type EventSubscriptionTemplateSms = {
|
|
1365
1389
|
subscribed?: boolean;
|
|
1366
|
-
template?:
|
|
1390
|
+
template?: SmsTemplate;
|
|
1367
1391
|
};
|
|
1368
1392
|
/** @returns {EventSubscriptionTemplateEmail} */
|
|
1369
1393
|
declare function EventSubscriptionTemplateEmail(): EventSubscriptionTemplateEmail;
|
|
1370
1394
|
type EventSubscriptionTemplateEmail = {
|
|
1371
1395
|
subscribed?: boolean;
|
|
1372
|
-
template?:
|
|
1396
|
+
template?: EmailTemplate;
|
|
1373
1397
|
};
|
|
1374
1398
|
/** @returns {EventSubscriptionTemplate} */
|
|
1375
1399
|
declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
|
|
@@ -1384,12 +1408,40 @@ type EventSubscription = {
|
|
|
1384
1408
|
is_default?: boolean;
|
|
1385
1409
|
_id?: string;
|
|
1386
1410
|
application?: string;
|
|
1387
|
-
event?:
|
|
1411
|
+
event?: EventSubscriptionEvents;
|
|
1388
1412
|
slug?: string;
|
|
1389
1413
|
created_at?: string;
|
|
1390
1414
|
updated_at?: string;
|
|
1391
1415
|
__v?: number;
|
|
1392
1416
|
};
|
|
1417
|
+
/** @returns {EventSubscriptionEvents} */
|
|
1418
|
+
declare function EventSubscriptionEvents(): EventSubscriptionEvents;
|
|
1419
|
+
type EventSubscriptionEvents = {
|
|
1420
|
+
category?: string;
|
|
1421
|
+
event_name?: string;
|
|
1422
|
+
group?: string;
|
|
1423
|
+
slug?: string;
|
|
1424
|
+
template?: EventTemplate;
|
|
1425
|
+
};
|
|
1426
|
+
/** @returns {EventTemplate} */
|
|
1427
|
+
declare function EventTemplate(): EventTemplate;
|
|
1428
|
+
type EventTemplate = {
|
|
1429
|
+
email?: EventProviderTemplates;
|
|
1430
|
+
pushnotification?: EventProviderTemplates;
|
|
1431
|
+
sms?: EventProviderTemplates;
|
|
1432
|
+
};
|
|
1433
|
+
/** @returns {EventProviderTemplates} */
|
|
1434
|
+
declare function EventProviderTemplates(): EventProviderTemplates;
|
|
1435
|
+
type EventProviderTemplates = {
|
|
1436
|
+
/**
|
|
1437
|
+
* - Provider type for the event template
|
|
1438
|
+
*/
|
|
1439
|
+
provider_type?: string;
|
|
1440
|
+
/**
|
|
1441
|
+
* - This is the unique id of the template
|
|
1442
|
+
*/
|
|
1443
|
+
template?: string;
|
|
1444
|
+
};
|
|
1393
1445
|
/** @returns {EventSubscriptions} */
|
|
1394
1446
|
declare function EventSubscriptions(): EventSubscriptions;
|
|
1395
1447
|
type EventSubscriptions = {
|
|
@@ -1762,6 +1814,14 @@ type SmsTemplate = {
|
|
|
1762
1814
|
/** @returns {SystemSmsTemplates} */
|
|
1763
1815
|
declare function SystemSmsTemplates(): SystemSmsTemplates;
|
|
1764
1816
|
type SystemSmsTemplates = {
|
|
1817
|
+
/**
|
|
1818
|
+
* - An array of system SMS templates
|
|
1819
|
+
*/
|
|
1820
|
+
items?: SystemSmsTemplate[];
|
|
1821
|
+
};
|
|
1822
|
+
/** @returns {SystemSmsTemplate} */
|
|
1823
|
+
declare function SystemSmsTemplate(): SystemSmsTemplate;
|
|
1824
|
+
type SystemSmsTemplate = {
|
|
1765
1825
|
url_shorten?: EnabledObj;
|
|
1766
1826
|
_id?: string;
|
|
1767
1827
|
is_system?: boolean;
|
|
@@ -1863,6 +1923,10 @@ type Page = {
|
|
|
1863
1923
|
* - The number of items per page.
|
|
1864
1924
|
*/
|
|
1865
1925
|
size?: number;
|
|
1926
|
+
/**
|
|
1927
|
+
* - The number of items per page.
|
|
1928
|
+
*/
|
|
1929
|
+
page_size?: number;
|
|
1866
1930
|
};
|
|
1867
1931
|
/** @returns {GenericError} */
|
|
1868
1932
|
declare function GenericError(): GenericError;
|