@gofynd/fdk-client-javascript 3.3.6 → 3.4.1

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 (54) 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 +115 -47
  8. package/sdk/partner/Logistics/LogisticsPartnerModel.js +67 -35
  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 +454 -12
  12. package/sdk/platform/Cart/CartPlatformModel.js +457 -10
  13. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  14. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
  15. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +9 -0
  16. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +4 -0
  17. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
  18. package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
  19. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
  20. package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
  21. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
  22. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
  23. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  24. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  25. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
  26. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
  27. package/sdk/platform/Content/ContentPlatformModel.d.ts +14 -19
  28. package/sdk/platform/Content/ContentPlatformModel.js +6 -20
  29. package/sdk/platform/Order/OrderPlatformModel.d.ts +237 -17
  30. package/sdk/platform/Order/OrderPlatformModel.js +388 -14
  31. package/sdk/platform/Order/OrderPlatformValidator.d.ts +15 -15
  32. package/sdk/platform/Order/OrderPlatformValidator.js +9 -9
  33. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -5
  34. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -3
  35. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +97 -1
  36. package/sdk/platform/Payment/PaymentPlatformModel.js +273 -0
  37. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
  38. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
  39. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
  40. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
  41. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
  42. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
  43. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1033 -113
  44. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +613 -35
  45. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
  46. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
  47. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
  48. package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
  49. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
  50. package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
  51. package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
  52. package/sdk/platform/User/UserPlatformModel.js +276 -7
  53. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
  54. package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
@@ -1,4 +1,73 @@
1
1
  export = ServiceabilityPlatformModel;
2
+ /**
3
+ * @typedef FulfillmentOption
4
+ * @property {string} [name] - Name of the fulfillment option.
5
+ * @property {string} [slug] - Unique identifier for the fulfillment option.
6
+ * @property {number} [company_id] - The unique identifier of the company.
7
+ * @property {string} [application_id] - The unique identifier of the application.
8
+ * @property {string} [description] - Description of the fulfillment option.
9
+ * @property {boolean} [is_default] - Whether this is the default fulfillment option.
10
+ * @property {string} [type] - Type of fulfillment option.
11
+ * @property {string} [status] - Status of the fulfillment option.
12
+ * @property {BusinessUnit[]} [business_unit]
13
+ * @property {FulfillmentStores} [fulfillment_stores]
14
+ * @property {FulfillmentProducts} [products]
15
+ * @property {CourierPartnerSchemes} [cp_schemes]
16
+ * @property {string} [id] - Unique identifier for the fulfillment option.
17
+ */
18
+ /**
19
+ * @typedef FulfillmentOptionProducts
20
+ * @property {FulfillmentOptionProduct} [items]
21
+ * @property {Page} [page]
22
+ */
23
+ /**
24
+ * @typedef FulfillmentOptionStores
25
+ * @property {FulfillmentOptionStore[]} [items] - List of stores with their details.
26
+ * @property {Page} [page]
27
+ */
28
+ /**
29
+ * @typedef FulfillmentOptionBulkValidate
30
+ * @property {string} [store_type] - Type of store related to fulfillment.
31
+ * @property {string} [file_path] - URL of the uploaded file.
32
+ * @property {string} [action] - Action to be performed, such as import.
33
+ * @property {string} [type] - Entity type being processed.
34
+ * @property {string} [fulfillment_option_slug] - Slug representing the
35
+ * fulfillment option.
36
+ * @property {FulfillmentOptionValidate} [request]
37
+ */
38
+ /**
39
+ * @typedef FulfillmentOptionBulkValidateData
40
+ * @property {string} [request_id] - Unique id generated for bulk operation.
41
+ */
42
+ /**
43
+ * @typedef FulfillmentOptionBulk
44
+ * @property {string} [file_path] - The URL of file from which data will be imported.
45
+ * @property {string} [type] - Specifies the type of bulk fulfillment request.
46
+ */
47
+ /**
48
+ * @typedef FulfillmentOptionBulkData
49
+ * @property {string} [request_id] - Unique identifier for the request.
50
+ * @property {FulfillmentOptionValidate} [request]
51
+ * @property {string} [fulfillment_option_slug] - Slug representing the
52
+ * fulfillment option.
53
+ * @property {string} [file_url] - URL of the uploaded file.
54
+ * @property {number} [total] - Total number of records processed.
55
+ * @property {number} [success] - Number of successful records.
56
+ * @property {number} [failed] - Number of failed records.
57
+ * @property {string} [action] - Action performed in the request.
58
+ * @property {string} [updated_at] - Timestamp of the last update.
59
+ * @property {string} [updated_by] - Identifier of the user who updated the request.
60
+ * @property {string} [type] - Type of the bulk import process.
61
+ * @property {number} [company_id] - The unique identifier of the company.
62
+ * @property {string} [application_id] - The unique identifier of the application.
63
+ * @property {string} [stage] - Current stage of the import process.
64
+ */
65
+ /**
66
+ * @typedef OperationResponseSchema
67
+ * @property {boolean} success - Indicates if the operation was successful
68
+ * @property {string} [message] - Optional message providing additional
69
+ * information about the operation
70
+ */
2
71
  /**
3
72
  * @typedef SelfshipSchema
4
73
  * @property {number} tat - Turn around time in the specified unit, used to
@@ -88,11 +157,13 @@ export = ServiceabilityPlatformModel;
88
157
  */
89
158
  /**
90
159
  * @typedef CreateZoneDataSchema
160
+ * @property {string} [fulfillment_option_slug] - Slug representing the
161
+ * fulfillment option.
91
162
  * @property {boolean} is_active - Indicates whether the zone is active or not.
92
163
  * @property {string} slug - Slug or URL-friendly version of the zone name.
93
164
  * @property {string} name - Name of the zone.
94
- * @property {number} company_id - Identifier of the company associated with the zone.
95
- * @property {string} application_id - Identifier for the application related to the zone.
165
+ * @property {number} company_id - The unique identifier of the company.
166
+ * @property {string} application_id - The unique identifier of the application.
96
167
  * @property {string[]} geo_areas - List of geographical areas associated with the zone.
97
168
  * @property {ZoneStores} stores
98
169
  * @property {ZoneProduct} product
@@ -114,9 +185,11 @@ export = ServiceabilityPlatformModel;
114
185
  /**
115
186
  * @typedef ZoneSchema
116
187
  * @property {Object} name - Name of the zone.
188
+ * @property {string} [fulfillment_option_slug] - Slug representing the
189
+ * fulfillment option.
117
190
  * @property {Object} slug - Slug identifier for the zone.
118
- * @property {Object} company_id - Id of the company that owns the zone.
119
- * @property {Object} application_id - Application Id associated with the zone.
191
+ * @property {Object} company_id - The unique identifier of the company.
192
+ * @property {Object} application_id - The unique identifier of the application.
120
193
  * @property {Object} is_active - Whether the zone is active or not.
121
194
  * @property {Object} geo_areas - List of geographical areas associated with the zone.
122
195
  * @property {Object} stores - List of stores in the zone, referencing a schema
@@ -265,6 +338,7 @@ export = ServiceabilityPlatformModel;
265
338
  */
