@gofynd/fdk-client-javascript 3.5.0 → 3.7.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 CHANGED
@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
234
234
  The above code will log the curl command in the console
235
235
 
236
236
  ```bash
237
- curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.5.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
237
+ curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.7.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
238
238
  Active Theme: Emerge
239
239
  ```
240
240
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gofynd/fdk-client-javascript",
3
- "version": "3.5.0",
3
+ "version": "3.7.0",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -12,7 +12,7 @@ declare class APIClient {
12
12
  * @param {object} body
13
13
  * @param {object} xHeaders
14
14
  */
15
- static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: any): Promise<import("axios").AxiosResponse<any, any>>;
15
+ static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
16
16
  }
17
17
  declare namespace APIClient {
18
18
  export { Options };
@@ -63,7 +63,7 @@ declare class ApplicationClient {
63
63
  body: any;
64
64
  headers: any;
65
65
  responseHeaders?: boolean;
66
- }): Promise<import("axios").AxiosResponse<any, any>>;
66
+ }): Promise<import("axios").AxiosResponse<any, any, {}>>;
67
67
  }
68
68
  import ApplicationConfig = require("./ApplicationConfig");
69
69
  import Cart = require("./Cart/CartApplicationClient");
@@ -8,8 +8,8 @@ declare class OAuthClient extends BaseOAuthClient {
8
8
  grant_type: any;
9
9
  refresh_token: any;
10
10
  code: any;
11
- }): Promise<import("axios").AxiosResponse<any, any>>;
12
- getOfflineAccessToken(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
13
- getOfflineAccessTokenObj(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
11
+ }): Promise<import("axios").AxiosResponse<any, any, {}>>;
12
+ getOfflineAccessToken(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
13
+ getOfflineAccessTokenObj(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
14
14
  }
15
15
  import BaseOAuthClient = require("../common/BaseOAuthClient");
@@ -13,7 +13,7 @@ declare class APIClient {
13
13
  * @param {object} xHeaders
14
14
  * @param {Options} options
15
15
  */
16
- static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<import("axios").AxiosResponse<any, any>>;
16
+ static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<import("axios").AxiosResponse<any, any, {}>>;
17
17
  get(url: any, config: any): Promise<any>;
18
18
  }
19
19
  declare namespace APIClient {
@@ -32,8 +32,8 @@ declare class PartnerClient {
32
32
  body: any;
33
33
  headers: any;
34
34
  responseHeaders?: boolean;
35
- }): Promise<import("axios").AxiosResponse<any, any>>;
36
- getAccesstokenObj(options: any): Promise<import("axios").AxiosResponse<any, any>>;
35
+ }): Promise<import("axios").AxiosResponse<any, any, {}>>;
36
+ getAccesstokenObj(options: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
37
37
  setToken(token: any): void;
38
38
  }
39
39
  import PartnerConfig = require("./PartnerConfig");
@@ -725,6 +725,10 @@ export = CartPlatformModel;
725
725
  * @property {Object} [meta] - Meta data related to article
726
726
  * @property {boolean} [allowed_refund] - Flag indicating whether refunds are
727
727
  * allowed at article level
728
+ * @property {number} [min_price_threshold] - Minimum allowed net price for the
729
+ * article. If the article's price after all discounts and adjustments falls
730
+ * below this threshold, the price adjustment will be automatically removed.
731
+ * (Applicable only for price adjustment discount type)
728
732
  */
729
733
  /**
730
734
  * @typedef PriceAdjustmentRestrictions
@@ -4234,6 +4238,13 @@ type Article = {
4234
4238
  * allowed at article level
4235
4239
  */
4236
4240
  allowed_refund?: boolean;
4241
+ /**
4242
+ * - Minimum allowed net price for the
4243
+ * article. If the article's price after all discounts and adjustments falls
4244
+ * below this threshold, the price adjustment will be automatically removed.
4245
+ * (Applicable only for price adjustment discount type)
4246
+ */
4247
+ min_price_threshold?: number;
4237
4248
  };
4238
4249
  /** @returns {PriceAdjustmentRestrictions} */
4239
4250
  declare function PriceAdjustmentRestrictions(): PriceAdjustmentRestrictions;
@@ -787,6 +787,10 @@ const Joi = require("joi");
787
787
  * @property {Object} [meta] - Meta data related to article
788
788
  * @property {boolean} [allowed_refund] - Flag indicating whether refunds are
789
789
  * allowed at article level
