@gofynd/fdk-client-javascript 3.4.2 → 3.4.4

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.4.2' --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.4.4' --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.4.2",
3
+ "version": "3.4.4",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -105,7 +105,7 @@ fdkAxios.interceptors.request.use(
105
105
  Logger({
106
106
  level: "ERROR",
107
107
  message: error.data || error.message,
108
- stack: error.data.stack || error.stack,
108
+ stack: error?.data?.stack || error.stack,
109
109
  });
110
110
  }
111
111
  );
@@ -632,7 +632,6 @@ export = CatalogPlatformModel;
632
632
  * @property {string} [template_tag]
633
633
  * @property {number} [total]
634
634
  * @property {string} [tracking_url]
635
- * @property {string[]} [tags]
636
635
  */
637
636
  /**
638
637
  * @typedef BulkProductRequestSchema
@@ -2629,9 +2628,16 @@ export = CatalogPlatformModel;
2629
2628
  /**
2630
2629
  * @typedef LocationQuantityRequestSchema
2631
2630
  * @property {string} [expiration_date] - The expiration date of the inventory item.
2632
- * @property {number} [total_quantity] - The total quantity of the inventory item.
2633
- * @property {number} [damaged_quantity] - The total quantity of the inventory item.
2634
- * @property {number} [not_available_quantity] - The total quantity of the inventory item.
2631
+ * @property {number} [total_quantity] - The total quantity of the inventory
2632
+ * item. Any one of total_quantity, damaged_quantity, not_available_quantity
2633
+ * should be provided.
2634
+ * @property {number} [damaged_quantity] - The damaged quantity of the inventory
2635
+ * item. Any one of total_quantity, damaged_quantity, not_available_quantity
2636
+ * should be provided.
2637
+ * @property {number} [not_available_quantity] - The not available quantity of
2638
+ * the inventory item. Any one of total_quantity, damaged_quantity,
2639
+ * not_available_quantity should be provided.
2640
+ * @property {string} [mode] - Indicates whether delta or replace operation for inventory
2635
2641
  */
2636
2642
  /**
2637
2643
  * @typedef LocationPriceQuantitySuccessResponseSchema
@@ -4253,6 +4259,7 @@ export = CatalogPlatformModel;
4253
4259
  * either price or quantity.
4254
4260
  * @property {string} file_path - URL of the uploaded file containing inventory
4255
4261
  * update data.
4262
+ * @property {string[]} [tags] - Tags associated with the inventory update job.
4256
4263
  * @property {BulkMeta} [meta]
4257
4264
  */
4258
4265
  /**
@@ -5748,7 +5755,6 @@ type BulkJob = {
5748
5755
  template_tag?: string;
5749
5756
  total?: number;
5750
5757
  tracking_url?: string;
5751
- tags?: string[];
5752
5758
  };
5753
5759
  /** @returns {BulkProductRequestSchema} */
5754
5760
  declare function BulkProductRequestSchema(): BulkProductRequestSchema;
@@ -10043,17 +10049,27 @@ type LocationQuantityRequestSchema = {
10043
10049
  */
10044
10050
  expiration_date?: string;
10045
10051
  /**
10046
- * - The total quantity of the inventory item.
10052
+ * - The total quantity of the inventory
10053
+ * item. Any one of total_quantity, damaged_quantity, not_available_quantity
10054
+ * should be provided.
10047
10055
  */
10048
10056
  total_quantity?: number;
10049
10057
  /**
10050
- * - The total quantity of the inventory item.
10058
+ * - The damaged quantity of the inventory
10059
+ * item. Any one of total_quantity, damaged_quantity, not_available_quantity
10060
+ * should be provided.
10051
10061
  */
10052
10062
  damaged_quantity?: number;
10053
10063
  /**
10054
- * - The total quantity of the inventory item.
10064
+ * - The not available quantity of
10065
+ * the inventory item. Any one of total_quantity, damaged_quantity,
10066
+ * not_available_quantity should be provided.
10055
10067
  */
10056
10068
  not_available_quantity?: number;
10069
+ /**
10070
+ * - Indicates whether delta or replace operation for inventory
10071
+ */
10072
+ mode?: string;
10057
10073
  };
10058
10074
  /** @returns {LocationPriceQuantitySuccessResponseSchema} */
10059
10075
  declare function LocationPriceQuantitySuccessResponseSchema(): LocationPriceQuantitySuccessResponseSchema;
@@ -13679,6 +13695,10 @@ type BulkInventoryJob = {
13679
13695
  * update data.
13680
13696
  */
13681
13697
  file_path: string;
13698
+ /**
13699
+ * - Tags associated with the inventory update job.
13700
+ */
13701
+ tags?: string[];
13682
13702
  meta?: BulkMeta;
13683
13703
  };
13684
13704
  /** @returns {Marketplaces} */
@@ -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
  /**
@@ -2891,9 +2890,16 @@ const Joi = require("joi");
2891
2890
  /**
2892
2891
  * @typedef LocationQuantityRequestSchema
2893
2892
  * @property {string} [expiration_date] - The expiration date of the inventory item.
2894
- * @property {number} [total_quantity] - The total quantity of the inventory item.
2895
- * @property {number} [damaged_quantity] - The total quantity of the inventory item.
2896
- * @property {number} [not_available_quantity] - The total quantity of the inventory item.
2893
+ * @property {number} [total_quantity] - The total quantity of the inventory
2894
+ * item. Any one of total_quantity, damaged_quantity, not_available_quantity
2895
+ * should be provided.
2896
+ * @property {number} [damaged_quantity] - The damaged quantity of the inventory
2897
+ * item. Any one of total_quantity, damaged_quantity, not_available_quantity
2898
+ * should be provided.
2899
+ * @property {number} [not_available_quantity] - The not available quantity of
2900
+ * the inventory item. Any one of total_quantity, damaged_quantity,
2901
+ * not_available_quantity should be provided.
2902
+ * @property {string} [mode] - Indicates whether delta or replace operation for inventory
2897
2903
  */
