@gofynd/fdk-client-javascript 3.4.0 → 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 (24) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +111 -43
  4. package/sdk/partner/Logistics/LogisticsPartnerModel.js +65 -33
  5. package/sdk/platform/Cart/CartPlatformModel.d.ts +262 -12
  6. package/sdk/platform/Cart/CartPlatformModel.js +334 -10
  7. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  8. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
  9. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +9 -0
  10. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +4 -0
  11. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  12. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  13. package/sdk/platform/Content/ContentPlatformModel.d.ts +14 -19
  14. package/sdk/platform/Content/ContentPlatformModel.js +6 -20
  15. package/sdk/platform/Order/OrderPlatformModel.d.ts +218 -17
  16. package/sdk/platform/Order/OrderPlatformModel.js +366 -14
  17. package/sdk/platform/Order/OrderPlatformValidator.d.ts +15 -15
  18. package/sdk/platform/Order/OrderPlatformValidator.js +9 -9
  19. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -5
  20. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -3
  21. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +97 -1
  22. package/sdk/platform/Payment/PaymentPlatformModel.js +273 -0
  23. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +50 -4
  24. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +22 -2
@@ -1290,10 +1290,99 @@ export = PaymentPlatformModel;
1290
1290
  * @property {string} [cart_id] - Unique identifier for the shopping cart.
1291
1291
  * @property {CreditAccountSummary} [account]
1292
1292
  */
1293
+ /**
1294
+ * @typedef {| "storefront"
1295
+ * | "store_os_pos"
1296
+ * | "kiosk"
1297
+ * | "scan_go"
1298
+ * | "smart_trolley"
1299
+ * | "gofynd"
1300
+ * | "uniket"
1301
+ * | "marketplace"
1302
+ * | "social_commerce"
1303
+ * | "ondc"
1304
+ * | "nexus"
1305
+ * | "nykaa_fashion"
1306
+ * | "etsy"
1307
+ * | "vuivui"
1308
+ * | "zilingo"
1309
+ * | "firstcry"
1310
+ * | "bukalapak"
1311
+ * | "myntra_ppmp"
1312
+ * | "lazada"
1313
+ * | "tiktok"
1314
+ * | "sfcc"
1315
+ * | "debenhams"
1316
+ * | "prestomall"
1317
+ * | "meesho"
1318
+ * | "amazon_vdf"
1319
+ * | "bigcommerce"
1320
+ * | "sendo"
1321
+ * | "storehippo"
1322
+ * | "cdiscount"
1323
+ * | "nykaa"
1324
+ * | "trendyol"
1325
+ * | "weloveshopping"
1326
+ * | "jollee"
1327
+ * | "wish"
1328
+ * | "tiki"
1329
+ * | "central_online"
1330
+ * | "q10"
1331
+ * | "cred"
1332
+ * | "walmart"
1333
+ * | "snapdeal"
1334
+ * | "flipkart"
1335
+ * | "blibli"
1336
+ * | "ajio_jit"
1337
+ * | "pharmeasy"
1338
+ * | "ezmall"
1339
+ * | "adobe_commerce"
1340
+ * | "kartmax"
1341
+ * | "shopee"
1342
+ * | "zalora"
1343
+ * | "prestashop"
1344
+ * | "smytten"
1345
+ * | "amazon_sc"
1346
+ * | "urbanpiper"
1347
+ * | "flipkart_quick"
1348
+ * | "woocommerce"
1349
+ * | "zivame"
1350
+ * | "lelong"
1351
+ * | "facebook"
1352
+ * | "jiomart"
1353
+ * | "gmc"
1354
+ * | "robins"
1355
+ * | "akulaku"
1356
+ * | "noon"
1357
+ * | "tatacliq"
1358
+ * | "kartrocket"
1359
+ * | "inorbit"
1360
+ * | "ajio_business"
1361
+ * | "swiggy"
1362
+ * | "asos"
1363
+ * | "tokopedia"
1364
+ * | "limeroad"
1365
+ * | "myntra_omni"
1366
+ * | "spoyl"
1367
+ * | "amazon_mlf"
1368
+ * | "fulfilled_by_lazada"
1369
+ * | "ebay"
1370
+ * | "jd"
1371
+ * | "amazon_pharmacy"
1372
+ * | "ajio_vms"
1373
+ * | "daraz"
1374
+ * | "oker"
1375
+ * | "flipkart_b2b"
1376
+ * | "amazon_mlf_ss"
1377
+ * | "woovly"
1378
+ * | "tata1mg"
1379
+ * | "zomato"
1380
+ * | "shopify"} OrderingSource
1381
+ */
1293
1382
  declare class PaymentPlatformModel {
1294
1383
  }
