@gofynd/fdk-client-javascript 3.17.0 → 3.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +40 -0
  4. package/sdk/application/Cart/CartApplicationClient.js +176 -0
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +18 -4
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +47 -4
  7. package/sdk/application/Content/ContentApplicationClient.d.ts +11 -1
  8. package/sdk/application/Content/ContentApplicationClient.js +40 -2
  9. package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -1
  10. package/sdk/application/Payment/PaymentApplicationClient.js +2 -0
  11. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +72 -10
  12. package/sdk/platform/Cart/CartPlatformApplicationClient.js +634 -33
  13. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +225 -1
  14. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +147 -0
  15. package/sdk/platform/Cart/CartPlatformModel.d.ts +951 -1
  16. package/sdk/platform/Cart/CartPlatformModel.js +597 -1
  17. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +123 -3
  18. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +829 -39
  19. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +205 -7
  20. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +154 -3
  21. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +5 -5
  22. package/sdk/platform/Catalog/CatalogPlatformClient.js +8 -5
  23. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1020 -29
  24. package/sdk/platform/Catalog/CatalogPlatformModel.js +836 -24
  25. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -0
  26. package/sdk/platform/Catalog/CatalogPlatformValidator.js +3 -0
  27. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +92 -1
  28. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +54 -0
  29. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +21 -0
  30. package/sdk/platform/Discount/DiscountPlatformModel.js +9 -0
  31. package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
  32. package/sdk/platform/Order/OrderPlatformClient.js +1 -1
  33. package/sdk/platform/Order/OrderPlatformModel.d.ts +20 -2
  34. package/sdk/platform/Order/OrderPlatformModel.js +9 -1
  35. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +14 -3
  36. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +88 -6
  37. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +28 -3
  38. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +22 -2
  39. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +356 -1
  40. package/sdk/platform/Payment/PaymentPlatformModel.js +229 -0
  41. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +29 -0
  42. package/sdk/platform/Webhook/WebhookPlatformModel.js +13 -0
  43. package/sdk/public/Webhook/WebhookPublicModel.d.ts +29 -0
  44. package/sdk/public/Webhook/WebhookPublicModel.js +13 -0
@@ -129,6 +129,19 @@ declare class Catalog {
129
129
  * @description: Add configuration for product catalog listing specific to a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createListingConfiguration/).
130
130
  */
131
131
  createListingConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
