@gofynd/fdk-client-javascript 3.7.0 → 3.8.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.7.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.8.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.7.0",
3
+ "version": "3.8.0",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -3,8 +3,10 @@ declare class Payment {
3
3
  constructor(_conf: any);
4
4
  _conf: any;
5
5
  _relativeUrls: {
6
+ addBeneficiary: string;
6
7
  addBeneficiaryDetails: string;
7
8
  addRefundBankAccountUsingOTP: string;
9
+ addRefundBeneficiaryUsingOTPSession: string;
8
10
  attachCardToCustomer: string;
9
11
  cancelPaymentLink: string;
10
12
  cardDetails: string;
@@ -16,6 +18,7 @@ declare class Payment {
16
18
  createPaymentOrder: string;
17
19
  customerCreditSummary: string;
18
20
  customerOnboard: string;
21
+ deleteBeneficiary: string;
19
22
  deleteUserCard: string;
20
23
  delinkWallet: string;
21
24
  enableOrDisableRefundTransferMode: string;
@@ -29,6 +32,8 @@ declare class Payment {
29
32
  getPaymentModeRoutes: string;
30
33
  getPaymentModeRoutesPaymentLink: string;
31
34
  getPosPaymentModeRoutes: string;
35
+ getRefundBeneficiaries: string;
36
+ getRefundBeneficiariesUsingOTPSession: string;
32
37
  getRupifiBannerDetails: string;
33
38
  getUserBeneficiariesDetail: string;
34
39
  initialisePayment: string;
@@ -52,6 +57,15 @@ declare class Payment {
52
57
  };
53
58
  _urls: {};
54
59
  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>;
55
69
  /**
56
70
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
57
71
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -70,6 +84,15 @@ declare class Payment {
70
84
  * @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/).
71
85
  */
72
86
  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>;
73
96
  /**
74
97
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
75
98
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -169,6 +192,15 @@ declare class Payment {
169
192
  * @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/).
170
193
  */
171
194
  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>;
172
204
  /**
173
205
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
174
206
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -286,6 +318,24 @@ declare class Payment {
286
318
  * @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/).
287
319
  */
288
320
  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>;
289
339
  /**
290
340
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
291
341
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -12,9 +12,13 @@ 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",
15
17
  addBeneficiaryDetails: "/service/application/payment/v1.0/refund/account",
16
18
  addRefundBankAccountUsingOTP:
17
19
  "/service/application/payment/v1.0/refund/account/otp",
20
+ addRefundBeneficiaryUsingOTPSession:
21
+ "/service/application/payment/v2.0/refund/user/beneficiary-otp",
18
22
  attachCardToCustomer: "/service/application/payment/v1.0/card/attach",
19
23
  cancelPaymentLink:
20
24
  "/service/application/payment/v1.0/cancel-payment-link/",
@@ -32,6 +36,8 @@ class Payment {
32
36
  customerCreditSummary:
33
37
  "/service/application/payment/v1.0/payment/credit-summary/",
34
38
  customerOnboard: "/service/application/payment/v1.0/credit-onboard/",
39
+ deleteBeneficiary:
40
+ "/service/application/payment/v1.0/refund/account/{id}",
35
41
  deleteUserCard: "/service/application/payment/v1.0/card/remove",
36
42
  delinkWallet:
37
43
  "/service/application/payment/v1.0/payment/options/wallet/delink",
@@ -54,6 +60,10 @@ class Payment {
54
60
  "/service/application/payment/v1.0/payment/options/link/",
55
61
  getPosPaymentModeRoutes:
56
62
  "/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",
57
67
  getRupifiBannerDetails: "/service/application/payment/v1.0/rupifi/banner",
58
68
  getUserBeneficiariesDetail:
59
69
  "/service/application/payment/v1.0/refund/user/beneficiary",
@@ -106,6 +116,43 @@ class Payment {
106
116
  };
107
117
  }
108
118
 
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
+
109
156
  /**
110
157
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
111
158
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -180,6 +227,43 @@ class Payment {
180
227
  return response;
181
228
  }
182
229
 
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
+
183
267
  /**
184
268
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
185
269
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -599,6 +683,52 @@ class Payment {
599
683
  return response;
600
684
  }
601
685
 
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
+
602
732
  /**
603
733
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
604
734
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -1126,6 +1256,86 @@ class Payment {
1126
1256
  return response;
1127
1257
  }
1128
1258
 
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
+
1129
1339
  /**
1130
1340
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1131
1341
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -62,6 +62,16 @@ 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>;
65
75
  /**
66
76
  * @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
67
77
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -160,6 +170,40 @@ declare class Catalog {
160
170
  * @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/).
161
171
  */
162
172
  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 Tax Rule
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.TaxComponentName>} - Success response
188
+ * @name createTaxComponentName
189
+ * @summary: Create tax component name
190
+ * @description: Tax components represent different types of taxes that may be applied to products or transactions,
191
+ * such as sales tax, value-added tax (VAT), goods and services tax, consumption tax,
192
+ * or other region-specific taxation systems. This endpoint allows companies to define and
193
+ * customize the names of tax components according to their local tax regulations and business requirements.
194
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxComponentName/).
195
+ */
196
+ createTaxComponentName({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxComponentNameParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxComponentName>;
197
+ /**
198
+ * @param {CatalogPlatformValidator.CreateTaxVersionParam} arg - Arg object
199
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
200
+ * @param {import("../PlatformAPIClient").Options} - Options
201
+ * @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
202
+ * @name createTaxVersion
203
+ * @summary: Create a tax version
204
+ * @description: Creates a tax rule using the provided rule_id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxVersion/).
205
+ */
206
+ createTaxVersion({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.CreateTaxVersionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxVersion>;
163
207
  /**
164
208
  * @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
165
209
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -213,6 +257,27 @@ declare class Catalog {
213
257
  * @description: Allows to delete size associated with product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteSize/).
214
258
  */
215
259
  deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>;
260
+ /**
261
+ * @param {CatalogPlatformValidator.DeleteTaxRuleParam} arg - Arg object
262
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
263
+ * @param {import("../PlatformAPIClient").Options} - Options
264
+ * @returns {Promise<Object>} - Success response
265
+ * @name deleteTaxRule
266
+ * @summary: Delete a tax rule
267
+ * @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.
268
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteTaxRule/).
269
+ */
270
+ deleteTaxRule({ ruleId, requestHeaders }?: CatalogPlatformValidator.DeleteTaxRuleParam, { responseHeaders }?: object): Promise<any>;
271
+ /**
272
+ * @param {CatalogPlatformValidator.DeleteTaxVersionParam} arg - Arg object
273
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
274
+ * @param {import("../PlatformAPIClient").Options} - Options
275
+ * @returns {Promise<Object>} - Success response
276
+ * @name deleteTaxVersion
277
+ * @summary: Delete a tax version
278
+ * @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/).
279
+ */
280
+ deleteTaxVersion({ ruleId, versionId, requestHeaders }?: CatalogPlatformValidator.DeleteTaxVersionParam, { responseHeaders }?: object): Promise<any>;
216
281
  /**
217
282
  * @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
218
283
  * - Arg object
@@ -269,6 +334,16 @@ declare class Catalog {
269
334
  * @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/).
270
335
  */
271
336
  getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
337
+ /**
338
+ * @param {CatalogPlatformValidator.GetAllTaxRulesParam} arg - Arg object
339
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
340
+ * @param {import("../PlatformAPIClient").Options} - Options
341
+ * @returns {Promise<CatalogPlatformModel.TaxRules>} - Success response
342
+ * @name getAllTaxRules
343
+ * @summary: Get all tax rules of a company
344
+ * @description: Returns array of all tax rules of a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAllTaxRules/).
345
+ */
346
+ getAllTaxRules({ q, statuses, page, limit, versionStatus, requestHeaders }?: CatalogPlatformValidator.GetAllTaxRulesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRules>;
272
347
  /**
273
348
  * @param {CatalogPlatformValidator.GetAttributeParam} arg - Arg object
274
349
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -332,6 +407,19 @@ declare class Catalog {
332
407
  * @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/).
333
408
  */
334
409
  getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
410
+ /**
411
+ * @param {CatalogPlatformValidator.GetHsCodesParam} arg - Arg object
412
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
413
+ * @param {import("../PlatformAPIClient").Options} - Options
414
+ * @returns {Promise<CatalogPlatformModel.HSCodes>} - Success response
415
+ * @name getHsCodes
416
+ * @summary: Get HS/SAC codes
417
+ * @description: Retrieve a list of HS (Harmonized System) or SAC (Service Accounting Code) codes for a company.
418
+ * HS codes are used for classifying goods in international trade, while SAC codes are used for classifying services for taxation purposes.
419
+ * Supports optional filtering and pagination.
420
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getHsCodes/).
421
+ */
422
+ getHsCodes({ page, limit, type, q, requestHeaders }?: CatalogPlatformValidator.GetHsCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSCodes>;
335
423
  /**
336
424
  * @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
337
425
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -786,6 +874,26 @@ declare class Catalog {
786
874
  q?: string;
787
875
  pageSize?: number;
788
876
  }): Paginator<CatalogPlatformModel.OptinStoreDetails>;
877
+ /**
878
+ * @param {CatalogPlatformValidator.GetTaxComponentNamesParam} arg - Arg object
879
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
880
+ * @param {import("../PlatformAPIClient").Options} - Options
881
+ * @returns {Promise<CatalogPlatformModel.GetTaxComponents>} - Success response
882
+ * @name getTaxComponentNames
883
+ * @summary: Get component names
884
+ * @description: Get component names for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getTaxComponentNames/).
885
+ */
886
+ getTaxComponentNames({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetTaxComponents>;
887
+ /**
888
+ * @param {CatalogPlatformValidator.GetTaxVersionDetailsParam} arg - Arg object
889
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
890
+ * @param {import("../PlatformAPIClient").Options} - Options
891
+ * @returns {Promise<CatalogPlatformModel.TaxRuleVersion>} - Success response
892
+ * @name getTaxVersionDetails
893
+ * @summary: Get tax versions for a tax rule
894
+ * @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/).
895
+ */
896
+ getTaxVersionDetails({ ruleId, versionStatus, limit, page, requestHeaders }?: CatalogPlatformValidator.GetTaxVersionDetailsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRuleVersion>;
789
897
  /**
790
898
  * @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
791
899
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1040,15 +1148,25 @@ declare class Catalog {
1040
1148
  */
1041
1149
  updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
1042
1150
  /**
1043
- * @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
1151
+ * @param {CatalogPlatformValidator.UpdateTaxRuleParam} arg - Arg object
1044
1152
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1045
1153
  * @param {import("../PlatformAPIClient").Options} - Options
1046
- * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
1047
- * @name uploadBulkProducts
1048
- * @summary: Upload bulk products
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/).
1154
+ * @returns {Promise<CatalogPlatformModel.TaxRule>} - Success response
1155
+ * @name updateTaxRule
1156
+ * @summary: Update Tax Rule
1157
+ * @description: Update an existing tax rule under a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxRule/).
1158
+ */
1159
+ updateTaxRule({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRule>;
1160
+ /**
1161
+ * @param {CatalogPlatformValidator.UpdateTaxVersionParam} arg - Arg object
1162
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1163
+ * @param {import("../PlatformAPIClient").Options} - Options
1164
+ * @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
1165
+ * @name updateTaxVersion
1166
+ * @summary: Update a tax version
1167
+ * @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/).
1050
1168
  */
1051
- uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
1169
+ updateTaxVersion({ ruleId, versionId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxVersionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxVersion>;
1052
1170
  /**
1053
1171
  * @param {CatalogPlatformValidator.ValidateProductGlobalTemplateParam} arg
1054
1172
  * - Arg object