266
339
  /**
267
340
  * @typedef GeoAreaRequestBody
341
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
268
342
  * @property {boolean} is_active - Indicates whether the geo area is active or not.
269
343
  * @property {string} name - The name of the geo area.
270
344
  * @property {string} slug - A slug is a human-readable URL segment, typically
@@ -289,6 +363,7 @@ export = ServiceabilityPlatformModel;
289
363
  * @property {Area[]} areas - A list of areas included in the geo area.
290
364
  * @property {string} [region_type] - Defines whether the region is based on
291
365
  * pincode or non-pincode.
366
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
292
367
  * @property {string} type - Specifies whether the geo area is for price or
293
368
  * delivery purposes.
294
369
  * @property {string} created_on - The timestamp when the record was created.
@@ -301,6 +376,7 @@ export = ServiceabilityPlatformModel;
301
376
  * @typedef GeoAreaPutResponseBody
302
377
  * @property {string} [name] - Name of the geo area.
303
378
  * @property {string} [geoarea_id] - Unique identifier for the geo area.
379
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
304
380
  * @property {string} [slug] - A slug is a human-readable URL segment, typically
305
381
  * generated from a title with special characters removed.
306
382
  * @property {boolean} [is_active] - Indicates whether the geo area is active or not.
@@ -328,6 +404,7 @@ export = ServiceabilityPlatformModel;
328
404
  * generated from a title with special characters removed.
329
405
  * @property {string} [application_id] - The unique identifier of the application.
330
406
  * @property {number} [company_id] - The unique identifier of the company.
407
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
331
408
  * @property {string} geoarea_id - A unique identifier for the geoarea.
332
409
  * @property {boolean} is_active - Indicates whether the geoarea is active.
333
410
  * @property {string} type - The type of geoarea (e.g., city, country).
@@ -777,9 +854,10 @@ export = ServiceabilityPlatformModel;
777
854
  * fetch or modify scheme details.
778
855
  * @property {string} name - Name of the scheme.
779
856
  * @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
780
- * forward pickup (nullable).
857
+ * forward pickup (nullable), having 24hour time format HH:MM.
781
858
  * @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
782
- * reverse pickup (nullable).
859
+ * reverse pickup (nullable), having 24hour time format HH:MM.
860
+ * @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
783
861
  * @property {CourierPartnerSchemeDefaultTat} [default_tat]
784
862
  * @property {ArithmeticOperations} weight
785
863
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -812,7 +890,7 @@ export = ServiceabilityPlatformModel;
812
890
  * @property {string} [extension_id] - Unique identifier of courier partner extension.
813
891
  * @property {string} [scheme_id] - Unique identifier for the scheme, used to
814
892
  * fetch or modify scheme details.
815
- * @property {string} [company_id] - Unique identifier of company.
893
+ * @property {string} [company_id] - The unique identifier of the company.
816
894
  * @property {string} name - Name of the scheme.
817
895
  * @property {ArithmeticOperations} weight
818
896
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -835,6 +913,12 @@ export = ServiceabilityPlatformModel;
835
913
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
836
914
  * quantity of items allowed in a non-quality check shipment.
837
915
  * @property {CourierPartnerSchemeFeatures} feature
916
+ * @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
917
+ * forward pickup (nullable), having 24hour time format HH:MM.
918
+ * @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
919
+ * reverse pickup (nullable), having 24hour time format HH:MM.
920
+ * @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
921
+ * @property {CourierPartnerSchemeDefaultTat} [default_tat]
838
922
  */
839
923
  /**
840
924
  * @typedef CourierPartnerSchemeUpdateDetailsSchema
@@ -1077,6 +1161,178 @@ export = ServiceabilityPlatformModel;
1077
1161
  * @typedef CompanyConfigurationSchema
1078
1162
  * @property {string[]} [sort] - An array of strings specifying sorting preferences.
1079
1163
  */