790
+ * @property {number} [min_price_threshold] - Minimum allowed net price for the
791
+ * article. If the article's price after all discounts and adjustments falls
792
+ * below this threshold, the price adjustment will be automatically removed.
793
+ * (Applicable only for price adjustment discount type)
790
794
  */
791
795
 
792
796
  /**
@@ -3481,6 +3485,7 @@ class CartPlatformModel {
3481
3485
  quantity: Joi.number(),
3482
3486
  meta: Joi.object().pattern(/\S/, Joi.any()),
3483
3487
  allowed_refund: Joi.boolean(),
3488
+ min_price_threshold: Joi.number(),
3484
3489
  });
3485
3490
  }
3486
3491
 
@@ -147,11 +147,89 @@ export = CatalogPlatformModel;
147
147
  * @property {number} [maximum] - The maximum quantity allowed for purchase.
148
148
  * @property {number} [minimum] - The minimum quantity required for purchase.
149
149
  */
150
+ /**
151
+ * @typedef Scores
152
+ * @property {number} [popularity] - This score captures how trending and
153
+ * popular a product is for a specific sales channel. It evaluates recent
154
+ * customer interactions such as views, wishlist adds, add-to-carts, and
155
+ * orders, applying time-based decay so newer activity matters more. The
156
+ * blended score is ranked within the channel to reflect relative popularity.
157
+ * A higher score means the product is currently engaging more customers,
158
+ * while a lower score shows limited or declining interest.
159
+ * @property {number} [availability] - This score measures how reliably a
160
+ * product is stocked for a specific sales channel. It compares the product’s
161
+ * current inventory with its highest observed inventory level, adjusted for
162
+ * how inventory is distributed across locations. A higher score means the
163
+ * product is readily available, while a lower score indicates limited stock
164
+ * or frequent stockouts. Products with no meaningful inventory history
165
+ * receive a default low score for interpretation.
166
+ * @property {number} [conversion] - This score measures how effectively a
167
+ * product converts customer interest into actual orders for a specific sales
168
+ * channel. It considers product views, wishlist adds, add-to-carts, and
169
+ * completed orders to calculate a conversion rate. The rate is then ranked
170
+ * within the channel to give a normalized score. A higher score means the
171
+ * product turns interest into purchases more successfully, while a lower
172
+ * score indicates weaker conversion performance.
173
+ * @property {number} [sold_quantity] - This score evaluates how many units of a
174
+ * product have been sold for a specific sales channel, compared to other
175
+ * products in the same channel. It calculates total quantities sold and
176
+ * converts them into a percentile rank. A higher score means the product
177
+ * sells in large volumes, while a lower score signals fewer units sold.
178
+ * Products without transactions are assigned a default low score.
179
+ * @property {number} [depth] - This score evaluates how well a product covers
180
+ * different size options for a specific sales channel within its category,
181
+ * while also factoring in the inventory available for each size. It compares
182
+ * the product’s size variety and stock depth against the maximum observed
183
+ * within that category and channel. A higher score means the product offers a
184
+ * broader and better-stocked size range, while a lower score reflects fewer
185
+ * options or limited inventory depth.
186
+ * @property {number} [discount] - This score reflects the level of discount a
187
+ * product offers for a specific sales channel, relative to others in the
188
+ * channel. It compares the product’s listed price (MRP) to its effective
189
+ * selling price (ESP) and ranks products by discount percentage. It also
190
+ * takes into account Discount Rules. A higher score indicates steeper
191
+ * discounts, while a lower score shows smaller or no discounts. Products
192
+ * without valid price data receive a default low score.
193
+ * @property {number} [revenue] - This score measures how much revenue a product
194
+ * generates for a specific sales channel, relative to other products in that
195
+ * channel. It looks at the total value of items sold and assigns a percentile
196
+ * rank. A higher score indicates the product drives stronger sales revenue,
197
+ * while a lower score means it contributes less revenue compared to peers.
198
+ * Products with no sales activity receive a default low score.
199
+ * @property {number} [cancelled] - This score measures the proportion of orders
200
+ * cancelled by the platform for a specific sales channel. A higher score
201
+ * indicates fewer cancellations, suggesting smoother fulfilment and better
202
+ * operational consistency. A lower score highlights products more prone to
203
+ * cancellations, which may result from inventory mismatches, processing
204
+ * issues, or operational inefficiencies.
205
+ * @property {number} [returns] - This score measures the proportion of orders
206
+ * that were returned for a specific sales channel. It is designed so that a
207
+ * higher score indicates fewer returns relative to total orders, reflecting
208
+ * better product reliability and customer satisfaction. A lower score means
209
+ * the product experiences more returns, which could signal quality issues,
210
+ * mismatched expectations, or customer dissatisfaction.
211
+ * @property {number} [catalogue] - This score evaluates the quality and
212
+ * completeness of a product’s catalogue content for a specific sales channel.
213
+ * It considers the presence of images, videos, and 3D models, along with the
214
+ * length of product descriptions. Balanced image counts, supportive media,
215
+ * and detailed descriptions contribute to a higher score. A higher score
216
+ * means the product is well-presented and informative, while a lower score
217
+ * indicates missing media or insufficient descriptions that may reduce
218
+ * customer confidence.
219
+ * @property {number} [listing] - This score reflects how recently a product was
220
+ * listed for a specific sales channel. It uses the product’s listing date to
221
+ * calculate how many days have passed since it became available, then
222
+ * normalizes this against other products in the same channel. A higher score
223
+ * means the product is relatively new and fresh on the channel, while a lower
224
+ * score indicates it has been listed for a longer time or lacks valid listing
225
+ * information.
226
+ */
150
227
  /**
151
228
  * @typedef ApplicationItemMeta
152
229
  * @property {Object} [_custom_json] - Custom JSON data for the item
153
230
  * @property {MetaFields[]} [_custom_meta] - Custom meta fields for the item
154
231
  * @property {Object} [alt_text] - Alternative text for the item's images
232
+ * @property {Scores} [scores]
155
233
  * @property {boolean} [is_cod] - Whether the item is available for Cash on
156
234
  * Delivery (COD) or not
157
235
  * @property {boolean} [is_gift] - Whether the item is a gift or not
@@ -4419,7 +4497,7 @@ export = CatalogPlatformModel;
4419
4497
  declare class CatalogPlatformModel {
4420
4498
  }
4421
4499
  declare namespace CatalogPlatformModel {
4422
- 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, FollowedProducts, FollowProduct, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType };
4500
+ export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, 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, FollowedProducts, FollowProduct, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType };
4423
4501
  }
4424
4502
  /** @returns {Action} */