1295
1384
  declare namespace PaymentPlatformModel {
1296
- export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, PaymentConfirmationElement, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, SkuDetails, AppliedOffer, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, CustomerValidationSchema, UserCreditSchema, CreditAccountSummary, ValidateCustomerCreditSchema };
1385
+ export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, PaymentConfirmationElement, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, SkuDetails, AppliedOffer, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, CustomerValidationSchema, UserCreditSchema, CreditAccountSummary, ValidateCustomerCreditSchema, OrderingSource };
1297
1386
  }
1298
1387
  /** @returns {PaymentGatewayConfigDetails} */
1299
1388
  declare function PaymentGatewayConfigDetails(): PaymentGatewayConfigDetails;
@@ -4692,3 +4781,10 @@ type ValidateCustomerCreditSchema = {
4692
4781
  cart_id?: string;
4693
4782
  account?: CreditAccountSummary;
4694
4783
  };
4784
+ /**
4785
+ * Enum: OrderingSource Used By: Payment
4786
+ *
4787
+ * @returns {OrderingSource}
4788
+ */
4789
+ declare function OrderingSource(): OrderingSource;
4790
+ type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "gofynd" | "uniket" | "marketplace" | "social_commerce" | "ondc" | "nexus" | "nykaa_fashion" | "etsy" | "vuivui" | "zilingo" | "firstcry" | "bukalapak" | "myntra_ppmp" | "lazada" | "tiktok" | "sfcc" | "debenhams" | "prestomall" | "meesho" | "amazon_vdf" | "bigcommerce" | "sendo" | "storehippo" | "cdiscount" | "nykaa" | "trendyol" | "weloveshopping" | "jollee" | "wish" | "tiki" | "central_online" | "q10" | "cred" | "walmart" | "snapdeal" | "flipkart" | "blibli" | "ajio_jit" | "pharmeasy" | "ezmall" | "adobe_commerce" | "kartmax" | "shopee" | "zalora" | "prestashop" | "smytten" | "amazon_sc" | "urbanpiper" | "flipkart_quick" | "woocommerce" | "zivame" | "lelong" | "facebook" | "jiomart" | "gmc" | "robins" | "akulaku" | "noon" | "tatacliq" | "kartrocket" | "inorbit" | "ajio_business" | "swiggy" | "asos" | "tokopedia" | "limeroad" | "myntra_omni" | "spoyl" | "amazon_mlf" | "fulfilled_by_lazada" | "ebay" | "jd" | "amazon_pharmacy" | "ajio_vms" | "daraz" | "oker" | "flipkart_b2b" | "amazon_mlf_ss" | "woovly" | "tata1mg" | "zomato" | "shopify";
@@ -1441,6 +1441,96 @@ const Joi = require("joi");
1441
1441
  * @property {CreditAccountSummary} [account]
1442
1442
  */
1443
1443
 
