ce-storefront 0.3.17 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +2 -2
- package/README.md +108 -129
- package/docs/sdks/addresses/README.md +363 -4
- package/docs/sdks/auth/README.md +0 -72
- package/docs/sdks/{cestorefrontaddresses → cestorefrontreviews}/README.md +34 -123
- package/docs/sdks/cestorefrontuser/README.md +735 -6
- package/docs/sdks/customers/README.md +18 -192
- package/docs/sdks/juspay/README.md +15 -15
- package/docs/sdks/loyalty/README.md +81 -0
- package/docs/sdks/notificationpreferences/README.md +162 -4
- package/docs/sdks/orders/README.md +5 -163
- package/docs/sdks/payments/README.md +95 -15
- package/docs/sdks/products/README.md +94 -15
- package/docs/sdks/{cards → refunds}/README.md +11 -12
- package/docs/sdks/reviews/README.md +13 -17
- package/docs/sdks/{catalogproducts → shipments}/README.md +12 -12
- package/docs/sdks/{shipment → shipping}/README.md +5 -5
- package/docs/sdks/{catalogskus → skus}/README.md +3 -3
- package/docs/sdks/user/README.md +0 -425
- package/docs/sdks/utils/README.md +72 -0
- package/docs/sdks/wishlist/README.md +5 -5
- package/esm/funcs/{authUsersAddProfileImage.d.ts → authUserAddProfileImage.d.ts} +2 -2
- package/esm/funcs/authUserAddProfileImage.d.ts.map +1 -0
- package/esm/funcs/{authUsersAddProfileImage.js → authUserAddProfileImage.js} +2 -2
- package/esm/funcs/authUserAddProfileImage.js.map +1 -0
- package/esm/funcs/{authUserDeactivate.d.ts → authUserDeactivateAccount.d.ts} +2 -2
- package/esm/funcs/authUserDeactivateAccount.d.ts.map +1 -0
- package/esm/funcs/{authUserDeactivate.js → authUserDeactivateAccount.js} +2 -2
- package/esm/funcs/authUserDeactivateAccount.js.map +1 -0
- package/esm/funcs/{userDeleteProfileImage.d.ts → authUserDeleteProfileImage.d.ts} +2 -2
- package/esm/funcs/authUserDeleteProfileImage.d.ts.map +1 -0
- package/esm/funcs/{userDeleteProfileImage.js → authUserDeleteProfileImage.js} +2 -2
- package/esm/funcs/authUserDeleteProfileImage.js.map +1 -0
- package/esm/funcs/{usersGet.d.ts → authUserGet.d.ts} +2 -2
- package/esm/funcs/authUserGet.d.ts.map +1 -0
- package/esm/funcs/{usersGet.js → authUserGet.js} +2 -2
- package/esm/funcs/authUserGet.js.map +1 -0
- package/esm/funcs/{usersGetProfileImage.d.ts → authUserGetProfileImage.d.ts} +2 -2
- package/esm/funcs/authUserGetProfileImage.d.ts.map +1 -0
- package/esm/funcs/{usersGetProfileImage.js → authUserGetProfileImage.js} +2 -2
- package/esm/funcs/authUserGetProfileImage.js.map +1 -0
- package/esm/funcs/{authLogout.d.ts → authUserLogout.d.ts} +2 -2
- package/esm/funcs/authUserLogout.d.ts.map +1 -0
- package/esm/funcs/{authLogout.js → authUserLogout.js} +2 -2
- package/esm/funcs/authUserLogout.js.map +1 -0
- package/esm/funcs/{userResetPassword.d.ts → authUserResetPassword.d.ts} +2 -2
- package/esm/funcs/authUserResetPassword.d.ts.map +1 -0
- package/esm/funcs/{userResetPassword.js → authUserResetPassword.js} +2 -2
- package/esm/funcs/authUserResetPassword.js.map +1 -0
- package/esm/funcs/{userUpdate.d.ts → authUserUpdate.d.ts} +2 -2
- package/esm/funcs/authUserUpdate.d.ts.map +1 -0
- package/esm/funcs/{userUpdate.js → authUserUpdate.js} +2 -2
- package/esm/funcs/authUserUpdate.js.map +1 -0
- package/esm/funcs/{userUpdateProfileImage.d.ts → authUserUpdateProfileImage.d.ts} +2 -2
- package/esm/funcs/authUserUpdateProfileImage.d.ts.map +1 -0
- package/esm/funcs/{userUpdateProfileImage.js → authUserUpdateProfileImage.js} +2 -2
- package/esm/funcs/authUserUpdateProfileImage.js.map +1 -0
- package/esm/funcs/{addressesGet.d.ts → catalogProductsGetCrossSells.d.ts} +4 -4
- package/esm/funcs/catalogProductsGetCrossSells.d.ts.map +1 -0
- package/esm/funcs/{productsListCrossSells.js → catalogProductsGetCrossSells.js} +2 -2
- package/esm/funcs/catalogProductsGetCrossSells.js.map +1 -0
- package/esm/funcs/{productsGetSimilar.d.ts → catalogProductsGetSimilar.d.ts} +2 -2
- package/esm/funcs/catalogProductsGetSimilar.d.ts.map +1 -0
- package/esm/funcs/{productsGetSimilar.js → catalogProductsGetSimilar.js} +2 -2
- package/esm/funcs/catalogProductsGetSimilar.js.map +1 -0
- package/esm/funcs/{productsGetUpsells.d.ts → catalogProductsGetUpsells.d.ts} +2 -2
- package/esm/funcs/catalogProductsGetUpsells.d.ts.map +1 -0
- package/esm/funcs/{productsGetUpsells.js → catalogProductsGetUpsells.js} +2 -2
- package/esm/funcs/catalogProductsGetUpsells.js.map +1 -0
- package/esm/funcs/{productsList.d.ts → catalogProductsList.d.ts} +2 -2
- package/esm/funcs/{customersAddAddress.d.ts.map → catalogProductsList.d.ts.map} +1 -1
- package/esm/funcs/{productsList.js → catalogProductsList.js} +2 -2
- package/esm/funcs/catalogProductsList.js.map +1 -0
- package/esm/funcs/{catalogProductReviewsCreate.d.ts → catalogProductsReviewsCreate.d.ts} +2 -2
- package/esm/funcs/catalogProductsReviewsCreate.d.ts.map +1 -0
- package/esm/funcs/{catalogProductReviewsCreate.js → catalogProductsReviewsCreate.js} +2 -2
- package/esm/funcs/catalogProductsReviewsCreate.js.map +1 -0
- package/esm/funcs/{customersUpdate.d.ts → customersAddressesAdd.d.ts} +4 -4
- package/esm/funcs/customersAddressesAdd.d.ts.map +1 -0
- package/esm/funcs/{customersAddAddress.js → customersAddressesAdd.js} +2 -2
- package/esm/funcs/customersAddressesAdd.js.map +1 -0
- package/esm/funcs/customersAddressesGet.d.ts +16 -0
- package/esm/funcs/customersAddressesGet.d.ts.map +1 -0
- package/esm/funcs/{addressesGet.js → customersAddressesGet.js} +2 -2
- package/esm/funcs/customersAddressesGet.js.map +1 -0
- package/esm/funcs/{customersGet.d.ts → customersGetCustomersId.d.ts} +2 -2
- package/esm/funcs/customersGetCustomersId.d.ts.map +1 -0
- package/esm/funcs/{customersGet.js → customersGetCustomersId.js} +2 -2
- package/esm/funcs/customersGetCustomersId.js.map +1 -0
- package/esm/funcs/{loyaltyPointsListActivities.d.ts → customersLoyaltyListActivities.d.ts} +2 -2
- package/esm/funcs/customersLoyaltyListActivities.d.ts.map +1 -0
- package/esm/funcs/{loyaltyPointsListActivities.js → customersLoyaltyListActivities.js} +2 -2
- package/esm/funcs/customersLoyaltyListActivities.js.map +1 -0
- package/esm/funcs/{customersCreate.d.ts → customersPostCustomers.d.ts} +2 -2
- package/esm/funcs/customersPostCustomers.d.ts.map +1 -0
- package/esm/funcs/{customersCreate.js → customersPostCustomers.js} +2 -2
- package/esm/funcs/customersPostCustomers.js.map +1 -0
- package/esm/funcs/customersPutCustomersId.d.ts +16 -0
- package/esm/funcs/customersPutCustomersId.d.ts.map +1 -0
- package/esm/funcs/{customersUpdate.js → customersPutCustomersId.js} +2 -2
- package/esm/funcs/customersPutCustomersId.js.map +1 -0
- package/esm/funcs/{ordersGetPaymentStatus.d.ts → customersReviewsList.d.ts} +4 -4
- package/esm/funcs/{usersGetProfileImage.d.ts.map → customersReviewsList.d.ts.map} +1 -1
- package/esm/funcs/{customersGetReviews.js → customersReviewsList.js} +2 -2
- package/esm/funcs/{usersGetProfileImage.js.map → customersReviewsList.js.map} +1 -1
- package/esm/funcs/{juspayGetCustomer.d.ts → juspayGetPaymentsJuspayCustomer.d.ts} +2 -2
- package/esm/funcs/juspayGetPaymentsJuspayCustomer.d.ts.map +1 -0
- package/esm/funcs/{juspayGetCustomer.js → juspayGetPaymentsJuspayCustomer.js} +2 -2
- package/esm/funcs/{juspayCreateOrder.js.map → juspayGetPaymentsJuspayCustomer.js.map} +1 -1
- package/esm/funcs/{wishlistRemoveItem.d.ts → juspayPostPaymentsJuspayCreateCustomer.d.ts} +5 -4
- package/esm/funcs/juspayPostPaymentsJuspayCreateCustomer.d.ts.map +1 -0
- package/esm/funcs/{juspayCreateCustomer.js → juspayPostPaymentsJuspayCreateCustomer.js} +2 -2
- package/esm/funcs/juspayPostPaymentsJuspayCreateCustomer.js.map +1 -0
- package/esm/funcs/{juspayCreateOrder.d.ts → juspayPostPaymentsJuspayCreateOrder.d.ts} +2 -2
- package/esm/funcs/juspayPostPaymentsJuspayCreateOrder.d.ts.map +1 -0
- package/esm/funcs/{juspayCreateOrder.js → juspayPostPaymentsJuspayCreateOrder.js} +2 -2
- package/esm/funcs/{juspayGetCustomer.js.map → juspayPostPaymentsJuspayCreateOrder.js.map} +1 -1
- package/esm/funcs/ordersGetOrdersIdPaymentStatus.d.ts +15 -0
- package/esm/funcs/ordersGetOrdersIdPaymentStatus.d.ts.map +1 -0
- package/esm/funcs/{ordersGetPaymentStatus.js → ordersGetOrdersIdPaymentStatus.js} +2 -2
- package/esm/funcs/ordersGetOrdersIdPaymentStatus.js.map +1 -0
- package/esm/funcs/{ordersGetRefunds.d.ts → ordersRefundsList.d.ts} +2 -2
- package/esm/funcs/{userResetPassword.d.ts.map → ordersRefundsList.d.ts.map} +1 -1
- package/esm/funcs/{ordersGetRefunds.js → ordersRefundsList.js} +2 -2
- package/esm/funcs/ordersRefundsList.js.map +1 -0
- package/esm/funcs/{ordersGetShipments.d.ts → ordersShipmentsList.d.ts} +2 -2
- package/esm/funcs/ordersShipmentsList.d.ts.map +1 -0
- package/esm/funcs/{ordersGetShipments.js → ordersShipmentsList.js} +2 -2
- package/esm/funcs/ordersShipmentsList.js.map +1 -0
- package/esm/funcs/{paymentsListMethods.d.ts → paymentsGetMethods.d.ts} +2 -2
- package/esm/funcs/{authUserDeactivate.d.ts.map → paymentsGetMethods.d.ts.map} +1 -1
- package/esm/funcs/{paymentsListMethods.js → paymentsGetMethods.js} +2 -2
- package/esm/funcs/paymentsGetMethods.js.map +1 -0
- package/esm/funcs/{paymentsCardsList.d.ts → paymentsGetPaymentsCards.d.ts} +2 -2
- package/esm/funcs/paymentsGetPaymentsCards.d.ts.map +1 -0
- package/esm/funcs/{paymentsCardsList.js → paymentsGetPaymentsCards.js} +2 -2
- package/esm/funcs/paymentsGetPaymentsCards.js.map +1 -0
- package/esm/funcs/{paymentsVerifyVpa.d.ts → paymentsGetPaymentsVerifyVpa.d.ts} +2 -2
- package/esm/funcs/paymentsGetPaymentsVerifyVpa.d.ts.map +1 -0
- package/esm/funcs/{paymentsVerifyVpa.js → paymentsGetPaymentsVerifyVpa.js} +2 -2
- package/esm/funcs/paymentsGetPaymentsVerifyVpa.js.map +1 -0
- package/esm/funcs/{paymentsAddCard.d.ts → paymentsPostPaymentsCards.d.ts} +2 -2
- package/esm/funcs/paymentsPostPaymentsCards.d.ts.map +1 -0
- package/esm/funcs/{paymentsAddCard.js → paymentsPostPaymentsCards.js} +2 -2
- package/esm/funcs/paymentsPostPaymentsCards.js.map +1 -0
- package/esm/funcs/{shipmentCheckPincodeServiceability.d.ts → shippingCheckPincodeServiceability.d.ts} +2 -2
- package/esm/funcs/{shipmentCheckPincodeServiceability.d.ts.map → shippingCheckPincodeServiceability.d.ts.map} +1 -1
- package/esm/funcs/{shipmentCheckPincodeServiceability.js → shippingCheckPincodeServiceability.js} +2 -2
- package/esm/funcs/{shipmentCheckPincodeServiceability.js.map → shippingCheckPincodeServiceability.js.map} +1 -1
- package/esm/funcs/{usersCreateNotificationPreferences.d.ts → userNotificationPreferencesCreate.d.ts} +2 -2
- package/esm/funcs/userNotificationPreferencesCreate.d.ts.map +1 -0
- package/esm/funcs/{usersCreateNotificationPreferences.js → userNotificationPreferencesCreate.js} +2 -2
- package/esm/funcs/userNotificationPreferencesCreate.js.map +1 -0
- package/esm/funcs/{authUserNotificationPreferencesGet.d.ts → userNotificationPreferencesGet.d.ts} +2 -2
- package/esm/funcs/userNotificationPreferencesGet.d.ts.map +1 -0
- package/esm/funcs/{authUserNotificationPreferencesGet.js → userNotificationPreferencesGet.js} +2 -2
- package/esm/funcs/userNotificationPreferencesGet.js.map +1 -0
- package/esm/funcs/{userUpdateNotificationPreferences.d.ts → userNotificationPreferencesUpdate.d.ts} +2 -2
- package/esm/funcs/{userUpdateNotificationPreferences.d.ts.map → userNotificationPreferencesUpdate.d.ts.map} +1 -1
- package/esm/funcs/{userUpdateNotificationPreferences.js → userNotificationPreferencesUpdate.js} +2 -2
- package/esm/funcs/{userUpdateNotificationPreferences.js.map → userNotificationPreferencesUpdate.js.map} +1 -1
- package/esm/funcs/{utilsCountriesGet.d.ts → utilsGetCountries.d.ts} +2 -2
- package/esm/funcs/{utilsCountriesGet.d.ts.map → utilsGetCountries.d.ts.map} +1 -1
- package/esm/funcs/{utilsCountriesGet.js → utilsGetCountries.js} +2 -2
- package/esm/funcs/{utilsCountriesGet.js.map → utilsGetCountries.js.map} +1 -1
- package/esm/funcs/{customersAddAddress.d.ts → wishlistDelete.d.ts} +4 -4
- package/esm/funcs/wishlistDelete.d.ts.map +1 -0
- package/esm/funcs/{wishlistRemoveItem.js → wishlistDelete.js} +2 -2
- package/esm/funcs/wishlistDelete.js.map +1 -0
- package/esm/lib/config.d.ts +2 -2
- package/esm/lib/config.js +2 -2
- package/esm/lib/config.js.map +1 -1
- package/esm/models/components/bundleproduct.d.ts +11 -11
- package/esm/models/components/bundleproduct.d.ts.map +1 -1
- package/esm/models/components/bundleproduct.js +22 -22
- package/esm/models/components/bundleproduct.js.map +1 -1
- package/esm/models/components/bundleproductdetail.d.ts +11 -11
- package/esm/models/components/bundleproductdetail.d.ts.map +1 -1
- package/esm/models/components/bundleproductdetail.js +22 -22
- package/esm/models/components/bundleproductdetail.js.map +1 -1
- package/esm/models/components/cartitem.d.ts +4 -4
- package/esm/models/components/cartitem.d.ts.map +1 -1
- package/esm/models/components/cartitem.js +8 -8
- package/esm/models/components/cartitem.js.map +1 -1
- package/esm/models/components/productimage.d.ts +2 -0
- package/esm/models/components/productimage.d.ts.map +1 -1
- package/esm/models/components/productimage.js +2 -0
- package/esm/models/components/productimage.js.map +1 -1
- package/esm/models/components/singleproduct.d.ts +6 -6
- package/esm/models/components/singleproduct.d.ts.map +1 -1
- package/esm/models/components/singleproduct.js +12 -12
- package/esm/models/components/singleproduct.js.map +1 -1
- package/esm/models/components/singleproductdetail.d.ts +6 -6
- package/esm/models/components/singleproductdetail.d.ts.map +1 -1
- package/esm/models/components/singleproductdetail.js +12 -12
- package/esm/models/components/singleproductdetail.js.map +1 -1
- package/esm/models/components/sku.d.ts +5 -5
- package/esm/models/components/sku.d.ts.map +1 -1
- package/esm/models/components/sku.js +10 -10
- package/esm/models/components/sku.js.map +1 -1
- package/esm/models/components/variant.d.ts +3 -3
- package/esm/models/components/variant.d.ts.map +1 -1
- package/esm/models/components/variant.js +6 -6
- package/esm/models/components/variant.js.map +1 -1
- package/esm/models/components/variantdetail.d.ts +3 -3
- package/esm/models/components/variantdetail.d.ts.map +1 -1
- package/esm/models/components/variantdetail.js +6 -6
- package/esm/models/components/variantdetail.js.map +1 -1
- package/esm/sdk/addresses.d.ts +28 -0
- package/esm/sdk/addresses.d.ts.map +1 -1
- package/esm/sdk/addresses.js +42 -2
- package/esm/sdk/addresses.js.map +1 -1
- package/esm/sdk/auth.d.ts +0 -10
- package/esm/sdk/auth.d.ts.map +1 -1
- package/esm/sdk/auth.js +0 -14
- package/esm/sdk/auth.js.map +1 -1
- package/esm/sdk/catalog.d.ts +5 -2
- package/esm/sdk/catalog.d.ts.map +1 -1
- package/esm/sdk/catalog.js +6 -2
- package/esm/sdk/catalog.js.map +1 -1
- package/esm/sdk/cestorefrontreviews.d.ts +19 -0
- package/esm/sdk/cestorefrontreviews.d.ts.map +1 -0
- package/esm/sdk/cestorefrontreviews.js +28 -0
- package/esm/sdk/cestorefrontreviews.js.map +1 -0
- package/esm/sdk/cestorefrontuser.d.ts +64 -4
- package/esm/sdk/cestorefrontuser.d.ts.map +1 -1
- package/esm/sdk/cestorefrontuser.js +92 -6
- package/esm/sdk/cestorefrontuser.js.map +1 -1
- package/esm/sdk/customers.d.ts +8 -19
- package/esm/sdk/customers.d.ts.map +1 -1
- package/esm/sdk/customers.js +15 -31
- package/esm/sdk/customers.js.map +1 -1
- package/esm/sdk/juspay.d.ts +3 -3
- package/esm/sdk/juspay.d.ts.map +1 -1
- package/esm/sdk/juspay.js +9 -9
- package/esm/sdk/juspay.js.map +1 -1
- package/esm/sdk/loyalty.d.ts +7 -0
- package/esm/sdk/loyalty.d.ts.map +1 -1
- package/esm/sdk/loyalty.js +10 -0
- package/esm/sdk/loyalty.js.map +1 -1
- package/esm/sdk/notificationpreferences.d.ts +14 -0
- package/esm/sdk/notificationpreferences.d.ts.map +1 -1
- package/esm/sdk/notificationpreferences.js +22 -2
- package/esm/sdk/notificationpreferences.js.map +1 -1
- package/esm/sdk/orders.d.ts +7 -15
- package/esm/sdk/orders.d.ts.map +1 -1
- package/esm/sdk/orders.js +11 -23
- package/esm/sdk/orders.js.map +1 -1
- package/esm/sdk/payments.d.ts +10 -6
- package/esm/sdk/payments.d.ts.map +1 -1
- package/esm/sdk/payments.js +19 -13
- package/esm/sdk/payments.js.map +1 -1
- package/esm/sdk/products.d.ts +14 -1
- package/esm/sdk/products.d.ts.map +1 -1
- package/esm/sdk/products.js +27 -9
- package/esm/sdk/products.js.map +1 -1
- package/esm/sdk/refunds.d.ts +12 -0
- package/esm/sdk/refunds.d.ts.map +1 -0
- package/esm/sdk/refunds.js +18 -0
- package/esm/sdk/refunds.js.map +1 -0
- package/esm/sdk/reviews.d.ts +3 -3
- package/esm/sdk/reviews.d.ts.map +1 -1
- package/esm/sdk/reviews.js +4 -4
- package/esm/sdk/reviews.js.map +1 -1
- package/esm/sdk/sdk.d.ts +3 -27
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +3 -35
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/shipments.d.ts +12 -0
- package/esm/sdk/shipments.d.ts.map +1 -0
- package/esm/sdk/shipments.js +18 -0
- package/esm/sdk/shipments.js.map +1 -0
- package/esm/sdk/{shipment.d.ts → shipping.d.ts} +2 -2
- package/esm/sdk/{shipment.d.ts.map → shipping.d.ts.map} +1 -1
- package/esm/sdk/{shipment.js → shipping.js} +4 -4
- package/esm/sdk/{shipment.js.map → shipping.js.map} +1 -1
- package/esm/sdk/{catalogskus.d.ts → skus.d.ts} +2 -2
- package/esm/sdk/skus.d.ts.map +1 -0
- package/esm/sdk/{catalogskus.js → skus.js} +2 -2
- package/esm/sdk/skus.js.map +1 -0
- package/esm/sdk/user.d.ts +4 -37
- package/esm/sdk/user.d.ts.map +1 -1
- package/esm/sdk/user.js +3 -50
- package/esm/sdk/user.js.map +1 -1
- package/esm/sdk/utils.d.ts +7 -3
- package/esm/sdk/utils.d.ts.map +1 -1
- package/esm/sdk/utils.js +9 -3
- package/esm/sdk/utils.js.map +1 -1
- package/esm/sdk/wishlist.d.ts +1 -1
- package/esm/sdk/wishlist.d.ts.map +1 -1
- package/esm/sdk/wishlist.js +3 -3
- package/esm/sdk/wishlist.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/{authUsersAddProfileImage.ts → authUserAddProfileImage.ts} +1 -1
- package/src/funcs/{authUserDeactivate.ts → authUserDeactivateAccount.ts} +1 -1
- package/src/funcs/{userDeleteProfileImage.ts → authUserDeleteProfileImage.ts} +1 -1
- package/src/funcs/{usersGet.ts → authUserGet.ts} +1 -1
- package/src/funcs/{usersGetProfileImage.ts → authUserGetProfileImage.ts} +1 -1
- package/src/funcs/{authLogout.ts → authUserLogout.ts} +1 -1
- package/src/funcs/{userResetPassword.ts → authUserResetPassword.ts} +1 -1
- package/src/funcs/{userUpdate.ts → authUserUpdate.ts} +1 -1
- package/src/funcs/{userUpdateProfileImage.ts → authUserUpdateProfileImage.ts} +1 -1
- package/src/funcs/{productsListCrossSells.ts → catalogProductsGetCrossSells.ts} +1 -1
- package/src/funcs/{productsGetSimilar.ts → catalogProductsGetSimilar.ts} +1 -1
- package/src/funcs/{productsGetUpsells.ts → catalogProductsGetUpsells.ts} +1 -1
- package/src/funcs/{productsList.ts → catalogProductsList.ts} +1 -1
- package/src/funcs/{catalogProductReviewsCreate.ts → catalogProductsReviewsCreate.ts} +1 -1
- package/src/funcs/{customersAddAddress.ts → customersAddressesAdd.ts} +1 -1
- package/src/funcs/{addressesGet.ts → customersAddressesGet.ts} +1 -1
- package/src/funcs/{customersGet.ts → customersGetCustomersId.ts} +1 -1
- package/src/funcs/{loyaltyPointsListActivities.ts → customersLoyaltyListActivities.ts} +1 -1
- package/src/funcs/{customersCreate.ts → customersPostCustomers.ts} +1 -1
- package/src/funcs/{customersUpdate.ts → customersPutCustomersId.ts} +1 -1
- package/src/funcs/{customersGetReviews.ts → customersReviewsList.ts} +1 -1
- package/src/funcs/{juspayGetCustomer.ts → juspayGetPaymentsJuspayCustomer.ts} +1 -1
- package/src/funcs/{juspayCreateCustomer.ts → juspayPostPaymentsJuspayCreateCustomer.ts} +1 -1
- package/src/funcs/{juspayCreateOrder.ts → juspayPostPaymentsJuspayCreateOrder.ts} +1 -1
- package/src/funcs/{ordersGetPaymentStatus.ts → ordersGetOrdersIdPaymentStatus.ts} +1 -1
- package/src/funcs/{ordersGetRefunds.ts → ordersRefundsList.ts} +1 -1
- package/src/funcs/{ordersGetShipments.ts → ordersShipmentsList.ts} +1 -1
- package/src/funcs/{paymentsListMethods.ts → paymentsGetMethods.ts} +1 -1
- package/src/funcs/{paymentsCardsList.ts → paymentsGetPaymentsCards.ts} +1 -1
- package/src/funcs/{paymentsVerifyVpa.ts → paymentsGetPaymentsVerifyVpa.ts} +1 -1
- package/src/funcs/{paymentsAddCard.ts → paymentsPostPaymentsCards.ts} +1 -1
- package/src/funcs/{shipmentCheckPincodeServiceability.ts → shippingCheckPincodeServiceability.ts} +1 -1
- package/src/funcs/{usersCreateNotificationPreferences.ts → userNotificationPreferencesCreate.ts} +1 -1
- package/src/funcs/{authUserNotificationPreferencesGet.ts → userNotificationPreferencesGet.ts} +1 -1
- package/src/funcs/{userUpdateNotificationPreferences.ts → userNotificationPreferencesUpdate.ts} +1 -1
- package/src/funcs/{utilsCountriesGet.ts → utilsGetCountries.ts} +1 -1
- package/src/funcs/{wishlistRemoveItem.ts → wishlistDelete.ts} +1 -1
- package/src/lib/config.ts +2 -2
- package/src/models/components/bundleproduct.ts +33 -33
- package/src/models/components/bundleproductdetail.ts +33 -33
- package/src/models/components/cartitem.ts +12 -12
- package/src/models/components/productimage.ts +4 -0
- package/src/models/components/singleproduct.ts +18 -18
- package/src/models/components/singleproductdetail.ts +18 -18
- package/src/models/components/sku.ts +15 -15
- package/src/models/components/variant.ts +9 -9
- package/src/models/components/variantdetail.ts +9 -9
- package/src/sdk/addresses.ts +74 -2
- package/src/sdk/auth.ts +0 -22
- package/src/sdk/catalog.ts +10 -4
- package/src/sdk/cestorefrontreviews.ts +45 -0
- package/src/sdk/cestorefrontuser.ts +160 -8
- package/src/sdk/customers.ts +19 -49
- package/src/sdk/juspay.ts +9 -9
- package/src/sdk/loyalty.ts +18 -0
- package/src/sdk/notificationpreferences.ts +38 -2
- package/src/sdk/orders.ts +15 -39
- package/src/sdk/payments.ts +27 -15
- package/src/sdk/products.ts +39 -9
- package/src/sdk/{cards.ts → refunds.ts} +7 -7
- package/src/sdk/reviews.ts +6 -6
- package/src/sdk/sdk.ts +4 -54
- package/src/sdk/shipments.ts +27 -0
- package/src/sdk/{shipment.ts → shipping.ts} +3 -3
- package/src/sdk/{catalogskus.ts → skus.ts} +1 -1
- package/src/sdk/user.ts +6 -90
- package/src/sdk/utils.ts +14 -4
- package/src/sdk/wishlist.ts +3 -3
- package/docs/sdks/authuser/README.md +0 -80
- package/docs/sdks/catalogproductreviews/README.md +0 -97
- package/docs/sdks/cestorefrontproducts/README.md +0 -6
- package/docs/sdks/cestorefrontusers/README.md +0 -92
- package/docs/sdks/countries/README.md +0 -79
- package/docs/sdks/loyaltypoints/README.md +0 -88
- package/docs/sdks/users/README.md +0 -240
- package/esm/funcs/addressesGet.d.ts.map +0 -1
- package/esm/funcs/addressesGet.js.map +0 -1
- package/esm/funcs/authLogout.d.ts.map +0 -1
- package/esm/funcs/authLogout.js.map +0 -1
- package/esm/funcs/authUserDeactivate.js.map +0 -1
- package/esm/funcs/authUserNotificationPreferencesGet.d.ts.map +0 -1
- package/esm/funcs/authUserNotificationPreferencesGet.js.map +0 -1
- package/esm/funcs/authUsersAddProfileImage.d.ts.map +0 -1
- package/esm/funcs/authUsersAddProfileImage.js.map +0 -1
- package/esm/funcs/catalogProductReviewsCreate.d.ts.map +0 -1
- package/esm/funcs/catalogProductReviewsCreate.js.map +0 -1
- package/esm/funcs/customersAddAddress.js.map +0 -1
- package/esm/funcs/customersCreate.d.ts.map +0 -1
- package/esm/funcs/customersCreate.js.map +0 -1
- package/esm/funcs/customersGet.d.ts.map +0 -1
- package/esm/funcs/customersGet.js.map +0 -1
- package/esm/funcs/customersGetReviews.d.ts +0 -15
- package/esm/funcs/customersGetReviews.d.ts.map +0 -1
- package/esm/funcs/customersGetReviews.js.map +0 -1
- package/esm/funcs/customersUpdate.d.ts.map +0 -1
- package/esm/funcs/customersUpdate.js.map +0 -1
- package/esm/funcs/juspayCreateCustomer.d.ts +0 -17
- package/esm/funcs/juspayCreateCustomer.d.ts.map +0 -1
- package/esm/funcs/juspayCreateCustomer.js.map +0 -1
- package/esm/funcs/juspayCreateOrder.d.ts.map +0 -1
- package/esm/funcs/juspayGetCustomer.d.ts.map +0 -1
- package/esm/funcs/loyaltyPointsListActivities.d.ts.map +0 -1
- package/esm/funcs/loyaltyPointsListActivities.js.map +0 -1
- package/esm/funcs/ordersGetPaymentStatus.d.ts.map +0 -1
- package/esm/funcs/ordersGetPaymentStatus.js.map +0 -1
- package/esm/funcs/ordersGetRefunds.d.ts.map +0 -1
- package/esm/funcs/ordersGetRefunds.js.map +0 -1
- package/esm/funcs/ordersGetShipments.d.ts.map +0 -1
- package/esm/funcs/ordersGetShipments.js.map +0 -1
- package/esm/funcs/paymentsAddCard.d.ts.map +0 -1
- package/esm/funcs/paymentsAddCard.js.map +0 -1
- package/esm/funcs/paymentsCardsList.d.ts.map +0 -1
- package/esm/funcs/paymentsCardsList.js.map +0 -1
- package/esm/funcs/paymentsListMethods.d.ts.map +0 -1
- package/esm/funcs/paymentsListMethods.js.map +0 -1
- package/esm/funcs/paymentsVerifyVpa.d.ts.map +0 -1
- package/esm/funcs/paymentsVerifyVpa.js.map +0 -1
- package/esm/funcs/productsGetSimilar.d.ts.map +0 -1
- package/esm/funcs/productsGetSimilar.js.map +0 -1
- package/esm/funcs/productsGetUpsells.d.ts.map +0 -1
- package/esm/funcs/productsGetUpsells.js.map +0 -1
- package/esm/funcs/productsList.d.ts.map +0 -1
- package/esm/funcs/productsList.js.map +0 -1
- package/esm/funcs/productsListCrossSells.d.ts +0 -16
- package/esm/funcs/productsListCrossSells.d.ts.map +0 -1
- package/esm/funcs/productsListCrossSells.js.map +0 -1
- package/esm/funcs/userDeleteProfileImage.d.ts.map +0 -1
- package/esm/funcs/userDeleteProfileImage.js.map +0 -1
- package/esm/funcs/userResetPassword.js.map +0 -1
- package/esm/funcs/userUpdate.d.ts.map +0 -1
- package/esm/funcs/userUpdate.js.map +0 -1
- package/esm/funcs/userUpdateProfileImage.d.ts.map +0 -1
- package/esm/funcs/userUpdateProfileImage.js.map +0 -1
- package/esm/funcs/usersCreateNotificationPreferences.d.ts.map +0 -1
- package/esm/funcs/usersCreateNotificationPreferences.js.map +0 -1
- package/esm/funcs/usersGet.d.ts.map +0 -1
- package/esm/funcs/usersGet.js.map +0 -1
- package/esm/funcs/wishlistRemoveItem.d.ts.map +0 -1
- package/esm/funcs/wishlistRemoveItem.js.map +0 -1
- package/esm/sdk/authuser.d.ts +0 -12
- package/esm/sdk/authuser.d.ts.map +0 -1
- package/esm/sdk/authuser.js +0 -18
- package/esm/sdk/authuser.js.map +0 -1
- package/esm/sdk/cards.d.ts +0 -12
- package/esm/sdk/cards.d.ts.map +0 -1
- package/esm/sdk/cards.js +0 -18
- package/esm/sdk/cards.js.map +0 -1
- package/esm/sdk/catalogproductreviews.d.ts +0 -12
- package/esm/sdk/catalogproductreviews.d.ts.map +0 -1
- package/esm/sdk/catalogproductreviews.js +0 -18
- package/esm/sdk/catalogproductreviews.js.map +0 -1
- package/esm/sdk/catalogproducts.d.ts +0 -12
- package/esm/sdk/catalogproducts.d.ts.map +0 -1
- package/esm/sdk/catalogproducts.js +0 -18
- package/esm/sdk/catalogproducts.js.map +0 -1
- package/esm/sdk/catalogskus.d.ts.map +0 -1
- package/esm/sdk/catalogskus.js.map +0 -1
- package/esm/sdk/cestorefrontaddresses.d.ts +0 -26
- package/esm/sdk/cestorefrontaddresses.d.ts.map +0 -1
- package/esm/sdk/cestorefrontaddresses.js +0 -38
- package/esm/sdk/cestorefrontaddresses.js.map +0 -1
- package/esm/sdk/cestorefrontproducts.d.ts +0 -10
- package/esm/sdk/cestorefrontproducts.d.ts.map +0 -1
- package/esm/sdk/cestorefrontproducts.js +0 -15
- package/esm/sdk/cestorefrontproducts.js.map +0 -1
- package/esm/sdk/cestorefrontusers.d.ts +0 -12
- package/esm/sdk/cestorefrontusers.d.ts.map +0 -1
- package/esm/sdk/cestorefrontusers.js +0 -18
- package/esm/sdk/cestorefrontusers.js.map +0 -1
- package/esm/sdk/countries.d.ts +0 -12
- package/esm/sdk/countries.d.ts.map +0 -1
- package/esm/sdk/countries.js +0 -18
- package/esm/sdk/countries.js.map +0 -1
- package/esm/sdk/loyaltypoints.d.ts +0 -12
- package/esm/sdk/loyaltypoints.d.ts.map +0 -1
- package/esm/sdk/loyaltypoints.js +0 -18
- package/esm/sdk/loyaltypoints.js.map +0 -1
- package/esm/sdk/users.d.ts +0 -26
- package/esm/sdk/users.d.ts.map +0 -1
- package/esm/sdk/users.js +0 -38
- package/esm/sdk/users.js.map +0 -1
- package/src/sdk/authuser.ts +0 -27
- package/src/sdk/catalogproductreviews.ts +0 -27
- package/src/sdk/catalogproducts.ts +0 -27
- package/src/sdk/cestorefrontaddresses.ts +0 -63
- package/src/sdk/cestorefrontproducts.ts +0 -19
- package/src/sdk/cestorefrontusers.ts +0 -27
- package/src/sdk/countries.ts +0 -25
- package/src/sdk/loyaltypoints.ts +0 -27
- package/src/sdk/users.ts +0 -63
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
# NotificationPreferences
|
|
2
|
-
(*
|
|
2
|
+
(*user.notificationPreferences*)
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
8
|
* [get](#get) - Retrieve user notification preferences
|
|
9
|
+
* [create](#create) - Create user notification preferences
|
|
10
|
+
* [update](#update) - Update user notification preferences
|
|
9
11
|
|
|
10
12
|
## get
|
|
11
13
|
|
|
@@ -21,7 +23,7 @@ const ceStorefront = new CeStorefront({
|
|
|
21
23
|
});
|
|
22
24
|
|
|
23
25
|
async function run() {
|
|
24
|
-
const result = await ceStorefront.
|
|
26
|
+
const result = await ceStorefront.user.notificationPreferences.get({
|
|
25
27
|
id: "<id>",
|
|
26
28
|
});
|
|
27
29
|
|
|
@@ -38,7 +40,7 @@ The standalone function version of this method:
|
|
|
38
40
|
|
|
39
41
|
```typescript
|
|
40
42
|
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
41
|
-
import {
|
|
43
|
+
import { userNotificationPreferencesGet } from "ce-storefront/funcs/userNotificationPreferencesGet.js";
|
|
42
44
|
|
|
43
45
|
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
44
46
|
// You can create one instance of it to use across an application.
|
|
@@ -47,7 +49,7 @@ const ceStorefront = new CeStorefrontCore({
|
|
|
47
49
|
});
|
|
48
50
|
|
|
49
51
|
async function run() {
|
|
50
|
-
const res = await
|
|
52
|
+
const res = await userNotificationPreferencesGet(ceStorefront, {
|
|
51
53
|
id: "<id>",
|
|
52
54
|
});
|
|
53
55
|
|
|
@@ -79,6 +81,162 @@ run();
|
|
|
79
81
|
|
|
80
82
|
### Errors
|
|
81
83
|
|
|
84
|
+
| Error Type | Status Code | Content Type |
|
|
85
|
+
| -------------- | -------------- | -------------- |
|
|
86
|
+
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
87
|
+
|
|
88
|
+
## create
|
|
89
|
+
|
|
90
|
+
Create user notification preferences API allows clients to create a user's notification preferences based on their unique user identifier (user_id).
|
|
91
|
+
|
|
92
|
+
### Example Usage
|
|
93
|
+
|
|
94
|
+
```typescript
|
|
95
|
+
import { CeStorefront } from "ce-storefront";
|
|
96
|
+
|
|
97
|
+
const ceStorefront = new CeStorefront({
|
|
98
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
async function run() {
|
|
102
|
+
const result = await ceStorefront.user.notificationPreferences.create({
|
|
103
|
+
id: "<id>",
|
|
104
|
+
requestBody: {},
|
|
105
|
+
});
|
|
106
|
+
|
|
107
|
+
// Handle the result
|
|
108
|
+
console.log(result);
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
run();
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Standalone function
|
|
115
|
+
|
|
116
|
+
The standalone function version of this method:
|
|
117
|
+
|
|
118
|
+
```typescript
|
|
119
|
+
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
120
|
+
import { userNotificationPreferencesCreate } from "ce-storefront/funcs/userNotificationPreferencesCreate.js";
|
|
121
|
+
|
|
122
|
+
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
123
|
+
// You can create one instance of it to use across an application.
|
|
124
|
+
const ceStorefront = new CeStorefrontCore({
|
|
125
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
async function run() {
|
|
129
|
+
const res = await userNotificationPreferencesCreate(ceStorefront, {
|
|
130
|
+
id: "<id>",
|
|
131
|
+
requestBody: {},
|
|
132
|
+
});
|
|
133
|
+
|
|
134
|
+
if (!res.ok) {
|
|
135
|
+
throw res.error;
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
const { value: result } = res;
|
|
139
|
+
|
|
140
|
+
// Handle the result
|
|
141
|
+
console.log(result);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
run();
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
| Parameter | Type | Required | Description |
|
|
150
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
151
|
+
| `request` | [operations.PostAuthUserIdNotificationPreferencesRequest](../../models/operations/postauthuseridnotificationpreferencesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
152
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
153
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
154
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
155
|
+
|
|
156
|
+
### Response
|
|
157
|
+
|
|
158
|
+
**Promise\<[operations.PostAuthUserIdNotificationPreferencesResponseBody](../../models/operations/postauthuseridnotificationpreferencesresponsebody.md)\>**
|
|
159
|
+
|
|
160
|
+
### Errors
|
|
161
|
+
|
|
162
|
+
| Error Type | Status Code | Content Type |
|
|
163
|
+
| -------------- | -------------- | -------------- |
|
|
164
|
+
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
165
|
+
|
|
166
|
+
## update
|
|
167
|
+
|
|
168
|
+
Update Notification Preferences API allows clients to update a user's notification preferences based on their unique user identifier (user_id).
|
|
169
|
+
|
|
170
|
+
### Example Usage
|
|
171
|
+
|
|
172
|
+
```typescript
|
|
173
|
+
import { CeStorefront } from "ce-storefront";
|
|
174
|
+
|
|
175
|
+
const ceStorefront = new CeStorefront({
|
|
176
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
async function run() {
|
|
180
|
+
const result = await ceStorefront.user.notificationPreferences.update({
|
|
181
|
+
id: "<id>",
|
|
182
|
+
requestBody: {},
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
// Handle the result
|
|
186
|
+
console.log(result);
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
run();
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Standalone function
|
|
193
|
+
|
|
194
|
+
The standalone function version of this method:
|
|
195
|
+
|
|
196
|
+
```typescript
|
|
197
|
+
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
198
|
+
import { userNotificationPreferencesUpdate } from "ce-storefront/funcs/userNotificationPreferencesUpdate.js";
|
|
199
|
+
|
|
200
|
+
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
201
|
+
// You can create one instance of it to use across an application.
|
|
202
|
+
const ceStorefront = new CeStorefrontCore({
|
|
203
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
204
|
+
});
|
|
205
|
+
|
|
206
|
+
async function run() {
|
|
207
|
+
const res = await userNotificationPreferencesUpdate(ceStorefront, {
|
|
208
|
+
id: "<id>",
|
|
209
|
+
requestBody: {},
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
if (!res.ok) {
|
|
213
|
+
throw res.error;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
const { value: result } = res;
|
|
217
|
+
|
|
218
|
+
// Handle the result
|
|
219
|
+
console.log(result);
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
run();
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Parameters
|
|
226
|
+
|
|
227
|
+
| Parameter | Type | Required | Description |
|
|
228
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
229
|
+
| `request` | [operations.PutAuthUserIdNotificationPreferencesRequest](../../models/operations/putauthuseridnotificationpreferencesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
230
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
231
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
232
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
233
|
+
|
|
234
|
+
### Response
|
|
235
|
+
|
|
236
|
+
**Promise\<[operations.PutAuthUserIdNotificationPreferencesResponseBody](../../models/operations/putauthuseridnotificationpreferencesresponsebody.md)\>**
|
|
237
|
+
|
|
238
|
+
### Errors
|
|
239
|
+
|
|
82
240
|
| Error Type | Status Code | Content Type |
|
|
83
241
|
| -------------- | -------------- | -------------- |
|
|
84
242
|
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
@@ -10,11 +10,9 @@ Orders
|
|
|
10
10
|
* [create](#create) - Create order
|
|
11
11
|
* [list](#list) - Retrieve all orders
|
|
12
12
|
* [get](#get) - Retrieve order detail
|
|
13
|
-
* [getShipments](#getshipments) - Retrieve order shipments
|
|
14
|
-
* [getRefunds](#getrefunds) - Retrieve order refunds
|
|
15
13
|
* [cancel](#cancel) - Cancel order
|
|
16
14
|
* [retryPayment](#retrypayment) - Retry payment
|
|
17
|
-
* [
|
|
15
|
+
* [getOrdersIdPaymentStatus](#getordersidpaymentstatus) - Retrieve payment status
|
|
18
16
|
|
|
19
17
|
## create
|
|
20
18
|
|
|
@@ -261,162 +259,6 @@ run();
|
|
|
261
259
|
| errors.NotFound | 404 | application/json |
|
|
262
260
|
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
263
261
|
|
|
264
|
-
## getShipments
|
|
265
|
-
|
|
266
|
-
Retrieve order shipments
|
|
267
|
-
|
|
268
|
-
### Example Usage
|
|
269
|
-
|
|
270
|
-
```typescript
|
|
271
|
-
import { CeStorefront } from "ce-storefront";
|
|
272
|
-
|
|
273
|
-
const ceStorefront = new CeStorefront({
|
|
274
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
275
|
-
});
|
|
276
|
-
|
|
277
|
-
async function run() {
|
|
278
|
-
const result = await ceStorefront.orders.getShipments({
|
|
279
|
-
orderNumber: "<value>",
|
|
280
|
-
});
|
|
281
|
-
|
|
282
|
-
// Handle the result
|
|
283
|
-
console.log(result);
|
|
284
|
-
}
|
|
285
|
-
|
|
286
|
-
run();
|
|
287
|
-
```
|
|
288
|
-
|
|
289
|
-
### Standalone function
|
|
290
|
-
|
|
291
|
-
The standalone function version of this method:
|
|
292
|
-
|
|
293
|
-
```typescript
|
|
294
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
295
|
-
import { ordersGetShipments } from "ce-storefront/funcs/ordersGetShipments.js";
|
|
296
|
-
|
|
297
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
298
|
-
// You can create one instance of it to use across an application.
|
|
299
|
-
const ceStorefront = new CeStorefrontCore({
|
|
300
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
301
|
-
});
|
|
302
|
-
|
|
303
|
-
async function run() {
|
|
304
|
-
const res = await ordersGetShipments(ceStorefront, {
|
|
305
|
-
orderNumber: "<value>",
|
|
306
|
-
});
|
|
307
|
-
|
|
308
|
-
if (!res.ok) {
|
|
309
|
-
throw res.error;
|
|
310
|
-
}
|
|
311
|
-
|
|
312
|
-
const { value: result } = res;
|
|
313
|
-
|
|
314
|
-
// Handle the result
|
|
315
|
-
console.log(result);
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
run();
|
|
319
|
-
```
|
|
320
|
-
|
|
321
|
-
### Parameters
|
|
322
|
-
|
|
323
|
-
| Parameter | Type | Required | Description |
|
|
324
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
325
|
-
| `request` | [operations.GetOrdersIdShipmentsRequest](../../models/operations/getordersidshipmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
326
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
327
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
328
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
329
|
-
|
|
330
|
-
### Response
|
|
331
|
-
|
|
332
|
-
**Promise\<[operations.GetOrdersIdShipmentsResponseBody](../../models/operations/getordersidshipmentsresponsebody.md)\>**
|
|
333
|
-
|
|
334
|
-
### Errors
|
|
335
|
-
|
|
336
|
-
| Error Type | Status Code | Content Type |
|
|
337
|
-
| ------------------- | ------------------- | ------------------- |
|
|
338
|
-
| errors.Unauthorized | 401 | application/json |
|
|
339
|
-
| errors.NotFound | 404 | application/json |
|
|
340
|
-
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
341
|
-
|
|
342
|
-
## getRefunds
|
|
343
|
-
|
|
344
|
-
Retrieve order refunds
|
|
345
|
-
|
|
346
|
-
### Example Usage
|
|
347
|
-
|
|
348
|
-
```typescript
|
|
349
|
-
import { CeStorefront } from "ce-storefront";
|
|
350
|
-
|
|
351
|
-
const ceStorefront = new CeStorefront({
|
|
352
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
353
|
-
});
|
|
354
|
-
|
|
355
|
-
async function run() {
|
|
356
|
-
const result = await ceStorefront.orders.getRefunds({
|
|
357
|
-
orderNumber: "<value>",
|
|
358
|
-
});
|
|
359
|
-
|
|
360
|
-
// Handle the result
|
|
361
|
-
console.log(result);
|
|
362
|
-
}
|
|
363
|
-
|
|
364
|
-
run();
|
|
365
|
-
```
|
|
366
|
-
|
|
367
|
-
### Standalone function
|
|
368
|
-
|
|
369
|
-
The standalone function version of this method:
|
|
370
|
-
|
|
371
|
-
```typescript
|
|
372
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
373
|
-
import { ordersGetRefunds } from "ce-storefront/funcs/ordersGetRefunds.js";
|
|
374
|
-
|
|
375
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
376
|
-
// You can create one instance of it to use across an application.
|
|
377
|
-
const ceStorefront = new CeStorefrontCore({
|
|
378
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
379
|
-
});
|
|
380
|
-
|
|
381
|
-
async function run() {
|
|
382
|
-
const res = await ordersGetRefunds(ceStorefront, {
|
|
383
|
-
orderNumber: "<value>",
|
|
384
|
-
});
|
|
385
|
-
|
|
386
|
-
if (!res.ok) {
|
|
387
|
-
throw res.error;
|
|
388
|
-
}
|
|
389
|
-
|
|
390
|
-
const { value: result } = res;
|
|
391
|
-
|
|
392
|
-
// Handle the result
|
|
393
|
-
console.log(result);
|
|
394
|
-
}
|
|
395
|
-
|
|
396
|
-
run();
|
|
397
|
-
```
|
|
398
|
-
|
|
399
|
-
### Parameters
|
|
400
|
-
|
|
401
|
-
| Parameter | Type | Required | Description |
|
|
402
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
403
|
-
| `request` | [operations.GetOrdersIdRefundsRequest](../../models/operations/getordersidrefundsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
404
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
405
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
406
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
407
|
-
|
|
408
|
-
### Response
|
|
409
|
-
|
|
410
|
-
**Promise\<[operations.GetOrdersIdRefundsResponseBody](../../models/operations/getordersidrefundsresponsebody.md)\>**
|
|
411
|
-
|
|
412
|
-
### Errors
|
|
413
|
-
|
|
414
|
-
| Error Type | Status Code | Content Type |
|
|
415
|
-
| ------------------- | ------------------- | ------------------- |
|
|
416
|
-
| errors.Unauthorized | 401 | application/json |
|
|
417
|
-
| errors.NotFound | 404 | application/json |
|
|
418
|
-
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
419
|
-
|
|
420
262
|
## cancel
|
|
421
263
|
|
|
422
264
|
Order cancellation
|
|
@@ -596,7 +438,7 @@ run();
|
|
|
596
438
|
| errors.NotFound | 404 | application/json |
|
|
597
439
|
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
598
440
|
|
|
599
|
-
##
|
|
441
|
+
## getOrdersIdPaymentStatus
|
|
600
442
|
|
|
601
443
|
Retrieve payment status of a paricular order.
|
|
602
444
|
|
|
@@ -610,7 +452,7 @@ const ceStorefront = new CeStorefront({
|
|
|
610
452
|
});
|
|
611
453
|
|
|
612
454
|
async function run() {
|
|
613
|
-
const result = await ceStorefront.orders.
|
|
455
|
+
const result = await ceStorefront.orders.getOrdersIdPaymentStatus({
|
|
614
456
|
orderNumber: "<value>",
|
|
615
457
|
});
|
|
616
458
|
|
|
@@ -627,7 +469,7 @@ The standalone function version of this method:
|
|
|
627
469
|
|
|
628
470
|
```typescript
|
|
629
471
|
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
630
|
-
import {
|
|
472
|
+
import { ordersGetOrdersIdPaymentStatus } from "ce-storefront/funcs/ordersGetOrdersIdPaymentStatus.js";
|
|
631
473
|
|
|
632
474
|
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
633
475
|
// You can create one instance of it to use across an application.
|
|
@@ -636,7 +478,7 @@ const ceStorefront = new CeStorefrontCore({
|
|
|
636
478
|
});
|
|
637
479
|
|
|
638
480
|
async function run() {
|
|
639
|
-
const res = await
|
|
481
|
+
const res = await ordersGetOrdersIdPaymentStatus(ceStorefront, {
|
|
640
482
|
orderNumber: "<value>",
|
|
641
483
|
});
|
|
642
484
|
|
|
@@ -8,9 +8,10 @@ Payments
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
10
|
* [generateHash](#generatehash) - Generate hash
|
|
11
|
-
* [
|
|
12
|
-
* [
|
|
13
|
-
* [
|
|
11
|
+
* [getMethods](#getmethods) - List all payment methods
|
|
12
|
+
* [getPaymentsCards](#getpaymentscards) - List all saved cards
|
|
13
|
+
* [postPaymentsCards](#postpaymentscards) - Add card
|
|
14
|
+
* [getPaymentsVerifyVpa](#getpaymentsverifyvpa) - Verify VPA
|
|
14
15
|
|
|
15
16
|
## generateHash
|
|
16
17
|
|
|
@@ -93,7 +94,7 @@ run();
|
|
|
93
94
|
| errors.NotFound | 404 | application/json |
|
|
94
95
|
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
95
96
|
|
|
96
|
-
##
|
|
97
|
+
## getMethods
|
|
97
98
|
|
|
98
99
|
List all payment methods
|
|
99
100
|
|
|
@@ -107,7 +108,7 @@ const ceStorefront = new CeStorefront({
|
|
|
107
108
|
});
|
|
108
109
|
|
|
109
110
|
async function run() {
|
|
110
|
-
const result = await ceStorefront.payments.
|
|
111
|
+
const result = await ceStorefront.payments.getMethods({
|
|
111
112
|
paymentGateway: "JUSPAY",
|
|
112
113
|
});
|
|
113
114
|
|
|
@@ -124,7 +125,7 @@ The standalone function version of this method:
|
|
|
124
125
|
|
|
125
126
|
```typescript
|
|
126
127
|
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
127
|
-
import {
|
|
128
|
+
import { paymentsGetMethods } from "ce-storefront/funcs/paymentsGetMethods.js";
|
|
128
129
|
|
|
129
130
|
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
130
131
|
// You can create one instance of it to use across an application.
|
|
@@ -133,7 +134,7 @@ const ceStorefront = new CeStorefrontCore({
|
|
|
133
134
|
});
|
|
134
135
|
|
|
135
136
|
async function run() {
|
|
136
|
-
const res = await
|
|
137
|
+
const res = await paymentsGetMethods(ceStorefront, {
|
|
137
138
|
paymentGateway: "JUSPAY",
|
|
138
139
|
});
|
|
139
140
|
|
|
@@ -169,7 +170,86 @@ run();
|
|
|
169
170
|
| -------------- | -------------- | -------------- |
|
|
170
171
|
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
171
172
|
|
|
172
|
-
##
|
|
173
|
+
## getPaymentsCards
|
|
174
|
+
|
|
175
|
+
List all saved cards.
|
|
176
|
+
|
|
177
|
+
### Example Usage
|
|
178
|
+
|
|
179
|
+
```typescript
|
|
180
|
+
import { CeStorefront } from "ce-storefront";
|
|
181
|
+
|
|
182
|
+
const ceStorefront = new CeStorefront({
|
|
183
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
184
|
+
});
|
|
185
|
+
|
|
186
|
+
async function run() {
|
|
187
|
+
const result = await ceStorefront.payments.getPaymentsCards({
|
|
188
|
+
paymentGateway: "JUSPAY",
|
|
189
|
+
});
|
|
190
|
+
|
|
191
|
+
// Handle the result
|
|
192
|
+
console.log(result);
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
run();
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
### Standalone function
|
|
199
|
+
|
|
200
|
+
The standalone function version of this method:
|
|
201
|
+
|
|
202
|
+
```typescript
|
|
203
|
+
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
204
|
+
import { paymentsGetPaymentsCards } from "ce-storefront/funcs/paymentsGetPaymentsCards.js";
|
|
205
|
+
|
|
206
|
+
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
207
|
+
// You can create one instance of it to use across an application.
|
|
208
|
+
const ceStorefront = new CeStorefrontCore({
|
|
209
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
async function run() {
|
|
213
|
+
const res = await paymentsGetPaymentsCards(ceStorefront, {
|
|
214
|
+
paymentGateway: "JUSPAY",
|
|
215
|
+
});
|
|
216
|
+
|
|
217
|
+
if (!res.ok) {
|
|
218
|
+
throw res.error;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
const { value: result } = res;
|
|
222
|
+
|
|
223
|
+
// Handle the result
|
|
224
|
+
console.log(result);
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
run();
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### Parameters
|
|
231
|
+
|
|
232
|
+
| Parameter | Type | Required | Description |
|
|
233
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
234
|
+
| `request` | [operations.GetPaymentsCardsRequest](../../models/operations/getpaymentscardsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
235
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
236
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
237
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
238
|
+
|
|
239
|
+
### Response
|
|
240
|
+
|
|
241
|
+
**Promise\<[operations.GetPaymentsCardsResponseBody](../../models/operations/getpaymentscardsresponsebody.md)\>**
|
|
242
|
+
|
|
243
|
+
### Errors
|
|
244
|
+
|
|
245
|
+
| Error Type | Status Code | Content Type |
|
|
246
|
+
| ------------------- | ------------------- | ------------------- |
|
|
247
|
+
| errors.BadRequest | 400 | application/json |
|
|
248
|
+
| errors.Unauthorized | 401 | application/json |
|
|
249
|
+
| errors.NotFound | 404 | application/json |
|
|
250
|
+
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
251
|
+
|
|
252
|
+
## postPaymentsCards
|
|
173
253
|
|
|
174
254
|
Add a new card
|
|
175
255
|
|
|
@@ -183,7 +263,7 @@ const ceStorefront = new CeStorefront({
|
|
|
183
263
|
});
|
|
184
264
|
|
|
185
265
|
async function run() {
|
|
186
|
-
const result = await ceStorefront.payments.
|
|
266
|
+
const result = await ceStorefront.payments.postPaymentsCards({
|
|
187
267
|
cardDetails: {},
|
|
188
268
|
});
|
|
189
269
|
|
|
@@ -200,7 +280,7 @@ The standalone function version of this method:
|
|
|
200
280
|
|
|
201
281
|
```typescript
|
|
202
282
|
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
203
|
-
import {
|
|
283
|
+
import { paymentsPostPaymentsCards } from "ce-storefront/funcs/paymentsPostPaymentsCards.js";
|
|
204
284
|
|
|
205
285
|
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
206
286
|
// You can create one instance of it to use across an application.
|
|
@@ -209,7 +289,7 @@ const ceStorefront = new CeStorefrontCore({
|
|
|
209
289
|
});
|
|
210
290
|
|
|
211
291
|
async function run() {
|
|
212
|
-
const res = await
|
|
292
|
+
const res = await paymentsPostPaymentsCards(ceStorefront, {
|
|
213
293
|
cardDetails: {},
|
|
214
294
|
});
|
|
215
295
|
|
|
@@ -248,7 +328,7 @@ run();
|
|
|
248
328
|
| errors.NotFound | 404 | application/json |
|
|
249
329
|
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
250
330
|
|
|
251
|
-
##
|
|
331
|
+
## getPaymentsVerifyVpa
|
|
252
332
|
|
|
253
333
|
The Virtual Payment Address or VPA is a unique ID given to an individual using the Unified Payment Interface (UPI) service to send or receive money. In the case of UPI collect VPA is the mandatory param and merchants are always advised to check if the VPA is valid or not.
|
|
254
334
|
Validating the VPA will help in reducing the failure rate due to incorrect vpa.
|
|
@@ -263,7 +343,7 @@ const ceStorefront = new CeStorefront({
|
|
|
263
343
|
});
|
|
264
344
|
|
|
265
345
|
async function run() {
|
|
266
|
-
const result = await ceStorefront.payments.
|
|
346
|
+
const result = await ceStorefront.payments.getPaymentsVerifyVpa({
|
|
267
347
|
paymentGateway: "JUSPAY",
|
|
268
348
|
});
|
|
269
349
|
|
|
@@ -280,7 +360,7 @@ The standalone function version of this method:
|
|
|
280
360
|
|
|
281
361
|
```typescript
|
|
282
362
|
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
283
|
-
import {
|
|
363
|
+
import { paymentsGetPaymentsVerifyVpa } from "ce-storefront/funcs/paymentsGetPaymentsVerifyVpa.js";
|
|
284
364
|
|
|
285
365
|
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
286
366
|
// You can create one instance of it to use across an application.
|
|
@@ -289,7 +369,7 @@ const ceStorefront = new CeStorefrontCore({
|
|
|
289
369
|
});
|
|
290
370
|
|
|
291
371
|
async function run() {
|
|
292
|
-
const res = await
|
|
372
|
+
const res = await paymentsGetPaymentsVerifyVpa(ceStorefront, {
|
|
293
373
|
paymentGateway: "JUSPAY",
|
|
294
374
|
});
|
|
295
375
|
|