@gofynd/fdk-client-javascript 3.4.1 → 3.4.3

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 (27) hide show
  1. package/README.md +23 -26
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +3 -2
  4. package/sdk/application/ApplicationClient.js +25 -19
  5. package/sdk/common/utils.js +6 -3
  6. package/sdk/partner/PartnerClient.d.ts +5 -2
  7. package/sdk/partner/PartnerClient.js +21 -7
  8. package/sdk/platform/Cart/CartPlatformModel.d.ts +2 -81
  9. package/sdk/platform/Cart/CartPlatformModel.js +2 -239
  10. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +39 -0
  11. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +256 -0
  12. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +59 -1
  13. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +45 -0
  14. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +31 -3
  15. package/sdk/platform/Catalog/CatalogPlatformModel.js +29 -2
  16. package/sdk/platform/Order/OrderPlatformModel.d.ts +7 -0
  17. package/sdk/platform/Order/OrderPlatformModel.js +3 -0
  18. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +0 -64
  19. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +0 -487
  20. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -68
  21. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +3 -76
  22. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1 -420
  23. package/sdk/platform/Payment/PaymentPlatformModel.js +0 -494
  24. package/sdk/platform/PlatformClient.d.ts +5 -2
  25. package/sdk/platform/PlatformClient.js +32 -18
  26. package/sdk/public/PublicClient.d.ts +3 -2
  27. package/sdk/public/PublicClient.js +13 -7
@@ -694,7 +694,6 @@ const Joi = require("joi");
694
694
  * @property {string} [template_tag]
695
695
  * @property {number} [total]
696
696
  * @property {string} [tracking_url]
697
- * @property {string[]} [tags]
698
697
  */
699
698
 
700
699
  /**
@@ -4659,6 +4658,7 @@ const Joi = require("joi");
4659
4658
  * either price or quantity.
4660
4659
  * @property {string} file_path - URL of the uploaded file containing inventory
4661
4660
  * update data.
4661
+ * @property {string[]} [tags] - Tags associated with the inventory update job.
4662
4662
  * @property {BulkMeta} [meta]
4663
4663
  */
4664
4664
 
@@ -4719,6 +4719,18 @@ const Joi = require("joi");
4719
4719
  * to be exported.
4720
4720
  */
4721
4721
 
4722
+ /**
4723
+ * @typedef FollowedProducts
4724
+ * @property {number[]} [item_ids]
4725
+ * @property {Page} [page]
4726
+ */
4727
+
4728
+ /**
4729
+ * @typedef FollowProduct
4730
+ * @property {string} [message] - A message indicating the result of the follow
4731
+ * or unfollow operation.
4732
+ */
4733
+
4722
4734
  /**
4723
4735
  * @typedef ActionPage
4724
4736
  * @property {Object} [params] - Parameters that should be considered in path.
@@ -5562,7 +5574,6 @@ class CatalogPlatformModel {
5562
5574
  template_tag: Joi.string().allow(""),
5563
5575
  total: Joi.number(),
5564
5576
  tracking_url: Joi.string().allow(""),
5565
- tags: Joi.array().items(Joi.string().allow("")),
5566
5577
  });
5567
5578
  }
5568
5579
 
@@ -9789,6 +9800,7 @@ class CatalogPlatformModel {
9789
9800
  company_id: Joi.string().allow("").required(),
9790
9801
  file_type: Joi.string().allow("").required(),
9791
9802
  file_path: Joi.string().allow("").required(),
9803
+ tags: Joi.array().items(Joi.string().allow("")),
9792
9804
  meta: CatalogPlatformModel.BulkMeta(),
9793
9805
  });
9794
9806
  }
@@ -9857,6 +9869,21 @@ class CatalogPlatformModel {
9857
9869
  });
9858
9870
  }
9859
9871
 
9872
+ /** @returns {FollowedProducts} */
9873
+ static FollowedProducts() {
9874
+ return Joi.object({
9875
+ item_ids: Joi.array().items(Joi.number()),
9876
+ page: CatalogPlatformModel.Page(),
9877
+ });
9878
+ }
9879
+
9880
+ /** @returns {FollowProduct} */
9881
+ static FollowProduct() {
9882
+ return Joi.object({
9883
+ message: Joi.string().allow(""),
9884
+ });
9885
+ }
9886
+
9860
9887
  /** @returns {ActionPage} */