1444
+ /**
1445
+ * @typedef {| "storefront"
1446
+ * | "store_os_pos"
1447
+ * | "kiosk"
1448
+ * | "scan_go"
1449
+ * | "smart_trolley"
1450
+ * | "gofynd"
1451
+ * | "uniket"
1452
+ * | "marketplace"
1453
+ * | "social_commerce"
1454
+ * | "ondc"
1455
+ * | "nexus"
1456
+ * | "nykaa_fashion"
1457
+ * | "etsy"
1458
+ * | "vuivui"
1459
+ * | "zilingo"
1460
+ * | "firstcry"
1461
+ * | "bukalapak"
1462
+ * | "myntra_ppmp"
1463
+ * | "lazada"
1464
+ * | "tiktok"
1465
+ * | "sfcc"
1466
+ * | "debenhams"
1467
+ * | "prestomall"
1468
+ * | "meesho"
1469
+ * | "amazon_vdf"
1470
+ * | "bigcommerce"
1471
+ * | "sendo"
1472
+ * | "storehippo"
1473
+ * | "cdiscount"
1474
+ * | "nykaa"
1475
+ * | "trendyol"
1476
+ * | "weloveshopping"
1477
+ * | "jollee"
1478
+ * | "wish"
1479
+ * | "tiki"
1480
+ * | "central_online"
1481
+ * | "q10"
1482
+ * | "cred"
1483
+ * | "walmart"
1484
+ * | "snapdeal"
1485
+ * | "flipkart"
1486
+ * | "blibli"
1487
+ * | "ajio_jit"
1488
+ * | "pharmeasy"
1489
+ * | "ezmall"
1490
+ * | "adobe_commerce"
1491
+ * | "kartmax"
1492
+ * | "shopee"
1493
+ * | "zalora"
1494
+ * | "prestashop"
1495
+ * | "smytten"
1496
+ * | "amazon_sc"
1497
+ * | "urbanpiper"
1498
+ * | "flipkart_quick"
1499
+ * | "woocommerce"
1500
+ * | "zivame"
1501
+ * | "lelong"
1502
+ * | "facebook"
1503
+ * | "jiomart"
1504
+ * | "gmc"
1505
+ * | "robins"
1506
+ * | "akulaku"
1507
+ * | "noon"
1508
+ * | "tatacliq"
1509
+ * | "kartrocket"
1510
+ * | "inorbit"
1511
+ * | "ajio_business"
1512
+ * | "swiggy"
1513
+ * | "asos"
1514
+ * | "tokopedia"
1515
+ * | "limeroad"
1516
+ * | "myntra_omni"
1517
+ * | "spoyl"
1518
+ * | "amazon_mlf"
1519
+ * | "fulfilled_by_lazada"
1520
+ * | "ebay"
1521
+ * | "jd"
1522
+ * | "amazon_pharmacy"
1523
+ * | "ajio_vms"
1524
+ * | "daraz"
1525
+ * | "oker"
1526
+ * | "flipkart_b2b"
1527
+ * | "amazon_mlf_ss"
1528
+ * | "woovly"
1529
+ * | "tata1mg"
1530
+ * | "zomato"
1531
+ * | "shopify"} OrderingSource
1532
+ */
1533
+
1444
1534
  class PaymentPlatformModel {
1445
1535
  /** @returns {PaymentGatewayConfigDetails} */
1446
1536
  static PaymentGatewayConfigDetails() {
@@ -3160,5 +3250,188 @@ class PaymentPlatformModel {
3160
3250
  account: PaymentPlatformModel.CreditAccountSummary(),
3161
3251
  });
3162
3252
  }