132
+ /**
133
+ * @param {CatalogPlatformApplicationValidator.CreatePriceFactoryParam} arg
134
+ * - Arg object
135
+ *
136
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
137
+ * @param {import("../PlatformAPIClient").Options} - Options
138
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
139
+ * @name createPriceFactory
140
+ * @summary: Create a Price Factory for an Application
141
+ * @description: Creates a new price factory configuration for the specified application under a given company. A price factory allows defining region-based or international pricing strategies using fixed or percentage-based adjustments per currency.
142
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createPriceFactory/).
143
+ */
144
+ createPriceFactory({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreatePriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
132
145
  /**
133
146
  * @param {CatalogPlatformApplicationValidator.CreateSearchConfigurationParam} arg
134
147
  * - Arg object
@@ -205,6 +218,19 @@ declare class Catalog {
205
218
  * @description: Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteListingConfiguration/).
206
219
  */
207
220
  deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
221
+ /**
222
+ * @param {CatalogPlatformApplicationValidator.DeletePriceFactoryParam} arg
223
+ * - Arg object
224
+ *
225
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
226
+ * @param {import("../PlatformAPIClient").Options} - Options
227
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
228
+ * @name deletePriceFactory
229
+ * @summary: Delete a Price Factory Configuration
230
+ * @description: Deletes a specific price factory configuration associated with a given company and application. This action is typically irreversible and will remove the pricing logic tied to the specified price factory ID.
231
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deletePriceFactory/).
232
+ */
233
+ deletePriceFactory({ priceFactoryId, requestHeaders }?: CatalogPlatformApplicationValidator.DeletePriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
208
234
  /**
209
235
  * @param {CatalogPlatformApplicationValidator.DeleteSearchConfigurationParam} arg
210
236
  * - Arg object
@@ -378,6 +404,18 @@ declare class Catalog {
378
404
  * @description: Retrieve sales channel product details by its item_id and depending upon filters sent in request. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAppProduct/).
379
405
  */
380
406
  getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>;
407
+ /**
408
+ * @param {CatalogPlatformApplicationValidator.GetAppProductPricesParam} arg
409
+ * - Arg object
410
+ *
411
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
412
+ * @param {import("../PlatformAPIClient").Options} - Options
413
+ * @returns {Promise<CatalogPlatformModel.AppProductPricesSchema>} - Success response
414
+ * @name getAppProductPrices
415
+ * @summary: Get prices for specific raw product items
416
+ * @description: Fetch pricing details for multiple raw products by their item IDs, scoped to a particular company and sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAppProductPrices/).
417
+ */
418
+ getAppProductPrices({ itemIds, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductPricesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppProductPricesSchema>;
381
419
  /**
382
420
  * @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
383
421
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -642,9 +680,9 @@ declare class Catalog {
642
680
  * @param {boolean} [arg.isDependent] - This query parameter is used to get
643
681
  * the dependent products in the listing.
644
682
  * @param {string} [arg.sortOn] - The order to sort the list of products on.
645
- * The supported sort parameters are popularity, price, redemption and
646
- * discount in either ascending or descending order. See the supported
647
- * values below.
683
+ * Supported values include latest, popular, price_asc, price_dsc,
684
+ * discount_asc, discount_dsc. Custom sort keys configured via listing
685
+ * configuration (e.g., best_selling) are also supported for cohort-based sorting.
648
686
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
649
687
  * page. Default is 12.
650
688
  * @param {string[]} [arg.itemIds] - Item Ids of product
@@ -886,6 +924,62 @@ declare class Catalog {
886
924
  * @description: Retrieve product listing configurations based on specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getListingConfigurations/).
887
925
  */
888
926
  getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponseSchema>;
927
+ /**
928
+ * @param {CatalogPlatformApplicationValidator.GetPriceFactoriesParam} arg
929
+ * - Arg object
930
+ *
931
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
932
+ * @param {import("../PlatformAPIClient").Options} - Options
933
+ * @returns {Promise<CatalogPlatformModel.PriceFactoryListResponseSchema>}
934
+ * - Success response
935
+ *
936
+ * @name getPriceFactories
937
+ * @summary: Retrieve Price Factories for an Application
938
+ * @description: Fetches a paginated list of price factories configured for the specified application within a company. Supports optional filters such as brand IDs, category IDs, seller identifier, item code, slug, and name to narrow down the results.
939
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getPriceFactories/).
940
+ */
941
+ getPriceFactories({ q, requestHeaders }?: CatalogPlatformApplicationValidator.GetPriceFactoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PriceFactoryListResponseSchema>;
942
+ /**
943
+ * @param {CatalogPlatformApplicationValidator.GetPriceFactoryParam} arg - Arg object
944
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
945
+ * @param {import("../PlatformAPIClient").Options} - Options
946
+ * @returns {Promise<CatalogPlatformModel.PriceFactoryConfigSchema>} -
947
+ * Success response
948
+ * @name getPriceFactory
949
+ * @summary: Retrieve a Specific Price Factory Configuration
950
+ * @description: Retrieves detailed information about a specific price factory configuration for the given application and company, using the unique price factory ID. This includes currency strategies, adjustment values, zone mapping, and audit metadata.
951
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getPriceFactory/).
952
+ */
953
+ getPriceFactory({ priceFactoryId, requestHeaders }?: CatalogPlatformApplicationValidator.GetPriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PriceFactoryConfigSchema>;
954
+ /**
955
+ * @param {CatalogPlatformApplicationValidator.GetPriceFactoryProductParam} arg
956
+ * - Arg object
957
+ *
958
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
959
+ * @param {import("../PlatformAPIClient").Options} - Options
960
+ * @returns {Promise<CatalogPlatformModel.PriceFactoryProductResponseSchema>}
961
+ * - Success response
962
+ *
963
+ * @name getPriceFactoryProduct
964
+ * @summary: Update marketplace optin
965
+ * @description: get price related information of item for given price factory - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getPriceFactoryProduct/).
966
+ */
967
+ getPriceFactoryProduct({ priceFactoryId, itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetPriceFactoryProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PriceFactoryProductResponseSchema>;
968
+ /**
969
+ * @param {CatalogPlatformApplicationValidator.GetPriceFactoryProductsParam} arg
970
+ * - Arg object
971
+ *
972
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
973
+ * @param {import("../PlatformAPIClient").Options} - Options
974
+ * @returns {Promise<CatalogPlatformModel.PriceFactoryProductListResponseSchema>}
975
+ * - Success response
976
+ *
977
+ * @name getPriceFactoryProducts
978
+ * @summary: Get Products associated with a Price Factory
979
+ * @description: Retrieves a paginated list of products linked to a specific price factory configuration for the given application and company. This endpoint returns item-level details such as pricing by currency, delivery zones, seller identifiers, media, and size-level configurations. Useful for viewing how pricing strategies are applied across different items.
980
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getPriceFactoryProducts/).
981
+ */
982
+ getPriceFactoryProducts({ priceFactoryId, brandIds, categoryIds, sellerIdentifier, itemCode, slug, name, active, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetPriceFactoryProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PriceFactoryProductListResponseSchema>;
889
983
  /**
890
984
  * @param {CatalogPlatformApplicationValidator.GetProductDetailBySlugParam} arg
891
985
  * - Arg object
@@ -1104,6 +1198,32 @@ declare class Catalog {
1104
1198
  * @description: Modify a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateListingConfiguration/).
1105
1199
  */
1106
1200
  updateListingConfiguration({ configType, configId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
1201
+ /**
1202
+ * @param {CatalogPlatformApplicationValidator.UpdatePriceFactoryParam} arg
1203
+ * - Arg object
1204
+ *
1205
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1206
+ * @param {import("../PlatformAPIClient").Options} - Options
1207
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
1208
+ * @name updatePriceFactory
1209
+ * @summary: Update an Existing Price Factory Configuration
1210
+ * @description: Allows partial update of an existing price factory configuration for a specific application and company using the provided price factory ID. Fields such as name, currencies, pricing strategies, or zone mapping can be modified.
1211
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updatePriceFactory/).
1212
+ */
1213
+ updatePriceFactory({ priceFactoryId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdatePriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
1214
+ /**
1215
+ * @param {CatalogPlatformApplicationValidator.UpdatePriceFactoryProductParam} arg
1216
+ * - Arg object
1217
+ *
1218
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1219
+ * @param {import("../PlatformAPIClient").Options} - Options
1220
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
1221
+ * @name updatePriceFactoryProduct
1222
+ * @summary: Partially update price factory product configuration
1223
+ * @description: Updates specific fields in the price factory product configuration. Use this to partially update pricing or status for a given product and size without overwriting the entire configuration.
1224
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updatePriceFactoryProduct/).
1225
+ */
1226
+ updatePriceFactoryProduct({ priceFactoryId, itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdatePriceFactoryProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
1107
1227
  /**
1108
1228
  * @param {CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam} arg
1109
1229
  * - Arg object