1164
+ /**
1165
+ * @typedef BusinessUnit
1166
+ * @property {string} [name] - Name of the business unit.
1167
+ * @property {boolean} [is_active] - Whether the business unit is active.
1168
+ */
1169
+ /**
1170
+ * @typedef FulfillmentStores
1171
+ * @property {number[]} [values] - List of store IDs associated with this
1172
+ * fulfillment option.
1173
+ * @property {string} [type] - Whether fulfillment applies to all stores or
1174
+ * specific stores.
1175
+ */
1176
+ /**
1177
+ * @typedef FulfillmentProducts
1178
+ * @property {number[]} [values] - List of product IDs associated with this
1179
+ * fulfillment option.
1180
+ * @property {string} [type] - Whether fulfillment applies to all products or
1181
+ * specific products.
1182
+ */
1183
+ /**
1184
+ * @typedef CourierPartnerSchemes
1185
+ * @property {CourierPartnerScheme[]} [values] - List of courier partner schemes
1186
+ * associated with this fulfillment option.
1187
+ * @property {string} [type] - Indicates whether all installed courier schemes
1188
+ * are used or only those specified by the seller.
1189
+ */
1190
+ /**
1191
+ * @typedef CourierPartnerScheme
1192
+ * @property {string} [scheme_id] - Unique identifier for the courier partner scheme.
1193
+ * @property {string} [cp_ext_id] - Unique identifier for the courier partner.
1194
+ */
1195
+ /**
1196
+ * @typedef FulfillmentOptionProduct
1197
+ * @property {number} [uid] - Unique identifier for the product.
1198
+ * @property {string} [name] - Name of the product.
1199
+ * @property {string} [slug] - Unique slug identifier for the product.
1200
+ * @property {string} [category_slug] - Slug identifier of the product's category.
1201
+ * @property {number} [category_uid] - Unique identifier for the product's category.
1202
+ * @property {string} [short_description] - Brief description of the product.
1203
+ * @property {string} [description] - Detailed description of the product in HTML format.
1204
+ * @property {number} [brand_uid] - Unique identifier for the brand.
1205
+ * @property {string} [currency] - Currency code used for product pricing.
1206
+ * @property {string} [item_code] - Unique code assigned to the product.
1207
+ * @property {string} [item_type] - Type of product (e.g., standard, set etc.).
1208
+ * @property {NetQuantity} [net_quantity]
1209
+ * @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
1210
+ * @property {boolean} [is_set] - Indicates if the product is a set of items.
1211
+ * @property {boolean} [is_dependent] - Indicates if the product depends on
1212
+ * another product.
1213
+ * @property {boolean} [is_active] - Status indicating if the product is active.
1214
+ * @property {boolean} [is_image_less_product] - Indicates if the product has no images.
1215
+ * @property {string} [size_guide] - URL or reference to the size guide.
1216
+ * @property {Object} [teaser_tag] - Teaser tag information for the product.
1217
+ * @property {string[]} [highlights] - Key highlights of the product.
1218
+ * @property {string[]} [tags] - Tags associated with the product.
1219
+ * @property {string[]} [product_group_tag] - Group tags assigned to the product.
1220
+ * @property {number[]} [departments] - Department identifiers associated with
1221
+ * the product.
1222
+ * @property {number} [company_id] - The unique identifier of the company.
1223
+ * @property {number[]} [company_ids] - List of company IDs associated with the product.
1224
+ * @property {string} [country_of_origin] - Country where the product is manufactured.
1225
+ * @property {string} [change_request_id] - Identifier for the change request
1226
+ * related to the product.
1227
+ * @property {Trader} [trader]
1228
+ * @property {string} [trader_type] - Type of trader (e.g., Manufacturer, Wholesaler).
1229
+ * @property {ProductPublish} [product_publish]
1230
+ * @property {TaxIdentifier} [tax_identifier]
1231
+ * @property {ReturnConfig} [return_config]
1232
+ * @property {CustomOrder} [custom_order]
1233
+ * @property {Size[]} [sizes] - Available sizes for the product.
1234
+ * @property {string[]} [media] - List of media assets related to the product.
1235
+ * @property {Object} [variant_media] - Media assets for different variants of
1236
+ * the product.
1237
+ * @property {Object} [variants] - Variant-specific details for the product.
1238
+ * @property {number} [no_of_boxes] - Number of boxes required for packaging the product.
1239
+ * @property {Object} [_custom_json] - Custom JSON data associated with the product.
1240
+ */
1241
+ /**
1242
+ * @typedef NetQuantity
1243
+ * @property {number} [value] - The quantity value of the product.
1244
+ * @property {string} [unit] - The unit of measurement for the quantity.
1245
+ */
1246
+ /**
1247
+ * @typedef Trader
1248
+ * @property {string} [name] - Name of the trader.
1249
+ * @property {string} [address] - Address of the trader.
1250
+ */
1251
+ /**
1252
+ * @typedef ProductPublish
1253
+ * @property {string} [product_online_date] - Date when the product went online.
1254
+ * @property {boolean} [is_set] - Indicates if the product is part of a set.
1255
+ */
1256
+ /**
1257
+ * @typedef TaxIdentifier
1258
+ * @property {string} [hsn_code] - HSN code assigned to the product.
1259
+ * @property {string} [hsn_code_id] - Identifier for the HSN code.
1260
+ * @property {string} [reporting_hsn] - Reporting HSN code.
1261
+ */
1262
+ /**
1263
+ * @typedef ReturnConfig
1264
+ * @property {boolean} [returnable] - Indicates if the product is returnable.
1265
+ * @property {number} [time] - Time duration allowed for returns.
1266
+ * @property {string} [unit] - Unit of time for return duration.
1267
+ */
1268
+ /**
1269
+ * @typedef CustomOrder
1270
+ * @property {boolean} [is_custom_order] - Indicates if the product is a custom order.
1271
+ * @property {number} [manufacturing_time] - Time required for manufacturing the product.
1272
+ * @property {string} [manufacturing_time_unit] - Unit of time for manufacturing.
1273
+ */
1274
+ /**
1275
+ * @typedef Size
1276
+ * @property {string} [size] - Size label of the product.
1277
+ * @property {number} [size_priority] - Priority assigned to the size.
1278
+ * @property {string} [item_dimensions_unit_of_measure] - Unit of measure for
1279
+ * item dimensions.
1280
+ * @property {number} [price_transfer] - Transfer price of the product.
1281
+ * @property {number} [item_height] - Height of the product.
1282
+ * @property {number} [item_length] - Length of the product.
1283
+ * @property {number} [item_width] - Width of the product.
1284
+ * @property {number} [item_weight] - Weight of the product.
1285
+ * @property {string} [item_weight_unit_of_measure] - Unit of measure for item weight.
1286
+ * @property {number} [price] - Selling price of the product.
1287
+ * @property {number} [price_effective] - Effective price after discounts.
1288
+ * @property {boolean} [is_set] - Indicates if the size belongs to a set.
1289
+ * @property {boolean} [track_inventory] - Indicates if inventory tracking is enabled.
1290
+ * @property {Identifier[]} [identifiers] - Unique identifiers associated with the size.
1291
+ * @property {Object} [_custom_json] - Custom JSON data associated with the size.
1292
+ */
1293
+ /**
1294
+ * @typedef Identifier
1295
+ * @property {string} [gtin_type] - Type of GTIN identifier (e.g., SKU, UPC, EAN).
1296
+ * @property {string} [gtin_value] - Value of the GTIN identifier.
1297
+ * @property {boolean} [primary] - Indicates if this is the primary identifier.
1298
+ */
1299
+ /**
1300
+ * @typedef Page
1301
+ * @property {number} [item_total] - The total number of all items across all pages.
1302
+ * @property {string} [next_id] - The identifier for the next page.
1303
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
1304
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
1305
+ * @property {number} [current] - The current page number.
1306
+ * @property {string} type - The type of the page, such as 'PageType'.
1307
+ * @property {number} [size] - The number of items per page.
1308
+ * @property {number} [page_size] - The number of items per page.
1309
+ */
1310
+ /**
1311
+ * @typedef FulfillmentOptionStore
1312
+ * @property {number} [uid] - Unique identifier for the store.
1313
+ * @property {Address} [address]
1314
+ * @property {number} [company_id] - The unique identifier of the company.
1315
+ * @property {string} [display_name] - Store name displayed in the UI.
1316
+ * @property {string} [name] - Name of the store.
1317
+ * @property {string} [store_type] - Type of store (e.g., high_street, mall).
1318
+ * @property {string[]} [tags] - Tags associated with the store.
1319
+ */
1320
+ /**
1321
+ * @typedef Address
1322
+ * @property {string} [address1] - Primary address line.
1323
+ * @property {string} [country] - Country where the store is located.
1324
+ * @property {string} [pincode] - Postal code of the store location.
1325
+ * @property {string} [city] - City where the store is located.
1326
+ * @property {string} [state] - State where the store is located.
1327
+ * @property {number} [latitude] - Latitude coordinate of the store.
1328
+ * @property {number} [longitude] - Longitude coordinate of the store.
1329
+ * @property {string} [country_code] - ISO country code of the store location.
1330
+ */
1331
+ /**
1332
+ * @typedef FulfillmentOptionValidate
1333
+ * @property {string} [entity_filter_type] - Type of entity filter applied.
1334
+ * @property {string} [fulfillment_option_type] - Type of fulfillment option selected.
1335
+ */
1080
1336
  /**
1081
1337
  * @typedef ProductSchema
1082
1338
  * @property {string} type - The classification of product type used in the
@@ -1108,8 +1364,8 @@ export = ServiceabilityPlatformModel;
1108
1364
  * @property {ListViewProduct} stores
1109
1365
  * @property {boolean} is_active - Indicates if the zone is active.
1110
1366
  * @property {ListViewProduct} product
1111
- * @property {number} company_id - Unique identifier for the company.
1112
- * @property {string} application_id - Unique identifier for the application.
1367
+ * @property {number} company_id - The unique identifier of the company.
1368
+ * @property {string} application_id - The unique identifier of the application.
1113
1369
  * @property {CreatedBy} created_by
1114
1370
  * @property {ModifiedBy} modified_by
1115
1371
  * @property {string} created_on - The timestamp when the record was created.
@@ -1139,17 +1395,6 @@ export = ServiceabilityPlatformModel;
1139
1395
  * @property {string} [name] - Name of the region.
1140
1396
  * @property {number} [count] - Count of items in the region.
1141
1397
  */