3253
+
3254
+ /**
3255
+ * Enum: OrderingSource Used By: Payment
3256
+ *
3257
+ * @returns {OrderingSource}
3258
+ */
3259
+ static OrderingSource() {
3260
+ return Joi.string().valid(
3261
+ "storefront",
3262
+
3263
+ "store_os_pos",
3264
+
3265
+ "kiosk",
3266
+
3267
+ "scan_go",
3268
+
3269
+ "smart_trolley",
3270
+
3271
+ "gofynd",
3272
+
3273
+ "uniket",
3274
+
3275
+ "marketplace",
3276
+
3277
+ "social_commerce",
3278
+
3279
+ "ondc",
3280
+
3281
+ "nexus",
3282
+
3283
+ "nykaa_fashion",
3284
+
3285
+ "etsy",
3286
+
3287
+ "vuivui",
3288
+
3289
+ "zilingo",
3290
+
3291
+ "firstcry",
3292
+
3293
+ "bukalapak",
3294
+
3295
+ "myntra_ppmp",
3296
+
3297
+ "lazada",
3298
+
3299
+ "tiktok",
3300
+
3301
+ "sfcc",
3302
+
3303
+ "debenhams",
3304
+
3305
+ "prestomall",
3306
+
3307
+ "meesho",
3308
+
3309
+ "amazon_vdf",
3310
+
3311
+ "bigcommerce",
3312
+
3313
+ "sendo",
3314
+
3315
+ "storehippo",
3316
+
3317
+ "cdiscount",
3318
+
3319
+ "nykaa",
3320
+
3321
+ "trendyol",
3322
+
3323
+ "weloveshopping",
3324
+
3325
+ "jollee",
3326
+
3327
+ "wish",
3328
+
3329
+ "tiki",
3330
+
3331
+ "central_online",
3332
+
3333
+ "q10",
3334
+
3335
+ "cred",
3336
+
3337
+ "walmart",
3338
+
3339
+ "snapdeal",
3340
+
3341
+ "flipkart",
3342
+
3343
+ "blibli",
3344
+
3345
+ "ajio_jit",
3346
+
3347
+ "pharmeasy",
3348
+
3349
+ "ezmall",
3350
+
3351
+ "adobe_commerce",
3352
+
3353
+ "kartmax",
3354
+
3355
+ "shopee",
3356
+
3357
+ "zalora",
3358
+
3359
+ "prestashop",
3360
+
3361
+ "smytten",
3362
+
3363
+ "amazon_sc",
3364
+
3365
+ "urbanpiper",
3366
+
3367
+ "flipkart_quick",
3368
+
3369
+ "woocommerce",
3370
+
3371
+ "zivame",
3372
+
3373
+ "lelong",
3374
+
3375
+ "facebook",
3376
+
3377
+ "jiomart",
3378
+
3379
+ "gmc",
3380
+
3381
+ "robins",
3382
+
3383
+ "akulaku",
3384
+
3385
+ "noon",
3386
+
3387
+ "tatacliq",
3388
+
3389
+ "kartrocket",
3390
+
3391
+ "inorbit",
3392
+
3393
+ "ajio_business",
3394
+
3395
+ "swiggy",
3396
+
3397
+ "asos",
3398
+
3399
+ "tokopedia",
3400
+
3401
+ "limeroad",
3402
+
3403
+ "myntra_omni",
3404
+
3405
+ "spoyl",
3406
+
3407
+ "amazon_mlf",
3408
+
3409
+ "fulfilled_by_lazada",
3410
+
3411
+ "ebay",
3412
+
3413
+ "jd",
3414
+
3415
+ "amazon_pharmacy",
3416
+
3417
+ "ajio_vms",
3418
+
3419
+ "daraz",
3420
+
3421
+ "oker",
3422
+
3423
+ "flipkart_b2b",
3424
+
3425
+ "amazon_mlf_ss",
3426
+
3427
+ "woovly",
3428
+
3429
+ "tata1mg",
3430
+
3431
+ "zomato",
3432
+
3433
+ "shopify"
3434
+ );
3435
+ }
3163
3436
  }
3164
3437
  module.exports = PaymentPlatformModel;
@@ -338,6 +338,7 @@ export = ServiceabilityPlatformModel;
338
338
  */