4425
4503
  declare function Action(): Action;
@@ -4714,6 +4792,117 @@ type ApplicationItemMOQ = {
4714
4792
  */
4715
4793
  minimum?: number;
4716
4794
  };
4795
+ /** @returns {Scores} */
4796
+ declare function Scores(): Scores;
4797
+ type Scores = {
4798
+ /**
4799
+ * - This score captures how trending and
4800
+ * popular a product is for a specific sales channel. It evaluates recent
4801
+ * customer interactions such as views, wishlist adds, add-to-carts, and
4802
+ * orders, applying time-based decay so newer activity matters more. The
4803
+ * blended score is ranked within the channel to reflect relative popularity.
4804
+ * A higher score means the product is currently engaging more customers,
4805
+ * while a lower score shows limited or declining interest.
4806
+ */
4807
+ popularity?: number;
4808
+ /**
4809
+ * - This score measures how reliably a
4810
+ * product is stocked for a specific sales channel. It compares the product’s
4811
+ * current inventory with its highest observed inventory level, adjusted for
4812
+ * how inventory is distributed across locations. A higher score means the
4813
+ * product is readily available, while a lower score indicates limited stock
4814
+ * or frequent stockouts. Products with no meaningful inventory history
4815
+ * receive a default low score for interpretation.
4816
+ */
4817
+ availability?: number;
4818
+ /**
4819
+ * - This score measures how effectively a
4820
+ * product converts customer interest into actual orders for a specific sales
4821
+ * channel. It considers product views, wishlist adds, add-to-carts, and
4822
+ * completed orders to calculate a conversion rate. The rate is then ranked
4823
+ * within the channel to give a normalized score. A higher score means the
4824
+ * product turns interest into purchases more successfully, while a lower
4825
+ * score indicates weaker conversion performance.
4826
+ */
4827
+ conversion?: number;
4828
+ /**
4829
+ * - This score evaluates how many units of a
4830
+ * product have been sold for a specific sales channel, compared to other
4831
+ * products in the same channel. It calculates total quantities sold and
4832
+ * converts them into a percentile rank. A higher score means the product
4833
+ * sells in large volumes, while a lower score signals fewer units sold.
4834
+ * Products without transactions are assigned a default low score.
4835
+ */
4836
+ sold_quantity?: number;
4837
+ /**
4838
+ * - This score evaluates how well a product covers
4839
+ * different size options for a specific sales channel within its category,
4840
+ * while also factoring in the inventory available for each size. It compares
4841
+ * the product’s size variety and stock depth against the maximum observed
4842
+ * within that category and channel. A higher score means the product offers a
4843
+ * broader and better-stocked size range, while a lower score reflects fewer
4844
+ * options or limited inventory depth.
4845
+ */
4846
+ depth?: number;
4847
+ /**
4848
+ * - This score reflects the level of discount a
4849
+ * product offers for a specific sales channel, relative to others in the
4850
+ * channel. It compares the product’s listed price (MRP) to its effective
4851
+ * selling price (ESP) and ranks products by discount percentage. It also
4852
+ * takes into account Discount Rules. A higher score indicates steeper
4853
+ * discounts, while a lower score shows smaller or no discounts. Products
4854
+ * without valid price data receive a default low score.
4855
+ */
4856
+ discount?: number;
4857
+ /**
4858
+ * - This score measures how much revenue a product
4859
+ * generates for a specific sales channel, relative to other products in that
4860
+ * channel. It looks at the total value of items sold and assigns a percentile
4861
+ * rank. A higher score indicates the product drives stronger sales revenue,
4862
+ * while a lower score means it contributes less revenue compared to peers.
4863
+ * Products with no sales activity receive a default low score.
4864
+ */
4865
+ revenue?: number;
4866
+ /**
4867
+ * - This score measures the proportion of orders
4868
+ * cancelled by the platform for a specific sales channel. A higher score
4869
+ * indicates fewer cancellations, suggesting smoother fulfilment and better
4870
+ * operational consistency. A lower score highlights products more prone to
4871
+ * cancellations, which may result from inventory mismatches, processing
4872
+ * issues, or operational inefficiencies.
4873
+ */
4874
+ cancelled?: number;
4875
+ /**
4876
+ * - This score measures the proportion of orders
4877
+ * that were returned for a specific sales channel. It is designed so that a
4878
+ * higher score indicates fewer returns relative to total orders, reflecting
4879
+ * better product reliability and customer satisfaction. A lower score means
4880
+ * the product experiences more returns, which could signal quality issues,
4881
+ * mismatched expectations, or customer dissatisfaction.
4882
+ */
4883
+ returns?: number;
4884
+ /**
4885
+ * - This score evaluates the quality and
4886
+ * completeness of a product’s catalogue content for a specific sales channel.
4887
+ * It considers the presence of images, videos, and 3D models, along with the
4888
+ * length of product descriptions. Balanced image counts, supportive media,
4889
+ * and detailed descriptions contribute to a higher score. A higher score
4890
+ * means the product is well-presented and informative, while a lower score
4891
+ * indicates missing media or insufficient descriptions that may reduce
4892
+ * customer confidence.
4893
+ */
4894
+ catalogue?: number;
4895
+ /**
4896
+ * - This score reflects how recently a product was
4897
+ * listed for a specific sales channel. It uses the product’s listing date to
4898
+ * calculate how many days have passed since it became available, then
4899
+ * normalizes this against other products in the same channel. A higher score
4900
+ * means the product is relatively new and fresh on the channel, while a lower
4901
+ * score indicates it has been listed for a longer time or lacks valid listing
4902
+ * information.
4903
+ */
4904
+ listing?: number;
4905
+ };
4717
4906
  /** @returns {ApplicationItemMeta} */