1142
- /**
1143
- * @typedef Page
1144
- * @property {number} [item_total] - The total number of all items across all pages.
1145
- * @property {string} [next_id] - The identifier for the next page.
1146
- * @property {boolean} [has_previous] - Indicates whether there is a previous page.
1147
- * @property {boolean} [has_next] - Indicates whether there is a next page.
1148
- * @property {number} [current] - The current page number.
1149
- * @property {string} type - The type of the page, such as 'PageType'.
1150
- * @property {number} [size] - The number of items per page.
1151
- * @property {number} [page_size] - The number of items per page.
1152
- */
1153
1398
  /**
1154
1399
  * @typedef ZoneStores
1155
1400
  * @property {Object} type - Type of zone store.
@@ -2036,8 +2281,184 @@ export = ServiceabilityPlatformModel;
2036
2281
  declare class ServiceabilityPlatformModel {
2037
2282
  }
2038
2283
  declare namespace ServiceabilityPlatformModel {
2039
- export { SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, Page, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
2284
+ export { FulfillmentOption, FulfillmentOptionProducts, FulfillmentOptionStores, FulfillmentOptionBulkValidate, FulfillmentOptionBulkValidateData, FulfillmentOptionBulk, FulfillmentOptionBulkData, OperationResponseSchema, SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
2040
2285
  }
2286
+ /** @returns {FulfillmentOption} */
2287
+ declare function FulfillmentOption(): FulfillmentOption;
2288
+ type FulfillmentOption = {
2289
+ /**
2290
+ * - Name of the fulfillment option.
2291
+ */
2292
+ name?: string;
2293
+ /**
2294
+ * - Unique identifier for the fulfillment option.
2295
+ */
2296
+ slug?: string;
2297
+ /**
2298
+ * - The unique identifier of the company.
2299
+ */
2300
+ company_id?: number;
2301
+ /**
2302
+ * - The unique identifier of the application.
2303
+ */
2304
+ application_id?: string;
2305
+ /**
2306
+ * - Description of the fulfillment option.
2307
+ */
2308
+ description?: string;
2309
+ /**
2310
+ * - Whether this is the default fulfillment option.
2311
+ */
2312
+ is_default?: boolean;
2313
+ /**
2314
+ * - Type of fulfillment option.
2315
+ */
2316
+ type?: string;
2317
+ /**
2318
+ * - Status of the fulfillment option.
2319
+ */
2320
+ status?: string;
2321
+ business_unit?: BusinessUnit[];
2322
+ fulfillment_stores?: FulfillmentStores;
2323
+ products?: FulfillmentProducts;
2324
+ cp_schemes?: CourierPartnerSchemes;
2325
+ /**
2326
+ * - Unique identifier for the fulfillment option.
2327
+ */
2328
+ id?: string;
2329
+ };
2330
+ /** @returns {FulfillmentOptionProducts} */
2331
+ declare function FulfillmentOptionProducts(): FulfillmentOptionProducts;
2332
+ type FulfillmentOptionProducts = {
2333
+ items?: FulfillmentOptionProduct;
2334
+ page?: Page;
2335
+ };
2336
+ /** @returns {FulfillmentOptionStores} */
2337
+ declare function FulfillmentOptionStores(): FulfillmentOptionStores;
2338
+ type FulfillmentOptionStores = {
2339
+ /**
2340
+ * - List of stores with their details.
2341
+ */
2342
+ items?: FulfillmentOptionStore[];
2343
+ page?: Page;
2344
+ };
2345
+ /** @returns {FulfillmentOptionBulkValidate} */
2346
+ declare function FulfillmentOptionBulkValidate(): FulfillmentOptionBulkValidate;
2347
+ type FulfillmentOptionBulkValidate = {
2348
+ /**
2349
+ * - Type of store related to fulfillment.
2350
+ */
2351
+ store_type?: string;
2352
+ /**
2353
+ * - URL of the uploaded file.
2354
+ */
2355
+ file_path?: string;
2356
+ /**
2357
+ * - Action to be performed, such as import.
2358
+ */
2359
+ action?: string;
2360
+ /**
2361
+ * - Entity type being processed.
2362
+ */
2363
+ type?: string;
2364
+ /**
2365
+ * - Slug representing the
2366
+ * fulfillment option.
2367
+ */
2368
+ fulfillment_option_slug?: string;
2369
+ request?: FulfillmentOptionValidate;
2370
+ };
2371
+ /** @returns {FulfillmentOptionBulkValidateData} */
2372
+ declare function FulfillmentOptionBulkValidateData(): FulfillmentOptionBulkValidateData;
2373
+ type FulfillmentOptionBulkValidateData = {
2374
+ /**
2375
+ * - Unique id generated for bulk operation.
2376
+ */
2377
+ request_id?: string;
2378
+ };
2379
+ /** @returns {FulfillmentOptionBulk} */
2380
+ declare function FulfillmentOptionBulk(): FulfillmentOptionBulk;
2381
+ type FulfillmentOptionBulk = {
2382
+ /**
2383
+ * - The URL of file from which data will be imported.
2384
+ */
2385
+ file_path?: string;
2386
+ /**
2387
+ * - Specifies the type of bulk fulfillment request.
2388
+ */
2389
+ type?: string;
2390
+ };
2391
+ /** @returns {FulfillmentOptionBulkData} */
2392
+ declare function FulfillmentOptionBulkData(): FulfillmentOptionBulkData;
2393
+ type FulfillmentOptionBulkData = {
2394
+ /**
2395
+ * - Unique identifier for the request.
2396
+ */
2397
+ request_id?: string;
2398
+ request?: FulfillmentOptionValidate;
2399
+ /**
2400
+ * - Slug representing the
2401
+ * fulfillment option.
2402
+ */
2403
+ fulfillment_option_slug?: string;
2404
+ /**
2405
+ * - URL of the uploaded file.
2406
+ */
2407
+ file_url?: string;
2408
+ /**
2409
+ * - Total number of records processed.
2410
+ */
2411
+ total?: number;
2412
+ /**
2413
+ * - Number of successful records.
2414
+ */
2415
+ success?: number;
2416
+ /**
2417
+ * - Number of failed records.
2418
+ */
2419
+ failed?: number;
2420
+ /**
2421
+ * - Action performed in the request.
2422
+ */
2423
+ action?: string;
2424
+ /**
2425
+ * - Timestamp of the last update.
2426
+ */
2427
+ updated_at?: string;
2428
+ /**
2429
+ * - Identifier of the user who updated the request.
2430
+ */
2431
+ updated_by?: string;
2432
+ /**
2433
+ * - Type of the bulk import process.
2434
+ */
2435
+ type?: string;
2436
+ /**
2437
+ * - The unique identifier of the company.
2438
+ */
2439
+ company_id?: number;
2440
+ /**
2441
+ * - The unique identifier of the application.
2442
+ */
2443
+ application_id?: string;
2444
+ /**
2445
+ * - Current stage of the import process.
2446
+ */
2447
+ stage?: string;
2448
+ };
2449
+ /** @returns {OperationResponseSchema} */
2450
+ declare function OperationResponseSchema(): OperationResponseSchema;
2451
+ type OperationResponseSchema = {
2452
+ /**
2453
+ * - Indicates if the operation was successful
2454
+ */
2455
+ success: boolean;
2456
+ /**
2457
+ * - Optional message providing additional
2458
+ * information about the operation
2459
+ */
2460
+ message?: string;
2461
+ };
2041
2462
  /** @returns {SelfshipSchema} */