339
339
  /**
340
340
  * @typedef GeoAreaRequestBody
341
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
341
342
  * @property {boolean} is_active - Indicates whether the geo area is active or not.
342
343
  * @property {string} name - The name of the geo area.
343
344
  * @property {string} slug - A slug is a human-readable URL segment, typically
@@ -362,6 +363,7 @@ export = ServiceabilityPlatformModel;
362
363
  * @property {Area[]} areas - A list of areas included in the geo area.
363
364
  * @property {string} [region_type] - Defines whether the region is based on
364
365
  * pincode or non-pincode.
366
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
365
367
  * @property {string} type - Specifies whether the geo area is for price or
366
368
  * delivery purposes.
367
369
  * @property {string} created_on - The timestamp when the record was created.
@@ -374,6 +376,7 @@ export = ServiceabilityPlatformModel;
374
376
  * @typedef GeoAreaPutResponseBody
375
377
  * @property {string} [name] - Name of the geo area.
376
378
  * @property {string} [geoarea_id] - Unique identifier for the geo area.
379
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
377
380
  * @property {string} [slug] - A slug is a human-readable URL segment, typically
378
381
  * generated from a title with special characters removed.
379
382
  * @property {boolean} [is_active] - Indicates whether the geo area is active or not.
@@ -401,6 +404,7 @@ export = ServiceabilityPlatformModel;
401
404
  * generated from a title with special characters removed.
402
405
  * @property {string} [application_id] - The unique identifier of the application.
403
406
  * @property {number} [company_id] - The unique identifier of the company.
407
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
404
408
  * @property {string} geoarea_id - A unique identifier for the geoarea.
405
409
  * @property {boolean} is_active - Indicates whether the geoarea is active.
406
410
  * @property {string} type - The type of geoarea (e.g., city, country).
@@ -850,9 +854,10 @@ export = ServiceabilityPlatformModel;
850
854
  * fetch or modify scheme details.
851
855
  * @property {string} name - Name of the scheme.
852
856
  * @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
853
- * forward pickup (nullable).
857
+ * forward pickup (nullable), having 24hour time format HH:MM.
854
858
  * @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
855
- * reverse pickup (nullable).
859
+ * reverse pickup (nullable), having 24hour time format HH:MM.
860
+ * @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
856
861
  * @property {CourierPartnerSchemeDefaultTat} [default_tat]
857
862
  * @property {ArithmeticOperations} weight
858
863
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -908,6 +913,12 @@ export = ServiceabilityPlatformModel;
908
913
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
909
914
  * quantity of items allowed in a non-quality check shipment.
910
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]
911
922
  */
912
923
  /**
913
924
  * @typedef CourierPartnerSchemeUpdateDetailsSchema
@@ -3123,6 +3134,10 @@ type GeoAreaBulkExportResult = {
3123
3134
  /** @returns {GeoAreaRequestBody} */
3124
3135
  declare function GeoAreaRequestBody(): GeoAreaRequestBody;