9861
9888
  static ActionPage() {
9862
9889
  return Joi.object({
@@ -3253,6 +3253,8 @@ export = OrderPlatformModel;
3253
3253
  * with the product.
3254
3254
  * @property {string[]} [images] - Array of image URLs representing different
3255
3255
  * views or angles of the item.
3256
+ * @property {string[]} [tags] - Custom labels or keywords associated with the
3257
+ * item for categorization, filtering, or business logic purposes.
3256
3258
  */
3257
3259
  /**
3258
3260
  * @typedef Dates
@@ -11783,6 +11785,11 @@ type PlatformItem = {
11783
11785
  * views or angles of the item.
11784
11786
  */
11785
11787
  images?: string[];
11788
+ /**
11789
+ * - Custom labels or keywords associated with the
11790
+ * item for categorization, filtering, or business logic purposes.
11791
+ */
11792
+ tags?: string[];
11786
11793
  };
11787
11794
  /** @returns {Dates} */
11788
11795
  declare function Dates(): Dates;
@@ -3520,6 +3520,8 @@ const Joi = require("joi");
3520
3520
  * with the product.
3521
3521
  * @property {string[]} [images] - Array of image URLs representing different
3522
3522
  * views or angles of the item.
3523
+ * @property {string[]} [tags] - Custom labels or keywords associated with the
3524
+ * item for categorization, filtering, or business logic purposes.
3523
3525
  */
3524
3526
 
3525
3527
  /**
@@ -8547,6 +8549,7 @@ class OrderPlatformModel {
8547
8549
  color: Joi.string().allow("").allow(null),
8548
8550
  department_id: Joi.number().allow(null),
8549
8551
  images: Joi.array().items(Joi.string().allow("")).allow(null, ""),
8552
+ tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
8550
8553
  });
8551
8554
  }
8552
8555
 
@@ -3,16 +3,6 @@ declare class Payment {
3
3
  constructor(config: any, applicationId: any);
4
4
  config: any;
5
5
  applicationId: any;
6
- /**
7
- * @param {PaymentPlatformApplicationValidator.AddEdcDeviceParam} arg - Arg object
8
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
9
- * @param {import("../PlatformAPIClient").Options} - Options
10
- * @returns {Promise<PaymentPlatformModel.EdcDeviceUpdateDetails>} - Success response
11
- * @name addEdcDevice
12
- * @summary: Create an EDC device
13
- * @description: Registration and addition of a new EDC device to the system - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/addEdcDevice/).
14
- */
15
- addEdcDevice({ terminalUniqueIdentifier, body, requestHeaders }?: PaymentPlatformApplicationValidator.AddEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceUpdateDetails>;
16
6
  /**
17
7
  * @param {PaymentPlatformApplicationValidator.AddRefundBankAccountUsingOTPParam} arg
18
8
  * - Arg object
@@ -99,40 +89,6 @@ declare class Payment {
99
89
  * @description: Create an order and payment on the aggregator side - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/createPaymentOrder/).
100
90
  */
101
91
  createPaymentOrder({ body, requestHeaders }?: PaymentPlatformApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentOrderDetails>;
102
- /**
103
- * @param {PaymentPlatformApplicationValidator.EdcAggregatorsAndModelListParam} arg
104
- * - Arg object
105
- *
106
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
107
- * @param {import("../PlatformAPIClient").Options} - Options
108
- * @returns {Promise<PaymentPlatformModel.EdcAggregatorAndModelListDetails>}
109
- * - Success response
110
- *
111
- * @name edcAggregatorsAndModelList
112
- * @summary: EDC aggregators and model list
113
- * @description: Retrieve a list of EDC (Electronic Data Capture) aggregators and models. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/edcAggregatorsAndModelList/).
114
- */
115
- edcAggregatorsAndModelList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcAggregatorAndModelListDetails>;
116
- /**
117
- * @param {PaymentPlatformApplicationValidator.EdcDeviceListParam} arg - Arg object
118
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
119
- * @param {import("../PlatformAPIClient").Options} - Options
120
- * @returns {Promise<PaymentPlatformModel.EdcDeviceListDetails>} - Success response
121
- * @name edcDeviceList
122
- * @summary: List EDC devices
123
- * @description: Retrieves a list of available Electronic Data Capture (EDC) devices. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/edcDeviceList/).
124
- */
125
- edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag, requestHeaders }?: PaymentPlatformApplicationValidator.EdcDeviceListParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceListDetails>;
126
- /**
127
- * @param {PaymentPlatformApplicationValidator.EdcDeviceStatsParam} arg - Arg object
128
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
129
- * @param {import("../PlatformAPIClient").Options} - Options
130
- * @returns {Promise<PaymentPlatformModel.EdcDeviceStatsDetails>} - Success response
131
- * @name edcDeviceStats
132
- * @summary: EDC device stats
133
- * @description: Information about EDC (Electronic Data Capture) devices linked to a specific application within a company. It provides statistics such as the count of active and inactive devices. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/edcDeviceStats/).
134
- */
135
- edcDeviceStats({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceStatsDetails>;
136
92
  /**
137
93
  * @param {PaymentPlatformApplicationValidator.GetBankAccountDetailsOpenAPIParam} arg
138
94
  * - Arg object
@@ -158,16 +114,6 @@ declare class Payment {
158
114
  * @description: Retrieve configuration settings like key, secret, webhook url, merchant salt for brand payment gateways. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getBrandPaymentGatewayConfig/).
159
115
  */
160
116
  getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayConfigDetails>;
161
- /**
162
- * @param {PaymentPlatformApplicationValidator.GetEdcDeviceParam} arg - Arg object
163
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
164
- * @param {import("../PlatformAPIClient").Options} - Options
165
- * @returns {Promise<PaymentPlatformModel.EdcDeviceDetails>} - Success response
166
- * @name getEdcDevice
167
- * @summary: Get an EDC device
168
- * @description: Retrieve comprehensive details regarding an Electronic Data Capture (EDC) device associated with a particular terminal unique identifier within a company's application.Upon success, it returns the detailed information of the EDC device, including terminal serial number, EDC device serial number, merchant store POS code, store ID, aggregator ID and name, device tag, activation status, and EDC model. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getEdcDevice/).
169
- */
170
- getEdcDevice({ terminalUniqueIdentifier, requestHeaders }?: PaymentPlatformApplicationValidator.GetEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceDetails>;
171
117
  /**
172
118
  * @param {PaymentPlatformApplicationValidator.GetMerchantAggregatorAppVersionParam} arg
173
119
  * - Arg object
@@ -556,16 +502,6 @@ declare class Payment {
556
502
  * @description: This allows access to seller to enable disable cod of specific user - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/setUserCODlimitRoutes/).
557
503
  */
558
504
  setUserCODlimitRoutes({ body, requestHeaders }?: PaymentPlatformApplicationValidator.SetUserCODlimitRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SetCODOptionDetails>;
559
- /**
560
- * @param {PaymentPlatformApplicationValidator.UpdateEdcDeviceParam} arg - Arg object
561
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
562
- * @param {import("../PlatformAPIClient").Options} - Options
563
- * @returns {Promise<PaymentPlatformModel.EdcDeviceAddDetails>} - Success response
564
- * @name updateEdcDevice
565
- * @summary: Update EDC device
566
- * @description: Enables the modification of settings and details associated with an Electronic Data Capture (EDC) device linked to a specific application within a company. Upon success, it returns the updated information of the EDC device. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/updateEdcDevice/).
567
- */
568
- updateEdcDevice({ body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateEdcDeviceParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.EdcDeviceAddDetails>;
569
505
  /**
570
506
  * @param {PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam} arg
571
507
  * - Arg object