@gofynd/fdk-client-javascript 3.3.2 → 3.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +14 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +55 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +39 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +20 -3
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +17 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +75 -0
- package/sdk/platform/Cart/CartPlatformModel.js +32 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -5
- package/sdk/platform/Catalog/CatalogPlatformClient.js +44 -8
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +44 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +4 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +2 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +105 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +70 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +57 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +41 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +1 -1
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +16 -1
- package/sdk/platform/Theme/ThemePlatformModel.js +18 -0
|
@@ -160,6 +160,7 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
|
|
|
160
160
|
* @property {boolean} [displaySplit] - Display Split Payment Option or not
|
|
161
161
|
* @property {boolean} [advancePayment] - Display Advance Payment Options or Normal
|
|
162
162
|
* @property {string} [shipmentId]
|
|
163
|
+
* @property {string} [customerId]
|
|
163
164
|
*/
|
|
164
165
|
|
|
165
166
|
/**
|
|
@@ -505,6 +506,7 @@ class PaymentPlatformApplicationValidator {
|
|
|
505
506
|
displaySplit: Joi.boolean(),
|
|
506
507
|
advancePayment: Joi.boolean(),
|
|
507
508
|
shipmentId: Joi.string().allow(""),
|
|
509
|
+
customerId: Joi.string().allow(""),
|
|
508
510
|
}).required();
|
|
509
511
|
}
|
|
510
512
|
|
|
@@ -112,6 +112,15 @@ export = PaymentPlatformModel;
|
|
|
112
112
|
* @property {number} [exp_year] - Exp_year
|
|
113
113
|
* @property {string} [name] - Name
|
|
114
114
|
* @property {string[]} [intent_app_error_list] - Intent_app_error_list
|
|
115
|
+
* @property {PaymentConfirmationElement[]} [payment_confirmation_elements] -
|
|
116
|
+
* List of additional fields required to confirm the payment, such as
|
|
117
|
+
* transaction ID or receipt image.
|
|
118
|
+
*/
|
|
119
|
+
/**
|
|
120
|
+
* @typedef PaymentConfirmationElement
|
|
121
|
+
* @property {boolean} [is_required]
|
|
122
|
+
* @property {string} [display_label]
|
|
123
|
+
* @property {string} [slug]
|
|
115
124
|
*/
|
|
116
125
|
/**
|
|
117
126
|
* @typedef RootPaymentMode
|
|
@@ -786,6 +795,8 @@ export = PaymentPlatformModel;
|
|
|
786
795
|
* redirected after a successful payment.
|
|
787
796
|
* @property {string} [failure_redirection_url] - URL to which the user will be
|
|
788
797
|
* redirected if the payment fails.
|
|
798
|
+
* @property {boolean} [send_communication] - Flag indicating whether to send
|
|
799
|
+
* communications (e.g., SMS or email) for the payment link
|
|
789
800
|
*/
|
|
790
801
|
/**
|
|
791
802
|
* @typedef CreatePaymentLinkDetails
|
|
@@ -859,6 +870,25 @@ export = PaymentPlatformModel;
|
|
|
859
870
|
* @property {Object} [offline] - Details to be updated for online payment configuration.
|
|
860
871
|
* @property {Object} [online] - Details to be updated for offline payment configuration.
|
|
861
872
|
*/
|
|
873
|
+
/**
|
|
874
|
+
* @typedef SkuDetails
|
|
875
|
+
* @property {string} [identifier] - SKU identifier of the offer
|
|
876
|
+
* @property {string} [sku_id] - Unique SKU identifier (example: GTIN, variant ID)
|
|
877
|
+
* @property {string} [sku_name] - Display name of the SKU
|
|
878
|
+
*/
|
|
879
|
+
/**
|
|
880
|
+
* @typedef AppliedOffer
|
|
881
|
+
* @property {boolean} [is_mop] - Whether the offer is a mop or not. MOP is a
|
|
882
|
+
* discount that is applied on the total order value.
|
|
883
|
+
* @property {string} [offer_type] - Type of offer. It can be either a bank or
|
|
884
|
+
* brand offer.
|
|
885
|
+
* @property {string} [offer_id] - Unique identifier for the offer.
|
|
886
|
+
* @property {string} [description] - Description of the offer.
|
|
887
|
+
* @property {number} [amount] - Amount of the offer in paise. (Example: ₹1 = 100 paise)
|
|
888
|
+
* @property {Object} [meta] - Extra meta data specific to extension
|
|
889
|
+
* @property {SkuDetails[]} [sku_details] - List of sku details for which the
|
|
890
|
+
* offer is applicable. This is applicable only for brand offers.
|
|
891
|
+
*/
|
|
862
892
|
/**
|
|
863
893
|
* @typedef OrderDetail
|
|
864
894
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
@@ -870,6 +900,7 @@ export = PaymentPlatformModel;
|
|
|
870
900
|
* @property {Object} aggregator_order_details - Aggregator order details
|
|
871
901
|
* generated by the payment gateway.
|
|
872
902
|
* @property {string} aggregator - Name of the payment gateway aggregator.
|
|
903
|
+
* @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
|
|
873
904
|
*/
|
|
874
905
|
/**
|
|
875
906
|
* @typedef AddressDetail
|
|
@@ -1262,7 +1293,7 @@ export = PaymentPlatformModel;
|
|
|
1262
1293
|
declare class PaymentPlatformModel {
|
|
1263
1294
|
}
|
|
1264
1295
|
declare namespace PaymentPlatformModel {
|
|
1265
|
-
export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, 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, 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 };
|
|
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 };
|
|
1266
1297
|
}
|
|
1267
1298
|
/** @returns {PaymentGatewayConfigDetails} */
|
|
1268
1299
|
declare function PaymentGatewayConfigDetails(): PaymentGatewayConfigDetails;
|
|
@@ -1585,6 +1616,19 @@ type PaymentModeList = {
|
|
|
1585
1616
|
* - Intent_app_error_list
|
|
1586
1617
|
*/
|
|
1587
1618
|
intent_app_error_list?: string[];
|
|
1619
|
+
/**
|
|
1620
|
+
* -
|
|
1621
|
+
* List of additional fields required to confirm the payment, such as
|
|
1622
|
+
* transaction ID or receipt image.
|
|
1623
|
+
*/
|
|
1624
|
+
payment_confirmation_elements?: PaymentConfirmationElement[];
|
|
1625
|
+
};
|
|
1626
|
+
/** @returns {PaymentConfirmationElement} */
|
|
1627
|
+
declare function PaymentConfirmationElement(): PaymentConfirmationElement;
|
|
1628
|
+
type PaymentConfirmationElement = {
|
|
1629
|
+
is_required?: boolean;
|
|
1630
|
+
display_label?: string;
|
|
1631
|
+
slug?: string;
|
|
1588
1632
|
};
|
|
1589
1633
|
/** @returns {RootPaymentMode} */
|
|
1590
1634
|
declare function RootPaymentMode(): RootPaymentMode;
|
|
@@ -3352,6 +3396,11 @@ type CreatePaymentLinkCreation = {
|
|
|
3352
3396
|
* redirected if the payment fails.
|
|
3353
3397
|
*/
|
|
3354
3398
|
failure_redirection_url?: string;
|
|
3399
|
+
/**
|
|
3400
|
+
* - Flag indicating whether to send
|
|
3401
|
+
* communications (e.g., SMS or email) for the payment link
|
|
3402
|
+
*/
|
|
3403
|
+
send_communication?: boolean;
|
|
3355
3404
|
};
|
|
3356
3405
|
/** @returns {CreatePaymentLinkDetails} */
|
|
3357
3406
|
declare function CreatePaymentLinkDetails(): CreatePaymentLinkDetails;
|
|
@@ -3544,6 +3593,57 @@ type MerchnatPaymentModeCreation = {
|
|
|
3544
3593
|
*/
|
|
3545
3594
|
online?: any;
|
|
3546
3595
|
};
|
|
3596
|
+
/** @returns {SkuDetails} */
|
|
3597
|
+
declare function SkuDetails(): SkuDetails;
|
|
3598
|
+
type SkuDetails = {
|
|
3599
|
+
/**
|
|
3600
|
+
* - SKU identifier of the offer
|
|
3601
|
+
*/
|
|
3602
|
+
identifier?: string;
|
|
3603
|
+
/**
|
|
3604
|
+
* - Unique SKU identifier (example: GTIN, variant ID)
|
|
3605
|
+
*/
|
|
3606
|
+
sku_id?: string;
|
|
3607
|
+
/**
|
|
3608
|
+
* - Display name of the SKU
|
|
3609
|
+
*/
|
|
3610
|
+
sku_name?: string;
|
|
3611
|
+
};
|
|
3612
|
+
/** @returns {AppliedOffer} */
|
|
3613
|
+
declare function AppliedOffer(): AppliedOffer;
|
|
3614
|
+
type AppliedOffer = {
|
|
3615
|
+
/**
|
|
3616
|
+
* - Whether the offer is a mop or not. MOP is a
|
|
3617
|
+
* discount that is applied on the total order value.
|
|
3618
|
+
*/
|
|
3619
|
+
is_mop?: boolean;
|
|
3620
|
+
/**
|
|
3621
|
+
* - Type of offer. It can be either a bank or
|
|
3622
|
+
* brand offer.
|
|
3623
|
+
*/
|
|
3624
|
+
offer_type?: string;
|
|
3625
|
+
/**
|
|
3626
|
+
* - Unique identifier for the offer.
|
|
3627
|
+
*/
|
|
3628
|
+
offer_id?: string;
|
|
3629
|
+
/**
|
|
3630
|
+
* - Description of the offer.
|
|
3631
|
+
*/
|
|
3632
|
+
description?: string;
|
|
3633
|
+
/**
|
|
3634
|
+
* - Amount of the offer in paise. (Example: ₹1 = 100 paise)
|
|
3635
|
+
*/
|
|
3636
|
+
amount?: number;
|
|
3637
|
+
/**
|
|
3638
|
+
* - Extra meta data specific to extension
|
|
3639
|
+
*/
|
|
3640
|
+
meta?: any;
|
|
3641
|
+
/**
|
|
3642
|
+
* - List of sku details for which the
|
|
3643
|
+
* offer is applicable. This is applicable only for brand offers.
|
|
3644
|
+
*/
|
|
3645
|
+
sku_details?: SkuDetails[];
|
|
3646
|
+
};
|
|
3547
3647
|
/** @returns {OrderDetail} */
|
|
3548
3648
|
declare function OrderDetail(): OrderDetail;
|
|
3549
3649
|
type OrderDetail = {
|
|
@@ -3574,6 +3674,10 @@ type OrderDetail = {
|
|
|
3574
3674
|
* - Name of the payment gateway aggregator.
|
|
3575
3675
|
*/
|
|
3576
3676
|
aggregator: string;
|
|
3677
|
+
/**
|
|
3678
|
+
* - List of offers applied on the order.
|
|
3679
|
+
*/
|
|
3680
|
+
applied_offers?: AppliedOffer[];
|
|
3577
3681
|
};
|
|
3578
3682
|
/** @returns {AddressDetail} */
|
|
3579
3683
|
declare function AddressDetail(): AddressDetail;
|
|
@@ -125,6 +125,16 @@ const Joi = require("joi");
|
|
|
125
125
|
* @property {number} [exp_year] - Exp_year
|
|
126
126
|
* @property {string} [name] - Name
|
|
127
127
|
* @property {string[]} [intent_app_error_list] - Intent_app_error_list
|
|
128
|
+
* @property {PaymentConfirmationElement[]} [payment_confirmation_elements] -
|
|
129
|
+
* List of additional fields required to confirm the payment, such as
|
|
130
|
+
* transaction ID or receipt image.
|
|
131
|
+
*/
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* @typedef PaymentConfirmationElement
|
|
135
|
+
* @property {boolean} [is_required]
|
|
136
|
+
* @property {string} [display_label]
|
|
137
|
+
* @property {string} [slug]
|
|
128
138
|
*/
|
|
129
139
|
|
|
130
140
|
/**
|
|
@@ -881,6 +891,8 @@ const Joi = require("joi");
|
|
|
881
891
|
* redirected after a successful payment.
|
|
882
892
|
* @property {string} [failure_redirection_url] - URL to which the user will be
|
|
883
893
|
* redirected if the payment fails.
|
|
894
|
+
* @property {boolean} [send_communication] - Flag indicating whether to send
|
|
895
|
+
* communications (e.g., SMS or email) for the payment link
|
|
884
896
|
*/
|
|
885
897
|
|
|
886
898
|
/**
|
|
@@ -966,6 +978,27 @@ const Joi = require("joi");
|
|
|
966
978
|
* @property {Object} [online] - Details to be updated for offline payment configuration.
|
|
967
979
|
*/
|
|
968
980
|
|
|
981
|
+
/**
|
|
982
|
+
* @typedef SkuDetails
|
|
983
|
+
* @property {string} [identifier] - SKU identifier of the offer
|
|
984
|
+
* @property {string} [sku_id] - Unique SKU identifier (example: GTIN, variant ID)
|
|
985
|
+
* @property {string} [sku_name] - Display name of the SKU
|
|
986
|
+
*/
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* @typedef AppliedOffer
|
|
990
|
+
* @property {boolean} [is_mop] - Whether the offer is a mop or not. MOP is a
|
|
991
|
+
* discount that is applied on the total order value.
|
|
992
|
+
* @property {string} [offer_type] - Type of offer. It can be either a bank or
|
|
993
|
+
* brand offer.
|
|
994
|
+
* @property {string} [offer_id] - Unique identifier for the offer.
|
|
995
|
+
* @property {string} [description] - Description of the offer.
|
|
996
|
+
* @property {number} [amount] - Amount of the offer in paise. (Example: ₹1 = 100 paise)
|
|
997
|
+
* @property {Object} [meta] - Extra meta data specific to extension
|
|
998
|
+
* @property {SkuDetails[]} [sku_details] - List of sku details for which the
|
|
999
|
+
* offer is applicable. This is applicable only for brand offers.
|
|
1000
|
+
*/
|
|
1001
|
+
|
|
969
1002
|
/**
|
|
970
1003
|
* @typedef OrderDetail
|
|
971
1004
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
@@ -977,6 +1010,7 @@ const Joi = require("joi");
|
|
|
977
1010
|
* @property {Object} aggregator_order_details - Aggregator order details
|
|
978
1011
|
* generated by the payment gateway.
|
|
979
1012
|
* @property {string} aggregator - Name of the payment gateway aggregator.
|
|
1013
|
+
* @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
|
|
980
1014
|
*/
|
|
981
1015
|
|
|
982
1016
|
/**
|
|
@@ -1560,6 +1594,18 @@ class PaymentPlatformModel {
|
|
|
1560
1594
|
intent_app_error_list: Joi.array()
|
|
1561
1595
|
.items(Joi.string().allow(""))
|
|
1562
1596
|
.allow(null, ""),
|
|
1597
|
+
payment_confirmation_elements: Joi.array().items(
|
|
1598
|
+
PaymentPlatformModel.PaymentConfirmationElement()
|
|
1599
|
+
),
|
|
1600
|
+
});
|
|
1601
|
+
}
|
|
1602
|
+
|
|
1603
|
+
/** @returns {PaymentConfirmationElement} */
|
|
1604
|
+
static PaymentConfirmationElement() {
|
|
1605
|
+
return Joi.object({
|
|
1606
|
+
is_required: Joi.boolean(),
|
|
1607
|
+
display_label: Joi.string().allow(""),
|
|
1608
|
+
slug: Joi.string().allow(""),
|
|
1563
1609
|
});
|
|
1564
1610
|
}
|
|
1565
1611
|
|
|
@@ -2487,6 +2533,7 @@ class PaymentPlatformModel {
|
|
|
2487
2533
|
external_order_id: Joi.string().allow("").required(),
|
|
2488
2534
|
success_redirection_url: Joi.string().allow(""),
|
|
2489
2535
|
failure_redirection_url: Joi.string().allow(""),
|
|
2536
|
+
send_communication: Joi.boolean(),
|
|
2490
2537
|
});
|
|
2491
2538
|
}
|
|
2492
2539
|
|
|
@@ -2595,6 +2642,28 @@ class PaymentPlatformModel {
|
|
|
2595
2642
|
});
|
|
2596
2643
|
}
|
|
2597
2644
|
|
|
2645
|
+
/** @returns {SkuDetails} */
|
|
2646
|
+
static SkuDetails() {
|
|
2647
|
+
return Joi.object({
|
|
2648
|
+
identifier: Joi.string().allow(""),
|
|
2649
|
+
sku_id: Joi.string().allow(""),
|
|
2650
|
+
sku_name: Joi.string().allow(""),
|
|
2651
|
+
});
|
|
2652
|
+
}
|
|
2653
|
+
|
|
2654
|
+
/** @returns {AppliedOffer} */
|
|
2655
|
+
static AppliedOffer() {
|
|
2656
|
+
return Joi.object({
|
|
2657
|
+
is_mop: Joi.boolean(),
|
|
2658
|
+
offer_type: Joi.string().allow(""),
|
|
2659
|
+
offer_id: Joi.string().allow(""),
|
|
2660
|
+
description: Joi.string().allow(""),
|
|
2661
|
+
amount: Joi.number(),
|
|
2662
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
2663
|
+
sku_details: Joi.array().items(PaymentPlatformModel.SkuDetails()),
|
|
2664
|
+
});
|
|
2665
|
+
}
|
|
2666
|
+
|
|
2598
2667
|
/** @returns {OrderDetail} */
|
|
2599
2668
|
static OrderDetail() {
|
|
2600
2669
|
return Joi.object({
|
|
@@ -2606,6 +2675,7 @@ class PaymentPlatformModel {
|
|
|
2606
2675
|
.pattern(/\S/, Joi.any())
|
|
2607
2676
|
.required(),
|
|
2608
2677
|
aggregator: Joi.string().allow("").required(),
|
|
2678
|
+
applied_offers: Joi.array().items(PaymentPlatformModel.AppliedOffer()),
|
|
2609
2679
|
});
|
|
2610
2680
|
}
|
|
2611
2681
|
|
|
@@ -776,6 +776,11 @@ export = ServiceabilityPlatformModel;
|
|
|
776
776
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
777
777
|
* fetch or modify scheme details.
|
|
778
778
|
* @property {string} name - Name of the scheme.
|
|
779
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
780
|
+
* forward pickup (nullable).
|
|
781
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
782
|
+
* reverse pickup (nullable).
|
|
783
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
779
784
|
* @property {ArithmeticOperations} weight
|
|
780
785
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
781
786
|
* @property {string} transport_type - Mode of transport associated with the
|
|
@@ -1281,6 +1286,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1281
1286
|
* @property {ArithmeticOperations} [shipment_weight]
|
|
1282
1287
|
* @property {ArithmeticOperations} [shipment_cost]
|
|
1283
1288
|
* @property {ArithmeticOperations} [shipment_volumetric_weight]
|
|
1289
|
+
* @property {StringComparisonOperations} [store_customer_location]
|
|
1284
1290
|
*/
|
|
1285
1291
|
/**
|
|
1286
1292
|
* @typedef LocationRule
|
|
@@ -1332,6 +1338,18 @@ export = ServiceabilityPlatformModel;
|
|
|
1332
1338
|
* @property {string} [stage] - Represents the current stage of the courier
|
|
1333
1339
|
* partner account (e.g., active, inactive, etc.).
|
|
1334
1340
|
*/
|
|
1341
|
+
/**
|
|
1342
|
+
* @typedef CourierPartnerSchemeDefaultTat
|
|
1343
|
+
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
1344
|
+
* time (tat) to be used for the given scheme or not.
|
|
1345
|
+
* @property {CourierPartnerSchemeTat} [tat]
|
|
1346
|
+
*/
|
|
1347
|
+
/**
|
|
1348
|
+
* @typedef CourierPartnerSchemeTat
|
|
1349
|
+
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
1350
|
+
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
1351
|
+
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
1352
|
+
*/
|
|
1335
1353
|
/**
|
|
1336
1354
|
* @typedef CourierPartnerSchemeFeatures
|
|
1337
1355
|
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
@@ -2018,7 +2036,7 @@ export = ServiceabilityPlatformModel;
|
|
|
2018
2036
|
declare class ServiceabilityPlatformModel {
|
|
2019
2037
|
}
|
|
2020
2038
|
declare namespace ServiceabilityPlatformModel {
|
|
2021
|
-
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, 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 };
|
|
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 };
|
|
2022
2040
|
}
|
|
2023
2041
|
/** @returns {SelfshipSchema} */
|
|
2024
2042
|
declare function SelfshipSchema(): SelfshipSchema;
|
|
@@ -3992,6 +4010,17 @@ type CourierPartnerSchemeDetailsModel = {
|
|
|
3992
4010
|
* - Name of the scheme.
|
|
3993
4011
|
*/
|
|
3994
4012
|
name: string;
|
|
4013
|
+
/**
|
|
4014
|
+
* - Default cutoff time for
|
|
4015
|
+
* forward pickup (nullable).
|
|
4016
|
+
*/
|
|
4017
|
+
default_forward_pickup_cutoff?: string;
|
|
4018
|
+
/**
|
|
4019
|
+
* - Default cutoff time for
|
|
4020
|
+
* reverse pickup (nullable).
|
|
4021
|
+
*/
|
|
4022
|
+
default_reverse_pickup_cutoff?: string;
|
|
4023
|
+
default_tat?: CourierPartnerSchemeDefaultTat;
|
|
3995
4024
|
weight: ArithmeticOperations;
|
|
3996
4025
|
volumetric_weight?: ArithmeticOperations;
|
|
3997
4026
|
/**
|
|
@@ -5195,6 +5224,7 @@ type CourierPartnerRuleConditions = {
|
|
|
5195
5224
|
shipment_weight?: ArithmeticOperations;
|
|
5196
5225
|
shipment_cost?: ArithmeticOperations;
|
|
5197
5226
|
shipment_volumetric_weight?: ArithmeticOperations;
|
|
5227
|
+
store_customer_location?: StringComparisonOperations;
|
|
5198
5228
|
};
|
|
5199
5229
|
/** @returns {LocationRule} */
|
|
5200
5230
|
declare function LocationRule(): LocationRule;
|
|
@@ -5309,6 +5339,32 @@ type CourierPartnerRuleCPListResult = {
|
|
|
5309
5339
|
*/
|
|
5310
5340
|
stage?: string;
|
|
5311
5341
|
};
|
|
5342
|
+
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
5343
|
+
declare function CourierPartnerSchemeDefaultTat(): CourierPartnerSchemeDefaultTat;
|
|
5344
|
+
type CourierPartnerSchemeDefaultTat = {
|
|
5345
|
+
/**
|
|
5346
|
+
* - Indicates whether the default turn around
|
|
5347
|
+
* time (tat) to be used for the given scheme or not.
|
|
5348
|
+
*/
|
|
5349
|
+
enabled?: boolean;
|
|
5350
|
+
tat?: CourierPartnerSchemeTat;
|
|
5351
|
+
};
|
|
5352
|
+
/** @returns {CourierPartnerSchemeTat} */
|
|
5353
|
+
declare function CourierPartnerSchemeTat(): CourierPartnerSchemeTat;
|
|
5354
|
+
type CourierPartnerSchemeTat = {
|
|
5355
|
+
/**
|
|
5356
|
+
* - Minimum turn around time (tat) value for a scheme.
|
|
5357
|
+
*/
|
|
5358
|
+
min?: number;
|
|
5359
|
+
/**
|
|
5360
|
+
* - Maximum turn around time (tat) value for a scheme.
|
|
5361
|
+
*/
|
|
5362
|
+
max?: number;
|
|
5363
|
+
/**
|
|
5364
|
+
* - Unit for the turn around time (tat) values for a scheme.
|
|
5365
|
+
*/
|
|
5366
|
+
unit?: string;
|
|
5367
|
+
};
|
|
5312
5368
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
5313
5369
|
declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
|
|
5314
5370
|
type CourierPartnerSchemeFeatures = {
|
|
@@ -852,6 +852,11 @@ const Joi = require("joi");
|
|
|
852
852
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
853
853
|
* fetch or modify scheme details.
|
|
854
854
|
* @property {string} name - Name of the scheme.
|
|
855
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
856
|
+
* forward pickup (nullable).
|
|
857
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
858
|
+
* reverse pickup (nullable).
|
|
859
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
855
860
|
* @property {ArithmeticOperations} weight
|
|
856
861
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
857
862
|
* @property {string} transport_type - Mode of transport associated with the
|
|
@@ -1407,6 +1412,7 @@ const Joi = require("joi");
|
|
|
1407
1412
|
* @property {ArithmeticOperations} [shipment_weight]
|
|
1408
1413
|
* @property {ArithmeticOperations} [shipment_cost]
|
|
1409
1414
|
* @property {ArithmeticOperations} [shipment_volumetric_weight]
|
|
1415
|
+
* @property {StringComparisonOperations} [store_customer_location]
|
|
1410
1416
|
*/
|
|
1411
1417
|
|
|
1412
1418
|
/**
|
|
@@ -1465,6 +1471,20 @@ const Joi = require("joi");
|
|
|
1465
1471
|
* partner account (e.g., active, inactive, etc.).
|
|
1466
1472
|
*/
|
|
1467
1473
|
|
|
1474
|
+
/**
|
|
1475
|
+
* @typedef CourierPartnerSchemeDefaultTat
|
|
1476
|
+
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
1477
|
+
* time (tat) to be used for the given scheme or not.
|
|
1478
|
+
* @property {CourierPartnerSchemeTat} [tat]
|
|
1479
|
+
*/
|
|
1480
|
+
|
|
1481
|
+
/**
|
|
1482
|
+
* @typedef CourierPartnerSchemeTat
|
|
1483
|
+
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
1484
|
+
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
1485
|
+
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
1486
|
+
*/
|
|
1487
|
+
|
|
1468
1488
|
/**
|
|
1469
1489
|
* @typedef CourierPartnerSchemeFeatures
|
|
1470
1490
|
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
@@ -3162,6 +3182,9 @@ class ServiceabilityPlatformModel {
|
|
|
3162
3182
|
extension_id: Joi.string().allow("").required(),
|
|
3163
3183
|
scheme_id: Joi.string().allow(""),
|
|
3164
3184
|
name: Joi.string().allow("").required(),
|
|
3185
|
+
default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
|
|
3186
|
+
default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
|
|
3187
|
+
default_tat: ServiceabilityPlatformModel.CourierPartnerSchemeDefaultTat(),
|
|
3165
3188
|
weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
|
|
3166
3189
|
volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3167
3190
|
transport_type: Joi.string().allow("").required(),
|
|
@@ -3748,6 +3771,7 @@ class ServiceabilityPlatformModel {
|
|
|
3748
3771
|
shipment_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3749
3772
|
shipment_cost: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3750
3773
|
shipment_volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3774
|
+
store_customer_location: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
3751
3775
|
});
|
|
3752
3776
|
}
|
|
3753
3777
|
|
|
@@ -3809,6 +3833,23 @@ class ServiceabilityPlatformModel {
|
|
|
3809
3833
|
});
|
|
3810
3834
|
}
|
|
3811
3835
|
|
|
3836
|
+
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
3837
|
+
static CourierPartnerSchemeDefaultTat() {
|
|
3838
|
+
return Joi.object({
|
|
3839
|
+
enabled: Joi.boolean(),
|
|
3840
|
+
tat: ServiceabilityPlatformModel.CourierPartnerSchemeTat(),
|
|
3841
|
+
});
|
|
3842
|
+
}
|
|
3843
|
+
|
|
3844
|
+
/** @returns {CourierPartnerSchemeTat} */
|
|
3845
|
+
static CourierPartnerSchemeTat() {
|
|
3846
|
+
return Joi.object({
|
|
3847
|
+
min: Joi.number(),
|
|
3848
|
+
max: Joi.number(),
|
|
3849
|
+
unit: Joi.string().allow(""),
|
|
3850
|
+
});
|
|
3851
|
+
}
|
|
3852
|
+
|
|
3812
3853
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
3813
3854
|
static CourierPartnerSchemeFeatures() {
|
|
3814
3855
|
return Joi.object({
|
|
@@ -180,7 +180,7 @@ declare class Theme {
|
|
|
180
180
|
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
181
181
|
* @name isUpgradable
|
|
182
182
|
* @summary: Check theme is upgradable
|
|
183
|
-
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace.
|
|
183
|
+
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
184
184
|
*/
|
|
185
185
|
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradable>;
|
|
186
186
|
/**
|
|
@@ -1268,7 +1268,7 @@ class Theme {
|
|
|
1268
1268
|
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
1269
1269
|
* @name isUpgradable
|
|
1270
1270
|
* @summary: Check theme is upgradable
|
|
1271
|
-
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace.
|
|
1271
|
+
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
1272
1272
|
*/
|
|
1273
1273
|
async isUpgradable(
|
|
1274
1274
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -91,6 +91,12 @@ export = ThemePlatformModel;
|
|
|
91
91
|
/**
|
|
92
92
|
* @typedef AvailablePageSectionMetaAttributes
|
|
93
93
|
* @property {Object} [attributes]
|
|
94
|
+
* @property {CanvasItem} [canvas]
|
|
95
|
+
*/
|
|
96
|
+
/**
|
|
97
|
+
* @typedef CanvasItem
|
|
98
|
+
* @property {string} [value]
|
|
99
|
+
* @property {string} [label]
|
|
94
100
|
*/
|
|
95
101
|
/**
|
|
96
102
|
* @typedef SEOMetaItem
|
|
@@ -131,6 +137,7 @@ export = ThemePlatformModel;
|
|
|
131
137
|
* @typedef AvailablePageSchemaSections
|
|
132
138
|
* @property {string} [name]
|
|
133
139
|
* @property {string} [label]
|
|
140
|
+
* @property {string} [canvas]
|
|
134
141
|
* @property {Object} [props]
|
|
135
142
|
* @property {string} [custom_css] - Custom CSS for a section
|
|
136
143
|
* @property {Object[]} [blocks]
|
|
@@ -599,7 +606,7 @@ export = ThemePlatformModel;
|
|
|
599
606
|
declare class ThemePlatformModel {
|
|
600
607
|
}
|
|
601
608
|
declare namespace ThemePlatformModel {
|
|
602
|
-
export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradable, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyTheme, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
|
|
609
|
+
export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, CanvasItem, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradable, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyTheme, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
|
|
603
610
|
}
|
|
604
611
|
/** @returns {GetExtensionSectionRes} */
|
|
605
612
|
declare function GetExtensionSectionRes(): GetExtensionSectionRes;
|
|
@@ -762,6 +769,13 @@ type AvailablePageSchema = {
|
|
|
762
769
|
declare function AvailablePageSectionMetaAttributes(): AvailablePageSectionMetaAttributes;
|
|
763
770
|
type AvailablePageSectionMetaAttributes = {
|
|
764
771
|
attributes?: any;
|
|
772
|
+
canvas?: CanvasItem;
|
|
773
|
+
};
|
|
774
|
+
/** @returns {CanvasItem} */
|
|
775
|
+
declare function CanvasItem(): CanvasItem;
|
|
776
|
+
type CanvasItem = {
|
|
777
|
+
value?: string;
|
|
778
|
+
label?: string;
|
|
765
779
|
};
|
|
766
780
|
/** @returns {SEOMetaItem} */
|
|
767
781
|
declare function SEOMetaItem(): SEOMetaItem;
|
|
@@ -812,6 +826,7 @@ declare function AvailablePageSchemaSections(): AvailablePageSchemaSections;
|
|
|
812
826
|
type AvailablePageSchemaSections = {
|
|
813
827
|
name?: string;
|
|
814
828
|
label?: string;
|
|
829
|
+
canvas?: string;
|
|
815
830
|
props?: any;
|
|
816
831
|
/**
|
|
817
832
|
* - Custom CSS for a section
|
|
@@ -103,6 +103,13 @@ const Joi = require("joi");
|
|
|
103
103
|
/**
|
|
104
104
|
* @typedef AvailablePageSectionMetaAttributes
|
|
105
105
|
* @property {Object} [attributes]
|
|
106
|
+
* @property {CanvasItem} [canvas]
|
|
107
|
+
*/
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* @typedef CanvasItem
|
|
111
|
+
* @property {string} [value]
|
|
112
|
+
* @property {string} [label]
|
|
106
113
|
*/
|
|
107
114
|
|
|
108
115
|
/**
|
|
@@ -150,6 +157,7 @@ const Joi = require("joi");
|
|
|
150
157
|
* @typedef AvailablePageSchemaSections
|
|
151
158
|
* @property {string} [name]
|
|
152
159
|
* @property {string} [label]
|
|
160
|
+
* @property {string} [canvas]
|
|
153
161
|
* @property {Object} [props]
|
|
154
162
|
* @property {string} [custom_css] - Custom CSS for a section
|
|
155
163
|
* @property {Object[]} [blocks]
|
|
@@ -808,6 +816,15 @@ class ThemePlatformModel {
|
|
|
808
816
|
static AvailablePageSectionMetaAttributes() {
|
|
809
817
|
return Joi.object({
|
|
810
818
|
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
819
|
+
canvas: ThemePlatformModel.CanvasItem(),
|
|
820
|
+
});
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
/** @returns {CanvasItem} */
|
|
824
|
+
static CanvasItem() {
|
|
825
|
+
return Joi.object({
|
|
826
|
+
value: Joi.string().allow(""),
|
|
827
|
+
label: Joi.string().allow(""),
|
|
811
828
|
});
|
|
812
829
|
}
|
|
813
830
|
|
|
@@ -869,6 +886,7 @@ class ThemePlatformModel {
|
|
|
869
886
|
return Joi.object({
|
|
870
887
|
name: Joi.string().allow(""),
|
|
871
888
|
label: Joi.string().allow(""),
|
|
889
|
+
canvas: Joi.string().allow(""),
|
|
872
890
|
props: Joi.object().pattern(/\S/, Joi.any()),
|
|
873
891
|
custom_css: Joi.string().allow(""),
|
|
874
892
|
blocks: Joi.array().items(Joi.any()),
|