4718
4907
  declare function ApplicationItemMeta(): ApplicationItemMeta;
4719
4908
  type ApplicationItemMeta = {
@@ -4729,6 +4918,7 @@ type ApplicationItemMeta = {
4729
4918
  * - Alternative text for the item's images
4730
4919
  */
4731
4920
  alt_text?: any;
4921
+ scores?: Scores;
4732
4922
  /**
4733
4923
  * - Whether the item is available for Cash on
4734
4924
  * Delivery (COD) or not
@@ -164,11 +164,90 @@ const Joi = require("joi");
164
164
  * @property {number} [minimum] - The minimum quantity required for purchase.
165
165
  */
166
166
 
167
+ /**
168
+ * @typedef Scores
169
+ * @property {number} [popularity] - This score captures how trending and
170
+ * popular a product is for a specific sales channel. It evaluates recent
171
+ * customer interactions such as views, wishlist adds, add-to-carts, and
172
+ * orders, applying time-based decay so newer activity matters more. The
173
+ * blended score is ranked within the channel to reflect relative popularity.
174
+ * A higher score means the product is currently engaging more customers,
175
+ * while a lower score shows limited or declining interest.
176
+ * @property {number} [availability] - This score measures how reliably a
177
+ * product is stocked for a specific sales channel. It compares the product’s
178
+ * current inventory with its highest observed inventory level, adjusted for
179
+ * how inventory is distributed across locations. A higher score means the
180
+ * product is readily available, while a lower score indicates limited stock
181
+ * or frequent stockouts. Products with no meaningful inventory history
182
+ * receive a default low score for interpretation.
183
+ * @property {number} [conversion] - This score measures how effectively a
184
+ * product converts customer interest into actual orders for a specific sales
185
+ * channel. It considers product views, wishlist adds, add-to-carts, and
186
+ * completed orders to calculate a conversion rate. The rate is then ranked
187
+ * within the channel to give a normalized score. A higher score means the
188
+ * product turns interest into purchases more successfully, while a lower
189
+ * score indicates weaker conversion performance.
190
+ * @property {number} [sold_quantity] - This score evaluates how many units of a
191
+ * product have been sold for a specific sales channel, compared to other
192
+ * products in the same channel. It calculates total quantities sold and
193
+ * converts them into a percentile rank. A higher score means the product
194
+ * sells in large volumes, while a lower score signals fewer units sold.
195
+ * Products without transactions are assigned a default low score.
196
+ * @property {number} [depth] - This score evaluates how well a product covers
197
+ * different size options for a specific sales channel within its category,
198
+ * while also factoring in the inventory available for each size. It compares
199
+ * the product’s size variety and stock depth against the maximum observed
200
+ * within that category and channel. A higher score means the product offers a
201
+ * broader and better-stocked size range, while a lower score reflects fewer
202
+ * options or limited inventory depth.
203
+ * @property {number} [discount] - This score reflects the level of discount a
204
+ * product offers for a specific sales channel, relative to others in the
205
+ * channel. It compares the product’s listed price (MRP) to its effective
206
+ * selling price (ESP) and ranks products by discount percentage. It also
207
+ * takes into account Discount Rules. A higher score indicates steeper
208
+ * discounts, while a lower score shows smaller or no discounts. Products
209
+ * without valid price data receive a default low score.
210
+ * @property {number} [revenue] - This score measures how much revenue a product
211
+ * generates for a specific sales channel, relative to other products in that
212
+ * channel. It looks at the total value of items sold and assigns a percentile
213
+ * rank. A higher score indicates the product drives stronger sales revenue,
214
+ * while a lower score means it contributes less revenue compared to peers.
215
+ * Products with no sales activity receive a default low score.
216
+ * @property {number} [cancelled] - This score measures the proportion of orders
217
+ * cancelled by the platform for a specific sales channel. A higher score
218
+ * indicates fewer cancellations, suggesting smoother fulfilment and better
219
+ * operational consistency. A lower score highlights products more prone to
220
+ * cancellations, which may result from inventory mismatches, processing
221
+ * issues, or operational inefficiencies.
222
+ * @property {number} [returns] - This score measures the proportion of orders
223
+ * that were returned for a specific sales channel. It is designed so that a
224
+ * higher score indicates fewer returns relative to total orders, reflecting
225
+ * better product reliability and customer satisfaction. A lower score means
226
+ * the product experiences more returns, which could signal quality issues,
227
+ * mismatched expectations, or customer dissatisfaction.
228
+ * @property {number} [catalogue] - This score evaluates the quality and
229
+ * completeness of a product’s catalogue content for a specific sales channel.
230
+ * It considers the presence of images, videos, and 3D models, along with the
231
+ * length of product descriptions. Balanced image counts, supportive media,
232
+ * and detailed descriptions contribute to a higher score. A higher score
233
+ * means the product is well-presented and informative, while a lower score
234
+ * indicates missing media or insufficient descriptions that may reduce
235
+ * customer confidence.
236
+ * @property {number} [listing] - This score reflects how recently a product was
237
+ * listed for a specific sales channel. It uses the product’s listing date to
238
+ * calculate how many days have passed since it became available, then
239
+ * normalizes this against other products in the same channel. A higher score
240
+ * means the product is relatively new and fresh on the channel, while a lower
241
+ * score indicates it has been listed for a longer time or lacks valid listing
242
+ * information.
243
+ */
244
+
167
245
  /**
168
246
  * @typedef ApplicationItemMeta
169
247
  * @property {Object} [_custom_json] - Custom JSON data for the item
170
248
  * @property {MetaFields[]} [_custom_meta] - Custom meta fields for the item
171
249
  * @property {Object} [alt_text] - Alternative text for the item's images
250
+ * @property {Scores} [scores]
172
251
  * @property {boolean} [is_cod] - Whether the item is available for Cash on
173
252
  * Delivery (COD) or not
174
253
  * @property {boolean} [is_gift] - Whether the item is a gift or not
@@ -5010,12 +5089,30 @@ class CatalogPlatformModel {
5010
5089
  });
5011
5090
  }
5012
5091
 
5092
+ /** @returns {Scores} */
5093
+ static Scores() {
5094
+ return Joi.object({
5095
+ popularity: Joi.number().allow(null),
5096
+ availability: Joi.number().allow(null),
5097
+ conversion: Joi.number().allow(null),
5098
+ sold_quantity: Joi.number().allow(null),
5099
+ depth: Joi.number().allow(null),
5100
+ discount: Joi.number().allow(null),
5101
+ revenue: Joi.number().allow(null),
5102
+ cancelled: Joi.number().allow(null),
5103
+ returns: Joi.number().allow(null),
5104
+ catalogue: Joi.number().allow(null),
5105
+ listing: Joi.number().allow(null),
5106
+ });
5107
+ }
5108
+
5013
5109
  /** @returns {ApplicationItemMeta} */
5014
5110
  static ApplicationItemMeta() {
5015
5111
  return Joi.object({
5016
5112
  _custom_json: Joi.object().pattern(/\S/, Joi.any()),
5017
5113
  _custom_meta: Joi.array().items(CatalogPlatformModel.MetaFields()),
5018
5114
  alt_text: Joi.object().pattern(/\S/, Joi.any()),
5115
+ scores: CatalogPlatformModel.Scores(),
5019
5116
  is_cod: Joi.boolean(),
5020
5117
  is_gift: Joi.boolean(),
5021
5118
  moq: CatalogPlatformModel.ApplicationItemMOQ(),
@@ -20,7 +20,7 @@ declare class OAuthClient {
20
20
  grant_type: any;
21
21
  refresh_token: any;
22
22
  code: any;
23
- }): Promise<import("axios").AxiosResponse<any, any>>;
24
- getOfflineAccessToken(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
25
- getOfflineAccessTokenObj(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
23
+ }): Promise<import("axios").AxiosResponse<any, any, {}>>;
24
+ getOfflineAccessToken(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
25
+ getOfflineAccessTokenObj(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
26
26
  }
@@ -3118,10 +3118,6 @@ export = OrderPlatformModel;
3118
3118
  */
3119
3119
  /**
3120
3120
  * @typedef Article
3121
- * @property {Object} [child_details] - Contains a flexible set of key-value
3122
- * pairs representing detailed information about the article's child entities,
3123
- * including dimensions (width, height, length), weight, and unique
3124
- * identifiers (EAN, article code, seller identifier) for each child entity.
3125
3121
  * @property {string} seller_identifier - Unique identifier assigned by the
3126
3122
  * seller to the article, used for inventory management.
3127
3123
  * @property {string} uid - A unique identifier for the article within the system.
@@ -3149,6 +3145,8 @@ export = OrderPlatformModel;
3149
3145
  * or collection.
3150
3146
  * @property {string[]} [tags] - Tags associated with the article for
3151
3147
  * categorization and search optimization.
3148
+ * @property {Object} [_custom_json] - A custom JSON object containing
3149
+ * additional details or configurations specific to the article.
3152
3150
  */
3153
3151
  /**
3154
3152
  * @typedef ShipmentListingBrand
@@ -11464,13 +11462,6 @@ type Weight = {
11464
11462
  /** @returns {Article} */
11465
11463
  declare function Article(): Article;
11466
11464
  type Article = {
11467
- /**
11468
- * - Contains a flexible set of key-value
11469
- * pairs representing detailed information about the article's child entities,
11470
- * including dimensions (width, height, length), weight, and unique
11471
- * identifiers (EAN, article code, seller identifier) for each child entity.
11472
- */
11473
- child_details?: any;
11474
11465
  /**
11475
11466
  * - Unique identifier assigned by the
11476
11467
  * seller to the article, used for inventory management.
@@ -11537,6 +11528,11 @@ type Article = {
11537
11528
  * categorization and search optimization.
11538
11529
  */
11539
11530
  tags?: string[];
11531
+ /**
11532
+ * - A custom JSON object containing
11533
+ * additional details or configurations specific to the article.
11534
+ */
11535
+ _custom_json?: any;
11540
11536
  };
11541
11537
  /** @returns {ShipmentListingBrand} */
11542
11538
  declare function ShipmentListingBrand(): ShipmentListingBrand;
@@ -3379,10 +3379,6 @@ const Joi = require("joi");
3379
3379
 
3380
3380
  /**
3381
3381
  * @typedef Article
3382
- * @property {Object} [child_details] - Contains a flexible set of key-value
3383
- * pairs representing detailed information about the article's child entities,
3384
- * including dimensions (width, height, length), weight, and unique
3385
- * identifiers (EAN, article code, seller identifier) for each child entity.
3386
3382
  * @property {string} seller_identifier - Unique identifier assigned by the
3387
3383
  * seller to the article, used for inventory management.
3388
3384
  * @property {string} uid - A unique identifier for the article within the system.
@@ -3410,6 +3406,8 @@ const Joi = require("joi");
3410
3406
  * or collection.
3411
3407
  * @property {string[]} [tags] - Tags associated with the article for
3412
3408
  * categorization and search optimization.
3409
+ * @property {Object} [_custom_json] - A custom JSON object containing
3410
+ * additional details or configurations specific to the article.
3413
3411
  */
3414
3412
 
3415
3413
  /**
@@ -8448,7 +8446,6 @@ class OrderPlatformModel {
8448
8446
  /** @returns {Article} */
8449
8447
  static Article() {
8450
8448
  return Joi.object({
8451
- child_details: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
8452
8449
  seller_identifier: Joi.string().allow("").required(),
8453
8450
  uid: Joi.string().allow("").required(),
8454
8451
  set: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
@@ -8464,6 +8461,7 @@ class OrderPlatformModel {
8464
8461
  size: Joi.string().allow("").required(),
8465
8462
  is_set: Joi.boolean().allow(null),
8466
8463
  tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
8464
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
8467
8465
  });
8468
8466
  }
8469
8467
 
@@ -11,7 +11,7 @@ declare class Partner {
11
11
  * Success response
12
12
  * @name addProxyPath
13
13
  * @summary: Create extension proxy
14
- * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
14
+ * @description: Use this endpoint to register a proxy for calling an extension's API from your storefront. This enables your storefront to interact with extension APIs seamlessly, helps enhance and extend your storefront's existing functionality using extensions, and simplifies integration by avoiding CORS issues when accessing extension APIs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
15
15
  */
16
16
  addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathCreation>;
17
17
  /**
@@ -22,7 +22,7 @@ declare class Partner {
22
22
  * Success response
23
23
  * @name removeProxyPath
24
24
  * @summary: Remove extension proxy
25
- * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
25
+ * @description: Remove the proxy that was created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
26
26
  */
27
27
  removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathDelete>;
28
28
  }
@@ -23,7 +23,7 @@ class Partner {
23
23
  * Success response
24
24
  * @name addProxyPath
25
25
  * @summary: Create extension proxy
26
- * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
26
+ * @description: Use this endpoint to register a proxy for calling an extension's API from your storefront. This enables your storefront to interact with extension APIs seamlessly, helps enhance and extend your storefront's existing functionality using extensions, and simplifies integration by avoiding CORS issues when accessing extension APIs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
27
27
  */
28
28
  async addProxyPath(
29
29
  { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -105,7 +105,7 @@ class Partner {
105
105
  * Success response
106
106
  * @name removeProxyPath
107
107
  * @summary: Remove extension proxy
108
- * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
108
+ * @description: Remove the proxy that was created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
109
109
  */
110
110
  async removeProxyPath(
111
111
  { extensionId, attachedPath, requestHeaders } = { requestHeaders: {} },
@@ -1,12 +1,13 @@
1
1
  export = PartnerPlatformApplicationValidator;
2
2
  /**
3
3
  * @typedef AddProxyPathParam
4
- * @property {string} extensionId - Extension id for which a proxy URL will be generated
4
+ * @property {string} extensionId - Extension's unique identifier for which a
5
+ * proxy URL will be generated
5
6
  * @property {PartnerPlatformModel.AddProxyReq} body
6
7
  */
7
8
  /**
8
9
  * @typedef RemoveProxyPathParam
9
- * @property {string} extensionId - Extension id for which proxy URL needs to be removed
10
+ * @property {string} extensionId - Extension ID for which proxy URL needs to be removed
10
11
  * @property {string} attachedPath - Attached path slug
11
12
  */
12
13
  declare class PartnerPlatformApplicationValidator {
@@ -20,14 +21,15 @@ declare namespace PartnerPlatformApplicationValidator {
20
21
  }
21
22
  type AddProxyPathParam = {
22
23
  /**
23
- * - Extension id for which a proxy URL will be generated
24
+ * - Extension's unique identifier for which a
25
+ * proxy URL will be generated
24
26
  */
25
27
  extensionId: string;
26
28
  body: PartnerPlatformModel.AddProxyReq;
27
29
  };
28
30
  type RemoveProxyPathParam = {
29
31
  /**
30
- * - Extension id for which proxy URL needs to be removed
32
+ * - Extension ID for which proxy URL needs to be removed
31
33
  */
32
34
  extensionId: string;
33
35
  /**
@@ -4,13 +4,14 @@ const PartnerPlatformModel = require("./PartnerPlatformModel");
4
4
 
5
5
  /**
6
6
  * @typedef AddProxyPathParam
7
- * @property {string} extensionId - Extension id for which a proxy URL will be generated
7
+ * @property {string} extensionId - Extension's unique identifier for which a
8
+ * proxy URL will be generated
8
9
  * @property {PartnerPlatformModel.AddProxyReq} body
9
10
  */
10
11
 
11
12
  /**
12
13
  * @typedef RemoveProxyPathParam
13
- * @property {string} extensionId - Extension id for which proxy URL needs to be removed
14
+ * @property {string} extensionId - Extension ID for which proxy URL needs to be removed
14
15
  * @property {string} attachedPath - Attached path slug
15
16
  */
16
17
 
@@ -1,9 +1,11 @@
1
1
  export = PartnerPlatformModel;
2
2
  /**
3
3
  * @typedef AddProxyReq
4
- * @property {string} [attached_path] - Proxy path slug
5
- * @property {string} [proxy_url] - The external URL for which the proxy URL
6
- * will be generated
4
+ * @property {string} [attached_path] - Attached path can be any slug that will
5
+ * be appended to the base URL to create a proxy endpoint, e.g.,
6
+ * /ext/{attached_path}. Note: attached_path should be unique for each
7
+ * extension within the same application.
8
+ * @property {string} [proxy_url] - External URL for which the proxy URL will be generated
7
9
  */
8
10
  /**
9
11
  * @typedef ExtensionProxyPathCreation
@@ -47,12 +49,14 @@ declare namespace PartnerPlatformModel {
47
49
  declare function AddProxyReq(): AddProxyReq;
48
50
  type AddProxyReq = {
49
51
  /**
50
- * - Proxy path slug
52
+ * - Attached path can be any slug that will
53
+ * be appended to the base URL to create a proxy endpoint, e.g.,
54
+ * /ext/{attached_path}. Note: attached_path should be unique for each
55
+ * extension within the same application.
51
56
  */
52
57
  attached_path?: string;
53
58
  /**
54
- * - The external URL for which the proxy URL
55
- * will be generated
59
+ * - External URL for which the proxy URL will be generated
56
60
  */
57
61
  proxy_url?: string;
58
62
  };
@@ -2,9 +2,11 @@ const Joi = require("joi");
2
2
 
3
3
  /**
4
4
  * @typedef AddProxyReq
5
- * @property {string} [attached_path] - Proxy path slug
6
- * @property {string} [proxy_url] - The external URL for which the proxy URL
7
- * will be generated
5
+ * @property {string} [attached_path] - Attached path can be any slug that will
6
+ * be appended to the base URL to create a proxy endpoint, e.g.,
7
+ * /ext/{attached_path}. Note: attached_path should be unique for each
8
+ * extension within the same application.
9
+ * @property {string} [proxy_url] - External URL for which the proxy URL will be generated
8
10
  */
9
11
 
10
12
  /**
@@ -13,7 +13,7 @@ declare class APIClient {
13
13
  * @param {object} xHeaders
14
14
  * @param {Options} options
15
15
  */
16
- static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<import("axios").AxiosResponse<any, any>>;
16
+ static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<import("axios").AxiosResponse<any, any, {}>>;
17
17
  get(url: any, config: any): Promise<any>;
18
18
  }
19
19
  declare namespace APIClient {
@@ -52,8 +52,8 @@ declare class PlatformClient {
52
52
  body: any;
53
53
  headers: any;
54
54
  responseHeaders?: boolean;
55
- }): Promise<import("axios").AxiosResponse<any, any>>;
56
- getAccesstokenObj(options: any): Promise<import("axios").AxiosResponse<any, any>>;
55
+ }): Promise<import("axios").AxiosResponse<any, any, {}>>;
56
+ getAccesstokenObj(options: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
57
57
  setToken(token: any): void;
58
58
  }
59
59
  import PlatformConfig = require("./PlatformConfig");
@@ -11,7 +11,7 @@ declare class PublicAPIClient {
11
11
  * @param {object} query
12
12
  * @param {object} body
13
13
  */
14
- static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any, options: any): Promise<import("axios").AxiosResponse<any, any>>;
14
+ static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any, options: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
15
15
  }
16
16
  declare namespace PublicAPIClient {
17
17
  export { Options };