@gofynd/fdk-client-javascript 3.3.6 → 3.4.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 (40) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  4. package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
  5. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
  6. package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
  7. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +4 -4
  8. package/sdk/partner/Logistics/LogisticsPartnerModel.js +2 -2
  9. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
  10. package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
  11. package/sdk/platform/Cart/CartPlatformModel.d.ts +193 -1
  12. package/sdk/platform/Cart/CartPlatformModel.js +123 -0
  13. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
  14. package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
  15. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
  16. package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
  17. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
  18. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
  19. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
  20. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
  21. package/sdk/platform/Order/OrderPlatformModel.d.ts +20 -1
  22. package/sdk/platform/Order/OrderPlatformModel.js +22 -0
  23. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
  24. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
  25. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
  26. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
  27. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
  28. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
  29. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
  30. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
  31. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
  32. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
  33. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
  34. package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
  35. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
  36. package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
  37. package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
  38. package/sdk/platform/User/UserPlatformModel.js +276 -7
  39. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
  40. package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
package/README.md CHANGED
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
237
237
  The above code will log the curl command in the console
238
238
 
239
239
  ```bash
240
- 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.3.6' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
240
+ 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.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
241
241
  Active Theme: Emerge
242
242
  ```
243
243
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gofynd/fdk-client-javascript",
3
- "version": "3.3.6",
3
+ "version": "3.4.0",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -324,7 +324,7 @@ declare class Catalog {
324
324
  * @summary: Get product price
325
325
  * @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductPriceBySlug/).
326
326
  */
