@gofynd/fdk-client-javascript 3.6.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.
Files changed (26) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Payment/PaymentApplicationClient.d.ts +0 -50
  4. package/sdk/application/Payment/PaymentApplicationClient.js +0 -210
  5. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  6. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
  7. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +5 -0
  8. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -0
  9. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +1 -125
  10. package/sdk/platform/Catalog/CatalogPlatformClient.js +131 -1111
  11. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +228 -1009
  12. package/sdk/platform/Catalog/CatalogPlatformModel.js +102 -681
  13. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -200
  14. package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -174
  15. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +4 -9
  16. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +4 -4
  17. package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -60
  18. package/sdk/platform/Order/OrderPlatformModel.js +3 -33
  19. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
  20. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
  21. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  22. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  23. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +10 -6
  24. package/sdk/platform/Partner/PartnerPlatformModel.js +5 -3
  25. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +10 -0
  26. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -0
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.6.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.6.0",
3
+ "version": "3.7.0",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -3,10 +3,8 @@ declare class Payment {
3
3
  constructor(_conf: any);
4
4
  _conf: any;
5
5
  _relativeUrls: {
6
- addBeneficiary: string;
7
6
  addBeneficiaryDetails: string;
8
7
  addRefundBankAccountUsingOTP: string;
9
- addRefundBeneficiaryUsingOTPSession: string;
10
8
  attachCardToCustomer: string;
11
9
  cancelPaymentLink: string;
12
10
  cardDetails: string;
@@ -18,7 +16,6 @@ declare class Payment {
18
16
  createPaymentOrder: string;
19
17
  customerCreditSummary: string;
20
18
  customerOnboard: string;
21
- deleteBeneficiary: string;
22
19
  deleteUserCard: string;
23
20
  delinkWallet: string;
24
21
  enableOrDisableRefundTransferMode: string;
@@ -32,8 +29,6 @@ declare class Payment {
32
29
  getPaymentModeRoutes: string;
33
30
  getPaymentModeRoutesPaymentLink: string;
34
31
  getPosPaymentModeRoutes: string;
35
- getRefundBeneficiaries: string;
36
- getRefundBeneficiariesUsingOTPSession: string;
37
32
  getRupifiBannerDetails: string;
38
33
  getUserBeneficiariesDetail: string;
39
34
  initialisePayment: string;
@@ -57,15 +52,6 @@ declare class Payment {
57
52
  };
58
53
  _urls: {};
59
54
  updateUrls(urls: any): void;
60
- /**
61
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
62
- * @param {import("../ApplicationAPIClient").Options} - Options
63
- * @returns {Promise<AddBeneficiaryResponseDetails>} - Success response
64
- * @name addBeneficiary
65
- * @summary: Add a beneficiary for refunds
66
- * @description: Adds a bank or UPI beneficiary to the user account for processing refunds. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/addBeneficiary/).
67
- */
68
- addBeneficiary({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AddBeneficiaryResponseDetails>;
69
55
  /**
70
56
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
71
57
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -84,15 +70,6 @@ declare class Payment {
84
70
  * @description: Add bank account specifically for refunds, employing OTP verification for security. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/addRefundBankAccountUsingOTP/).
85
71
  */
86
72
  addRefundBankAccountUsingOTP({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RefundAccountDetails>;
87
- /**
88
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
89
- * @param {import("../ApplicationAPIClient").Options} - Options
90
- * @returns {Promise<AddBeneficiaryResponseDetails>} - Success response
91
- * @name addRefundBeneficiaryUsingOTPSession
92
- * @summary: Add a beneficiary for refunds using OTP session
93
- * @description: Adds a bank or UPI beneficiary to the user account after completing an OTP verification session. The beneficiary details are securely linked with the user's refund preferences and will be used for processing refunds against specific orders and shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/addRefundBeneficiaryUsingOTPSession/).
94
- */
95
- addRefundBeneficiaryUsingOTPSession({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AddBeneficiaryResponseDetails>;
96
73
  /**
97
74
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
98
75
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -192,15 +169,6 @@ declare class Payment {
192
169
  * @description: Initiate the onboarding process for payment services, providing personal, business, and device information, along with marketplace details, to enable customer registration and credit availability. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/customerOnboard/).
193
170
  */
194
171
  customerOnboard({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomerOnboardingDetails>;
195
- /**
196
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
197
- * @param {import("../ApplicationAPIClient").Options} - Options
198
- * @returns {Promise<DeleteBeneficiaryDetails>} - Success response
199
- * @name deleteBeneficiary
200
- * @summary: Delete a refund beneficiary
201
- * @description: This API endpoint is used to delete a refund beneficiary using their beneficiary ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/deleteBeneficiary/).
202
- */
203
- deleteBeneficiary({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<DeleteBeneficiaryDetails>;
204
172
  /**
205
173
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
206
174
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -318,24 +286,6 @@ declare class Payment {
318
286
  * @description: Get available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getPosPaymentModeRoutes/).
319
287
  */
320
288
  getPosPaymentModeRoutes({ amount, cartId, pincode, orderType, checkoutMode, refresh, cardReference, userDetails, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PaymentModeRouteDetails>;
321
- /**
322
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
323
- * @param {import("../ApplicationAPIClient").Options} - Options
324
- * @returns {Promise<RefundBeneficiaries>} - Success response
325
- * @name getRefundBeneficiaries
326
- * @summary: Get Refund Beneficiaries
327
- * @description: Returns a list of UPI and Bank refund beneficiaries associated with a user. Both `order_id` and `shipment_id` are optional query parameters. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiaries/).
328
- */
329
- getRefundBeneficiaries({ orderId, shipmentId, filterBy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RefundBeneficiaries>;
330
- /**
331
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
332
- * @param {import("../ApplicationAPIClient").Options} - Options
333
- * @returns {Promise<RefundBeneficiaries>} - Success response
334
- * @name getRefundBeneficiariesUsingOTPSession
335
- * @summary: Get Refund Beneficiaries using OTP session
336
- * @description: Returns a list of UPI and Bank refund beneficiaries associated with a user for a given order and shipment. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiariesUsingOTPSession/).
337
- */
338
- getRefundBeneficiariesUsingOTPSession({ orderId, shipmentId, filterBy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RefundBeneficiaries>;
339
289
  /**
340
290
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
341
291
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -12,13 +12,9 @@ class Payment {
12
12
  constructor(_conf) {
13
13
  this._conf = _conf;
14
14
  this._relativeUrls = {
15
- addBeneficiary:
16
- "/service/application/payment/v2.0/refund/user/beneficiary",
17
15
  addBeneficiaryDetails: "/service/application/payment/v1.0/refund/account",
18
16
  addRefundBankAccountUsingOTP:
19
17
  "/service/application/payment/v1.0/refund/account/otp",
20
- addRefundBeneficiaryUsingOTPSession:
21
- "/service/application/payment/v2.0/refund/user/beneficiary-otp",
22
18
  attachCardToCustomer: "/service/application/payment/v1.0/card/attach",
23
19
  cancelPaymentLink:
24
20
  "/service/application/payment/v1.0/cancel-payment-link/",
@@ -36,8 +32,6 @@ class Payment {
36
32
  customerCreditSummary:
37
33
  "/service/application/payment/v1.0/payment/credit-summary/",
38
34
  customerOnboard: "/service/application/payment/v1.0/credit-onboard/",
39
- deleteBeneficiary:
40
- "/service/application/payment/v1.0/refund/account/{id}",
41
35
  deleteUserCard: "/service/application/payment/v1.0/card/remove",
42
36
  delinkWallet:
43
37
  "/service/application/payment/v1.0/payment/options/wallet/delink",
@@ -60,10 +54,6 @@ class Payment {
60
54
  "/service/application/payment/v1.0/payment/options/link/",
61
55
  getPosPaymentModeRoutes:
62
56
  "/service/application/payment/v1.0/payment/options/pos",
63
- getRefundBeneficiaries:
64
- "/service/application/payment/v2.0/refund/user/beneficiary",
65
- getRefundBeneficiariesUsingOTPSession:
66
- "/service/application/payment/v2.0/refund/user/beneficiary-otp",
67
57
  getRupifiBannerDetails: "/service/application/payment/v1.0/rupifi/banner",
68
58
  getUserBeneficiariesDetail:
69
59
  "/service/application/payment/v1.0/refund/user/beneficiary",
@@ -116,43 +106,6 @@ class Payment {
116
106
  };
117
107
  }
118
108
 
119
- /**
120
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
121
- * @param {import("../ApplicationAPIClient").Options} - Options
122
- * @returns {Promise<AddBeneficiaryResponseDetails>} - Success response
123
- * @name addBeneficiary
124
- * @summary: Add a beneficiary for refunds
125
- * @description: Adds a bank or UPI beneficiary to the user account for processing refunds. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/addBeneficiary/).
126
- */
127
- async addBeneficiary(
128
- { body, requestHeaders } = { requestHeaders: {} },
129
- { responseHeaders } = { responseHeaders: false }
130
- ) {
131
- const query_params = {};
132
-
133
- const xHeaders = {};
134
-
135
- const response = await ApplicationAPIClient.execute(
136
- this._conf,
137
- "post",
138
- constructUrl({
139
- url: this._urls["addBeneficiary"],
140
- params: {},
141
- }),
142
- query_params,
143
- body,
144
- { ...xHeaders, ...requestHeaders },
145
- { responseHeaders }
146
- );
147
-
148
- let responseData = response;
149
- if (responseHeaders) {
150
- responseData = response[0];
151
- }
152
-
153
- return response;
154
- }
155
-
156
109
  /**
157
110
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
158
111
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -227,43 +180,6 @@ class Payment {
227
180
  return response;
228
181
  }
229
182
 
230
- /**
231
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
232
- * @param {import("../ApplicationAPIClient").Options} - Options
233
- * @returns {Promise<AddBeneficiaryResponseDetails>} - Success response
234
- * @name addRefundBeneficiaryUsingOTPSession
235
- * @summary: Add a beneficiary for refunds using OTP session
236
- * @description: Adds a bank or UPI beneficiary to the user account after completing an OTP verification session. The beneficiary details are securely linked with the user's refund preferences and will be used for processing refunds against specific orders and shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/addRefundBeneficiaryUsingOTPSession/).
237
- */
238
- async addRefundBeneficiaryUsingOTPSession(
239
- { body, requestHeaders } = { requestHeaders: {} },
240
- { responseHeaders } = { responseHeaders: false }
241
- ) {
242
- const query_params = {};
243
-
244
- const xHeaders = {};
245
-
246
- const response = await ApplicationAPIClient.execute(
247
- this._conf,
248
- "post",
249
- constructUrl({
250
- url: this._urls["addRefundBeneficiaryUsingOTPSession"],
251
- params: {},
252
- }),
253
- query_params,
254
- body,
255
- { ...xHeaders, ...requestHeaders },
256
- { responseHeaders }
257
- );
258
-
259
- let responseData = response;
260
- if (responseHeaders) {
261
- responseData = response[0];
262
- }
263
-
264
- return response;
265
- }
266
-
267
183
  /**
268
184
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
269
185
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -683,52 +599,6 @@ class Payment {
683
599
  return response;
684
600
  }
685
601
 
686
- /**
687
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
688
- * @param {import("../ApplicationAPIClient").Options} - Options
689
- * @returns {Promise<DeleteBeneficiaryDetails>} - Success response
690
- * @name deleteBeneficiary
691
- * @summary: Delete a refund beneficiary
692
- * @description: This API endpoint is used to delete a refund beneficiary using their beneficiary ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/deleteBeneficiary/).
693
- */
694
- async deleteBeneficiary(
695
- { id, requestHeaders } = { requestHeaders: {} },
696
- { responseHeaders } = { responseHeaders: false }
697
- ) {
698
- const errors = validateRequiredParams(arguments[0], ["id"]);
699
- if (errors.length > 0) {
700
- const error = new FDKClientValidationError({
701
- message: "Missing required field",
702
- details: errors,
703
- });
704
- return Promise.reject(new FDKClientValidationError(error));
705
- }
706
-
707
- const query_params = {};
708
-
709
- const xHeaders = {};
710
-
711
- const response = await ApplicationAPIClient.execute(
712
- this._conf,
713
- "delete",
714
- constructUrl({
715
- url: this._urls["deleteBeneficiary"],
716
- params: { id },
717
- }),
718
- query_params,
719
- undefined,
720
- { ...xHeaders, ...requestHeaders },
721
- { responseHeaders }
722
- );
723
-
724
- let responseData = response;
725
- if (responseHeaders) {
726
- responseData = response[0];
727
- }
728
-
729
- return response;
730
- }
731
-
732
602
  /**
733
603
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
734
604
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -1256,86 +1126,6 @@ class Payment {
1256
1126
  return response;
1257
1127
  }
1258
1128
 
1259
- /**
1260
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1261
- * @param {import("../ApplicationAPIClient").Options} - Options
1262
- * @returns {Promise<RefundBeneficiaries>} - Success response
1263
- * @name getRefundBeneficiaries
1264
- * @summary: Get Refund Beneficiaries
1265
- * @description: Returns a list of UPI and Bank refund beneficiaries associated with a user. Both `order_id` and `shipment_id` are optional query parameters. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiaries/).
1266
- */
1267
- async getRefundBeneficiaries(
1268
- { orderId, shipmentId, filterBy, requestHeaders } = { requestHeaders: {} },
1269
- { responseHeaders } = { responseHeaders: false }
1270
- ) {
1271
- const query_params = {};
1272
- query_params["order_id"] = orderId;
1273
- query_params["shipment_id"] = shipmentId;
1274
- query_params["filter_by"] = filterBy;
1275
-
1276
- const xHeaders = {};
1277
-
1278
- const response = await ApplicationAPIClient.execute(
1279
- this._conf,
1280
- "get",
1281
- constructUrl({
1282
- url: this._urls["getRefundBeneficiaries"],
1283
- params: {},
1284
- }),
1285
- query_params,
1286
- undefined,
1287
- { ...xHeaders, ...requestHeaders },
1288
- { responseHeaders }
1289
- );
1290
-
1291
- let responseData = response;
1292
- if (responseHeaders) {
1293
- responseData = response[0];
1294
- }
1295
-
1296
- return response;
1297
- }
1298
-
1299
- /**
1300
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1301
- * @param {import("../ApplicationAPIClient").Options} - Options
1302
- * @returns {Promise<RefundBeneficiaries>} - Success response
1303
- * @name getRefundBeneficiariesUsingOTPSession
1304
- * @summary: Get Refund Beneficiaries using OTP session
1305
- * @description: Returns a list of UPI and Bank refund beneficiaries associated with a user for a given order and shipment. Use the optional filter_by enum parameter to refine the response. When the value of filter_by is order, the API returns only beneficiaries associated with the order. When the value of filter_by is shipment, it returns only beneficiaries associated with the shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/payment/getRefundBeneficiariesUsingOTPSession/).
1306
- */
1307
- async getRefundBeneficiariesUsingOTPSession(
1308
- { orderId, shipmentId, filterBy, requestHeaders } = { requestHeaders: {} },
1309
- { responseHeaders } = { responseHeaders: false }
1310
- ) {
1311
- const query_params = {};
1312
- query_params["order_id"] = orderId;
1313
- query_params["shipment_id"] = shipmentId;
1314
- query_params["filter_by"] = filterBy;
1315
-
1316
- const xHeaders = {};
1317
-
1318
- const response = await ApplicationAPIClient.execute(
1319
- this._conf,
1320
- "get",
1321
- constructUrl({
1322
- url: this._urls["getRefundBeneficiariesUsingOTPSession"],
1323
- params: {},
1324
- }),
1325
- query_params,
1326
- undefined,
1327
- { ...xHeaders, ...requestHeaders },
1328
- { responseHeaders }
1329
- );
1330
-
1331
- let responseData = response;
1332
- if (responseHeaders) {
1333
- responseData = response[0];
1334
- }
1335
-
1336
- return response;
1337
- }
1338
-
1339
1129
  /**
1340
1130
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1341
1131
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -861,7 +861,7 @@ declare class Catalog {
861
861
  * @description: List all product ids a user has wishlisted or is following for sales channel.
862
862
  * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getFollowedProducts/).
863
863
  */
864
- getFollowedProducts({ userId, pageId, requestHeaders }?: CatalogPlatformApplicationValidator.GetFollowedProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowedProducts>;
864
+ getFollowedProducts({ userId, pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetFollowedProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowedProducts>;
865
865
  /**
866
866
  * @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
867
867
  * - Arg object
@@ -4591,7 +4591,7 @@ class Catalog {
4591
4591
  * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getFollowedProducts/).
4592
4592
  */
4593
4593
  async getFollowedProducts(
4594
- { userId, pageId, requestHeaders } = { requestHeaders: {} },
4594
+ { userId, pageId, pageSize, requestHeaders } = { requestHeaders: {} },
4595
4595
  { responseHeaders } = { responseHeaders: false }
4596
4596
  ) {
4597
4597
  const {
@@ -4600,6 +4600,7 @@ class Catalog {
4600
4600
  {
4601
4601
  userId,
4602
4602
  pageId,
4603
+ pageSize,
4603
4604
  },
4604
4605
  { abortEarly: false, allowUnknown: true }
4605
4606
  );
@@ -4614,6 +4615,7 @@ class Catalog {
4614
4615
  {
4615
4616
  userId,
4616
4617
  pageId,
4618
+ pageSize,
4617
4619
  },
4618
4620
  { abortEarly: false, allowUnknown: false }
4619
4621
  );
@@ -4626,6 +4628,7 @@ class Catalog {
4626
4628
 
4627
4629
  const query_params = {};
4628
4630
  query_params["page_id"] = pageId;
4631
+ query_params["page_size"] = pageSize;
4629
4632
 
4630
4633
  const response = await PlatformAPIClient.execute(
4631
4634
  this.config,
@@ -341,6 +341,7 @@ export = CatalogPlatformApplicationValidator;
341
341
  * @property {string} userId - User ID to fetch the followed list
342
342
  * @property {string} [pageId] - The identifier used to retrieve the next set of
343
343
  * results. This parameter follows cursor-based pagination.
344
+ * @property {number} [pageSize] - Number of items per page
344
345
  */
345
346
  /**
346
347
  * @typedef GetGroupConfigurationsParam
@@ -1246,6 +1247,10 @@ type GetFollowedProductsParam = {
1246
1247
  * results. This parameter follows cursor-based pagination.
1247
1248
  */
1248
1249
  pageId?: string;
1250
+ /**
1251
+ * - Number of items per page
1252
+ */
1253
+ pageSize?: number;
1249
1254
  };
1250
1255
  type GetGroupConfigurationsParam = {
1251
1256
  /**
@@ -390,6 +390,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
390
390
  * @property {string} userId - User ID to fetch the followed list
391
391
  * @property {string} [pageId] - The identifier used to retrieve the next set of
392
392
  * results. This parameter follows cursor-based pagination.
393
+ * @property {number} [pageSize] - Number of items per page
393
394
  */
394
395
 
395
396
  /**
@@ -935,6 +936,7 @@ class CatalogPlatformApplicationValidator {
935
936
  return Joi.object({
936
937
  userId: Joi.string().allow("").required(),
937
938
  pageId: Joi.string().allow(""),
939
+ pageSize: Joi.number(),
938
940
  }).required();
939
941
  }
940
942
 
@@ -62,16 +62,6 @@ declare class Catalog {
62
62
  * @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createBulkProductUploadJob/).
63
63
  */
64
64
  createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
65
- /**
66
- * @param {CatalogPlatformValidator.CreateHsCodeParam} arg - Arg object
67
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
68
- * @param {import("../PlatformAPIClient").Options} - Options
69
- * @returns {Promise<CatalogPlatformModel.HSCodeItem>} - Success response
70
- * @name createHsCode
71
- * @summary: Create HS/SAC code
72
- * @description: Create HS/SAC code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createHsCode/).
73
- */
74
- createHsCode({ body, requestHeaders }?: CatalogPlatformValidator.CreateHsCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSCodeItem>;
75
65
  /**
76
66
  * @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
77
67
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -170,36 +160,6 @@ declare class Catalog {
170
160
  * @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createSizeGuide/).
171
161
  */
172
162
  createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
173
- /**
174
- * @param {CatalogPlatformValidator.CreateTaxParam} arg - Arg object
175
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
176
- * @param {import("../PlatformAPIClient").Options} - Options
177
- * @returns {Promise<CatalogPlatformModel.CreateTax>} - Success response
178
- * @name createTax
179
- * @summary: Create a new Tax Rule and immediately generate its corresponding live version.
180
- * @description: Create a tax rule and its version for under a specific company. This also creates a live version of the rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTax/).
181
- */
182
- createTax({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateTax>;
183
- /**
184
- * @param {CatalogPlatformValidator.CreateTaxComponentNameParam} arg - Arg object
185
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
186
- * @param {import("../PlatformAPIClient").Options} - Options
187
- * @returns {Promise<CatalogPlatformModel.TaxComponentRes>} - Success response
188
- * @name createTaxComponentName
189
- * @summary: Create component names
190
- * @description: Create component names for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxComponentName/).
191
- */
192
- createTaxComponentName({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxComponentNameParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxComponentRes>;
193
- /**
194
- * @param {CatalogPlatformValidator.CreateTaxVersionParam} arg - Arg object
195
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
196
- * @param {import("../PlatformAPIClient").Options} - Options
197
- * @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
198
- * @name createTaxVersion
199
- * @summary: Create a tax version
200
- * @description: Creates a tax rule using the provided rule_id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxVersion/).
201
- */
202
- createTaxVersion({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.CreateTaxVersionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxVersion>;
203
163
  /**
204
164
  * @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
205
165
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -253,27 +213,6 @@ declare class Catalog {
253
213
  * @description: Allows to delete size associated with product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteSize/).
254
214
  */
255
215
  deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>;
256
- /**
257
- * @param {CatalogPlatformValidator.DeleteTaxRuleParam} arg - Arg object
258
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
259
- * @param {import("../PlatformAPIClient").Options} - Options
260
- * @returns {Promise<Object>} - Success response
261
- * @name deleteTaxRule
262
- * @summary: Delete a tax rule
263
- * @description: Deletes a tax rule along with all its versions using the provided rule_id. You can not delete a rule if 1. it is the default tax rule 2. it is applied to any product. You will need to set any other tax rule as default or will need to attach a different tax rule to the products, then only you can delete the rule.
264
- * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteTaxRule/).
265
- */
266
- deleteTaxRule({ ruleId, requestHeaders }?: CatalogPlatformValidator.DeleteTaxRuleParam, { responseHeaders }?: object): Promise<any>;
267
- /**
268
- * @param {CatalogPlatformValidator.DeleteTaxVersionParam} arg - Arg object
269
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
270
- * @param {import("../PlatformAPIClient").Options} - Options
271
- * @returns {Promise<Object>} - Success response
272
- * @name deleteTaxVersion
273
- * @summary: Delete a tax version
274
- * @description: Deletes a tax rule using the provided rule_id. On future/scheduled version can be deleted. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteTaxVersion/).
275
- */
276
- deleteTaxVersion({ ruleId, versionId, requestHeaders }?: CatalogPlatformValidator.DeleteTaxVersionParam, { responseHeaders }?: object): Promise<any>;
277
216
  /**
278
217
  * @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
279
218
  * - Arg object
@@ -330,16 +269,6 @@ declare class Catalog {
330
269
  * @description: Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAllProductHsnCodes/).
331
270
  */
332
271
  getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
333
- /**
334
- * @param {CatalogPlatformValidator.GetAllTaxRulesParam} arg - Arg object
335
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
336
- * @param {import("../PlatformAPIClient").Options} - Options
337
- * @returns {Promise<CatalogPlatformModel.TaxRules>} - Success response
338
- * @name getAllTaxRules
339
- * @summary: Get all tax rules of a company
340
- * @description: Returns array of all tax rules of a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAllTaxRules/).
341
- */
342
- getAllTaxRules({ q, statuses, page, limit, versionStatus, requestHeaders }?: CatalogPlatformValidator.GetAllTaxRulesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRules>;
343
272
  /**
344
273
  * @param {CatalogPlatformValidator.GetAttributeParam} arg - Arg object
345
274
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -403,19 +332,6 @@ declare class Catalog {
403
332
  * @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getDepartmentData/).
404
333
  */
405
334
  getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
406
- /**
407
- * @param {CatalogPlatformValidator.GetHsCodesParam} arg - Arg object
408
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
409
- * @param {import("../PlatformAPIClient").Options} - Options
410
- * @returns {Promise<CatalogPlatformModel.HSCodes>} - Success response
411
- * @name getHsCodes
412
- * @summary: Get HS/SAC codes
413
- * @description: Retrieve a list of HS (Harmonized System) or SAC (Service Accounting Code) codes for a company.
414
- * HS codes are used for classifying goods in international trade, while SAC codes are used for classifying services for taxation purposes.
415
- * Supports optional filtering and pagination.
416
- * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getHsCodes/).
417
- */
418
- getHsCodes({ page, limit, type, q, requestHeaders }?: CatalogPlatformValidator.GetHsCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSCodes>;
419
335
  /**
420
336
  * @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
421
337
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -870,26 +786,6 @@ declare class Catalog {
870
786
  q?: string;
871
787
  pageSize?: number;
872
788
  }): Paginator<CatalogPlatformModel.OptinStoreDetails>;
873
- /**
874
- * @param {CatalogPlatformValidator.GetTaxComponentNamesParam} arg - Arg object
875
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
876
- * @param {import("../PlatformAPIClient").Options} - Options
877
- * @returns {Promise<CatalogPlatformModel.GetTaxComponents>} - Success response
878
- * @name getTaxComponentNames
879
- * @summary: Get component names
880
- * @description: Get component names for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getTaxComponentNames/).
881
- */
882
- getTaxComponentNames({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetTaxComponents>;
883
- /**
884
- * @param {CatalogPlatformValidator.GetTaxVersionDetailsParam} arg - Arg object
885
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
886
- * @param {import("../PlatformAPIClient").Options} - Options
887
- * @returns {Promise<CatalogPlatformModel.TaxRuleVersion>} - Success response
888
- * @name getTaxVersionDetails
889
- * @summary: Get tax versions for a tax rule
890
- * @description: Retrieve versions of a tax rule with support for filtering by query parameters (e.g., live, past, all). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getTaxVersionDetails/).
891
- */
892
- getTaxVersionDetails({ ruleId, versionStatus, limit, page, requestHeaders }?: CatalogPlatformValidator.GetTaxVersionDetailsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRuleVersion>;
893
789
  /**
894
790
  * @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
895
791
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1143,26 +1039,6 @@ declare class Catalog {
1143
1039
  * @description: Allows to edit a specific size guide. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateSizeGuide/).
1144
1040
  */
1145
1041
  updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
1146
- /**
1147
- * @param {CatalogPlatformValidator.UpdateTaxRuleParam} arg - Arg object
1148
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1149
- * @param {import("../PlatformAPIClient").Options} - Options
1150
- * @returns {Promise<CatalogPlatformModel.TaxRule>} - Success response
1151
- * @name updateTaxRule
1152
- * @summary: Update a Tax Rule for a Product
1153
- * @description: Update an existing tax rule under a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxRule/).
1154
- */
1155
- updateTaxRule({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRule>;
1156
- /**
1157
- * @param {CatalogPlatformValidator.UpdateTaxVersionParam} arg - Arg object
1158
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1159
- * @param {import("../PlatformAPIClient").Options} - Options
1160
- * @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
1161
- * @name updateTaxVersion
1162
- * @summary: Update a tax version
1163
- * @description: Updates a tax rule using the provided rule_id. You can update any part of a scheduled version but only tax name of live version can be updated. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxVersion/).
1164
- */
1165
- updateTaxVersion({ ruleId, versionId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxVersionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxVersion>;
1166
1042
  /**
1167
1043
  * @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
1168
1044
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1170,7 +1046,7 @@ declare class Catalog {
1170
1046
  * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
1171
1047
  * @name uploadBulkProducts
1172
1048
  * @summary: Upload bulk products
1173
- * @description: Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/uploadBulkProducts/).
1049
+ * @description: Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/uploadBulkProducts/).
1174
1050
  */
1175
1051
  uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
1176
1052
  /**