2042
2463
  declare function SelfshipSchema(): SelfshipSchema;
2043
2464
  type SelfshipSchema = {
@@ -2248,6 +2669,11 @@ type CommonErrorResult = {
2248
2669
  /** @returns {CreateZoneDataSchema} */
2249
2670
  declare function CreateZoneDataSchema(): CreateZoneDataSchema;
2250
2671
  type CreateZoneDataSchema = {
2672
+ /**
2673
+ * - Slug representing the
2674
+ * fulfillment option.
2675
+ */
2676
+ fulfillment_option_slug?: string;
2251
2677
  /**
2252
2678
  * - Indicates whether the zone is active or not.
2253
2679
  */
@@ -2261,11 +2687,11 @@ type CreateZoneDataSchema = {
2261
2687
  */
2262
2688
  name: string;
2263
2689
  /**
2264
- * - Identifier of the company associated with the zone.
2690
+ * - The unique identifier of the company.
2265
2691
  */
2266
2692
  company_id: number;
2267
2693
  /**
2268
- * - Identifier for the application related to the zone.
2694
+ * - The unique identifier of the application.
2269
2695
  */
2270
2696
  application_id: string;
2271
2697
  /**
@@ -2311,16 +2737,21 @@ type ZoneSchema = {
2311
2737
  * - Name of the zone.
2312
2738
  */
2313
2739
  name: any;
2740
+ /**
2741
+ * - Slug representing the
2742
+ * fulfillment option.
2743
+ */
2744
+ fulfillment_option_slug?: string;
2314
2745
  /**
2315
2746
  * - Slug identifier for the zone.
2316
2747
  */
2317
2748
  slug: any;
2318
2749
  /**
2319
- * - Id of the company that owns the zone.
2750
+ * - The unique identifier of the company.
2320
2751
  */
2321
2752
  company_id: any;
2322
2753
  /**
2323
- * - Application Id associated with the zone.
2754
+ * - The unique identifier of the application.
2324
2755
  */
2325
2756
  application_id: any;
2326
2757
  /**
@@ -2703,6 +3134,10 @@ type GeoAreaBulkExportResult = {
2703
3134
  /** @returns {GeoAreaRequestBody} */
2704
3135
  declare function GeoAreaRequestBody(): GeoAreaRequestBody;
2705
3136
  type GeoAreaRequestBody = {
3137
+ /**
3138
+ * - Indicates whether geo area is polygon or not.
3139
+ */
3140
+ is_polygon?: boolean;
2706
3141
  /**
2707
3142
  * - Indicates whether the geo area is active or not.
2708
3143
  */
@@ -2765,6 +3200,10 @@ type GeoAreaResponseBody = {
2765
3200
  * pincode or non-pincode.
2766
3201
  */
2767
3202
  region_type?: string;
3203
+ /**
3204
+ * - Indicates whether geo area is polygon or not.
3205
+ */
3206
+ is_polygon?: boolean;
2768
3207
  /**
2769
3208
  * - Specifies whether the geo area is for price or
2770
3209
  * delivery purposes.
@@ -2796,6 +3235,10 @@ type GeoAreaPutResponseBody = {
2796
3235
  * - Unique identifier for the geo area.
2797
3236
  */
2798
3237
  geoarea_id?: string;
3238
+ /**
3239
+ * - Indicates whether geo area is polygon or not.
3240
+ */
3241
+ is_polygon?: boolean;
2799
3242
  /**
2800
3243
  * - A slug is a human-readable URL segment, typically
2801
3244
  * generated from a title with special characters removed.
@@ -2864,6 +3307,10 @@ type GeoAreaDetails = {
2864
3307
  * - The unique identifier of the company.
2865
3308
  */
2866
3309
  company_id?: number;
3310
+ /**
3311
+ * - Indicates whether geo area is polygon or not.
3312
+ */
3313
+ is_polygon?: boolean;
2867
3314
  /**
2868
3315
  * - A unique identifier for the geoarea.
2869
3316
  */
@@ -4012,14 +4459,18 @@ type CourierPartnerSchemeDetailsModel = {
4012
4459
  name: string;
4013
4460
  /**
4014
4461
  * - Default cutoff time for
4015
- * forward pickup (nullable).
4462
+ * forward pickup (nullable), having 24hour time format HH:MM.
4016
4463
  */
4017
4464
  default_forward_pickup_cutoff?: string;
4018
4465
  /**
4019
4466
  * - Default cutoff time for
4020
- * reverse pickup (nullable).
4467
+ * reverse pickup (nullable), having 24hour time format HH:MM.
4021
4468
  */
4022
4469
  default_reverse_pickup_cutoff?: string;
4470
+ /**
4471
+ * - Timezone for default cutoff time.
4472
+ */
4473
+ default_cutoff_timezone?: string;
4023
4474
  default_tat?: CourierPartnerSchemeDefaultTat;
4024
4475
  weight: ArithmeticOperations;
4025
4476
  volumetric_weight?: ArithmeticOperations;
@@ -4093,7 +4544,7 @@ type CourierPartnerSchemeModelSchema = {
4093
4544
  */
4094
4545
  scheme_id?: string;
4095
4546
  /**
4096
- * - Unique identifier of company.
4547
+ * - The unique identifier of the company.
4097
4548
  */
4098
4549
  company_id?: string;
4099
4550
  /**
@@ -4148,6 +4599,21 @@ type CourierPartnerSchemeModelSchema = {
4148
4599
  */
4149
4600
  non_qc_shipment_item_quantity?: number;
4150
4601
  feature: CourierPartnerSchemeFeatures;
4602
+ /**
4603
+ * - Default cutoff time for
4604
+ * forward pickup (nullable), having 24hour time format HH:MM.
4605
+ */
4606
+ default_forward_pickup_cutoff?: string;
4607
+ /**
4608
+ * - Default cutoff time for
4609
+ * reverse pickup (nullable), having 24hour time format HH:MM.
4610
+ */
4611
+ default_reverse_pickup_cutoff?: string;
4612
+ /**
4613
+ * - Timezone for default cutoff time.
4614
+ */
4615
+ default_cutoff_timezone?: string;
4616
+ default_tat?: CourierPartnerSchemeDefaultTat;
4151
4617
  };
4152
4618
  /** @returns {CourierPartnerSchemeUpdateDetailsSchema} */
4153
4619
  declare function CourierPartnerSchemeUpdateDetailsSchema(): CourierPartnerSchemeUpdateDetailsSchema;
@@ -4698,84 +5164,574 @@ type CompanyConfigurationSchema = {
4698
5164
  */
4699
5165
  sort?: string[];
4700
5166
  };
4701
- /** @returns {ProductSchema} */
4702
- declare function ProductSchema(): ProductSchema;
4703
- type ProductSchema = {
5167
+ /** @returns {BusinessUnit} */
5168
+ declare function BusinessUnit(): BusinessUnit;
5169
+ type BusinessUnit = {
4704
5170
  /**
4705
- * - The classification of product type used in the
4706
- * zone, whether it's a list of categories, departments, tags, or item_ids.
5171
+ * - Name of the business unit.
4707
5172
  */
4708
- type: string;
5173
+ name?: string;
4709
5174
  /**
4710
- * - List of values representing the products or the
4711
- * type of products selected for the delivery zone.
5175
+ * - Whether the business unit is active.
4712
5176
  */
4713
- values: any[];
5177
+ is_active?: boolean;
4714
5178
  };
4715
- /** @returns {StoresSchema} */
4716
- declare function StoresSchema(): StoresSchema;
4717
- type StoresSchema = {
5179
+ /** @returns {FulfillmentStores} */
5180
+ declare function FulfillmentStores(): FulfillmentStores;
5181
+ type FulfillmentStores = {
4718
5182
  /**
4719
- * - Classification of whether all stores in the
4720
- * application are considered or a custom selection of stores by the seller.
5183
+ * - List of store IDs associated with this
5184
+ * fulfillment option.
4721
5185
  */
4722
- type: string;
5186
+ values?: number[];
4723
5187
  /**
4724
- * - List of store Ids mapped to the delivery zone
4725
- * when custom type is selected.
5188
+ * - Whether fulfillment applies to all stores or
5189
+ * specific stores.
4726
5190
  */
4727
- values: number[];
5191
+ type?: string;
4728
5192
  };
4729
- /** @returns {CreatedBy} */
4730
- declare function CreatedBy(): CreatedBy;
4731
- type CreatedBy = {
5193
+ /** @returns {FulfillmentProducts} */
5194
+ declare function FulfillmentProducts(): FulfillmentProducts;
5195
+ type FulfillmentProducts = {
4732
5196
  /**
4733
- * - Identifier of the user or system that created the object.
5197
+ * - List of product IDs associated with this
5198
+ * fulfillment option.
4734
5199
  */
4735
- id?: string;
4736
- };
4737
- /** @returns {ModifiedBy} */
4738
- declare function ModifiedBy(): ModifiedBy;
4739
- type ModifiedBy = {
5200
+ values?: number[];
4740
5201
  /**
4741
- * - Identifier of the user or system that created the object.
5202
+ * - Whether fulfillment applies to all products or
5203
+ * specific products.
4742
5204
  */
4743
- id?: string;
5205
+ type?: string;
4744
5206
  };
4745
- /** @returns {ListViewItems} */
4746
- declare function ListViewItems(): ListViewItems;
4747
- type ListViewItems = {
5207
+ /** @returns {CourierPartnerSchemes} */
5208
+ declare function CourierPartnerSchemes(): CourierPartnerSchemes;
5209
+ type CourierPartnerSchemes = {
4748
5210
  /**
4749
- * - Unique identifier for the zone.
5211
+ * - List of courier partner schemes
5212
+ * associated with this fulfillment option.
4750
5213
  */
4751
- zone_id: string;
5214
+ values?: CourierPartnerScheme[];
4752
5215
  /**
4753
- * - Name of the zone.
5216
+ * - Indicates whether all installed courier schemes
5217
+ * are used or only those specified by the seller.
4754
5218
  */
4755
- name: string;
5219
+ type?: string;
5220
+ };
5221
+ /** @returns {CourierPartnerScheme} */
5222
+ declare function CourierPartnerScheme(): CourierPartnerScheme;
5223
+ type CourierPartnerScheme = {
4756
5224
  /**
4757
- * - Array of geographical areas associated with the zone.
5225
+ * - Unique identifier for the courier partner scheme.
4758
5226
  */
4759
- geo_areas: GeoArea[];
5227
+ scheme_id?: string;
4760
5228
  /**
4761
- * - Slug for the zone.
5229
+ * - Unique identifier for the courier partner.
4762
5230
  */
4763
- slug: string;
4764
- stores: ListViewProduct;
5231
+ cp_ext_id?: string;
5232
+ };
5233
+ /** @returns {FulfillmentOptionProduct} */
5234
+ declare function FulfillmentOptionProduct(): FulfillmentOptionProduct;
5235
+ type FulfillmentOptionProduct = {
4765
5236
  /**
4766
- * - Indicates if the zone is active.
5237
+ * - Unique identifier for the product.
4767
5238
  */
4768
- is_active: boolean;
4769
- product: ListViewProduct;
5239
+ uid?: number;
4770
5240
  /**
4771
- * - Unique identifier for the company.
5241
+ * - Name of the product.
4772
5242
  */
4773
- company_id: number;
5243
+ name?: string;
4774
5244
  /**
4775
- * - Unique identifier for the application.
5245
+ * - Unique slug identifier for the product.
4776
5246
  */
4777
- application_id: string;
4778
- created_by: CreatedBy;
5247
+ slug?: string;
5248
+ /**
5249
+ * - Slug identifier of the product's category.
5250
+ */
5251
+ category_slug?: string;
5252
+ /**
5253
+ * - Unique identifier for the product's category.
5254
+ */
5255
+ category_uid?: number;
5256
+ /**
5257
+ * - Brief description of the product.
5258
+ */
5259
+ short_description?: string;
5260
+ /**
5261
+ * - Detailed description of the product in HTML format.
5262
+ */
5263
+ description?: string;
5264
+ /**
5265
+ * - Unique identifier for the brand.
5266
+ */
5267
+ brand_uid?: number;
5268
+ /**
5269
+ * - Currency code used for product pricing.
5270
+ */
5271
+ currency?: string;
5272
+ /**
5273
+ * - Unique code assigned to the product.
5274
+ */
5275
+ item_code?: string;
5276
+ /**
5277
+ * - Type of product (e.g., standard, set etc.).
5278
+ */
5279
+ item_type?: string;
5280
+ net_quantity?: NetQuantity;
5281
+ /**
5282
+ * - Indicates if the product supports multiple sizes.
5283
+ */
5284
+ multi_size?: boolean;
5285
+ /**
5286
+ * - Indicates if the product is a set of items.
5287
+ */
5288
+ is_set?: boolean;
5289
+ /**
5290
+ * - Indicates if the product depends on
5291
+ * another product.
5292
+ */
5293
+ is_dependent?: boolean;
5294
+ /**
5295
+ * - Status indicating if the product is active.
5296
+ */
5297
+ is_active?: boolean;
5298
+ /**
5299
+ * - Indicates if the product has no images.
5300
+ */
5301
+ is_image_less_product?: boolean;
5302
+ /**
5303
+ * - URL or reference to the size guide.
5304
+ */
5305
+ size_guide?: string;
5306
+ /**
5307
+ * - Teaser tag information for the product.
5308
+ */
5309
+ teaser_tag?: any;
5310
+ /**
5311
+ * - Key highlights of the product.
5312
+ */
5313
+ highlights?: string[];
5314
+ /**
5315
+ * - Tags associated with the product.
5316
+ */
5317
+ tags?: string[];
5318
+ /**
5319
+ * - Group tags assigned to the product.
5320
+ */
5321
+ product_group_tag?: string[];
5322
+ /**
5323
+ * - Department identifiers associated with
5324
+ * the product.
5325
+ */
5326
+ departments?: number[];
5327
+ /**
5328
+ * - The unique identifier of the company.
5329
+ */
5330
+ company_id?: number;
5331
+ /**
5332
+ * - List of company IDs associated with the product.
5333
+ */
5334
+ company_ids?: number[];
5335
+ /**
5336
+ * - Country where the product is manufactured.
5337
+ */
5338
+ country_of_origin?: string;
5339
+ /**
5340
+ * - Identifier for the change request
5341
+ * related to the product.
5342
+ */
5343
+ change_request_id?: string;
5344
+ trader?: Trader;
5345
+ /**
5346
+ * - Type of trader (e.g., Manufacturer, Wholesaler).
5347
+ */
5348
+ trader_type?: string;
5349
+ product_publish?: ProductPublish;
5350
+ tax_identifier?: TaxIdentifier;
5351
+ return_config?: ReturnConfig;
5352
+ custom_order?: CustomOrder;
5353
+ /**
5354
+ * - Available sizes for the product.
5355
+ */
5356
+ sizes?: Size[];
5357
+ /**
5358
+ * - List of media assets related to the product.
5359
+ */
5360
+ media?: string[];
5361
+ /**
5362
+ * - Media assets for different variants of
5363
+ * the product.
5364
+ */
5365
+ variant_media?: any;
5366
+ /**
5367
+ * - Variant-specific details for the product.
5368
+ */
5369
+ variants?: any;
5370
+ /**
5371
+ * - Number of boxes required for packaging the product.
5372
+ */
5373
+ no_of_boxes?: number;
5374
+ /**
5375
+ * - Custom JSON data associated with the product.
5376
+ */
5377
+ _custom_json?: any;
5378
+ };
5379
+ /** @returns {NetQuantity} */
5380
+ declare function NetQuantity(): NetQuantity;
5381
+ type NetQuantity = {
5382
+ /**
5383
+ * - The quantity value of the product.
5384
+ */
5385
+ value?: number;
5386
+ /**
5387
+ * - The unit of measurement for the quantity.
5388
+ */
5389
+ unit?: string;
5390
+ };
5391
+ /** @returns {Trader} */
5392
+ declare function Trader(): Trader;
5393
+ type Trader = {
5394
+ /**
5395
+ * - Name of the trader.
5396
+ */
5397
+ name?: string;
5398
+ /**
5399
+ * - Address of the trader.
5400
+ */
5401
+ address?: string;
5402
+ };
5403
+ /** @returns {ProductPublish} */
5404
+ declare function ProductPublish(): ProductPublish;
5405
+ type ProductPublish = {
5406
+ /**
5407
+ * - Date when the product went online.
5408
+ */
5409
+ product_online_date?: string;
5410
+ /**
5411
+ * - Indicates if the product is part of a set.
5412
+ */
5413
+ is_set?: boolean;
5414
+ };
5415
+ /** @returns {TaxIdentifier} */
5416
+ declare function TaxIdentifier(): TaxIdentifier;
5417
+ type TaxIdentifier = {
5418
+ /**
5419
+ * - HSN code assigned to the product.
5420
+ */
5421
+ hsn_code?: string;
5422
+ /**
5423
+ * - Identifier for the HSN code.
5424
+ */
5425
+ hsn_code_id?: string;
5426
+ /**
5427
+ * - Reporting HSN code.
5428
+ */
5429
+ reporting_hsn?: string;
5430
+ };
5431
+ /** @returns {ReturnConfig} */
5432
+ declare function ReturnConfig(): ReturnConfig;
5433
+ type ReturnConfig = {
5434
+ /**
5435
+ * - Indicates if the product is returnable.
5436
+ */
5437
+ returnable?: boolean;
5438
+ /**
5439
+ * - Time duration allowed for returns.
5440
+ */
5441
+ time?: number;
5442
+ /**
5443
+ * - Unit of time for return duration.
5444
+ */
5445
+ unit?: string;
5446
+ };
5447
+ /** @returns {CustomOrder} */
5448
+ declare function CustomOrder(): CustomOrder;
5449
+ type CustomOrder = {
5450
+ /**
5451
+ * - Indicates if the product is a custom order.
5452
+ */
5453
+ is_custom_order?: boolean;
5454
+ /**
5455
+ * - Time required for manufacturing the product.
5456
+ */
5457
+ manufacturing_time?: number;
5458
+ /**
5459
+ * - Unit of time for manufacturing.
5460
+ */
5461
+ manufacturing_time_unit?: string;
5462
+ };
5463
+ /** @returns {Size} */
5464
+ declare function Size(): Size;
5465
+ type Size = {
5466
+ /**
5467
+ * - Size label of the product.
5468
+ */
5469
+ size?: string;
5470
+ /**
5471
+ * - Priority assigned to the size.
5472
+ */
5473
+ size_priority?: number;
5474
+ /**
5475
+ * - Unit of measure for
5476
+ * item dimensions.
5477
+ */
5478
+ item_dimensions_unit_of_measure?: string;
5479
+ /**
5480
+ * - Transfer price of the product.
5481
+ */
5482
+ price_transfer?: number;
5483
+ /**
5484
+ * - Height of the product.
5485
+ */
5486
+ item_height?: number;
5487
+ /**
5488
+ * - Length of the product.
5489
+ */
5490
+ item_length?: number;
5491
+ /**
5492
+ * - Width of the product.
5493
+ */
5494
+ item_width?: number;
5495
+ /**
5496
+ * - Weight of the product.
5497
+ */
5498
+ item_weight?: number;
5499
+ /**
5500
+ * - Unit of measure for item weight.
5501
+ */
5502
+ item_weight_unit_of_measure?: string;
5503
+ /**
5504
+ * - Selling price of the product.
5505
+ */
5506
+ price?: number;
5507
+ /**
5508
+ * - Effective price after discounts.
5509
+ */
5510
+ price_effective?: number;
5511
+ /**
5512
+ * - Indicates if the size belongs to a set.
5513
+ */
5514
+ is_set?: boolean;
5515
+ /**
5516
+ * - Indicates if inventory tracking is enabled.
5517
+ */
5518
+ track_inventory?: boolean;
5519
+ /**
5520
+ * - Unique identifiers associated with the size.
5521
+ */
5522
+ identifiers?: Identifier[];
5523
+ /**
5524
+ * - Custom JSON data associated with the size.
5525
+ */
5526
+ _custom_json?: any;
5527
+ };
5528
+ /** @returns {Identifier} */
5529
+ declare function Identifier(): Identifier;
5530
+ type Identifier = {
5531
+ /**
5532
+ * - Type of GTIN identifier (e.g., SKU, UPC, EAN).
5533
+ */
5534
+ gtin_type?: string;
5535
+ /**
5536
+ * - Value of the GTIN identifier.
5537
+ */
5538
+ gtin_value?: string;
5539
+ /**
5540
+ * - Indicates if this is the primary identifier.
5541
+ */
5542
+ primary?: boolean;
5543
+ };
5544
+ /** @returns {Page} */
5545
+ declare function Page(): Page;
5546
+ type Page = {
5547
+ /**
5548
+ * - The total number of all items across all pages.
5549
+ */
5550
+ item_total?: number;
5551
+ /**
5552
+ * - The identifier for the next page.
5553
+ */
5554
+ next_id?: string;
5555
+ /**
5556
+ * - Indicates whether there is a previous page.
5557
+ */
5558
+ has_previous?: boolean;
5559
+ /**
5560
+ * - Indicates whether there is a next page.
5561
+ */
5562
+ has_next?: boolean;
5563
+ /**
5564
+ * - The current page number.
5565
+ */
5566
+ current?: number;
5567
+ /**
5568
+ * - The type of the page, such as 'PageType'.
5569
+ */
5570
+ type: string;
5571
+ /**
5572
+ * - The number of items per page.
5573
+ */
5574
+ size?: number;
5575
+ /**
5576
+ * - The number of items per page.
5577
+ */
5578
+ page_size?: number;
5579
+ };
5580
+ /** @returns {FulfillmentOptionStore} */
5581
+ declare function FulfillmentOptionStore(): FulfillmentOptionStore;
5582
+ type FulfillmentOptionStore = {
5583
+ /**
5584
+ * - Unique identifier for the store.
5585
+ */
5586
+ uid?: number;
5587
+ address?: Address;
5588
+ /**
5589
+ * - The unique identifier of the company.
5590
+ */
5591
+ company_id?: number;
5592
+ /**
5593
+ * - Store name displayed in the UI.
5594
+ */
5595
+ display_name?: string;
5596
+ /**
5597
+ * - Name of the store.
5598
+ */
5599
+ name?: string;
5600
+ /**
5601
+ * - Type of store (e.g., high_street, mall).
5602
+ */
5603
+ store_type?: string;
5604
+ /**
5605
+ * - Tags associated with the store.
5606
+ */
5607
+ tags?: string[];
5608
+ };
5609
+ /** @returns {Address} */
5610
+ declare function Address(): Address;
5611
+ type Address = {
5612
+ /**
5613
+ * - Primary address line.
5614
+ */
5615
+ address1?: string;
5616
+ /**
5617
+ * - Country where the store is located.
5618
+ */
5619
+ country?: string;
5620
+ /**
5621
+ * - Postal code of the store location.
5622
+ */
5623
+ pincode?: string;
5624
+ /**
5625
+ * - City where the store is located.
5626
+ */
5627
+ city?: string;
5628
+ /**
5629
+ * - State where the store is located.
5630
+ */
5631
+ state?: string;
5632
+ /**
5633
+ * - Latitude coordinate of the store.
5634
+ */
5635
+ latitude?: number;
5636
+ /**
5637
+ * - Longitude coordinate of the store.
5638
+ */
5639
+ longitude?: number;
5640
+ /**
5641
+ * - ISO country code of the store location.
5642
+ */
5643
+ country_code?: string;
5644
+ };
5645
+ /** @returns {FulfillmentOptionValidate} */
5646
+ declare function FulfillmentOptionValidate(): FulfillmentOptionValidate;
5647
+ type FulfillmentOptionValidate = {
5648
+ /**
5649
+ * - Type of entity filter applied.
5650
+ */
5651
+ entity_filter_type?: string;
5652
+ /**
5653
+ * - Type of fulfillment option selected.
5654
+ */
5655
+ fulfillment_option_type?: string;
5656
+ };
5657
+ /** @returns {ProductSchema} */
5658
+ declare function ProductSchema(): ProductSchema;
5659
+ type ProductSchema = {
5660
+ /**
5661
+ * - The classification of product type used in the
5662
+ * zone, whether it's a list of categories, departments, tags, or item_ids.
5663
+ */
5664
+ type: string;
5665
+ /**
5666
+ * - List of values representing the products or the
5667
+ * type of products selected for the delivery zone.
5668
+ */
5669
+ values: any[];
5670
+ };
5671
+ /** @returns {StoresSchema} */
5672
+ declare function StoresSchema(): StoresSchema;
5673
+ type StoresSchema = {
5674
+ /**
5675
+ * - Classification of whether all stores in the
5676
+ * application are considered or a custom selection of stores by the seller.
5677
+ */
5678
+ type: string;
5679
+ /**
5680
+ * - List of store Ids mapped to the delivery zone
5681
+ * when custom type is selected.
5682
+ */
5683
+ values: number[];
5684
+ };
5685
+ /** @returns {CreatedBy} */
5686
+ declare function CreatedBy(): CreatedBy;
5687
+ type CreatedBy = {
5688
+ /**
5689
+ * - Identifier of the user or system that created the object.
5690
+ */
5691
+ id?: string;
5692
+ };
5693
+ /** @returns {ModifiedBy} */
5694
+ declare function ModifiedBy(): ModifiedBy;
5695
+ type ModifiedBy = {
5696
+ /**
5697
+ * - Identifier of the user or system that created the object.
5698
+ */
5699
+ id?: string;
5700
+ };
5701
+ /** @returns {ListViewItems} */
5702
+ declare function ListViewItems(): ListViewItems;
5703
+ type ListViewItems = {
5704
+ /**
5705
+ * - Unique identifier for the zone.
5706
+ */
5707
+ zone_id: string;
5708
+ /**
5709
+ * - Name of the zone.
5710
+ */
5711
+ name: string;
5712
+ /**
5713
+ * - Array of geographical areas associated with the zone.
5714
+ */
5715
+ geo_areas: GeoArea[];
5716
+ /**
5717
+ * - Slug for the zone.
5718
+ */
5719
+ slug: string;
5720
+ stores: ListViewProduct;
5721
+ /**
5722
+ * - Indicates if the zone is active.
5723
+ */
5724
+ is_active: boolean;
5725
+ product: ListViewProduct;
5726
+ /**
5727
+ * - The unique identifier of the company.
5728
+ */
5729
+ company_id: number;
5730
+ /**
5731
+ * - The unique identifier of the application.
5732
+ */
5733
+ application_id: string;
5734
+ created_by: CreatedBy;
4779
5735
  modified_by: ModifiedBy;
4780
5736
  /**
4781
5737
  * - The timestamp when the record was created.
@@ -4847,42 +5803,6 @@ type RegionSchema = {
4847
5803
  */
4848
5804
  count?: number;
4849
5805
  };
4850
- /** @returns {Page} */
4851
- declare function Page(): Page;
4852
- type Page = {
4853
- /**
4854
- * - The total number of all items across all pages.
4855
- */
4856
- item_total?: number;
4857
- /**
4858
- * - The identifier for the next page.
4859
- */
4860
- next_id?: string;
4861
- /**
4862
- * - Indicates whether there is a previous page.
4863
- */
4864
- has_previous?: boolean;
4865
- /**
4866
- * - Indicates whether there is a next page.
4867
- */
4868
- has_next?: boolean;
4869
- /**
4870
- * - The current page number.
4871
- */
4872
- current?: number;
4873
- /**
4874
- * - The type of the page, such as 'PageType'.
4875
- */
4876
- type: string;
4877
- /**
4878
- * - The number of items per page.
4879
- */
4880
- size?: number;
4881
- /**
4882
- * - The number of items per page.
4883
- */
4884
- page_size?: number;
4885
- };
4886
5806
  /** @returns {ZoneStores} */
4887
5807
  declare function ZoneStores(): ZoneStores;
4888
5808
  type ZoneStores = {