2898
2904
 
2899
2905
  /**
@@ -4659,6 +4665,7 @@ const Joi = require("joi");
4659
4665
  * either price or quantity.
4660
4666
  * @property {string} file_path - URL of the uploaded file containing inventory
4661
4667
  * update data.
4668
+ * @property {string[]} [tags] - Tags associated with the inventory update job.
4662
4669
  * @property {BulkMeta} [meta]
4663
4670
  */
4664
4671
 
@@ -5574,7 +5581,6 @@ class CatalogPlatformModel {
5574
5581
  template_tag: Joi.string().allow(""),
5575
5582
  total: Joi.number(),
5576
5583
  tracking_url: Joi.string().allow(""),
5577
- tags: Joi.array().items(Joi.string().allow("")),
5578
5584
  });
5579
5585
  }
5580
5586
 
@@ -7962,6 +7968,7 @@ class CatalogPlatformModel {
7962
7968
  total_quantity: Joi.number(),
7963
7969
  damaged_quantity: Joi.number(),
7964
7970
  not_available_quantity: Joi.number(),
7971
+ mode: Joi.string().allow(""),
7965
7972
  });
7966
7973
  }
7967
7974
 
@@ -9801,6 +9808,7 @@ class CatalogPlatformModel {
9801
9808
  company_id: Joi.string().allow("").required(),
9802
9809
  file_type: Joi.string().allow("").required(),
9803
9810
  file_path: Joi.string().allow("").required(),
9811
+ tags: Joi.array().items(Joi.string().allow("")),
9804
9812
  meta: CatalogPlatformModel.BulkMeta(),
9805
9813
  });
9806
9814
  }
@@ -114,6 +114,7 @@ export = CommunicationPlatformModel;
114
114
  * @property {string} [name]
115
115
  * @property {string} [file_url]
116
116
  * @property {string} [type]
117
+ * @property {string} [datasource_type] - Type of the datasource (audience or user_group)
117
118
  * @property {number} [records_count]
118
119
  * @property {string} [application]
119
120
  */
@@ -147,6 +148,7 @@ export = CommunicationPlatformModel;
147
148
  * @property {string} [_id]
148
149
  * @property {string} [datasource]
149
150
  * @property {string} [type]
151
+ * @property {string} [datasource_type] - Type of the datasource (audience or user_group)
150
152
  * @property {string} [name]
151
153
  * @property {string} [application]
152
154
  * @property {string} [created_at]
@@ -1027,6 +1029,10 @@ type CampaignReq = {
1027
1029
  name?: string;
1028
1030
  file_url?: string;
1029
1031
  type?: string;
1032
+ /**
1033
+ * - Type of the datasource (audience or user_group)
1034
+ */
1035
+ datasource_type?: string;
1030
1036
  records_count?: number;
1031
1037
  application?: string;
1032
1038
  };
@@ -1065,6 +1071,10 @@ type Campaign = {
1065
1071
  _id?: string;
1066
1072
  datasource?: string;
1067
1073
  type?: string;
1074
+ /**
1075
+ * - Type of the datasource (audience or user_group)
1076
+ */
1077
+ datasource_type?: string;
1068
1078
  name?: string;
1069
1079
  application?: string;
1070
1080
  created_at?: string;
@@ -133,6 +133,7 @@ const Joi = require("joi");
133
133
  * @property {string} [name]
134
134
  * @property {string} [file_url]
135
135
  * @property {string} [type]
136
+ * @property {string} [datasource_type] - Type of the datasource (audience or user_group)
136
137
  * @property {number} [records_count]
137
138
  * @property {string} [application]
138
139
  */
@@ -171,6 +172,7 @@ const Joi = require("joi");
171
172
  * @property {string} [_id]
172
173
  * @property {string} [datasource]
173
174
  * @property {string} [type]
175
+ * @property {string} [datasource_type] - Type of the datasource (audience or user_group)
174
176
  * @property {string} [name]
175
177
  * @property {string} [application]
176
178
  * @property {string} [created_at]
@@ -1178,6 +1180,7 @@ class CommunicationPlatformModel {
1178
1180
  name: Joi.string().allow(""),
1179
1181
  file_url: Joi.string().allow(""),
1180
1182
  type: Joi.string().allow(""),
1183
+ datasource_type: Joi.string().allow(""),
1181
1184
  records_count: Joi.number(),
1182
1185
  application: Joi.string().allow(""),
1183
1186
  });
@@ -1226,6 +1229,7 @@ class CommunicationPlatformModel {
1226
1229
  _id: Joi.string().allow(""),
1227
1230
  datasource: Joi.string().allow(""),
1228
1231
  type: Joi.string().allow(""),
1232
+ datasource_type: Joi.string().allow(""),
1229
1233
  name: Joi.string().allow(""),
1230
1234
  application: Joi.string().allow(""),
1231
1235
  created_at: Joi.string().allow(""),
@@ -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