3125
3136
  type GeoAreaRequestBody = {
3137
+ /**
3138
+ * - Indicates whether geo area is polygon or not.
3139
+ */
3140
+ is_polygon?: boolean;
3126
3141
  /**
3127
3142
  * - Indicates whether the geo area is active or not.
3128
3143
  */
@@ -3185,6 +3200,10 @@ type GeoAreaResponseBody = {
3185
3200
  * pincode or non-pincode.
3186
3201
  */
3187
3202
  region_type?: string;
3203
+ /**
3204
+ * - Indicates whether geo area is polygon or not.
3205
+ */
3206
+ is_polygon?: boolean;
3188
3207
  /**
3189
3208
  * - Specifies whether the geo area is for price or
3190
3209
  * delivery purposes.
@@ -3216,6 +3235,10 @@ type GeoAreaPutResponseBody = {
3216
3235
  * - Unique identifier for the geo area.
3217
3236
  */
3218
3237
  geoarea_id?: string;
3238
+ /**
3239
+ * - Indicates whether geo area is polygon or not.
3240
+ */
3241
+ is_polygon?: boolean;
3219
3242
  /**
3220
3243
  * - A slug is a human-readable URL segment, typically
3221
3244
  * generated from a title with special characters removed.
@@ -3284,6 +3307,10 @@ type GeoAreaDetails = {
3284
3307
  * - The unique identifier of the company.
3285
3308
  */
3286
3309
  company_id?: number;
3310
+ /**
3311
+ * - Indicates whether geo area is polygon or not.
3312
+ */
3313
+ is_polygon?: boolean;
3287
3314
  /**
3288
3315
  * - A unique identifier for the geoarea.
3289
3316
  */
@@ -4432,14 +4459,18 @@ type CourierPartnerSchemeDetailsModel = {
4432
4459
  name: string;
4433
4460
  /**
4434
4461
  * - Default cutoff time for
4435
- * forward pickup (nullable).
4462
+ * forward pickup (nullable), having 24hour time format HH:MM.
4436
4463
  */
4437
4464
  default_forward_pickup_cutoff?: string;
4438
4465
  /**
4439
4466
  * - Default cutoff time for
4440
- * reverse pickup (nullable).
4467
+ * reverse pickup (nullable), having 24hour time format HH:MM.
4441
4468
  */
4442
4469
  default_reverse_pickup_cutoff?: string;
4470
+ /**
4471
+ * - Timezone for default cutoff time.
4472
+ */
4473
+ default_cutoff_timezone?: string;
4443
4474
  default_tat?: CourierPartnerSchemeDefaultTat;
4444
4475
  weight: ArithmeticOperations;
4445
4476
  volumetric_weight?: ArithmeticOperations;
@@ -4568,6 +4599,21 @@ type CourierPartnerSchemeModelSchema = {
4568
4599
  */
4569
4600
  non_qc_shipment_item_quantity?: number;
4570
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;
4571
4617
  };
4572
4618
  /** @returns {CourierPartnerSchemeUpdateDetailsSchema} */
4573
4619
  declare function CourierPartnerSchemeUpdateDetailsSchema(): CourierPartnerSchemeUpdateDetailsSchema;
@@ -379,6 +379,7 @@ const Joi = require("joi");
379
379
 
380
380
  /**
381
381
  * @typedef GeoAreaRequestBody
382
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
382
383
  * @property {boolean} is_active - Indicates whether the geo area is active or not.
383
384
  * @property {string} name - The name of the geo area.
384
385
  * @property {string} slug - A slug is a human-readable URL segment, typically
@@ -405,6 +406,7 @@ const Joi = require("joi");
405
406
  * @property {Area[]} areas - A list of areas included in the geo area.
406
407
  * @property {string} [region_type] - Defines whether the region is based on
407
408
  * pincode or non-pincode.
409
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
408
410
  * @property {string} type - Specifies whether the geo area is for price or
409
411
  * delivery purposes.
410
412
  * @property {string} created_on - The timestamp when the record was created.
@@ -418,6 +420,7 @@ const Joi = require("joi");
418
420
  * @typedef GeoAreaPutResponseBody
419
421
  * @property {string} [name] - Name of the geo area.
420
422
  * @property {string} [geoarea_id] - Unique identifier for the geo area.
423
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
421
424
  * @property {string} [slug] - A slug is a human-readable URL segment, typically
422
425
  * generated from a title with special characters removed.
423
426
  * @property {boolean} [is_active] - Indicates whether the geo area is active or not.
@@ -447,6 +450,7 @@ const Joi = require("joi");
447
450
  * generated from a title with special characters removed.
448
451
  * @property {string} [application_id] - The unique identifier of the application.
449
452
  * @property {number} [company_id] - The unique identifier of the company.
453
+ * @property {boolean} [is_polygon] - Indicates whether geo area is polygon or not.
450
454
  * @property {string} geoarea_id - A unique identifier for the geoarea.
451
455
  * @property {boolean} is_active - Indicates whether the geoarea is active.
452
456
  * @property {string} type - The type of geoarea (e.g., city, country).
@@ -934,9 +938,10 @@ const Joi = require("joi");
934
938
  * fetch or modify scheme details.
935
939
  * @property {string} name - Name of the scheme.
936
940
  * @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
937
- * forward pickup (nullable).
941
+ * forward pickup (nullable), having 24hour time format HH:MM.
938
942
  * @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
939
- * reverse pickup (nullable).
943
+ * reverse pickup (nullable), having 24hour time format HH:MM.
944
+ * @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
940
945
  * @property {CourierPartnerSchemeDefaultTat} [default_tat]
941
946
  * @property {ArithmeticOperations} weight
942
947
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -993,6 +998,12 @@ const Joi = require("joi");
993
998
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
994
999
  * quantity of items allowed in a non-quality check shipment.
995
1000
  * @property {CourierPartnerSchemeFeatures} feature
1001
+ * @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
1002
+ * forward pickup (nullable), having 24hour time format HH:MM.
1003
+ * @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
1004
+ * reverse pickup (nullable), having 24hour time format HH:MM.
1005
+ * @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
1006
+ * @property {CourierPartnerSchemeDefaultTat} [default_tat]
996
1007
  */
997
1008
 
998
1009
  /**
@@ -2946,6 +2957,7 @@ class ServiceabilityPlatformModel {
2946
2957
  /** @returns {GeoAreaRequestBody} */
2947
2958
  static GeoAreaRequestBody() {
2948
2959
  return Joi.object({
2960
+ is_polygon: Joi.boolean().allow(null),
2949
2961
  is_active: Joi.boolean().required(),
2950
2962
  name: Joi.string().allow("").required(),
2951
2963
  slug: Joi.string().allow("").required(),
@@ -2972,6 +2984,7 @@ class ServiceabilityPlatformModel {
2972
2984
  is_active: Joi.boolean().required(),
2973
2985
  areas: Joi.array().items(ServiceabilityPlatformModel.Area()).required(),
2974
2986
  region_type: Joi.string().allow("").allow(null),
2987
+ is_polygon: Joi.boolean().allow(null),
2975
2988
  type: Joi.string().allow("").required(),
2976
2989
  created_on: Joi.string().allow("").required(),
2977
2990
  modified_on: Joi.string().allow("").required(),
@@ -2986,6 +2999,7 @@ class ServiceabilityPlatformModel {
2986
2999
  return Joi.object({
2987
3000
  name: Joi.string().allow(""),
2988
3001
  geoarea_id: Joi.string().allow(""),
3002
+ is_polygon: Joi.boolean().allow(null),
2989
3003
  slug: Joi.string().allow(""),
2990
3004
  is_active: Joi.boolean(),
2991
3005
  areas: Joi.array().items(ServiceabilityPlatformModel.Area()),
@@ -3014,6 +3028,7 @@ class ServiceabilityPlatformModel {
3014
3028
  slug: Joi.string().allow("").required(),
3015
3029
  application_id: Joi.string().allow(""),
3016
3030
  company_id: Joi.number(),
3031
+ is_polygon: Joi.boolean().allow(null),
3017
3032
  geoarea_id: Joi.string().allow("").required(),
3018
3033
  is_active: Joi.boolean().required(),
3019
3034
  type: Joi.string().allow("").required(),
@@ -3539,6 +3554,7 @@ class ServiceabilityPlatformModel {
3539
3554
  name: Joi.string().allow("").required(),
3540
3555
  default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
3541
3556
  default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
3557
+ default_cutoff_timezone: Joi.string().allow("").allow(null),
3542
3558
  default_tat: ServiceabilityPlatformModel.CourierPartnerSchemeDefaultTat(),
3543
3559
  weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
3544
3560
  volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
@@ -3578,6 +3594,10 @@ class ServiceabilityPlatformModel {
3578
3594
  qc_shipment_item_quantity: Joi.number().allow(null),
3579
3595
  non_qc_shipment_item_quantity: Joi.number().allow(null),
3580
3596
  feature: ServiceabilityPlatformModel.CourierPartnerSchemeFeatures().required(),
3597
+ default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
3598
+ default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
3599
+ default_cutoff_timezone: Joi.string().allow("").allow(null),
3600
+ default_tat: ServiceabilityPlatformModel.CourierPartnerSchemeDefaultTat(),
3581
3601
  });
3582
3602
  }
3583
3603