327
- getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV4>;
327
+ getProductPriceBySlug({ slug, size, storeId, moq, fulfillmentOptionSlug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV4>;
328
328
  /**
329
329
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
330
330
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -333,7 +333,7 @@ declare class Catalog {
333
333
  * @summary: List sellers
334
334
  * @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
335
335
  */
336
- getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
336
+ getProductSellersBySlug({ slug, size, strategy, fulfillmentOptionSlug, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
337
337
  /**
338
338
  * @param {Object} arg - Arg object.
339
339
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -344,15 +344,18 @@ declare class Catalog {
344
344
  * /service/application/catalog/v1.0/products/sizes.
345
345
  * @param {string} [arg.strategy] - Sort stores on the basis of strategy.
346
346
  * eg, fast-delivery, low-price, optimal.
347
+ * @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
348
+ * method, indicating whether an order is for home delivery or store pickup
347
349
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
348
350
  * @returns {Paginator<ProductSizeSellersResponseV4>}
349
351
  * @summary: List sellers
350
352
  * @description: List all sellers offering a specific product identified by its slug and size.
351
353
  */
352
- getProductSellersBySlugPaginator({ slug, size, strategy, pageSize }?: {
354
+ getProductSellersBySlugPaginator({ slug, size, strategy, fulfillmentOptionSlug, pageSize, }?: {
353
355
  slug: string;
354
356
  size: string;
355
357
  strategy?: string;
358
+ fulfillmentOptionSlug?: string;
356
359
  pageSize?: number;
357
360
  }): Paginator<ProductSizeSellersResponseV4>;
358
361
  /**
@@ -1168,7 +1168,9 @@ class Catalog {
1168
1168
  * @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductPriceBySlug/).
1169
1169
  */
1170
1170
  async getProductPriceBySlug(
1171
- { slug, size, storeId, moq, requestHeaders } = { requestHeaders: {} },
1171
+ { slug, size, storeId, moq, fulfillmentOptionSlug, requestHeaders } = {
1172
+ requestHeaders: {},
1173
+ },
1172
1174
  { responseHeaders } = { responseHeaders: false }
1173
1175
  ) {
1174
1176
  const errors = validateRequiredParams(arguments[0], ["slug", "size"]);
@@ -1183,6 +1185,7 @@ class Catalog {
1183
1185
  const query_params = {};
1184
1186
  query_params["store_id"] = storeId;
1185
1187
  query_params["moq"] = moq;
1188
+ query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
1186
1189
 
1187
1190
  const xHeaders = {};
1188
1191
 
@@ -1216,9 +1219,15 @@ class Catalog {
1216
1219
  * @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
1217
1220
  */
1218
1221
  async getProductSellersBySlug(
1219
- { slug, size, strategy, pageNo, pageSize, requestHeaders } = {
1220
- requestHeaders: {},
1221
- },
1222
+ {
1223
+ slug,
1224
+ size,
1225
+ strategy,
1226
+ fulfillmentOptionSlug,
1227
+ pageNo,
1228
+ pageSize,
1229
+ requestHeaders,
1230
+ } = { requestHeaders: {} },
1222
1231
  { responseHeaders } = { responseHeaders: false }
1223
1232
  ) {
1224
1233
  const errors = validateRequiredParams(arguments[0], ["slug", "size"]);
@@ -1232,6 +1241,7 @@ class Catalog {
1232
1241
 
1233
1242
  const query_params = {};
1234
1243
  query_params["strategy"] = strategy;
1244
+ query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
1235
1245
  query_params["page_no"] = pageNo;
1236
1246
  query_params["page_size"] = pageSize;
1237
1247
 
@@ -1268,12 +1278,20 @@ class Catalog {
1268
1278
  * /service/application/catalog/v1.0/products/sizes.
1269
1279
  * @param {string} [arg.strategy] - Sort stores on the basis of strategy.
1270
1280
  * eg, fast-delivery, low-price, optimal.
1281
+ * @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
1282
+ * method, indicating whether an order is for home delivery or store pickup
1271
1283
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
1272
1284
  * @returns {Paginator<ProductSizeSellersResponseV4>}
1273
1285
  * @summary: List sellers
1274
1286
  * @description: List all sellers offering a specific product identified by its slug and size.
1275
1287
  */
1276
- getProductSellersBySlugPaginator({ slug, size, strategy, pageSize } = {}) {
1288
+ getProductSellersBySlugPaginator({
1289
+ slug,
1290
+ size,
1291
+ strategy,
1292
+ fulfillmentOptionSlug,
1293
+ pageSize,
1294
+ } = {}) {
1277
1295
  const paginator = new Paginator();
1278
1296
  const callback = async () => {
1279
1297
  const pageId = paginator.nextId;
@@ -1283,6 +1301,7 @@ class Catalog {
1283
1301
  slug: slug,
1284
1302
  size: size,
1285
1303
  strategy: strategy,
1304
+ fulfillmentOptionSlug: fulfillmentOptionSlug,
1286
1305
  pageNo: pageNo,
1287
1306
  pageSize: pageSize,
1288
1307
  });
@@ -8,6 +8,7 @@ declare class Logistic {
8
8
  getCountry: string;
9
9
  getCourierPartners: string;
10
10
  getDeliveryPromise: string;
11
+ getFulfillmentOptions: string;
11
12
  getLocalities: string;
12
13
  getLocality: string;
13
14
  getPincodeCity: string;
@@ -60,6 +61,15 @@ declare class Logistic {
60
61
  * @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
61
62
  */
62
63
  getDeliveryPromise({ xLocationDetail, xApplicationData, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
64
+ /**
65
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
66
+ * @param {import("../ApplicationAPIClient").Options} - Options
67
+ * @returns {Promise<FulfillmentOptionsList>} - Success response
68
+ * @name getFulfillmentOptions
69
+ * @summary: Get fulfillment options
70
+ * @description: Fetches available fulfillment options. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptions/).
71
+ */
72
+ getFulfillmentOptions({ xApplicationData, productSlug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FulfillmentOptionsList>;
63
73
  /**
64
74
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
65
75
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -20,6 +20,8 @@ class Logistic {
20
20
  "/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners",
21
21
  getDeliveryPromise:
22
22
  "/service/application/logistics/v1.0/delivery-promise",
23
+ getFulfillmentOptions:
24
+ "/service/application/logistics/v1.0/fulfillment-options",
23
25
  getLocalities:
24
26
  "/service/application/logistics/v1.0/localities/{locality_type}",
25
27
  getLocality:
@@ -270,6 +272,48 @@ class Logistic {
270
272
  return response;
271
273
  }
272
274
 
275
+ /**
276
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
277
+ * @param {import("../ApplicationAPIClient").Options} - Options
278
+ * @returns {Promise<FulfillmentOptionsList>} - Success response
279
+ * @name getFulfillmentOptions
280
+ * @summary: Get fulfillment options
281
+ * @description: Fetches available fulfillment options. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptions/).
282
+ */
283
+ async getFulfillmentOptions(
284
+ { xApplicationData, productSlug, storeId, requestHeaders } = {
285
+ requestHeaders: {},
286
+ },
287
+ { responseHeaders } = { responseHeaders: false }
288
+ ) {
289
+ const query_params = {};
290
+ query_params["product_slug"] = productSlug;
291
+ query_params["store_id"] = storeId;
292
+
293
+ const xHeaders = {};
294
+ xHeaders["x-application-data"] = xApplicationData;
295
+
296
+ const response = await ApplicationAPIClient.execute(
297
+ this._conf,
298
+ "get",
299
+ constructUrl({
300
+ url: this._urls["getFulfillmentOptions"],
301
+ params: {},
302
+ }),
303
+ query_params,
304
+ undefined,
305
+ { ...xHeaders, ...requestHeaders },
306
+ { responseHeaders }
307
+ );
308
+
309
+ let responseData = response;
310
+ if (responseHeaders) {
311
+ responseData = response[0];
312
+ }
313
+
314
+ return response;
315
+ }
316
+
273
317
  /**
274
318
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
275
319
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -8,7 +8,7 @@ export = LogisticsPartnerModel;
8
8
  * @property {string} [extension_id] - Unique identifier of courier partner extension.
9
9
  * @property {string} [scheme_id] - Unique identifier for the scheme, used to
10
10
  * fetch or modify scheme details.
11
- * @property {string} [company_id] - Unique identifier of company.
11
+ * @property {string} [company_id] - The unique identifier of the company.
12
12
  * @property {string} name - Name of the scheme.
13
13
  * @property {ArithmeticOperations} weight
14
14
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -394,7 +394,7 @@ export = LogisticsPartnerModel;
394
394
  * @property {string} [created_on] - The timestamp when the record was created.
395
395
  * @property {string} [modified_on] - The timestamp when the record last modified.
396
396
  * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
397
- * @property {string} [company_id] - Unique identifier of company.
397
+ * @property {string} [company_id] - The unique identifier of the company.
398
398
  * @property {string} name - Name of the scheme.
399
399
  * @property {ArithmeticOperations} weight
400
400
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -658,7 +658,7 @@ type CourierPartnerSchemeModelSchema = {
658
658
  */
659
659
  scheme_id?: string;
660
660
  /**
661
- * - Unique identifier of company.
661
+ * - The unique identifier of the company.
662
662
  */
663
663
  company_id?: string;
664
664
  /**
@@ -1576,7 +1576,7 @@ type CourierPartnerPutSchema = {
1576
1576
  */
1577
1577
  scheme_id?: string;
1578
1578
  /**
1579
- * - Unique identifier of company.
1579
+ * - The unique identifier of the company.
1580
1580
  */
1581
1581
  company_id?: string;
1582
1582
  /**
@@ -9,7 +9,7 @@ const Joi = require("joi");
9
9
  * @property {string} [extension_id] - Unique identifier of courier partner extension.
10
10
  * @property {string} [scheme_id] - Unique identifier for the scheme, used to
11
11
  * fetch or modify scheme details.
12
- * @property {string} [company_id] - Unique identifier of company.
12
+ * @property {string} [company_id] - The unique identifier of the company.
13
13
  * @property {string} name - Name of the scheme.
14
14
  * @property {ArithmeticOperations} weight
15
15
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -417,7 +417,7 @@ const Joi = require("joi");
417
417
  * @property {string} [created_on] - The timestamp when the record was created.
418
418
  * @property {string} [modified_on] - The timestamp when the record last modified.
419
419
  * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
420
- * @property {string} [company_id] - Unique identifier of company.
420
+ * @property {string} [company_id] - The unique identifier of the company.
421
421
  * @property {string} name - Name of the scheme.
422
422
  * @property {ArithmeticOperations} weight
423
423
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -307,6 +307,7 @@ export = WebhookPartnerModel;
307
307
  * @property {string} [name] - The name of the item.
308
308
  * @property {string} [webhook_url] - The URL of the webhook associated with the item.
309
309
  * @property {string} [provider] - The provider of the item.
310
+ * @property {string} [source] - Source that subscriber belongs to.
310
311
  * @property {Association} [association]
311
312
  * @property {Object} [custom_headers] - Custom headers associated with the item, if any.
312
313
  * @property {string} [status] - The current status of the item.
@@ -1062,6 +1063,10 @@ type ItemSchema = {
1062
1063
  * - The provider of the item.
1063
1064
  */
1064
1065
  provider?: string;
1066
+ /**
1067
+ * - Source that subscriber belongs to.
1068
+ */
1069
+ source?: string;
1065
1070
  association?: Association;
1066
1071
  /**
1067
1072
  * - Custom headers associated with the item, if any.
@@ -341,6 +341,7 @@ const Joi = require("joi");
341
341
  * @property {string} [name] - The name of the item.
342
342
  * @property {string} [webhook_url] - The URL of the webhook associated with the item.
343
343
  * @property {string} [provider] - The provider of the item.
344
+ * @property {string} [source] - Source that subscriber belongs to.
344
345
  * @property {Association} [association]
345
346
  * @property {Object} [custom_headers] - Custom headers associated with the item, if any.
346
347
  * @property {string} [status] - The current status of the item.
@@ -703,6 +704,7 @@ class WebhookPartnerModel {
703
704
  name: Joi.string().allow(""),
704
705
  webhook_url: Joi.string().allow(""),
705
706
  provider: Joi.string().allow(""),
707
+ source: Joi.string().allow("").allow(null),
706
708
  association: WebhookPartnerModel.Association(),
707
709
  custom_headers: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
708
710
  status: Joi.string().allow(""),
@@ -944,6 +944,39 @@ export = CartPlatformModel;
944
944
  * @property {string} [store_code] - A unique code or identifier for the store,
945
945
  * often used for internal reference
946
946
  */
947
+ /**
948
+ * @typedef FulfillmentOptionSchema
949
+ * @property {string} [slug] - Unique identifier for the delivery type.
950
+ * @property {string} [description] - Description of the delivery service.
951
+ * @property {boolean} [is_default] - Indicates if this is the default delivery option.
952
+ * @property {string} [id] - Unique ID of the delivery service.
953
+ * @property {string} [type] - Type of fulfillment option.
954
+ * @property {string} [name] - Name of the delivery service.
955
+ */
956
+ /**
957
+ * @typedef StoreTimingSchema
958
+ * @property {number} [hour] - The hour of the store in 24-hour format (e.g., 9 for 9 AM).
959
+ * @property {number} [minute] - The minute of the store (e.g., 30 for 9:30 AM).
960
+ */
961
+ /**
962
+ * @typedef StoreHoursSchema
963
+ * @property {string} [weekday] - The day of the week (e.g., "Monday", "Tuesday").
964
+ * @property {StoreTimingSchema} [opening]
965
+ * @property {StoreTimingSchema} [closing]
966
+ * @property {boolean} [open] - Indicates whether the store is open on the
967
+ * specified weekday.
968
+ */
969
+ /**
970
+ * @typedef PickupStoreDetailSchema
971
+ * @property {number} [store_id] - A unique identifier for the store.
972
+ * @property {string} [name] - The name of the store or pickup location.
973
+ * @property {string} [pincode] - The postal code of the store's location.
974
+ * @property {number} [distance] - The distance between the store and the
975
+ * customer's location.
976
+ * @property {string} [address] - The full address of the store.
977
+ * @property {Object} [store_hours] - The store's operational hours for each day
978
+ * of the week.
979
+ */
947
980
  /**
948
981
  * @typedef ProductArticle
949
982
  * @property {string} [seller_identifier] - List of identifiers used by sellers
@@ -975,6 +1008,8 @@ export = CartPlatformModel;
975
1008
  * @property {Object} [meta] - Meta data of article in cart
976
1009
  * @property {string} [size] - Size of the article added in cart
977
1010
  * @property {StoreInfo} [store]
1011
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
1012
+ * @property {PickupStoreDetailSchema} [pickup_store_detail]
978
1013
  * @property {number} [item_index] - Specify the index of article in cart.
979
1014
  * @property {string[]} [tags] - A list of article tags
980
1015
  */
@@ -1381,6 +1416,16 @@ export = CartPlatformModel;
1381
1416
  * @typedef CartCommonConfig
1382
1417
  * @property {DeliveryChargesConfig} [delivery_charges_config]
1383
1418
  */
1419
+ /**
1420
+ * @typedef PlatformAlternatePickupPerson
1421
+ * @property {boolean} [enabled] - Indicates whether an alternate pickup person
1422
+ * is enabled.
1423
+ * @property {string} [name] - Name of the alternate pickup person.
1424
+ * @property {string} [email] - Email address of the alternate pickup person.
1425
+ * @property {string} [phone] - Phone number of the alternate pickup person.
1426
+ * @property {string} [country_phone_code] - Country phone code of the alternate
1427
+ * pickup person (e.g., "+91").
1428
+ */
1384
1429
  /**
1385
1430
  * @typedef CartDetailResult
1386
1431
  * @property {number} [cart_id] - Unique identifier of the user cart
@@ -1422,6 +1467,7 @@ export = CartPlatformModel;
1422
1467
  * @property {string} [pan_no] - Permanent Account Number of the user
1423
1468
  * @property {Object} [custom_cart_meta] - Custom meta details added cart
1424
1469
  * checkout API payload
1470
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
1425
1471
  * @property {boolean} [free_gift_selection_available] - Determines if the cart
1426
1472
  * has available promotion free gift items to choose on its added items
1427
1473
  */
@@ -1453,6 +1499,10 @@ export = CartPlatformModel;
1453
1499
  * @property {boolean} [pos] - Filed to determine whether user is making request
1454
1500
  * from pos or not
1455
1501
  * @property {string} [seller_identifier] - Add items using seller identifier for store os
1502
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
1503
+ * method, indicating whether an order is for home delivery or store pickup
1504
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
1505
+ * selected by the user from which user wants to pickup the product.
1456
1506
  */
1457
1507
  /**
1458
1508
  * @typedef AddCartCreation
@@ -1499,6 +1549,10 @@ export = CartPlatformModel;
1499
1549
  * product falls to be updated
1500
1550
  * @property {CartProductIdentifer} identifiers
1501
1551
  * @property {string} [article_id] - Article id of the product in cart
1552
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
1553
+ * method, indicating whether an order is for home delivery or store pickup
1554
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
1555
+ * selected by the user from which user
1502
1556
  */
1503
1557
  /**
1504
1558
  * @typedef FreeGiftItemCreation
@@ -1897,6 +1951,7 @@ export = CartPlatformModel;
1897
1951
  * @property {string} [dp_id] - Delivery partner id of the shipment
1898
1952
  * @property {string} [fulfillment_type] - Fulfilment type of shipment
1899
1953
  * @property {ShipmentArticle[]} [articles] - List of articles in shipment
1954
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
1900
1955
  */
1901
1956
  /**
1902
1957
  * @typedef PlatformCartShipmentsResult
@@ -1953,6 +2008,7 @@ export = CartPlatformModel;
1953
2008
  * @property {string} [gstin] - GSTIN number to be added in user cart
1954
2009
  * @property {Object} [pick_up_customer_details] - Customer contact details for
1955
2010
  * customer pickup at store
2011
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
1956
2012
  * @property {string} [checkout_mode] - Checkout mode of user cart
1957
2013
  * @property {Object} [gift_details] - Gift details is open json which can
1958
2014
  * include gift message
@@ -2352,7 +2408,7 @@ export = CartPlatformModel;
2352
2408
  declare class CartPlatformModel {
2353
2409
  }
2354
2410
  declare namespace CartPlatformModel {
2355
- export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, DiscountRules, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
2411
+ export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, FulfillmentOptionSchema, StoreTimingSchema, StoreHoursSchema, PickupStoreDetailSchema, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, PlatformAlternatePickupPerson, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, DiscountRules, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
2356
2412
  }
2357
2413
  /** @returns {CouponDateMeta} */
2358
2414
  declare function CouponDateMeta(): CouponDateMeta;
@@ -4658,6 +4714,91 @@ type StoreInfo = {
4658
4714
  */
4659
4715
  store_code?: string;
4660
4716
  };
4717
+ /** @returns {FulfillmentOptionSchema} */
4718
+ declare function FulfillmentOptionSchema(): FulfillmentOptionSchema;
4719
+ type FulfillmentOptionSchema = {
4720
+ /**
4721
+ * - Unique identifier for the delivery type.
4722
+ */
4723
+ slug?: string;
4724
+ /**
4725
+ * - Description of the delivery service.
4726
+ */
4727
+ description?: string;
4728
+ /**
4729
+ * - Indicates if this is the default delivery option.
4730
+ */
4731
+ is_default?: boolean;
4732
+ /**
4733
+ * - Unique ID of the delivery service.
4734
+ */
4735
+ id?: string;
4736
+ /**
4737
+ * - Type of fulfillment option.
4738
+ */
4739
+ type?: string;
4740
+ /**
4741
+ * - Name of the delivery service.
4742
+ */
4743
+ name?: string;
4744
+ };
4745
+ /** @returns {StoreTimingSchema} */
4746
+ declare function StoreTimingSchema(): StoreTimingSchema;
4747
+ type StoreTimingSchema = {
4748
+ /**
4749
+ * - The hour of the store in 24-hour format (e.g., 9 for 9 AM).
4750
+ */
4751
+ hour?: number;
4752
+ /**
4753
+ * - The minute of the store (e.g., 30 for 9:30 AM).
4754
+ */
4755
+ minute?: number;
4756
+ };
4757
+ /** @returns {StoreHoursSchema} */
4758
+ declare function StoreHoursSchema(): StoreHoursSchema;
4759
+ type StoreHoursSchema = {
4760
+ /**
4761
+ * - The day of the week (e.g., "Monday", "Tuesday").
4762
+ */
4763
+ weekday?: string;
4764
+ opening?: StoreTimingSchema;
4765
+ closing?: StoreTimingSchema;
4766
+ /**
4767
+ * - Indicates whether the store is open on the
4768
+ * specified weekday.
4769
+ */
4770
+ open?: boolean;
4771
+ };
4772
+ /** @returns {PickupStoreDetailSchema} */
4773
+ declare function PickupStoreDetailSchema(): PickupStoreDetailSchema;
4774
+ type PickupStoreDetailSchema = {
4775
+ /**
4776
+ * - A unique identifier for the store.
4777
+ */
4778
+ store_id?: number;
4779
+ /**
4780
+ * - The name of the store or pickup location.
4781
+ */
4782
+ name?: string;
4783
+ /**
4784
+ * - The postal code of the store's location.
4785
+ */
4786
+ pincode?: string;
4787
+ /**
4788
+ * - The distance between the store and the
4789
+ * customer's location.
4790
+ */
4791
+ distance?: number;
4792
+ /**
4793
+ * - The full address of the store.
4794
+ */
4795
+ address?: string;
4796
+ /**
4797
+ * - The store's operational hours for each day
4798
+ * of the week.
4799
+ */
4800
+ store_hours?: any;
4801
+ };
4661
4802
  /** @returns {ProductArticle} */
4662
4803
  declare function ProductArticle(): ProductArticle;
4663
4804
  type ProductArticle = {
@@ -4738,6 +4879,8 @@ type ProductArticle = {
4738
4879
  */
4739
4880
  size?: string;
4740
4881
  store?: StoreInfo;
4882
+ fulfillment_option?: FulfillmentOptionSchema;
4883
+ pickup_store_detail?: PickupStoreDetailSchema;
4741
4884
  /**
4742
4885
  * - Specify the index of article in cart.
4743
4886
  */
@@ -5812,6 +5955,32 @@ declare function CartCommonConfig(): CartCommonConfig;
5812
5955
  type CartCommonConfig = {
5813
5956
  delivery_charges_config?: DeliveryChargesConfig;
5814
5957
  };
5958
+ /** @returns {PlatformAlternatePickupPerson} */
5959
+ declare function PlatformAlternatePickupPerson(): PlatformAlternatePickupPerson;
5960
+ type PlatformAlternatePickupPerson = {
5961
+ /**
5962
+ * - Indicates whether an alternate pickup person
5963
+ * is enabled.
5964
+ */
5965
+ enabled?: boolean;
5966
+ /**
5967
+ * - Name of the alternate pickup person.
5968
+ */
5969
+ name?: string;
5970
+ /**
5971
+ * - Email address of the alternate pickup person.
5972
+ */
5973
+ email?: string;
5974
+ /**
5975
+ * - Phone number of the alternate pickup person.
5976
+ */
5977
+ phone?: string;
5978
+ /**
5979
+ * - Country phone code of the alternate
5980
+ * pickup person (e.g., "+91").
5981
+ */
5982
+ country_phone_code?: string;
5983
+ };
5815
5984
  /** @returns {CartDetailResult} */
5816
5985
  declare function CartDetailResult(): CartDetailResult;
5817
5986
  type CartDetailResult = {
@@ -5917,6 +6086,7 @@ type CartDetailResult = {
5917
6086
  * checkout API payload
5918
6087
  */
5919
6088
  custom_cart_meta?: any;
6089
+ alternate_pickup_person?: PlatformAlternatePickupPerson;
5920
6090
  /**
5921
6091
  * - Determines if the cart
5922
6092
  * has available promotion free gift items to choose on its added items
@@ -6000,6 +6170,16 @@ type AddProductCart = {
6000
6170
  * - Add items using seller identifier for store os
6001
6171
  */
6002
6172
  seller_identifier?: string;
6173
+ /**
6174
+ * - Specifies the fulfillment
6175
+ * method, indicating whether an order is for home delivery or store pickup
6176
+ */
6177
+ fulfillment_option_slug?: string;
6178
+ /**
6179
+ * - Unique identifier of the pickup store
6180
+ * selected by the user from which user wants to pickup the product.
6181
+ */
6182
+ pickup_store_id?: number;
6003
6183
  };
6004
6184
  /** @returns {AddCartCreation} */
6005
6185
  declare function AddCartCreation(): AddCartCreation;
@@ -6116,6 +6296,16 @@ type UpdateProductCart = {
6116
6296
  * - Article id of the product in cart
6117
6297
  */
6118
6298
  article_id?: string;
6299
+ /**
6300
+ * - Specifies the fulfillment
6301
+ * method, indicating whether an order is for home delivery or store pickup
6302
+ */
6303
+ fulfillment_option_slug?: string;
6304
+ /**
6305
+ * - Unique identifier of the pickup store
6306
+ * selected by the user from which user
6307
+ */
6308
+ pickup_store_id?: number;
6119
6309
  };
6120
6310
  /** @returns {FreeGiftItemCreation} */
6121
6311
  declare function FreeGiftItemCreation(): FreeGiftItemCreation;
@@ -7145,6 +7335,7 @@ type PlatformShipmentDetails = {
7145
7335
  * - List of articles in shipment
7146
7336
  */
7147
7337
  articles?: ShipmentArticle[];
7338
+ fulfillment_option?: FulfillmentOptionSchema;
7148
7339
  };
7149
7340
  /** @returns {PlatformCartShipmentsResult} */
7150
7341
  declare function PlatformCartShipmentsResult(): PlatformCartShipmentsResult;
@@ -7286,6 +7477,7 @@ type PlatformCartMetaCreation = {
7286
7477
  * customer pickup at store
7287
7478
  */
7288
7479
  pick_up_customer_details?: any;
7480
+ alternate_pickup_person?: PlatformAlternatePickupPerson;
7289
7481
  /**
7290
7482
  * - Checkout mode of user cart
7291
7483
  */