commerce-sdk-isomorphic 2.0.0 → 2.1.0-dev.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/lib/index.cjs.d.ts +2668 -50
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +2668 -50
- package/lib/index.esm.js +1 -1
- package/package.json +4 -4
package/lib/index.cjs.d.ts
CHANGED
|
@@ -705,9 +705,8 @@ type ShopperBasketsParameters = ShopperBasketsPathParameters & BaseUriParameters
|
|
|
705
705
|
* API Version: 2.0.3<br />
|
|
706
706
|
* Last Updated: <br />
|
|
707
707
|
* </span>
|
|
708
|
-
|
|
709
708
|
*
|
|
710
|
-
|
|
709
|
+
*
|
|
711
710
|
*/
|
|
712
711
|
declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters & Record<string, unknown>> {
|
|
713
712
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -716,6 +715,433 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
716
715
|
};
|
|
717
716
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-baskets/{version}";
|
|
718
717
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
718
|
+
static readonly paramKeys: {
|
|
719
|
+
readonly createBasket: readonly [
|
|
720
|
+
"organizationId",
|
|
721
|
+
"taxMode",
|
|
722
|
+
"temporary",
|
|
723
|
+
"siteId",
|
|
724
|
+
"locale"
|
|
725
|
+
];
|
|
726
|
+
readonly createBasketRequired: readonly [
|
|
727
|
+
"organizationId",
|
|
728
|
+
"siteId"
|
|
729
|
+
];
|
|
730
|
+
readonly transferBasket: readonly [
|
|
731
|
+
"organizationId",
|
|
732
|
+
"overrideExisting",
|
|
733
|
+
"siteId",
|
|
734
|
+
"locale"
|
|
735
|
+
];
|
|
736
|
+
readonly transferBasketRequired: readonly [
|
|
737
|
+
"organizationId",
|
|
738
|
+
"siteId"
|
|
739
|
+
];
|
|
740
|
+
readonly mergeBasket: readonly [
|
|
741
|
+
"organizationId",
|
|
742
|
+
"createDestinationBasket",
|
|
743
|
+
"productItemMergeMode",
|
|
744
|
+
"siteId",
|
|
745
|
+
"locale"
|
|
746
|
+
];
|
|
747
|
+
readonly mergeBasketRequired: readonly [
|
|
748
|
+
"organizationId",
|
|
749
|
+
"siteId"
|
|
750
|
+
];
|
|
751
|
+
readonly deleteBasket: readonly [
|
|
752
|
+
"organizationId",
|
|
753
|
+
"basketId",
|
|
754
|
+
"siteId"
|
|
755
|
+
];
|
|
756
|
+
readonly deleteBasketRequired: readonly [
|
|
757
|
+
"organizationId",
|
|
758
|
+
"basketId",
|
|
759
|
+
"siteId"
|
|
760
|
+
];
|
|
761
|
+
readonly getBasket: readonly [
|
|
762
|
+
"organizationId",
|
|
763
|
+
"basketId",
|
|
764
|
+
"siteId",
|
|
765
|
+
"locale"
|
|
766
|
+
];
|
|
767
|
+
readonly getBasketRequired: readonly [
|
|
768
|
+
"organizationId",
|
|
769
|
+
"basketId",
|
|
770
|
+
"siteId"
|
|
771
|
+
];
|
|
772
|
+
readonly updateBasket: readonly [
|
|
773
|
+
"organizationId",
|
|
774
|
+
"basketId",
|
|
775
|
+
"siteId",
|
|
776
|
+
"locale"
|
|
777
|
+
];
|
|
778
|
+
readonly updateBasketRequired: readonly [
|
|
779
|
+
"organizationId",
|
|
780
|
+
"basketId",
|
|
781
|
+
"siteId"
|
|
782
|
+
];
|
|
783
|
+
readonly updateAsAgentBasket: readonly [
|
|
784
|
+
"organizationId",
|
|
785
|
+
"basketId",
|
|
786
|
+
"siteId",
|
|
787
|
+
"locale"
|
|
788
|
+
];
|
|
789
|
+
readonly updateAsAgentBasketRequired: readonly [
|
|
790
|
+
"organizationId",
|
|
791
|
+
"basketId",
|
|
792
|
+
"siteId"
|
|
793
|
+
];
|
|
794
|
+
readonly updateBillingAddressForBasket: readonly [
|
|
795
|
+
"organizationId",
|
|
796
|
+
"basketId",
|
|
797
|
+
"useAsShipping",
|
|
798
|
+
"removeExternalTax",
|
|
799
|
+
"siteId",
|
|
800
|
+
"locale"
|
|
801
|
+
];
|
|
802
|
+
readonly updateBillingAddressForBasketRequired: readonly [
|
|
803
|
+
"organizationId",
|
|
804
|
+
"basketId",
|
|
805
|
+
"siteId"
|
|
806
|
+
];
|
|
807
|
+
readonly addCouponToBasket: readonly [
|
|
808
|
+
"organizationId",
|
|
809
|
+
"basketId",
|
|
810
|
+
"siteId",
|
|
811
|
+
"locale"
|
|
812
|
+
];
|
|
813
|
+
readonly addCouponToBasketRequired: readonly [
|
|
814
|
+
"organizationId",
|
|
815
|
+
"basketId",
|
|
816
|
+
"siteId"
|
|
817
|
+
];
|
|
818
|
+
readonly removeCouponFromBasket: readonly [
|
|
819
|
+
"organizationId",
|
|
820
|
+
"basketId",
|
|
821
|
+
"couponItemId",
|
|
822
|
+
"siteId",
|
|
823
|
+
"locale"
|
|
824
|
+
];
|
|
825
|
+
readonly removeCouponFromBasketRequired: readonly [
|
|
826
|
+
"organizationId",
|
|
827
|
+
"basketId",
|
|
828
|
+
"couponItemId",
|
|
829
|
+
"siteId"
|
|
830
|
+
];
|
|
831
|
+
readonly updateCustomerForBasket: readonly [
|
|
832
|
+
"organizationId",
|
|
833
|
+
"basketId",
|
|
834
|
+
"siteId",
|
|
835
|
+
"locale"
|
|
836
|
+
];
|
|
837
|
+
readonly updateCustomerForBasketRequired: readonly [
|
|
838
|
+
"organizationId",
|
|
839
|
+
"basketId",
|
|
840
|
+
"siteId"
|
|
841
|
+
];
|
|
842
|
+
readonly addGiftCertificateItemToBasket: readonly [
|
|
843
|
+
"organizationId",
|
|
844
|
+
"basketId",
|
|
845
|
+
"siteId",
|
|
846
|
+
"locale"
|
|
847
|
+
];
|
|
848
|
+
readonly addGiftCertificateItemToBasketRequired: readonly [
|
|
849
|
+
"organizationId",
|
|
850
|
+
"basketId",
|
|
851
|
+
"siteId"
|
|
852
|
+
];
|
|
853
|
+
readonly removeGiftCertificateItemFromBasket: readonly [
|
|
854
|
+
"organizationId",
|
|
855
|
+
"basketId",
|
|
856
|
+
"giftCertificateItemId",
|
|
857
|
+
"siteId",
|
|
858
|
+
"locale"
|
|
859
|
+
];
|
|
860
|
+
readonly removeGiftCertificateItemFromBasketRequired: readonly [
|
|
861
|
+
"organizationId",
|
|
862
|
+
"basketId",
|
|
863
|
+
"giftCertificateItemId",
|
|
864
|
+
"siteId"
|
|
865
|
+
];
|
|
866
|
+
readonly updateGiftCertificateItemInBasket: readonly [
|
|
867
|
+
"organizationId",
|
|
868
|
+
"basketId",
|
|
869
|
+
"giftCertificateItemId",
|
|
870
|
+
"siteId",
|
|
871
|
+
"locale"
|
|
872
|
+
];
|
|
873
|
+
readonly updateGiftCertificateItemInBasketRequired: readonly [
|
|
874
|
+
"organizationId",
|
|
875
|
+
"basketId",
|
|
876
|
+
"giftCertificateItemId",
|
|
877
|
+
"siteId"
|
|
878
|
+
];
|
|
879
|
+
readonly addItemToBasket: readonly [
|
|
880
|
+
"organizationId",
|
|
881
|
+
"basketId",
|
|
882
|
+
"siteId",
|
|
883
|
+
"locale"
|
|
884
|
+
];
|
|
885
|
+
readonly addItemToBasketRequired: readonly [
|
|
886
|
+
"organizationId",
|
|
887
|
+
"basketId",
|
|
888
|
+
"siteId"
|
|
889
|
+
];
|
|
890
|
+
readonly removeItemFromBasket: readonly [
|
|
891
|
+
"organizationId",
|
|
892
|
+
"basketId",
|
|
893
|
+
"itemId",
|
|
894
|
+
"siteId",
|
|
895
|
+
"locale"
|
|
896
|
+
];
|
|
897
|
+
readonly removeItemFromBasketRequired: readonly [
|
|
898
|
+
"organizationId",
|
|
899
|
+
"basketId",
|
|
900
|
+
"itemId",
|
|
901
|
+
"siteId"
|
|
902
|
+
];
|
|
903
|
+
readonly updateItemInBasket: readonly [
|
|
904
|
+
"organizationId",
|
|
905
|
+
"basketId",
|
|
906
|
+
"itemId",
|
|
907
|
+
"removeExternalTax",
|
|
908
|
+
"siteId",
|
|
909
|
+
"locale"
|
|
910
|
+
];
|
|
911
|
+
readonly updateItemInBasketRequired: readonly [
|
|
912
|
+
"organizationId",
|
|
913
|
+
"basketId",
|
|
914
|
+
"itemId",
|
|
915
|
+
"siteId"
|
|
916
|
+
];
|
|
917
|
+
readonly addTaxesForBasketItem: readonly [
|
|
918
|
+
"organizationId",
|
|
919
|
+
"basketId",
|
|
920
|
+
"itemId",
|
|
921
|
+
"siteId"
|
|
922
|
+
];
|
|
923
|
+
readonly addTaxesForBasketItemRequired: readonly [
|
|
924
|
+
"organizationId",
|
|
925
|
+
"basketId",
|
|
926
|
+
"itemId",
|
|
927
|
+
"siteId"
|
|
928
|
+
];
|
|
929
|
+
readonly addPaymentInstrumentToBasket: readonly [
|
|
930
|
+
"organizationId",
|
|
931
|
+
"basketId",
|
|
932
|
+
"siteId",
|
|
933
|
+
"locale"
|
|
934
|
+
];
|
|
935
|
+
readonly addPaymentInstrumentToBasketRequired: readonly [
|
|
936
|
+
"organizationId",
|
|
937
|
+
"basketId",
|
|
938
|
+
"siteId"
|
|
939
|
+
];
|
|
940
|
+
readonly removePaymentInstrumentFromBasket: readonly [
|
|
941
|
+
"organizationId",
|
|
942
|
+
"basketId",
|
|
943
|
+
"paymentInstrumentId",
|
|
944
|
+
"siteId",
|
|
945
|
+
"locale"
|
|
946
|
+
];
|
|
947
|
+
readonly removePaymentInstrumentFromBasketRequired: readonly [
|
|
948
|
+
"organizationId",
|
|
949
|
+
"basketId",
|
|
950
|
+
"paymentInstrumentId",
|
|
951
|
+
"siteId"
|
|
952
|
+
];
|
|
953
|
+
readonly updatePaymentInstrumentInBasket: readonly [
|
|
954
|
+
"organizationId",
|
|
955
|
+
"basketId",
|
|
956
|
+
"paymentInstrumentId",
|
|
957
|
+
"removeExternalTax",
|
|
958
|
+
"siteId",
|
|
959
|
+
"locale"
|
|
960
|
+
];
|
|
961
|
+
readonly updatePaymentInstrumentInBasketRequired: readonly [
|
|
962
|
+
"organizationId",
|
|
963
|
+
"basketId",
|
|
964
|
+
"paymentInstrumentId",
|
|
965
|
+
"siteId"
|
|
966
|
+
];
|
|
967
|
+
readonly getPaymentMethodsForBasket: readonly [
|
|
968
|
+
"organizationId",
|
|
969
|
+
"basketId",
|
|
970
|
+
"siteId",
|
|
971
|
+
"locale"
|
|
972
|
+
];
|
|
973
|
+
readonly getPaymentMethodsForBasketRequired: readonly [
|
|
974
|
+
"organizationId",
|
|
975
|
+
"basketId",
|
|
976
|
+
"siteId"
|
|
977
|
+
];
|
|
978
|
+
readonly addPriceAdjustmentToBasket: readonly [
|
|
979
|
+
"organizationId",
|
|
980
|
+
"basketId",
|
|
981
|
+
"siteId",
|
|
982
|
+
"locale"
|
|
983
|
+
];
|
|
984
|
+
readonly addPriceAdjustmentToBasketRequired: readonly [
|
|
985
|
+
"organizationId",
|
|
986
|
+
"basketId",
|
|
987
|
+
"siteId"
|
|
988
|
+
];
|
|
989
|
+
readonly removePriceAdjustmentFromBasket: readonly [
|
|
990
|
+
"organizationId",
|
|
991
|
+
"basketId",
|
|
992
|
+
"priceAdjustmentId",
|
|
993
|
+
"siteId",
|
|
994
|
+
"locale"
|
|
995
|
+
];
|
|
996
|
+
readonly removePriceAdjustmentFromBasketRequired: readonly [
|
|
997
|
+
"organizationId",
|
|
998
|
+
"basketId",
|
|
999
|
+
"priceAdjustmentId",
|
|
1000
|
+
"siteId"
|
|
1001
|
+
];
|
|
1002
|
+
readonly updatePriceAdjustmentInBasket: readonly [
|
|
1003
|
+
"organizationId",
|
|
1004
|
+
"basketId",
|
|
1005
|
+
"priceAdjustmentId",
|
|
1006
|
+
"siteId"
|
|
1007
|
+
];
|
|
1008
|
+
readonly updatePriceAdjustmentInBasketRequired: readonly [
|
|
1009
|
+
"organizationId",
|
|
1010
|
+
"basketId",
|
|
1011
|
+
"priceAdjustmentId",
|
|
1012
|
+
"siteId"
|
|
1013
|
+
];
|
|
1014
|
+
readonly getPriceBooksForBasket: readonly [
|
|
1015
|
+
"organizationId",
|
|
1016
|
+
"basketId",
|
|
1017
|
+
"siteId"
|
|
1018
|
+
];
|
|
1019
|
+
readonly getPriceBooksForBasketRequired: readonly [
|
|
1020
|
+
"organizationId",
|
|
1021
|
+
"basketId",
|
|
1022
|
+
"siteId"
|
|
1023
|
+
];
|
|
1024
|
+
readonly addPriceBooksToBasket: readonly [
|
|
1025
|
+
"organizationId",
|
|
1026
|
+
"basketId",
|
|
1027
|
+
"siteId"
|
|
1028
|
+
];
|
|
1029
|
+
readonly addPriceBooksToBasketRequired: readonly [
|
|
1030
|
+
"organizationId",
|
|
1031
|
+
"basketId",
|
|
1032
|
+
"siteId"
|
|
1033
|
+
];
|
|
1034
|
+
readonly createShipmentForBasket: readonly [
|
|
1035
|
+
"organizationId",
|
|
1036
|
+
"basketId",
|
|
1037
|
+
"siteId",
|
|
1038
|
+
"locale"
|
|
1039
|
+
];
|
|
1040
|
+
readonly createShipmentForBasketRequired: readonly [
|
|
1041
|
+
"organizationId",
|
|
1042
|
+
"basketId",
|
|
1043
|
+
"siteId"
|
|
1044
|
+
];
|
|
1045
|
+
readonly removeShipmentFromBasket: readonly [
|
|
1046
|
+
"organizationId",
|
|
1047
|
+
"basketId",
|
|
1048
|
+
"shipmentId",
|
|
1049
|
+
"siteId",
|
|
1050
|
+
"locale"
|
|
1051
|
+
];
|
|
1052
|
+
readonly removeShipmentFromBasketRequired: readonly [
|
|
1053
|
+
"organizationId",
|
|
1054
|
+
"basketId",
|
|
1055
|
+
"shipmentId",
|
|
1056
|
+
"siteId"
|
|
1057
|
+
];
|
|
1058
|
+
readonly updateShipmentForBasket: readonly [
|
|
1059
|
+
"organizationId",
|
|
1060
|
+
"basketId",
|
|
1061
|
+
"shipmentId",
|
|
1062
|
+
"siteId",
|
|
1063
|
+
"locale"
|
|
1064
|
+
];
|
|
1065
|
+
readonly updateShipmentForBasketRequired: readonly [
|
|
1066
|
+
"organizationId",
|
|
1067
|
+
"basketId",
|
|
1068
|
+
"shipmentId",
|
|
1069
|
+
"siteId"
|
|
1070
|
+
];
|
|
1071
|
+
readonly updateShippingAddressForShipment: readonly [
|
|
1072
|
+
"organizationId",
|
|
1073
|
+
"basketId",
|
|
1074
|
+
"shipmentId",
|
|
1075
|
+
"useAsBilling",
|
|
1076
|
+
"removeExternalTax",
|
|
1077
|
+
"siteId",
|
|
1078
|
+
"locale"
|
|
1079
|
+
];
|
|
1080
|
+
readonly updateShippingAddressForShipmentRequired: readonly [
|
|
1081
|
+
"organizationId",
|
|
1082
|
+
"basketId",
|
|
1083
|
+
"shipmentId",
|
|
1084
|
+
"siteId"
|
|
1085
|
+
];
|
|
1086
|
+
readonly updateShippingMethodForShipment: readonly [
|
|
1087
|
+
"organizationId",
|
|
1088
|
+
"basketId",
|
|
1089
|
+
"shipmentId",
|
|
1090
|
+
"siteId",
|
|
1091
|
+
"locale"
|
|
1092
|
+
];
|
|
1093
|
+
readonly updateShippingMethodForShipmentRequired: readonly [
|
|
1094
|
+
"organizationId",
|
|
1095
|
+
"basketId",
|
|
1096
|
+
"shipmentId",
|
|
1097
|
+
"siteId"
|
|
1098
|
+
];
|
|
1099
|
+
readonly getShippingMethodsForShipment: readonly [
|
|
1100
|
+
"organizationId",
|
|
1101
|
+
"basketId",
|
|
1102
|
+
"shipmentId",
|
|
1103
|
+
"siteId",
|
|
1104
|
+
"locale"
|
|
1105
|
+
];
|
|
1106
|
+
readonly getShippingMethodsForShipmentRequired: readonly [
|
|
1107
|
+
"organizationId",
|
|
1108
|
+
"basketId",
|
|
1109
|
+
"shipmentId",
|
|
1110
|
+
"siteId"
|
|
1111
|
+
];
|
|
1112
|
+
readonly updateAsStorefrontBasket: readonly [
|
|
1113
|
+
"organizationId",
|
|
1114
|
+
"basketId",
|
|
1115
|
+
"exchange",
|
|
1116
|
+
"siteId",
|
|
1117
|
+
"locale"
|
|
1118
|
+
];
|
|
1119
|
+
readonly updateAsStorefrontBasketRequired: readonly [
|
|
1120
|
+
"organizationId",
|
|
1121
|
+
"basketId",
|
|
1122
|
+
"siteId"
|
|
1123
|
+
];
|
|
1124
|
+
readonly getTaxesFromBasket: readonly [
|
|
1125
|
+
"organizationId",
|
|
1126
|
+
"basketId",
|
|
1127
|
+
"siteId"
|
|
1128
|
+
];
|
|
1129
|
+
readonly getTaxesFromBasketRequired: readonly [
|
|
1130
|
+
"organizationId",
|
|
1131
|
+
"basketId",
|
|
1132
|
+
"siteId"
|
|
1133
|
+
];
|
|
1134
|
+
readonly addTaxesForBasket: readonly [
|
|
1135
|
+
"organizationId",
|
|
1136
|
+
"basketId",
|
|
1137
|
+
"siteId"
|
|
1138
|
+
];
|
|
1139
|
+
readonly addTaxesForBasketRequired: readonly [
|
|
1140
|
+
"organizationId",
|
|
1141
|
+
"basketId",
|
|
1142
|
+
"siteId"
|
|
1143
|
+
];
|
|
1144
|
+
};
|
|
719
1145
|
/**
|
|
720
1146
|
* Creates a new basket.
|
|
721
1147
|
|
|
@@ -4405,9 +4831,8 @@ declare namespace ShopperBasketsTypes {
|
|
|
4405
4831
|
* API Version: 2.0.3<br />
|
|
4406
4832
|
* Last Updated: <br />
|
|
4407
4833
|
* </span>
|
|
4408
|
-
|
|
4409
4834
|
*
|
|
4410
|
-
|
|
4835
|
+
*
|
|
4411
4836
|
*/
|
|
4412
4837
|
class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters & Record<string, unknown>> {
|
|
4413
4838
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -4416,6 +4841,433 @@ declare namespace ShopperBasketsTypes {
|
|
|
4416
4841
|
};
|
|
4417
4842
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-baskets/{version}";
|
|
4418
4843
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
4844
|
+
static readonly paramKeys: {
|
|
4845
|
+
readonly createBasket: readonly [
|
|
4846
|
+
"organizationId",
|
|
4847
|
+
"taxMode",
|
|
4848
|
+
"temporary",
|
|
4849
|
+
"siteId",
|
|
4850
|
+
"locale"
|
|
4851
|
+
];
|
|
4852
|
+
readonly createBasketRequired: readonly [
|
|
4853
|
+
"organizationId",
|
|
4854
|
+
"siteId"
|
|
4855
|
+
];
|
|
4856
|
+
readonly transferBasket: readonly [
|
|
4857
|
+
"organizationId",
|
|
4858
|
+
"overrideExisting",
|
|
4859
|
+
"siteId",
|
|
4860
|
+
"locale"
|
|
4861
|
+
];
|
|
4862
|
+
readonly transferBasketRequired: readonly [
|
|
4863
|
+
"organizationId",
|
|
4864
|
+
"siteId"
|
|
4865
|
+
];
|
|
4866
|
+
readonly mergeBasket: readonly [
|
|
4867
|
+
"organizationId",
|
|
4868
|
+
"createDestinationBasket",
|
|
4869
|
+
"productItemMergeMode",
|
|
4870
|
+
"siteId",
|
|
4871
|
+
"locale"
|
|
4872
|
+
];
|
|
4873
|
+
readonly mergeBasketRequired: readonly [
|
|
4874
|
+
"organizationId",
|
|
4875
|
+
"siteId"
|
|
4876
|
+
];
|
|
4877
|
+
readonly deleteBasket: readonly [
|
|
4878
|
+
"organizationId",
|
|
4879
|
+
"basketId",
|
|
4880
|
+
"siteId"
|
|
4881
|
+
];
|
|
4882
|
+
readonly deleteBasketRequired: readonly [
|
|
4883
|
+
"organizationId",
|
|
4884
|
+
"basketId",
|
|
4885
|
+
"siteId"
|
|
4886
|
+
];
|
|
4887
|
+
readonly getBasket: readonly [
|
|
4888
|
+
"organizationId",
|
|
4889
|
+
"basketId",
|
|
4890
|
+
"siteId",
|
|
4891
|
+
"locale"
|
|
4892
|
+
];
|
|
4893
|
+
readonly getBasketRequired: readonly [
|
|
4894
|
+
"organizationId",
|
|
4895
|
+
"basketId",
|
|
4896
|
+
"siteId"
|
|
4897
|
+
];
|
|
4898
|
+
readonly updateBasket: readonly [
|
|
4899
|
+
"organizationId",
|
|
4900
|
+
"basketId",
|
|
4901
|
+
"siteId",
|
|
4902
|
+
"locale"
|
|
4903
|
+
];
|
|
4904
|
+
readonly updateBasketRequired: readonly [
|
|
4905
|
+
"organizationId",
|
|
4906
|
+
"basketId",
|
|
4907
|
+
"siteId"
|
|
4908
|
+
];
|
|
4909
|
+
readonly updateAsAgentBasket: readonly [
|
|
4910
|
+
"organizationId",
|
|
4911
|
+
"basketId",
|
|
4912
|
+
"siteId",
|
|
4913
|
+
"locale"
|
|
4914
|
+
];
|
|
4915
|
+
readonly updateAsAgentBasketRequired: readonly [
|
|
4916
|
+
"organizationId",
|
|
4917
|
+
"basketId",
|
|
4918
|
+
"siteId"
|
|
4919
|
+
];
|
|
4920
|
+
readonly updateBillingAddressForBasket: readonly [
|
|
4921
|
+
"organizationId",
|
|
4922
|
+
"basketId",
|
|
4923
|
+
"useAsShipping",
|
|
4924
|
+
"removeExternalTax",
|
|
4925
|
+
"siteId",
|
|
4926
|
+
"locale"
|
|
4927
|
+
];
|
|
4928
|
+
readonly updateBillingAddressForBasketRequired: readonly [
|
|
4929
|
+
"organizationId",
|
|
4930
|
+
"basketId",
|
|
4931
|
+
"siteId"
|
|
4932
|
+
];
|
|
4933
|
+
readonly addCouponToBasket: readonly [
|
|
4934
|
+
"organizationId",
|
|
4935
|
+
"basketId",
|
|
4936
|
+
"siteId",
|
|
4937
|
+
"locale"
|
|
4938
|
+
];
|
|
4939
|
+
readonly addCouponToBasketRequired: readonly [
|
|
4940
|
+
"organizationId",
|
|
4941
|
+
"basketId",
|
|
4942
|
+
"siteId"
|
|
4943
|
+
];
|
|
4944
|
+
readonly removeCouponFromBasket: readonly [
|
|
4945
|
+
"organizationId",
|
|
4946
|
+
"basketId",
|
|
4947
|
+
"couponItemId",
|
|
4948
|
+
"siteId",
|
|
4949
|
+
"locale"
|
|
4950
|
+
];
|
|
4951
|
+
readonly removeCouponFromBasketRequired: readonly [
|
|
4952
|
+
"organizationId",
|
|
4953
|
+
"basketId",
|
|
4954
|
+
"couponItemId",
|
|
4955
|
+
"siteId"
|
|
4956
|
+
];
|
|
4957
|
+
readonly updateCustomerForBasket: readonly [
|
|
4958
|
+
"organizationId",
|
|
4959
|
+
"basketId",
|
|
4960
|
+
"siteId",
|
|
4961
|
+
"locale"
|
|
4962
|
+
];
|
|
4963
|
+
readonly updateCustomerForBasketRequired: readonly [
|
|
4964
|
+
"organizationId",
|
|
4965
|
+
"basketId",
|
|
4966
|
+
"siteId"
|
|
4967
|
+
];
|
|
4968
|
+
readonly addGiftCertificateItemToBasket: readonly [
|
|
4969
|
+
"organizationId",
|
|
4970
|
+
"basketId",
|
|
4971
|
+
"siteId",
|
|
4972
|
+
"locale"
|
|
4973
|
+
];
|
|
4974
|
+
readonly addGiftCertificateItemToBasketRequired: readonly [
|
|
4975
|
+
"organizationId",
|
|
4976
|
+
"basketId",
|
|
4977
|
+
"siteId"
|
|
4978
|
+
];
|
|
4979
|
+
readonly removeGiftCertificateItemFromBasket: readonly [
|
|
4980
|
+
"organizationId",
|
|
4981
|
+
"basketId",
|
|
4982
|
+
"giftCertificateItemId",
|
|
4983
|
+
"siteId",
|
|
4984
|
+
"locale"
|
|
4985
|
+
];
|
|
4986
|
+
readonly removeGiftCertificateItemFromBasketRequired: readonly [
|
|
4987
|
+
"organizationId",
|
|
4988
|
+
"basketId",
|
|
4989
|
+
"giftCertificateItemId",
|
|
4990
|
+
"siteId"
|
|
4991
|
+
];
|
|
4992
|
+
readonly updateGiftCertificateItemInBasket: readonly [
|
|
4993
|
+
"organizationId",
|
|
4994
|
+
"basketId",
|
|
4995
|
+
"giftCertificateItemId",
|
|
4996
|
+
"siteId",
|
|
4997
|
+
"locale"
|
|
4998
|
+
];
|
|
4999
|
+
readonly updateGiftCertificateItemInBasketRequired: readonly [
|
|
5000
|
+
"organizationId",
|
|
5001
|
+
"basketId",
|
|
5002
|
+
"giftCertificateItemId",
|
|
5003
|
+
"siteId"
|
|
5004
|
+
];
|
|
5005
|
+
readonly addItemToBasket: readonly [
|
|
5006
|
+
"organizationId",
|
|
5007
|
+
"basketId",
|
|
5008
|
+
"siteId",
|
|
5009
|
+
"locale"
|
|
5010
|
+
];
|
|
5011
|
+
readonly addItemToBasketRequired: readonly [
|
|
5012
|
+
"organizationId",
|
|
5013
|
+
"basketId",
|
|
5014
|
+
"siteId"
|
|
5015
|
+
];
|
|
5016
|
+
readonly removeItemFromBasket: readonly [
|
|
5017
|
+
"organizationId",
|
|
5018
|
+
"basketId",
|
|
5019
|
+
"itemId",
|
|
5020
|
+
"siteId",
|
|
5021
|
+
"locale"
|
|
5022
|
+
];
|
|
5023
|
+
readonly removeItemFromBasketRequired: readonly [
|
|
5024
|
+
"organizationId",
|
|
5025
|
+
"basketId",
|
|
5026
|
+
"itemId",
|
|
5027
|
+
"siteId"
|
|
5028
|
+
];
|
|
5029
|
+
readonly updateItemInBasket: readonly [
|
|
5030
|
+
"organizationId",
|
|
5031
|
+
"basketId",
|
|
5032
|
+
"itemId",
|
|
5033
|
+
"removeExternalTax",
|
|
5034
|
+
"siteId",
|
|
5035
|
+
"locale"
|
|
5036
|
+
];
|
|
5037
|
+
readonly updateItemInBasketRequired: readonly [
|
|
5038
|
+
"organizationId",
|
|
5039
|
+
"basketId",
|
|
5040
|
+
"itemId",
|
|
5041
|
+
"siteId"
|
|
5042
|
+
];
|
|
5043
|
+
readonly addTaxesForBasketItem: readonly [
|
|
5044
|
+
"organizationId",
|
|
5045
|
+
"basketId",
|
|
5046
|
+
"itemId",
|
|
5047
|
+
"siteId"
|
|
5048
|
+
];
|
|
5049
|
+
readonly addTaxesForBasketItemRequired: readonly [
|
|
5050
|
+
"organizationId",
|
|
5051
|
+
"basketId",
|
|
5052
|
+
"itemId",
|
|
5053
|
+
"siteId"
|
|
5054
|
+
];
|
|
5055
|
+
readonly addPaymentInstrumentToBasket: readonly [
|
|
5056
|
+
"organizationId",
|
|
5057
|
+
"basketId",
|
|
5058
|
+
"siteId",
|
|
5059
|
+
"locale"
|
|
5060
|
+
];
|
|
5061
|
+
readonly addPaymentInstrumentToBasketRequired: readonly [
|
|
5062
|
+
"organizationId",
|
|
5063
|
+
"basketId",
|
|
5064
|
+
"siteId"
|
|
5065
|
+
];
|
|
5066
|
+
readonly removePaymentInstrumentFromBasket: readonly [
|
|
5067
|
+
"organizationId",
|
|
5068
|
+
"basketId",
|
|
5069
|
+
"paymentInstrumentId",
|
|
5070
|
+
"siteId",
|
|
5071
|
+
"locale"
|
|
5072
|
+
];
|
|
5073
|
+
readonly removePaymentInstrumentFromBasketRequired: readonly [
|
|
5074
|
+
"organizationId",
|
|
5075
|
+
"basketId",
|
|
5076
|
+
"paymentInstrumentId",
|
|
5077
|
+
"siteId"
|
|
5078
|
+
];
|
|
5079
|
+
readonly updatePaymentInstrumentInBasket: readonly [
|
|
5080
|
+
"organizationId",
|
|
5081
|
+
"basketId",
|
|
5082
|
+
"paymentInstrumentId",
|
|
5083
|
+
"removeExternalTax",
|
|
5084
|
+
"siteId",
|
|
5085
|
+
"locale"
|
|
5086
|
+
];
|
|
5087
|
+
readonly updatePaymentInstrumentInBasketRequired: readonly [
|
|
5088
|
+
"organizationId",
|
|
5089
|
+
"basketId",
|
|
5090
|
+
"paymentInstrumentId",
|
|
5091
|
+
"siteId"
|
|
5092
|
+
];
|
|
5093
|
+
readonly getPaymentMethodsForBasket: readonly [
|
|
5094
|
+
"organizationId",
|
|
5095
|
+
"basketId",
|
|
5096
|
+
"siteId",
|
|
5097
|
+
"locale"
|
|
5098
|
+
];
|
|
5099
|
+
readonly getPaymentMethodsForBasketRequired: readonly [
|
|
5100
|
+
"organizationId",
|
|
5101
|
+
"basketId",
|
|
5102
|
+
"siteId"
|
|
5103
|
+
];
|
|
5104
|
+
readonly addPriceAdjustmentToBasket: readonly [
|
|
5105
|
+
"organizationId",
|
|
5106
|
+
"basketId",
|
|
5107
|
+
"siteId",
|
|
5108
|
+
"locale"
|
|
5109
|
+
];
|
|
5110
|
+
readonly addPriceAdjustmentToBasketRequired: readonly [
|
|
5111
|
+
"organizationId",
|
|
5112
|
+
"basketId",
|
|
5113
|
+
"siteId"
|
|
5114
|
+
];
|
|
5115
|
+
readonly removePriceAdjustmentFromBasket: readonly [
|
|
5116
|
+
"organizationId",
|
|
5117
|
+
"basketId",
|
|
5118
|
+
"priceAdjustmentId",
|
|
5119
|
+
"siteId",
|
|
5120
|
+
"locale"
|
|
5121
|
+
];
|
|
5122
|
+
readonly removePriceAdjustmentFromBasketRequired: readonly [
|
|
5123
|
+
"organizationId",
|
|
5124
|
+
"basketId",
|
|
5125
|
+
"priceAdjustmentId",
|
|
5126
|
+
"siteId"
|
|
5127
|
+
];
|
|
5128
|
+
readonly updatePriceAdjustmentInBasket: readonly [
|
|
5129
|
+
"organizationId",
|
|
5130
|
+
"basketId",
|
|
5131
|
+
"priceAdjustmentId",
|
|
5132
|
+
"siteId"
|
|
5133
|
+
];
|
|
5134
|
+
readonly updatePriceAdjustmentInBasketRequired: readonly [
|
|
5135
|
+
"organizationId",
|
|
5136
|
+
"basketId",
|
|
5137
|
+
"priceAdjustmentId",
|
|
5138
|
+
"siteId"
|
|
5139
|
+
];
|
|
5140
|
+
readonly getPriceBooksForBasket: readonly [
|
|
5141
|
+
"organizationId",
|
|
5142
|
+
"basketId",
|
|
5143
|
+
"siteId"
|
|
5144
|
+
];
|
|
5145
|
+
readonly getPriceBooksForBasketRequired: readonly [
|
|
5146
|
+
"organizationId",
|
|
5147
|
+
"basketId",
|
|
5148
|
+
"siteId"
|
|
5149
|
+
];
|
|
5150
|
+
readonly addPriceBooksToBasket: readonly [
|
|
5151
|
+
"organizationId",
|
|
5152
|
+
"basketId",
|
|
5153
|
+
"siteId"
|
|
5154
|
+
];
|
|
5155
|
+
readonly addPriceBooksToBasketRequired: readonly [
|
|
5156
|
+
"organizationId",
|
|
5157
|
+
"basketId",
|
|
5158
|
+
"siteId"
|
|
5159
|
+
];
|
|
5160
|
+
readonly createShipmentForBasket: readonly [
|
|
5161
|
+
"organizationId",
|
|
5162
|
+
"basketId",
|
|
5163
|
+
"siteId",
|
|
5164
|
+
"locale"
|
|
5165
|
+
];
|
|
5166
|
+
readonly createShipmentForBasketRequired: readonly [
|
|
5167
|
+
"organizationId",
|
|
5168
|
+
"basketId",
|
|
5169
|
+
"siteId"
|
|
5170
|
+
];
|
|
5171
|
+
readonly removeShipmentFromBasket: readonly [
|
|
5172
|
+
"organizationId",
|
|
5173
|
+
"basketId",
|
|
5174
|
+
"shipmentId",
|
|
5175
|
+
"siteId",
|
|
5176
|
+
"locale"
|
|
5177
|
+
];
|
|
5178
|
+
readonly removeShipmentFromBasketRequired: readonly [
|
|
5179
|
+
"organizationId",
|
|
5180
|
+
"basketId",
|
|
5181
|
+
"shipmentId",
|
|
5182
|
+
"siteId"
|
|
5183
|
+
];
|
|
5184
|
+
readonly updateShipmentForBasket: readonly [
|
|
5185
|
+
"organizationId",
|
|
5186
|
+
"basketId",
|
|
5187
|
+
"shipmentId",
|
|
5188
|
+
"siteId",
|
|
5189
|
+
"locale"
|
|
5190
|
+
];
|
|
5191
|
+
readonly updateShipmentForBasketRequired: readonly [
|
|
5192
|
+
"organizationId",
|
|
5193
|
+
"basketId",
|
|
5194
|
+
"shipmentId",
|
|
5195
|
+
"siteId"
|
|
5196
|
+
];
|
|
5197
|
+
readonly updateShippingAddressForShipment: readonly [
|
|
5198
|
+
"organizationId",
|
|
5199
|
+
"basketId",
|
|
5200
|
+
"shipmentId",
|
|
5201
|
+
"useAsBilling",
|
|
5202
|
+
"removeExternalTax",
|
|
5203
|
+
"siteId",
|
|
5204
|
+
"locale"
|
|
5205
|
+
];
|
|
5206
|
+
readonly updateShippingAddressForShipmentRequired: readonly [
|
|
5207
|
+
"organizationId",
|
|
5208
|
+
"basketId",
|
|
5209
|
+
"shipmentId",
|
|
5210
|
+
"siteId"
|
|
5211
|
+
];
|
|
5212
|
+
readonly updateShippingMethodForShipment: readonly [
|
|
5213
|
+
"organizationId",
|
|
5214
|
+
"basketId",
|
|
5215
|
+
"shipmentId",
|
|
5216
|
+
"siteId",
|
|
5217
|
+
"locale"
|
|
5218
|
+
];
|
|
5219
|
+
readonly updateShippingMethodForShipmentRequired: readonly [
|
|
5220
|
+
"organizationId",
|
|
5221
|
+
"basketId",
|
|
5222
|
+
"shipmentId",
|
|
5223
|
+
"siteId"
|
|
5224
|
+
];
|
|
5225
|
+
readonly getShippingMethodsForShipment: readonly [
|
|
5226
|
+
"organizationId",
|
|
5227
|
+
"basketId",
|
|
5228
|
+
"shipmentId",
|
|
5229
|
+
"siteId",
|
|
5230
|
+
"locale"
|
|
5231
|
+
];
|
|
5232
|
+
readonly getShippingMethodsForShipmentRequired: readonly [
|
|
5233
|
+
"organizationId",
|
|
5234
|
+
"basketId",
|
|
5235
|
+
"shipmentId",
|
|
5236
|
+
"siteId"
|
|
5237
|
+
];
|
|
5238
|
+
readonly updateAsStorefrontBasket: readonly [
|
|
5239
|
+
"organizationId",
|
|
5240
|
+
"basketId",
|
|
5241
|
+
"exchange",
|
|
5242
|
+
"siteId",
|
|
5243
|
+
"locale"
|
|
5244
|
+
];
|
|
5245
|
+
readonly updateAsStorefrontBasketRequired: readonly [
|
|
5246
|
+
"organizationId",
|
|
5247
|
+
"basketId",
|
|
5248
|
+
"siteId"
|
|
5249
|
+
];
|
|
5250
|
+
readonly getTaxesFromBasket: readonly [
|
|
5251
|
+
"organizationId",
|
|
5252
|
+
"basketId",
|
|
5253
|
+
"siteId"
|
|
5254
|
+
];
|
|
5255
|
+
readonly getTaxesFromBasketRequired: readonly [
|
|
5256
|
+
"organizationId",
|
|
5257
|
+
"basketId",
|
|
5258
|
+
"siteId"
|
|
5259
|
+
];
|
|
5260
|
+
readonly addTaxesForBasket: readonly [
|
|
5261
|
+
"organizationId",
|
|
5262
|
+
"basketId",
|
|
5263
|
+
"siteId"
|
|
5264
|
+
];
|
|
5265
|
+
readonly addTaxesForBasketRequired: readonly [
|
|
5266
|
+
"organizationId",
|
|
5267
|
+
"basketId",
|
|
5268
|
+
"siteId"
|
|
5269
|
+
];
|
|
5270
|
+
};
|
|
4419
5271
|
/**
|
|
4420
5272
|
* Creates a new basket.
|
|
4421
5273
|
|
|
@@ -7396,9 +8248,8 @@ type ShopperContextsParameters = ShopperContextsPathParameters & BaseUriParamete
|
|
|
7396
8248
|
* API Version: 0.0.26<br />
|
|
7397
8249
|
* Last Updated: <br />
|
|
7398
8250
|
* </span>
|
|
7399
|
-
|
|
7400
8251
|
*
|
|
7401
|
-
|
|
8252
|
+
*
|
|
7402
8253
|
*/
|
|
7403
8254
|
declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters & Record<string, unknown>> {
|
|
7404
8255
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -7407,6 +8258,44 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7407
8258
|
};
|
|
7408
8259
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/{version}";
|
|
7409
8260
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
8261
|
+
static readonly paramKeys: {
|
|
8262
|
+
readonly getShopperContext: readonly [
|
|
8263
|
+
"organizationId",
|
|
8264
|
+
"usid",
|
|
8265
|
+
"siteId"
|
|
8266
|
+
];
|
|
8267
|
+
readonly getShopperContextRequired: readonly [
|
|
8268
|
+
"organizationId",
|
|
8269
|
+
"usid"
|
|
8270
|
+
];
|
|
8271
|
+
readonly createShopperContext: readonly [
|
|
8272
|
+
"organizationId",
|
|
8273
|
+
"usid",
|
|
8274
|
+
"siteId"
|
|
8275
|
+
];
|
|
8276
|
+
readonly createShopperContextRequired: readonly [
|
|
8277
|
+
"organizationId",
|
|
8278
|
+
"usid"
|
|
8279
|
+
];
|
|
8280
|
+
readonly deleteShopperContext: readonly [
|
|
8281
|
+
"organizationId",
|
|
8282
|
+
"usid",
|
|
8283
|
+
"siteId"
|
|
8284
|
+
];
|
|
8285
|
+
readonly deleteShopperContextRequired: readonly [
|
|
8286
|
+
"organizationId",
|
|
8287
|
+
"usid"
|
|
8288
|
+
];
|
|
8289
|
+
readonly updateShopperContext: readonly [
|
|
8290
|
+
"organizationId",
|
|
8291
|
+
"usid",
|
|
8292
|
+
"siteId"
|
|
8293
|
+
];
|
|
8294
|
+
readonly updateShopperContextRequired: readonly [
|
|
8295
|
+
"organizationId",
|
|
8296
|
+
"usid"
|
|
8297
|
+
];
|
|
8298
|
+
};
|
|
7410
8299
|
/**
|
|
7411
8300
|
* Gets the shopper's context based on the shopperJWT.
|
|
7412
8301
|
*
|
|
@@ -8038,9 +8927,8 @@ declare namespace ShopperContextsTypes {
|
|
|
8038
8927
|
* API Version: 0.0.26<br />
|
|
8039
8928
|
* Last Updated: <br />
|
|
8040
8929
|
* </span>
|
|
8041
|
-
|
|
8042
8930
|
*
|
|
8043
|
-
|
|
8931
|
+
*
|
|
8044
8932
|
*/
|
|
8045
8933
|
class ShopperContexts<ConfigParameters extends ShopperContextsParameters & Record<string, unknown>> {
|
|
8046
8934
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -8049,6 +8937,44 @@ declare namespace ShopperContextsTypes {
|
|
|
8049
8937
|
};
|
|
8050
8938
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/{version}";
|
|
8051
8939
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
8940
|
+
static readonly paramKeys: {
|
|
8941
|
+
readonly getShopperContext: readonly [
|
|
8942
|
+
"organizationId",
|
|
8943
|
+
"usid",
|
|
8944
|
+
"siteId"
|
|
8945
|
+
];
|
|
8946
|
+
readonly getShopperContextRequired: readonly [
|
|
8947
|
+
"organizationId",
|
|
8948
|
+
"usid"
|
|
8949
|
+
];
|
|
8950
|
+
readonly createShopperContext: readonly [
|
|
8951
|
+
"organizationId",
|
|
8952
|
+
"usid",
|
|
8953
|
+
"siteId"
|
|
8954
|
+
];
|
|
8955
|
+
readonly createShopperContextRequired: readonly [
|
|
8956
|
+
"organizationId",
|
|
8957
|
+
"usid"
|
|
8958
|
+
];
|
|
8959
|
+
readonly deleteShopperContext: readonly [
|
|
8960
|
+
"organizationId",
|
|
8961
|
+
"usid",
|
|
8962
|
+
"siteId"
|
|
8963
|
+
];
|
|
8964
|
+
readonly deleteShopperContextRequired: readonly [
|
|
8965
|
+
"organizationId",
|
|
8966
|
+
"usid"
|
|
8967
|
+
];
|
|
8968
|
+
readonly updateShopperContext: readonly [
|
|
8969
|
+
"organizationId",
|
|
8970
|
+
"usid",
|
|
8971
|
+
"siteId"
|
|
8972
|
+
];
|
|
8973
|
+
readonly updateShopperContextRequired: readonly [
|
|
8974
|
+
"organizationId",
|
|
8975
|
+
"usid"
|
|
8976
|
+
];
|
|
8977
|
+
};
|
|
8052
8978
|
/**
|
|
8053
8979
|
* Gets the shopper's context based on the shopperJWT.
|
|
8054
8980
|
*
|
|
@@ -9267,9 +10193,8 @@ type ShopperCustomersParameters = ShopperCustomersPathParameters & BaseUriParame
|
|
|
9267
10193
|
* API Version: 0.0.48<br />
|
|
9268
10194
|
* Last Updated: <br />
|
|
9269
10195
|
* </span>
|
|
9270
|
-
|
|
9271
10196
|
*
|
|
9272
|
-
|
|
10197
|
+
*
|
|
9273
10198
|
*/
|
|
9274
10199
|
declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParameters & Record<string, unknown>> {
|
|
9275
10200
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -9278,6 +10203,331 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
9278
10203
|
};
|
|
9279
10204
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/customer/shopper-customers/{version}";
|
|
9280
10205
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
10206
|
+
static readonly paramKeys: {
|
|
10207
|
+
readonly registerCustomer: readonly [
|
|
10208
|
+
"organizationId",
|
|
10209
|
+
"siteId"
|
|
10210
|
+
];
|
|
10211
|
+
readonly registerCustomerRequired: readonly [
|
|
10212
|
+
"organizationId",
|
|
10213
|
+
"siteId"
|
|
10214
|
+
];
|
|
10215
|
+
readonly resetPassword: readonly [
|
|
10216
|
+
"organizationId",
|
|
10217
|
+
"siteId"
|
|
10218
|
+
];
|
|
10219
|
+
readonly resetPasswordRequired: readonly [
|
|
10220
|
+
"organizationId",
|
|
10221
|
+
"siteId"
|
|
10222
|
+
];
|
|
10223
|
+
readonly getResetPasswordToken: readonly [
|
|
10224
|
+
"organizationId",
|
|
10225
|
+
"siteId"
|
|
10226
|
+
];
|
|
10227
|
+
readonly getResetPasswordTokenRequired: readonly [
|
|
10228
|
+
"organizationId",
|
|
10229
|
+
"siteId"
|
|
10230
|
+
];
|
|
10231
|
+
readonly registerExternalProfile: readonly [
|
|
10232
|
+
"organizationId",
|
|
10233
|
+
"siteId"
|
|
10234
|
+
];
|
|
10235
|
+
readonly registerExternalProfileRequired: readonly [
|
|
10236
|
+
"organizationId",
|
|
10237
|
+
"siteId"
|
|
10238
|
+
];
|
|
10239
|
+
readonly getExternalProfile: readonly [
|
|
10240
|
+
"organizationId",
|
|
10241
|
+
"externalId",
|
|
10242
|
+
"authenticationProviderId",
|
|
10243
|
+
"siteId"
|
|
10244
|
+
];
|
|
10245
|
+
readonly getExternalProfileRequired: readonly [
|
|
10246
|
+
"organizationId",
|
|
10247
|
+
"externalId",
|
|
10248
|
+
"authenticationProviderId",
|
|
10249
|
+
"siteId"
|
|
10250
|
+
];
|
|
10251
|
+
readonly getCustomer: readonly [
|
|
10252
|
+
"organizationId",
|
|
10253
|
+
"customerId",
|
|
10254
|
+
"siteId"
|
|
10255
|
+
];
|
|
10256
|
+
readonly getCustomerRequired: readonly [
|
|
10257
|
+
"organizationId",
|
|
10258
|
+
"customerId",
|
|
10259
|
+
"siteId"
|
|
10260
|
+
];
|
|
10261
|
+
readonly updateCustomer: readonly [
|
|
10262
|
+
"organizationId",
|
|
10263
|
+
"customerId",
|
|
10264
|
+
"siteId"
|
|
10265
|
+
];
|
|
10266
|
+
readonly updateCustomerRequired: readonly [
|
|
10267
|
+
"organizationId",
|
|
10268
|
+
"customerId",
|
|
10269
|
+
"siteId"
|
|
10270
|
+
];
|
|
10271
|
+
readonly createCustomerAddress: readonly [
|
|
10272
|
+
"organizationId",
|
|
10273
|
+
"customerId",
|
|
10274
|
+
"siteId"
|
|
10275
|
+
];
|
|
10276
|
+
readonly createCustomerAddressRequired: readonly [
|
|
10277
|
+
"organizationId",
|
|
10278
|
+
"customerId",
|
|
10279
|
+
"siteId"
|
|
10280
|
+
];
|
|
10281
|
+
readonly getCustomerAddress: readonly [
|
|
10282
|
+
"organizationId",
|
|
10283
|
+
"customerId",
|
|
10284
|
+
"addressName",
|
|
10285
|
+
"siteId"
|
|
10286
|
+
];
|
|
10287
|
+
readonly getCustomerAddressRequired: readonly [
|
|
10288
|
+
"organizationId",
|
|
10289
|
+
"customerId",
|
|
10290
|
+
"addressName",
|
|
10291
|
+
"siteId"
|
|
10292
|
+
];
|
|
10293
|
+
readonly removeCustomerAddress: readonly [
|
|
10294
|
+
"organizationId",
|
|
10295
|
+
"customerId",
|
|
10296
|
+
"addressName",
|
|
10297
|
+
"siteId"
|
|
10298
|
+
];
|
|
10299
|
+
readonly removeCustomerAddressRequired: readonly [
|
|
10300
|
+
"organizationId",
|
|
10301
|
+
"customerId",
|
|
10302
|
+
"addressName",
|
|
10303
|
+
"siteId"
|
|
10304
|
+
];
|
|
10305
|
+
readonly updateCustomerAddress: readonly [
|
|
10306
|
+
"organizationId",
|
|
10307
|
+
"customerId",
|
|
10308
|
+
"addressName",
|
|
10309
|
+
"siteId"
|
|
10310
|
+
];
|
|
10311
|
+
readonly updateCustomerAddressRequired: readonly [
|
|
10312
|
+
"organizationId",
|
|
10313
|
+
"customerId",
|
|
10314
|
+
"addressName",
|
|
10315
|
+
"siteId"
|
|
10316
|
+
];
|
|
10317
|
+
readonly getCustomerBaskets: readonly [
|
|
10318
|
+
"organizationId",
|
|
10319
|
+
"customerId",
|
|
10320
|
+
"siteId"
|
|
10321
|
+
];
|
|
10322
|
+
readonly getCustomerBasketsRequired: readonly [
|
|
10323
|
+
"organizationId",
|
|
10324
|
+
"customerId",
|
|
10325
|
+
"siteId"
|
|
10326
|
+
];
|
|
10327
|
+
readonly getCustomerOrders: readonly [
|
|
10328
|
+
"organizationId",
|
|
10329
|
+
"customerId",
|
|
10330
|
+
"crossSites",
|
|
10331
|
+
"from",
|
|
10332
|
+
"until",
|
|
10333
|
+
"status",
|
|
10334
|
+
"siteId",
|
|
10335
|
+
"offset",
|
|
10336
|
+
"limit"
|
|
10337
|
+
];
|
|
10338
|
+
readonly getCustomerOrdersRequired: readonly [
|
|
10339
|
+
"organizationId",
|
|
10340
|
+
"customerId",
|
|
10341
|
+
"siteId"
|
|
10342
|
+
];
|
|
10343
|
+
readonly updateCustomerPassword: readonly [
|
|
10344
|
+
"organizationId",
|
|
10345
|
+
"customerId",
|
|
10346
|
+
"siteId"
|
|
10347
|
+
];
|
|
10348
|
+
readonly updateCustomerPasswordRequired: readonly [
|
|
10349
|
+
"organizationId",
|
|
10350
|
+
"customerId",
|
|
10351
|
+
"siteId"
|
|
10352
|
+
];
|
|
10353
|
+
readonly createCustomerPaymentInstrument: readonly [
|
|
10354
|
+
"organizationId",
|
|
10355
|
+
"customerId",
|
|
10356
|
+
"siteId"
|
|
10357
|
+
];
|
|
10358
|
+
readonly createCustomerPaymentInstrumentRequired: readonly [
|
|
10359
|
+
"organizationId",
|
|
10360
|
+
"customerId",
|
|
10361
|
+
"siteId"
|
|
10362
|
+
];
|
|
10363
|
+
readonly deleteCustomerPaymentInstrument: readonly [
|
|
10364
|
+
"organizationId",
|
|
10365
|
+
"customerId",
|
|
10366
|
+
"paymentInstrumentId",
|
|
10367
|
+
"siteId"
|
|
10368
|
+
];
|
|
10369
|
+
readonly deleteCustomerPaymentInstrumentRequired: readonly [
|
|
10370
|
+
"organizationId",
|
|
10371
|
+
"customerId",
|
|
10372
|
+
"paymentInstrumentId",
|
|
10373
|
+
"siteId"
|
|
10374
|
+
];
|
|
10375
|
+
readonly getCustomerPaymentInstrument: readonly [
|
|
10376
|
+
"organizationId",
|
|
10377
|
+
"customerId",
|
|
10378
|
+
"paymentInstrumentId",
|
|
10379
|
+
"siteId"
|
|
10380
|
+
];
|
|
10381
|
+
readonly getCustomerPaymentInstrumentRequired: readonly [
|
|
10382
|
+
"organizationId",
|
|
10383
|
+
"customerId",
|
|
10384
|
+
"paymentInstrumentId",
|
|
10385
|
+
"siteId"
|
|
10386
|
+
];
|
|
10387
|
+
readonly getCustomerProductLists: readonly [
|
|
10388
|
+
"organizationId",
|
|
10389
|
+
"customerId",
|
|
10390
|
+
"siteId"
|
|
10391
|
+
];
|
|
10392
|
+
readonly getCustomerProductListsRequired: readonly [
|
|
10393
|
+
"organizationId",
|
|
10394
|
+
"customerId",
|
|
10395
|
+
"siteId"
|
|
10396
|
+
];
|
|
10397
|
+
readonly createCustomerProductList: readonly [
|
|
10398
|
+
"organizationId",
|
|
10399
|
+
"customerId",
|
|
10400
|
+
"siteId"
|
|
10401
|
+
];
|
|
10402
|
+
readonly createCustomerProductListRequired: readonly [
|
|
10403
|
+
"organizationId",
|
|
10404
|
+
"customerId",
|
|
10405
|
+
"siteId"
|
|
10406
|
+
];
|
|
10407
|
+
readonly deleteCustomerProductList: readonly [
|
|
10408
|
+
"organizationId",
|
|
10409
|
+
"customerId",
|
|
10410
|
+
"listId",
|
|
10411
|
+
"siteId"
|
|
10412
|
+
];
|
|
10413
|
+
readonly deleteCustomerProductListRequired: readonly [
|
|
10414
|
+
"organizationId",
|
|
10415
|
+
"customerId",
|
|
10416
|
+
"listId",
|
|
10417
|
+
"siteId"
|
|
10418
|
+
];
|
|
10419
|
+
readonly getCustomerProductList: readonly [
|
|
10420
|
+
"organizationId",
|
|
10421
|
+
"customerId",
|
|
10422
|
+
"listId",
|
|
10423
|
+
"siteId"
|
|
10424
|
+
];
|
|
10425
|
+
readonly getCustomerProductListRequired: readonly [
|
|
10426
|
+
"organizationId",
|
|
10427
|
+
"customerId",
|
|
10428
|
+
"listId",
|
|
10429
|
+
"siteId"
|
|
10430
|
+
];
|
|
10431
|
+
readonly updateCustomerProductList: readonly [
|
|
10432
|
+
"organizationId",
|
|
10433
|
+
"customerId",
|
|
10434
|
+
"listId",
|
|
10435
|
+
"siteId"
|
|
10436
|
+
];
|
|
10437
|
+
readonly updateCustomerProductListRequired: readonly [
|
|
10438
|
+
"organizationId",
|
|
10439
|
+
"customerId",
|
|
10440
|
+
"listId",
|
|
10441
|
+
"siteId"
|
|
10442
|
+
];
|
|
10443
|
+
readonly createCustomerProductListItem: readonly [
|
|
10444
|
+
"organizationId",
|
|
10445
|
+
"customerId",
|
|
10446
|
+
"listId",
|
|
10447
|
+
"siteId"
|
|
10448
|
+
];
|
|
10449
|
+
readonly createCustomerProductListItemRequired: readonly [
|
|
10450
|
+
"organizationId",
|
|
10451
|
+
"customerId",
|
|
10452
|
+
"listId",
|
|
10453
|
+
"siteId"
|
|
10454
|
+
];
|
|
10455
|
+
readonly deleteCustomerProductListItem: readonly [
|
|
10456
|
+
"organizationId",
|
|
10457
|
+
"customerId",
|
|
10458
|
+
"listId",
|
|
10459
|
+
"itemId",
|
|
10460
|
+
"siteId"
|
|
10461
|
+
];
|
|
10462
|
+
readonly deleteCustomerProductListItemRequired: readonly [
|
|
10463
|
+
"organizationId",
|
|
10464
|
+
"customerId",
|
|
10465
|
+
"listId",
|
|
10466
|
+
"itemId",
|
|
10467
|
+
"siteId"
|
|
10468
|
+
];
|
|
10469
|
+
readonly getCustomerProductListItem: readonly [
|
|
10470
|
+
"organizationId",
|
|
10471
|
+
"customerId",
|
|
10472
|
+
"listId",
|
|
10473
|
+
"itemId",
|
|
10474
|
+
"siteId"
|
|
10475
|
+
];
|
|
10476
|
+
readonly getCustomerProductListItemRequired: readonly [
|
|
10477
|
+
"organizationId",
|
|
10478
|
+
"customerId",
|
|
10479
|
+
"listId",
|
|
10480
|
+
"itemId",
|
|
10481
|
+
"siteId"
|
|
10482
|
+
];
|
|
10483
|
+
readonly updateCustomerProductListItem: readonly [
|
|
10484
|
+
"organizationId",
|
|
10485
|
+
"customerId",
|
|
10486
|
+
"listId",
|
|
10487
|
+
"itemId",
|
|
10488
|
+
"siteId"
|
|
10489
|
+
];
|
|
10490
|
+
readonly updateCustomerProductListItemRequired: readonly [
|
|
10491
|
+
"organizationId",
|
|
10492
|
+
"customerId",
|
|
10493
|
+
"listId",
|
|
10494
|
+
"itemId",
|
|
10495
|
+
"siteId"
|
|
10496
|
+
];
|
|
10497
|
+
readonly getPublicProductListsBySearchTerm: readonly [
|
|
10498
|
+
"organizationId",
|
|
10499
|
+
"email",
|
|
10500
|
+
"firstName",
|
|
10501
|
+
"lastName",
|
|
10502
|
+
"siteId"
|
|
10503
|
+
];
|
|
10504
|
+
readonly getPublicProductListsBySearchTermRequired: readonly [
|
|
10505
|
+
"organizationId",
|
|
10506
|
+
"siteId"
|
|
10507
|
+
];
|
|
10508
|
+
readonly getPublicProductList: readonly [
|
|
10509
|
+
"organizationId",
|
|
10510
|
+
"listId",
|
|
10511
|
+
"siteId"
|
|
10512
|
+
];
|
|
10513
|
+
readonly getPublicProductListRequired: readonly [
|
|
10514
|
+
"organizationId",
|
|
10515
|
+
"listId",
|
|
10516
|
+
"siteId"
|
|
10517
|
+
];
|
|
10518
|
+
readonly getProductListItem: readonly [
|
|
10519
|
+
"organizationId",
|
|
10520
|
+
"listId",
|
|
10521
|
+
"itemId",
|
|
10522
|
+
"siteId"
|
|
10523
|
+
];
|
|
10524
|
+
readonly getProductListItemRequired: readonly [
|
|
10525
|
+
"organizationId",
|
|
10526
|
+
"listId",
|
|
10527
|
+
"itemId",
|
|
10528
|
+
"siteId"
|
|
10529
|
+
];
|
|
10530
|
+
};
|
|
9281
10531
|
/**
|
|
9282
10532
|
* Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API. The return type object for this endpoint is a common customer object shared by multiple Shopper Customer endpoints. In this case, all customer object details are returned, but attributes that are not included in the response, although they might be part of the customer object, are ignored. For example, although address information is included in the customer object, it is not displayed in the response for this endpoint and is ignored.
|
|
9283
10533
|
*
|
|
@@ -12279,9 +13529,8 @@ declare namespace ShopperCustomersTypes {
|
|
|
12279
13529
|
* API Version: 0.0.48<br />
|
|
12280
13530
|
* Last Updated: <br />
|
|
12281
13531
|
* </span>
|
|
12282
|
-
|
|
12283
13532
|
*
|
|
12284
|
-
|
|
13533
|
+
*
|
|
12285
13534
|
*/
|
|
12286
13535
|
class ShopperCustomers<ConfigParameters extends ShopperCustomersParameters & Record<string, unknown>> {
|
|
12287
13536
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -12290,6 +13539,331 @@ declare namespace ShopperCustomersTypes {
|
|
|
12290
13539
|
};
|
|
12291
13540
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/customer/shopper-customers/{version}";
|
|
12292
13541
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
13542
|
+
static readonly paramKeys: {
|
|
13543
|
+
readonly registerCustomer: readonly [
|
|
13544
|
+
"organizationId",
|
|
13545
|
+
"siteId"
|
|
13546
|
+
];
|
|
13547
|
+
readonly registerCustomerRequired: readonly [
|
|
13548
|
+
"organizationId",
|
|
13549
|
+
"siteId"
|
|
13550
|
+
];
|
|
13551
|
+
readonly resetPassword: readonly [
|
|
13552
|
+
"organizationId",
|
|
13553
|
+
"siteId"
|
|
13554
|
+
];
|
|
13555
|
+
readonly resetPasswordRequired: readonly [
|
|
13556
|
+
"organizationId",
|
|
13557
|
+
"siteId"
|
|
13558
|
+
];
|
|
13559
|
+
readonly getResetPasswordToken: readonly [
|
|
13560
|
+
"organizationId",
|
|
13561
|
+
"siteId"
|
|
13562
|
+
];
|
|
13563
|
+
readonly getResetPasswordTokenRequired: readonly [
|
|
13564
|
+
"organizationId",
|
|
13565
|
+
"siteId"
|
|
13566
|
+
];
|
|
13567
|
+
readonly registerExternalProfile: readonly [
|
|
13568
|
+
"organizationId",
|
|
13569
|
+
"siteId"
|
|
13570
|
+
];
|
|
13571
|
+
readonly registerExternalProfileRequired: readonly [
|
|
13572
|
+
"organizationId",
|
|
13573
|
+
"siteId"
|
|
13574
|
+
];
|
|
13575
|
+
readonly getExternalProfile: readonly [
|
|
13576
|
+
"organizationId",
|
|
13577
|
+
"externalId",
|
|
13578
|
+
"authenticationProviderId",
|
|
13579
|
+
"siteId"
|
|
13580
|
+
];
|
|
13581
|
+
readonly getExternalProfileRequired: readonly [
|
|
13582
|
+
"organizationId",
|
|
13583
|
+
"externalId",
|
|
13584
|
+
"authenticationProviderId",
|
|
13585
|
+
"siteId"
|
|
13586
|
+
];
|
|
13587
|
+
readonly getCustomer: readonly [
|
|
13588
|
+
"organizationId",
|
|
13589
|
+
"customerId",
|
|
13590
|
+
"siteId"
|
|
13591
|
+
];
|
|
13592
|
+
readonly getCustomerRequired: readonly [
|
|
13593
|
+
"organizationId",
|
|
13594
|
+
"customerId",
|
|
13595
|
+
"siteId"
|
|
13596
|
+
];
|
|
13597
|
+
readonly updateCustomer: readonly [
|
|
13598
|
+
"organizationId",
|
|
13599
|
+
"customerId",
|
|
13600
|
+
"siteId"
|
|
13601
|
+
];
|
|
13602
|
+
readonly updateCustomerRequired: readonly [
|
|
13603
|
+
"organizationId",
|
|
13604
|
+
"customerId",
|
|
13605
|
+
"siteId"
|
|
13606
|
+
];
|
|
13607
|
+
readonly createCustomerAddress: readonly [
|
|
13608
|
+
"organizationId",
|
|
13609
|
+
"customerId",
|
|
13610
|
+
"siteId"
|
|
13611
|
+
];
|
|
13612
|
+
readonly createCustomerAddressRequired: readonly [
|
|
13613
|
+
"organizationId",
|
|
13614
|
+
"customerId",
|
|
13615
|
+
"siteId"
|
|
13616
|
+
];
|
|
13617
|
+
readonly getCustomerAddress: readonly [
|
|
13618
|
+
"organizationId",
|
|
13619
|
+
"customerId",
|
|
13620
|
+
"addressName",
|
|
13621
|
+
"siteId"
|
|
13622
|
+
];
|
|
13623
|
+
readonly getCustomerAddressRequired: readonly [
|
|
13624
|
+
"organizationId",
|
|
13625
|
+
"customerId",
|
|
13626
|
+
"addressName",
|
|
13627
|
+
"siteId"
|
|
13628
|
+
];
|
|
13629
|
+
readonly removeCustomerAddress: readonly [
|
|
13630
|
+
"organizationId",
|
|
13631
|
+
"customerId",
|
|
13632
|
+
"addressName",
|
|
13633
|
+
"siteId"
|
|
13634
|
+
];
|
|
13635
|
+
readonly removeCustomerAddressRequired: readonly [
|
|
13636
|
+
"organizationId",
|
|
13637
|
+
"customerId",
|
|
13638
|
+
"addressName",
|
|
13639
|
+
"siteId"
|
|
13640
|
+
];
|
|
13641
|
+
readonly updateCustomerAddress: readonly [
|
|
13642
|
+
"organizationId",
|
|
13643
|
+
"customerId",
|
|
13644
|
+
"addressName",
|
|
13645
|
+
"siteId"
|
|
13646
|
+
];
|
|
13647
|
+
readonly updateCustomerAddressRequired: readonly [
|
|
13648
|
+
"organizationId",
|
|
13649
|
+
"customerId",
|
|
13650
|
+
"addressName",
|
|
13651
|
+
"siteId"
|
|
13652
|
+
];
|
|
13653
|
+
readonly getCustomerBaskets: readonly [
|
|
13654
|
+
"organizationId",
|
|
13655
|
+
"customerId",
|
|
13656
|
+
"siteId"
|
|
13657
|
+
];
|
|
13658
|
+
readonly getCustomerBasketsRequired: readonly [
|
|
13659
|
+
"organizationId",
|
|
13660
|
+
"customerId",
|
|
13661
|
+
"siteId"
|
|
13662
|
+
];
|
|
13663
|
+
readonly getCustomerOrders: readonly [
|
|
13664
|
+
"organizationId",
|
|
13665
|
+
"customerId",
|
|
13666
|
+
"crossSites",
|
|
13667
|
+
"from",
|
|
13668
|
+
"until",
|
|
13669
|
+
"status",
|
|
13670
|
+
"siteId",
|
|
13671
|
+
"offset",
|
|
13672
|
+
"limit"
|
|
13673
|
+
];
|
|
13674
|
+
readonly getCustomerOrdersRequired: readonly [
|
|
13675
|
+
"organizationId",
|
|
13676
|
+
"customerId",
|
|
13677
|
+
"siteId"
|
|
13678
|
+
];
|
|
13679
|
+
readonly updateCustomerPassword: readonly [
|
|
13680
|
+
"organizationId",
|
|
13681
|
+
"customerId",
|
|
13682
|
+
"siteId"
|
|
13683
|
+
];
|
|
13684
|
+
readonly updateCustomerPasswordRequired: readonly [
|
|
13685
|
+
"organizationId",
|
|
13686
|
+
"customerId",
|
|
13687
|
+
"siteId"
|
|
13688
|
+
];
|
|
13689
|
+
readonly createCustomerPaymentInstrument: readonly [
|
|
13690
|
+
"organizationId",
|
|
13691
|
+
"customerId",
|
|
13692
|
+
"siteId"
|
|
13693
|
+
];
|
|
13694
|
+
readonly createCustomerPaymentInstrumentRequired: readonly [
|
|
13695
|
+
"organizationId",
|
|
13696
|
+
"customerId",
|
|
13697
|
+
"siteId"
|
|
13698
|
+
];
|
|
13699
|
+
readonly deleteCustomerPaymentInstrument: readonly [
|
|
13700
|
+
"organizationId",
|
|
13701
|
+
"customerId",
|
|
13702
|
+
"paymentInstrumentId",
|
|
13703
|
+
"siteId"
|
|
13704
|
+
];
|
|
13705
|
+
readonly deleteCustomerPaymentInstrumentRequired: readonly [
|
|
13706
|
+
"organizationId",
|
|
13707
|
+
"customerId",
|
|
13708
|
+
"paymentInstrumentId",
|
|
13709
|
+
"siteId"
|
|
13710
|
+
];
|
|
13711
|
+
readonly getCustomerPaymentInstrument: readonly [
|
|
13712
|
+
"organizationId",
|
|
13713
|
+
"customerId",
|
|
13714
|
+
"paymentInstrumentId",
|
|
13715
|
+
"siteId"
|
|
13716
|
+
];
|
|
13717
|
+
readonly getCustomerPaymentInstrumentRequired: readonly [
|
|
13718
|
+
"organizationId",
|
|
13719
|
+
"customerId",
|
|
13720
|
+
"paymentInstrumentId",
|
|
13721
|
+
"siteId"
|
|
13722
|
+
];
|
|
13723
|
+
readonly getCustomerProductLists: readonly [
|
|
13724
|
+
"organizationId",
|
|
13725
|
+
"customerId",
|
|
13726
|
+
"siteId"
|
|
13727
|
+
];
|
|
13728
|
+
readonly getCustomerProductListsRequired: readonly [
|
|
13729
|
+
"organizationId",
|
|
13730
|
+
"customerId",
|
|
13731
|
+
"siteId"
|
|
13732
|
+
];
|
|
13733
|
+
readonly createCustomerProductList: readonly [
|
|
13734
|
+
"organizationId",
|
|
13735
|
+
"customerId",
|
|
13736
|
+
"siteId"
|
|
13737
|
+
];
|
|
13738
|
+
readonly createCustomerProductListRequired: readonly [
|
|
13739
|
+
"organizationId",
|
|
13740
|
+
"customerId",
|
|
13741
|
+
"siteId"
|
|
13742
|
+
];
|
|
13743
|
+
readonly deleteCustomerProductList: readonly [
|
|
13744
|
+
"organizationId",
|
|
13745
|
+
"customerId",
|
|
13746
|
+
"listId",
|
|
13747
|
+
"siteId"
|
|
13748
|
+
];
|
|
13749
|
+
readonly deleteCustomerProductListRequired: readonly [
|
|
13750
|
+
"organizationId",
|
|
13751
|
+
"customerId",
|
|
13752
|
+
"listId",
|
|
13753
|
+
"siteId"
|
|
13754
|
+
];
|
|
13755
|
+
readonly getCustomerProductList: readonly [
|
|
13756
|
+
"organizationId",
|
|
13757
|
+
"customerId",
|
|
13758
|
+
"listId",
|
|
13759
|
+
"siteId"
|
|
13760
|
+
];
|
|
13761
|
+
readonly getCustomerProductListRequired: readonly [
|
|
13762
|
+
"organizationId",
|
|
13763
|
+
"customerId",
|
|
13764
|
+
"listId",
|
|
13765
|
+
"siteId"
|
|
13766
|
+
];
|
|
13767
|
+
readonly updateCustomerProductList: readonly [
|
|
13768
|
+
"organizationId",
|
|
13769
|
+
"customerId",
|
|
13770
|
+
"listId",
|
|
13771
|
+
"siteId"
|
|
13772
|
+
];
|
|
13773
|
+
readonly updateCustomerProductListRequired: readonly [
|
|
13774
|
+
"organizationId",
|
|
13775
|
+
"customerId",
|
|
13776
|
+
"listId",
|
|
13777
|
+
"siteId"
|
|
13778
|
+
];
|
|
13779
|
+
readonly createCustomerProductListItem: readonly [
|
|
13780
|
+
"organizationId",
|
|
13781
|
+
"customerId",
|
|
13782
|
+
"listId",
|
|
13783
|
+
"siteId"
|
|
13784
|
+
];
|
|
13785
|
+
readonly createCustomerProductListItemRequired: readonly [
|
|
13786
|
+
"organizationId",
|
|
13787
|
+
"customerId",
|
|
13788
|
+
"listId",
|
|
13789
|
+
"siteId"
|
|
13790
|
+
];
|
|
13791
|
+
readonly deleteCustomerProductListItem: readonly [
|
|
13792
|
+
"organizationId",
|
|
13793
|
+
"customerId",
|
|
13794
|
+
"listId",
|
|
13795
|
+
"itemId",
|
|
13796
|
+
"siteId"
|
|
13797
|
+
];
|
|
13798
|
+
readonly deleteCustomerProductListItemRequired: readonly [
|
|
13799
|
+
"organizationId",
|
|
13800
|
+
"customerId",
|
|
13801
|
+
"listId",
|
|
13802
|
+
"itemId",
|
|
13803
|
+
"siteId"
|
|
13804
|
+
];
|
|
13805
|
+
readonly getCustomerProductListItem: readonly [
|
|
13806
|
+
"organizationId",
|
|
13807
|
+
"customerId",
|
|
13808
|
+
"listId",
|
|
13809
|
+
"itemId",
|
|
13810
|
+
"siteId"
|
|
13811
|
+
];
|
|
13812
|
+
readonly getCustomerProductListItemRequired: readonly [
|
|
13813
|
+
"organizationId",
|
|
13814
|
+
"customerId",
|
|
13815
|
+
"listId",
|
|
13816
|
+
"itemId",
|
|
13817
|
+
"siteId"
|
|
13818
|
+
];
|
|
13819
|
+
readonly updateCustomerProductListItem: readonly [
|
|
13820
|
+
"organizationId",
|
|
13821
|
+
"customerId",
|
|
13822
|
+
"listId",
|
|
13823
|
+
"itemId",
|
|
13824
|
+
"siteId"
|
|
13825
|
+
];
|
|
13826
|
+
readonly updateCustomerProductListItemRequired: readonly [
|
|
13827
|
+
"organizationId",
|
|
13828
|
+
"customerId",
|
|
13829
|
+
"listId",
|
|
13830
|
+
"itemId",
|
|
13831
|
+
"siteId"
|
|
13832
|
+
];
|
|
13833
|
+
readonly getPublicProductListsBySearchTerm: readonly [
|
|
13834
|
+
"organizationId",
|
|
13835
|
+
"email",
|
|
13836
|
+
"firstName",
|
|
13837
|
+
"lastName",
|
|
13838
|
+
"siteId"
|
|
13839
|
+
];
|
|
13840
|
+
readonly getPublicProductListsBySearchTermRequired: readonly [
|
|
13841
|
+
"organizationId",
|
|
13842
|
+
"siteId"
|
|
13843
|
+
];
|
|
13844
|
+
readonly getPublicProductList: readonly [
|
|
13845
|
+
"organizationId",
|
|
13846
|
+
"listId",
|
|
13847
|
+
"siteId"
|
|
13848
|
+
];
|
|
13849
|
+
readonly getPublicProductListRequired: readonly [
|
|
13850
|
+
"organizationId",
|
|
13851
|
+
"listId",
|
|
13852
|
+
"siteId"
|
|
13853
|
+
];
|
|
13854
|
+
readonly getProductListItem: readonly [
|
|
13855
|
+
"organizationId",
|
|
13856
|
+
"listId",
|
|
13857
|
+
"itemId",
|
|
13858
|
+
"siteId"
|
|
13859
|
+
];
|
|
13860
|
+
readonly getProductListItemRequired: readonly [
|
|
13861
|
+
"organizationId",
|
|
13862
|
+
"listId",
|
|
13863
|
+
"itemId",
|
|
13864
|
+
"siteId"
|
|
13865
|
+
];
|
|
13866
|
+
};
|
|
12293
13867
|
/**
|
|
12294
13868
|
* Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API. The return type object for this endpoint is a common customer object shared by multiple Shopper Customer endpoints. In this case, all customer object details are returned, but attributes that are not included in the response, although they might be part of the customer object, are ignored. For example, although address information is included in the customer object, it is not displayed in the response for this endpoint and is ignored.
|
|
12295
13869
|
*
|
|
@@ -14291,10 +15865,10 @@ type ShopperDiscoverySearchParameters = ShopperDiscoverySearchPathParameters & B
|
|
|
14291
15865
|
* API Version: 1.1.6<br />
|
|
14292
15866
|
* Last Updated: <br />
|
|
14293
15867
|
* </span>
|
|
15868
|
+
*
|
|
14294
15869
|
* @beta
|
|
14295
15870
|
*
|
|
14296
15871
|
*
|
|
14297
|
-
|
|
14298
15872
|
*/
|
|
14299
15873
|
declare class ShopperDiscoverySearch<ConfigParameters extends ShopperDiscoverySearchParameters & Record<string, unknown>> {
|
|
14300
15874
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -14303,6 +15877,33 @@ declare class ShopperDiscoverySearch<ConfigParameters extends ShopperDiscoverySe
|
|
|
14303
15877
|
};
|
|
14304
15878
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/discovery/query/{version}";
|
|
14305
15879
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
15880
|
+
static readonly paramKeys: {
|
|
15881
|
+
readonly retrieveResults: readonly [
|
|
15882
|
+
"organizationId",
|
|
15883
|
+
"channelId",
|
|
15884
|
+
"locale",
|
|
15885
|
+
"offset",
|
|
15886
|
+
"limit"
|
|
15887
|
+
];
|
|
15888
|
+
readonly retrieveResultsRequired: readonly [
|
|
15889
|
+
"organizationId",
|
|
15890
|
+
"channelId",
|
|
15891
|
+
"locale"
|
|
15892
|
+
];
|
|
15893
|
+
readonly getSuggestions: readonly [
|
|
15894
|
+
"organizationId",
|
|
15895
|
+
"channelId",
|
|
15896
|
+
"suggestionTypes",
|
|
15897
|
+
"searchText",
|
|
15898
|
+
"locale"
|
|
15899
|
+
];
|
|
15900
|
+
readonly getSuggestionsRequired: readonly [
|
|
15901
|
+
"organizationId",
|
|
15902
|
+
"channelId",
|
|
15903
|
+
"suggestionTypes",
|
|
15904
|
+
"locale"
|
|
15905
|
+
];
|
|
15906
|
+
};
|
|
14306
15907
|
/**
|
|
14307
15908
|
* This method retrieves search results for a Channel.
|
|
14308
15909
|
*
|
|
@@ -14967,10 +16568,10 @@ declare namespace ShopperDiscoverySearchTypes {
|
|
|
14967
16568
|
* API Version: 1.1.6<br />
|
|
14968
16569
|
* Last Updated: <br />
|
|
14969
16570
|
* </span>
|
|
16571
|
+
*
|
|
14970
16572
|
* @beta
|
|
14971
16573
|
*
|
|
14972
16574
|
*
|
|
14973
|
-
|
|
14974
16575
|
*/
|
|
14975
16576
|
class ShopperDiscoverySearch<ConfigParameters extends ShopperDiscoverySearchParameters & Record<string, unknown>> {
|
|
14976
16577
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -14979,6 +16580,33 @@ declare namespace ShopperDiscoverySearchTypes {
|
|
|
14979
16580
|
};
|
|
14980
16581
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/discovery/query/{version}";
|
|
14981
16582
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
16583
|
+
static readonly paramKeys: {
|
|
16584
|
+
readonly retrieveResults: readonly [
|
|
16585
|
+
"organizationId",
|
|
16586
|
+
"channelId",
|
|
16587
|
+
"locale",
|
|
16588
|
+
"offset",
|
|
16589
|
+
"limit"
|
|
16590
|
+
];
|
|
16591
|
+
readonly retrieveResultsRequired: readonly [
|
|
16592
|
+
"organizationId",
|
|
16593
|
+
"channelId",
|
|
16594
|
+
"locale"
|
|
16595
|
+
];
|
|
16596
|
+
readonly getSuggestions: readonly [
|
|
16597
|
+
"organizationId",
|
|
16598
|
+
"channelId",
|
|
16599
|
+
"suggestionTypes",
|
|
16600
|
+
"searchText",
|
|
16601
|
+
"locale"
|
|
16602
|
+
];
|
|
16603
|
+
readonly getSuggestionsRequired: readonly [
|
|
16604
|
+
"organizationId",
|
|
16605
|
+
"channelId",
|
|
16606
|
+
"suggestionTypes",
|
|
16607
|
+
"locale"
|
|
16608
|
+
];
|
|
16609
|
+
};
|
|
14982
16610
|
/**
|
|
14983
16611
|
* This method retrieves search results for a Channel.
|
|
14984
16612
|
*
|
|
@@ -15312,9 +16940,8 @@ type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriPara
|
|
|
15312
16940
|
* API Version: 1.0.4<br />
|
|
15313
16941
|
* Last Updated: <br />
|
|
15314
16942
|
* </span>
|
|
15315
|
-
|
|
15316
16943
|
*
|
|
15317
|
-
|
|
16944
|
+
*
|
|
15318
16945
|
*/
|
|
15319
16946
|
declare class ShopperExperience<ConfigParameters extends ShopperExperienceParameters & Record<string, unknown>> {
|
|
15320
16947
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -15323,6 +16950,36 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
|
|
|
15323
16950
|
};
|
|
15324
16951
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/{version}";
|
|
15325
16952
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
16953
|
+
static readonly paramKeys: {
|
|
16954
|
+
readonly getPages: readonly [
|
|
16955
|
+
"organizationId",
|
|
16956
|
+
"categoryId",
|
|
16957
|
+
"productId",
|
|
16958
|
+
"aspectTypeId",
|
|
16959
|
+
"aspectAttributes",
|
|
16960
|
+
"parameters",
|
|
16961
|
+
"siteId",
|
|
16962
|
+
"locale"
|
|
16963
|
+
];
|
|
16964
|
+
readonly getPagesRequired: readonly [
|
|
16965
|
+
"organizationId",
|
|
16966
|
+
"aspectTypeId",
|
|
16967
|
+
"siteId"
|
|
16968
|
+
];
|
|
16969
|
+
readonly getPage: readonly [
|
|
16970
|
+
"organizationId",
|
|
16971
|
+
"pageId",
|
|
16972
|
+
"aspectAttributes",
|
|
16973
|
+
"parameters",
|
|
16974
|
+
"siteId",
|
|
16975
|
+
"locale"
|
|
16976
|
+
];
|
|
16977
|
+
readonly getPageRequired: readonly [
|
|
16978
|
+
"organizationId",
|
|
16979
|
+
"pageId",
|
|
16980
|
+
"siteId"
|
|
16981
|
+
];
|
|
16982
|
+
};
|
|
15326
16983
|
/**
|
|
15327
16984
|
* Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
|
|
15328
16985
|
|
|
@@ -15945,9 +17602,8 @@ declare namespace ShopperExperienceTypes {
|
|
|
15945
17602
|
* API Version: 1.0.4<br />
|
|
15946
17603
|
* Last Updated: <br />
|
|
15947
17604
|
* </span>
|
|
15948
|
-
|
|
15949
17605
|
*
|
|
15950
|
-
|
|
17606
|
+
*
|
|
15951
17607
|
*/
|
|
15952
17608
|
class ShopperExperience<ConfigParameters extends ShopperExperienceParameters & Record<string, unknown>> {
|
|
15953
17609
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -15956,6 +17612,36 @@ declare namespace ShopperExperienceTypes {
|
|
|
15956
17612
|
};
|
|
15957
17613
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/{version}";
|
|
15958
17614
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
17615
|
+
static readonly paramKeys: {
|
|
17616
|
+
readonly getPages: readonly [
|
|
17617
|
+
"organizationId",
|
|
17618
|
+
"categoryId",
|
|
17619
|
+
"productId",
|
|
17620
|
+
"aspectTypeId",
|
|
17621
|
+
"aspectAttributes",
|
|
17622
|
+
"parameters",
|
|
17623
|
+
"siteId",
|
|
17624
|
+
"locale"
|
|
17625
|
+
];
|
|
17626
|
+
readonly getPagesRequired: readonly [
|
|
17627
|
+
"organizationId",
|
|
17628
|
+
"aspectTypeId",
|
|
17629
|
+
"siteId"
|
|
17630
|
+
];
|
|
17631
|
+
readonly getPage: readonly [
|
|
17632
|
+
"organizationId",
|
|
17633
|
+
"pageId",
|
|
17634
|
+
"aspectAttributes",
|
|
17635
|
+
"parameters",
|
|
17636
|
+
"siteId",
|
|
17637
|
+
"locale"
|
|
17638
|
+
];
|
|
17639
|
+
readonly getPageRequired: readonly [
|
|
17640
|
+
"organizationId",
|
|
17641
|
+
"pageId",
|
|
17642
|
+
"siteId"
|
|
17643
|
+
];
|
|
17644
|
+
};
|
|
15959
17645
|
/**
|
|
15960
17646
|
* Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
|
|
15961
17647
|
|
|
@@ -16303,9 +17989,8 @@ type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters &
|
|
|
16303
17989
|
* API Version: 1.0.15<br />
|
|
16304
17990
|
* Last Updated: <br />
|
|
16305
17991
|
* </span>
|
|
16306
|
-
|
|
16307
17992
|
*
|
|
16308
|
-
|
|
17993
|
+
*
|
|
16309
17994
|
*/
|
|
16310
17995
|
declare class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertificatesParameters & Record<string, unknown>> {
|
|
16311
17996
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -16314,6 +17999,16 @@ declare class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertif
|
|
|
16314
17999
|
};
|
|
16315
18000
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-gift-certificates/{version}";
|
|
16316
18001
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
18002
|
+
static readonly paramKeys: {
|
|
18003
|
+
readonly getGiftCertificate: readonly [
|
|
18004
|
+
"organizationId",
|
|
18005
|
+
"siteId"
|
|
18006
|
+
];
|
|
18007
|
+
readonly getGiftCertificateRequired: readonly [
|
|
18008
|
+
"organizationId",
|
|
18009
|
+
"siteId"
|
|
18010
|
+
];
|
|
18011
|
+
};
|
|
16317
18012
|
/**
|
|
16318
18013
|
* Action to retrieve an existing gift certificate.
|
|
16319
18014
|
*
|
|
@@ -16780,9 +18475,8 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
16780
18475
|
* API Version: 1.0.15<br />
|
|
16781
18476
|
* Last Updated: <br />
|
|
16782
18477
|
* </span>
|
|
16783
|
-
|
|
16784
18478
|
*
|
|
16785
|
-
|
|
18479
|
+
*
|
|
16786
18480
|
*/
|
|
16787
18481
|
class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertificatesParameters & Record<string, unknown>> {
|
|
16788
18482
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -16791,6 +18485,16 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
16791
18485
|
};
|
|
16792
18486
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-gift-certificates/{version}";
|
|
16793
18487
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
18488
|
+
static readonly paramKeys: {
|
|
18489
|
+
readonly getGiftCertificate: readonly [
|
|
18490
|
+
"organizationId",
|
|
18491
|
+
"siteId"
|
|
18492
|
+
];
|
|
18493
|
+
readonly getGiftCertificateRequired: readonly [
|
|
18494
|
+
"organizationId",
|
|
18495
|
+
"siteId"
|
|
18496
|
+
];
|
|
18497
|
+
};
|
|
16794
18498
|
/**
|
|
16795
18499
|
* Action to retrieve an existing gift certificate.
|
|
16796
18500
|
*
|
|
@@ -17129,9 +18833,8 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
|
|
|
17129
18833
|
* API Version: 1.39.22<br />
|
|
17130
18834
|
* Last Updated: <br />
|
|
17131
18835
|
* </span>
|
|
17132
|
-
|
|
17133
18836
|
*
|
|
17134
|
-
|
|
18837
|
+
*
|
|
17135
18838
|
*/
|
|
17136
18839
|
declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Record<string, unknown>> {
|
|
17137
18840
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -17140,6 +18843,145 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
17140
18843
|
};
|
|
17141
18844
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
17142
18845
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
18846
|
+
static readonly paramKeys: {
|
|
18847
|
+
readonly authenticateCustomer: readonly [
|
|
18848
|
+
"organizationId"
|
|
18849
|
+
];
|
|
18850
|
+
readonly authenticateCustomerRequired: readonly [
|
|
18851
|
+
"organizationId"
|
|
18852
|
+
];
|
|
18853
|
+
readonly authorizePasswordlessCustomer: readonly [
|
|
18854
|
+
"organizationId"
|
|
18855
|
+
];
|
|
18856
|
+
readonly authorizePasswordlessCustomerRequired: readonly [
|
|
18857
|
+
"organizationId"
|
|
18858
|
+
];
|
|
18859
|
+
readonly logoutCustomer: readonly [
|
|
18860
|
+
"organizationId",
|
|
18861
|
+
"client_id",
|
|
18862
|
+
"refresh_token",
|
|
18863
|
+
"channel_id",
|
|
18864
|
+
"hint"
|
|
18865
|
+
];
|
|
18866
|
+
readonly logoutCustomerRequired: readonly [
|
|
18867
|
+
"organizationId",
|
|
18868
|
+
"client_id",
|
|
18869
|
+
"refresh_token"
|
|
18870
|
+
];
|
|
18871
|
+
readonly authorizeCustomer: readonly [
|
|
18872
|
+
"organizationId",
|
|
18873
|
+
"redirect_uri",
|
|
18874
|
+
"response_type",
|
|
18875
|
+
"client_id",
|
|
18876
|
+
"scope",
|
|
18877
|
+
"state",
|
|
18878
|
+
"usid",
|
|
18879
|
+
"hint",
|
|
18880
|
+
"channel_id",
|
|
18881
|
+
"code_challenge",
|
|
18882
|
+
"ui_locales"
|
|
18883
|
+
];
|
|
18884
|
+
readonly authorizeCustomerRequired: readonly [
|
|
18885
|
+
"organizationId",
|
|
18886
|
+
"redirect_uri",
|
|
18887
|
+
"response_type",
|
|
18888
|
+
"client_id",
|
|
18889
|
+
"code_challenge"
|
|
18890
|
+
];
|
|
18891
|
+
readonly getAccessToken: readonly [
|
|
18892
|
+
"organizationId"
|
|
18893
|
+
];
|
|
18894
|
+
readonly getAccessTokenRequired: readonly [
|
|
18895
|
+
"organizationId"
|
|
18896
|
+
];
|
|
18897
|
+
readonly getSessionBridgeAccessToken: readonly [
|
|
18898
|
+
"organizationId"
|
|
18899
|
+
];
|
|
18900
|
+
readonly getSessionBridgeAccessTokenRequired: readonly [
|
|
18901
|
+
"organizationId"
|
|
18902
|
+
];
|
|
18903
|
+
readonly getTrustedSystemAccessToken: readonly [
|
|
18904
|
+
"organizationId"
|
|
18905
|
+
];
|
|
18906
|
+
readonly getTrustedSystemAccessTokenRequired: readonly [
|
|
18907
|
+
"organizationId"
|
|
18908
|
+
];
|
|
18909
|
+
readonly getTrustedAgentAuthorizationToken: readonly [
|
|
18910
|
+
"organizationId",
|
|
18911
|
+
"client_id",
|
|
18912
|
+
"channel_id",
|
|
18913
|
+
"code_challenge",
|
|
18914
|
+
"login_id",
|
|
18915
|
+
"idp_origin",
|
|
18916
|
+
"redirect_uri",
|
|
18917
|
+
"response_type"
|
|
18918
|
+
];
|
|
18919
|
+
readonly getTrustedAgentAuthorizationTokenRequired: readonly [
|
|
18920
|
+
"organizationId",
|
|
18921
|
+
"client_id",
|
|
18922
|
+
"channel_id",
|
|
18923
|
+
"code_challenge",
|
|
18924
|
+
"login_id",
|
|
18925
|
+
"idp_origin",
|
|
18926
|
+
"redirect_uri",
|
|
18927
|
+
"response_type"
|
|
18928
|
+
];
|
|
18929
|
+
readonly getTrustedAgentAccessToken: readonly [
|
|
18930
|
+
"organizationId"
|
|
18931
|
+
];
|
|
18932
|
+
readonly getTrustedAgentAccessTokenRequired: readonly [
|
|
18933
|
+
"organizationId"
|
|
18934
|
+
];
|
|
18935
|
+
readonly getPasswordResetToken: readonly [
|
|
18936
|
+
"organizationId"
|
|
18937
|
+
];
|
|
18938
|
+
readonly getPasswordResetTokenRequired: readonly [
|
|
18939
|
+
"organizationId"
|
|
18940
|
+
];
|
|
18941
|
+
readonly resetPassword: readonly [
|
|
18942
|
+
"organizationId"
|
|
18943
|
+
];
|
|
18944
|
+
readonly resetPasswordRequired: readonly [
|
|
18945
|
+
"organizationId"
|
|
18946
|
+
];
|
|
18947
|
+
readonly getPasswordLessAccessToken: readonly [
|
|
18948
|
+
"organizationId"
|
|
18949
|
+
];
|
|
18950
|
+
readonly getPasswordLessAccessTokenRequired: readonly [
|
|
18951
|
+
"organizationId"
|
|
18952
|
+
];
|
|
18953
|
+
readonly revokeToken: readonly [
|
|
18954
|
+
"organizationId"
|
|
18955
|
+
];
|
|
18956
|
+
readonly revokeTokenRequired: readonly [
|
|
18957
|
+
"organizationId"
|
|
18958
|
+
];
|
|
18959
|
+
readonly introspectToken: readonly [
|
|
18960
|
+
"organizationId"
|
|
18961
|
+
];
|
|
18962
|
+
readonly introspectTokenRequired: readonly [
|
|
18963
|
+
"organizationId"
|
|
18964
|
+
];
|
|
18965
|
+
readonly getUserInfo: readonly [
|
|
18966
|
+
"organizationId",
|
|
18967
|
+
"channel_id"
|
|
18968
|
+
];
|
|
18969
|
+
readonly getUserInfoRequired: readonly [
|
|
18970
|
+
"organizationId"
|
|
18971
|
+
];
|
|
18972
|
+
readonly getWellknownOpenidConfiguration: readonly [
|
|
18973
|
+
"organizationId"
|
|
18974
|
+
];
|
|
18975
|
+
readonly getWellknownOpenidConfigurationRequired: readonly [
|
|
18976
|
+
"organizationId"
|
|
18977
|
+
];
|
|
18978
|
+
readonly getJwksUri: readonly [
|
|
18979
|
+
"organizationId"
|
|
18980
|
+
];
|
|
18981
|
+
readonly getJwksUriRequired: readonly [
|
|
18982
|
+
"organizationId"
|
|
18983
|
+
];
|
|
18984
|
+
};
|
|
17143
18985
|
/**
|
|
17144
18986
|
* Logs in a shopper with credentials that are managed by a B2C Commerce instance (ECOM). It follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).
|
|
17145
18987
|
|
|
@@ -18759,9 +20601,8 @@ declare namespace ShopperLoginTypes {
|
|
|
18759
20601
|
* API Version: 1.39.22<br />
|
|
18760
20602
|
* Last Updated: <br />
|
|
18761
20603
|
* </span>
|
|
18762
|
-
|
|
18763
20604
|
*
|
|
18764
|
-
|
|
20605
|
+
*
|
|
18765
20606
|
*/
|
|
18766
20607
|
class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Record<string, unknown>> {
|
|
18767
20608
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -18770,6 +20611,145 @@ declare namespace ShopperLoginTypes {
|
|
|
18770
20611
|
};
|
|
18771
20612
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
18772
20613
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
20614
|
+
static readonly paramKeys: {
|
|
20615
|
+
readonly authenticateCustomer: readonly [
|
|
20616
|
+
"organizationId"
|
|
20617
|
+
];
|
|
20618
|
+
readonly authenticateCustomerRequired: readonly [
|
|
20619
|
+
"organizationId"
|
|
20620
|
+
];
|
|
20621
|
+
readonly authorizePasswordlessCustomer: readonly [
|
|
20622
|
+
"organizationId"
|
|
20623
|
+
];
|
|
20624
|
+
readonly authorizePasswordlessCustomerRequired: readonly [
|
|
20625
|
+
"organizationId"
|
|
20626
|
+
];
|
|
20627
|
+
readonly logoutCustomer: readonly [
|
|
20628
|
+
"organizationId",
|
|
20629
|
+
"client_id",
|
|
20630
|
+
"refresh_token",
|
|
20631
|
+
"channel_id",
|
|
20632
|
+
"hint"
|
|
20633
|
+
];
|
|
20634
|
+
readonly logoutCustomerRequired: readonly [
|
|
20635
|
+
"organizationId",
|
|
20636
|
+
"client_id",
|
|
20637
|
+
"refresh_token"
|
|
20638
|
+
];
|
|
20639
|
+
readonly authorizeCustomer: readonly [
|
|
20640
|
+
"organizationId",
|
|
20641
|
+
"redirect_uri",
|
|
20642
|
+
"response_type",
|
|
20643
|
+
"client_id",
|
|
20644
|
+
"scope",
|
|
20645
|
+
"state",
|
|
20646
|
+
"usid",
|
|
20647
|
+
"hint",
|
|
20648
|
+
"channel_id",
|
|
20649
|
+
"code_challenge",
|
|
20650
|
+
"ui_locales"
|
|
20651
|
+
];
|
|
20652
|
+
readonly authorizeCustomerRequired: readonly [
|
|
20653
|
+
"organizationId",
|
|
20654
|
+
"redirect_uri",
|
|
20655
|
+
"response_type",
|
|
20656
|
+
"client_id",
|
|
20657
|
+
"code_challenge"
|
|
20658
|
+
];
|
|
20659
|
+
readonly getAccessToken: readonly [
|
|
20660
|
+
"organizationId"
|
|
20661
|
+
];
|
|
20662
|
+
readonly getAccessTokenRequired: readonly [
|
|
20663
|
+
"organizationId"
|
|
20664
|
+
];
|
|
20665
|
+
readonly getSessionBridgeAccessToken: readonly [
|
|
20666
|
+
"organizationId"
|
|
20667
|
+
];
|
|
20668
|
+
readonly getSessionBridgeAccessTokenRequired: readonly [
|
|
20669
|
+
"organizationId"
|
|
20670
|
+
];
|
|
20671
|
+
readonly getTrustedSystemAccessToken: readonly [
|
|
20672
|
+
"organizationId"
|
|
20673
|
+
];
|
|
20674
|
+
readonly getTrustedSystemAccessTokenRequired: readonly [
|
|
20675
|
+
"organizationId"
|
|
20676
|
+
];
|
|
20677
|
+
readonly getTrustedAgentAuthorizationToken: readonly [
|
|
20678
|
+
"organizationId",
|
|
20679
|
+
"client_id",
|
|
20680
|
+
"channel_id",
|
|
20681
|
+
"code_challenge",
|
|
20682
|
+
"login_id",
|
|
20683
|
+
"idp_origin",
|
|
20684
|
+
"redirect_uri",
|
|
20685
|
+
"response_type"
|
|
20686
|
+
];
|
|
20687
|
+
readonly getTrustedAgentAuthorizationTokenRequired: readonly [
|
|
20688
|
+
"organizationId",
|
|
20689
|
+
"client_id",
|
|
20690
|
+
"channel_id",
|
|
20691
|
+
"code_challenge",
|
|
20692
|
+
"login_id",
|
|
20693
|
+
"idp_origin",
|
|
20694
|
+
"redirect_uri",
|
|
20695
|
+
"response_type"
|
|
20696
|
+
];
|
|
20697
|
+
readonly getTrustedAgentAccessToken: readonly [
|
|
20698
|
+
"organizationId"
|
|
20699
|
+
];
|
|
20700
|
+
readonly getTrustedAgentAccessTokenRequired: readonly [
|
|
20701
|
+
"organizationId"
|
|
20702
|
+
];
|
|
20703
|
+
readonly getPasswordResetToken: readonly [
|
|
20704
|
+
"organizationId"
|
|
20705
|
+
];
|
|
20706
|
+
readonly getPasswordResetTokenRequired: readonly [
|
|
20707
|
+
"organizationId"
|
|
20708
|
+
];
|
|
20709
|
+
readonly resetPassword: readonly [
|
|
20710
|
+
"organizationId"
|
|
20711
|
+
];
|
|
20712
|
+
readonly resetPasswordRequired: readonly [
|
|
20713
|
+
"organizationId"
|
|
20714
|
+
];
|
|
20715
|
+
readonly getPasswordLessAccessToken: readonly [
|
|
20716
|
+
"organizationId"
|
|
20717
|
+
];
|
|
20718
|
+
readonly getPasswordLessAccessTokenRequired: readonly [
|
|
20719
|
+
"organizationId"
|
|
20720
|
+
];
|
|
20721
|
+
readonly revokeToken: readonly [
|
|
20722
|
+
"organizationId"
|
|
20723
|
+
];
|
|
20724
|
+
readonly revokeTokenRequired: readonly [
|
|
20725
|
+
"organizationId"
|
|
20726
|
+
];
|
|
20727
|
+
readonly introspectToken: readonly [
|
|
20728
|
+
"organizationId"
|
|
20729
|
+
];
|
|
20730
|
+
readonly introspectTokenRequired: readonly [
|
|
20731
|
+
"organizationId"
|
|
20732
|
+
];
|
|
20733
|
+
readonly getUserInfo: readonly [
|
|
20734
|
+
"organizationId",
|
|
20735
|
+
"channel_id"
|
|
20736
|
+
];
|
|
20737
|
+
readonly getUserInfoRequired: readonly [
|
|
20738
|
+
"organizationId"
|
|
20739
|
+
];
|
|
20740
|
+
readonly getWellknownOpenidConfiguration: readonly [
|
|
20741
|
+
"organizationId"
|
|
20742
|
+
];
|
|
20743
|
+
readonly getWellknownOpenidConfigurationRequired: readonly [
|
|
20744
|
+
"organizationId"
|
|
20745
|
+
];
|
|
20746
|
+
readonly getJwksUri: readonly [
|
|
20747
|
+
"organizationId"
|
|
20748
|
+
];
|
|
20749
|
+
readonly getJwksUriRequired: readonly [
|
|
20750
|
+
"organizationId"
|
|
20751
|
+
];
|
|
20752
|
+
};
|
|
18773
20753
|
/**
|
|
18774
20754
|
* Logs in a shopper with credentials that are managed by a B2C Commerce instance (ECOM). It follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).
|
|
18775
20755
|
|
|
@@ -20409,9 +22389,8 @@ type ShopperOrdersParameters = ShopperOrdersPathParameters & BaseUriParameters &
|
|
|
20409
22389
|
* API Version: 0.4.7<br />
|
|
20410
22390
|
* Last Updated: <br />
|
|
20411
22391
|
* </span>
|
|
20412
|
-
|
|
20413
22392
|
*
|
|
20414
|
-
|
|
22393
|
+
*
|
|
20415
22394
|
*/
|
|
20416
22395
|
declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & Record<string, unknown>> {
|
|
20417
22396
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -20420,6 +22399,97 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
|
|
|
20420
22399
|
};
|
|
20421
22400
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-orders/{version}";
|
|
20422
22401
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
22402
|
+
static readonly paramKeys: {
|
|
22403
|
+
readonly createOrder: readonly [
|
|
22404
|
+
"organizationId",
|
|
22405
|
+
"siteId",
|
|
22406
|
+
"locale"
|
|
22407
|
+
];
|
|
22408
|
+
readonly createOrderRequired: readonly [
|
|
22409
|
+
"organizationId",
|
|
22410
|
+
"siteId"
|
|
22411
|
+
];
|
|
22412
|
+
readonly getOrder: readonly [
|
|
22413
|
+
"organizationId",
|
|
22414
|
+
"orderNo",
|
|
22415
|
+
"siteId",
|
|
22416
|
+
"locale"
|
|
22417
|
+
];
|
|
22418
|
+
readonly getOrderRequired: readonly [
|
|
22419
|
+
"organizationId",
|
|
22420
|
+
"orderNo",
|
|
22421
|
+
"siteId"
|
|
22422
|
+
];
|
|
22423
|
+
readonly guestOrderLookup: readonly [
|
|
22424
|
+
"organizationId",
|
|
22425
|
+
"orderNo",
|
|
22426
|
+
"siteId",
|
|
22427
|
+
"locale"
|
|
22428
|
+
];
|
|
22429
|
+
readonly guestOrderLookupRequired: readonly [
|
|
22430
|
+
"organizationId",
|
|
22431
|
+
"orderNo",
|
|
22432
|
+
"siteId"
|
|
22433
|
+
];
|
|
22434
|
+
readonly createPaymentInstrumentForOrder: readonly [
|
|
22435
|
+
"organizationId",
|
|
22436
|
+
"orderNo",
|
|
22437
|
+
"siteId",
|
|
22438
|
+
"locale"
|
|
22439
|
+
];
|
|
22440
|
+
readonly createPaymentInstrumentForOrderRequired: readonly [
|
|
22441
|
+
"organizationId",
|
|
22442
|
+
"orderNo",
|
|
22443
|
+
"siteId"
|
|
22444
|
+
];
|
|
22445
|
+
readonly removePaymentInstrumentFromOrder: readonly [
|
|
22446
|
+
"organizationId",
|
|
22447
|
+
"orderNo",
|
|
22448
|
+
"paymentInstrumentId",
|
|
22449
|
+
"siteId",
|
|
22450
|
+
"locale"
|
|
22451
|
+
];
|
|
22452
|
+
readonly removePaymentInstrumentFromOrderRequired: readonly [
|
|
22453
|
+
"organizationId",
|
|
22454
|
+
"orderNo",
|
|
22455
|
+
"paymentInstrumentId",
|
|
22456
|
+
"siteId"
|
|
22457
|
+
];
|
|
22458
|
+
readonly updatePaymentInstrumentForOrder: readonly [
|
|
22459
|
+
"organizationId",
|
|
22460
|
+
"orderNo",
|
|
22461
|
+
"paymentInstrumentId",
|
|
22462
|
+
"siteId",
|
|
22463
|
+
"locale"
|
|
22464
|
+
];
|
|
22465
|
+
readonly updatePaymentInstrumentForOrderRequired: readonly [
|
|
22466
|
+
"organizationId",
|
|
22467
|
+
"orderNo",
|
|
22468
|
+
"paymentInstrumentId",
|
|
22469
|
+
"siteId"
|
|
22470
|
+
];
|
|
22471
|
+
readonly getPaymentMethodsForOrder: readonly [
|
|
22472
|
+
"organizationId",
|
|
22473
|
+
"orderNo",
|
|
22474
|
+
"siteId",
|
|
22475
|
+
"locale"
|
|
22476
|
+
];
|
|
22477
|
+
readonly getPaymentMethodsForOrderRequired: readonly [
|
|
22478
|
+
"organizationId",
|
|
22479
|
+
"orderNo",
|
|
22480
|
+
"siteId"
|
|
22481
|
+
];
|
|
22482
|
+
readonly getTaxesFromOrder: readonly [
|
|
22483
|
+
"organizationId",
|
|
22484
|
+
"orderNo",
|
|
22485
|
+
"siteId"
|
|
22486
|
+
];
|
|
22487
|
+
readonly getTaxesFromOrderRequired: readonly [
|
|
22488
|
+
"organizationId",
|
|
22489
|
+
"orderNo",
|
|
22490
|
+
"siteId"
|
|
22491
|
+
];
|
|
22492
|
+
};
|
|
20423
22493
|
/**
|
|
20424
22494
|
* Submits an order based on a prepared basket. The only considered value from the request body is basketId.
|
|
20425
22495
|
*
|
|
@@ -21868,9 +23938,8 @@ declare namespace ShopperOrdersTypes {
|
|
|
21868
23938
|
* API Version: 0.4.7<br />
|
|
21869
23939
|
* Last Updated: <br />
|
|
21870
23940
|
* </span>
|
|
21871
|
-
|
|
21872
23941
|
*
|
|
21873
|
-
|
|
23942
|
+
*
|
|
21874
23943
|
*/
|
|
21875
23944
|
class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & Record<string, unknown>> {
|
|
21876
23945
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -21879,6 +23948,97 @@ declare namespace ShopperOrdersTypes {
|
|
|
21879
23948
|
};
|
|
21880
23949
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-orders/{version}";
|
|
21881
23950
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
23951
|
+
static readonly paramKeys: {
|
|
23952
|
+
readonly createOrder: readonly [
|
|
23953
|
+
"organizationId",
|
|
23954
|
+
"siteId",
|
|
23955
|
+
"locale"
|
|
23956
|
+
];
|
|
23957
|
+
readonly createOrderRequired: readonly [
|
|
23958
|
+
"organizationId",
|
|
23959
|
+
"siteId"
|
|
23960
|
+
];
|
|
23961
|
+
readonly getOrder: readonly [
|
|
23962
|
+
"organizationId",
|
|
23963
|
+
"orderNo",
|
|
23964
|
+
"siteId",
|
|
23965
|
+
"locale"
|
|
23966
|
+
];
|
|
23967
|
+
readonly getOrderRequired: readonly [
|
|
23968
|
+
"organizationId",
|
|
23969
|
+
"orderNo",
|
|
23970
|
+
"siteId"
|
|
23971
|
+
];
|
|
23972
|
+
readonly guestOrderLookup: readonly [
|
|
23973
|
+
"organizationId",
|
|
23974
|
+
"orderNo",
|
|
23975
|
+
"siteId",
|
|
23976
|
+
"locale"
|
|
23977
|
+
];
|
|
23978
|
+
readonly guestOrderLookupRequired: readonly [
|
|
23979
|
+
"organizationId",
|
|
23980
|
+
"orderNo",
|
|
23981
|
+
"siteId"
|
|
23982
|
+
];
|
|
23983
|
+
readonly createPaymentInstrumentForOrder: readonly [
|
|
23984
|
+
"organizationId",
|
|
23985
|
+
"orderNo",
|
|
23986
|
+
"siteId",
|
|
23987
|
+
"locale"
|
|
23988
|
+
];
|
|
23989
|
+
readonly createPaymentInstrumentForOrderRequired: readonly [
|
|
23990
|
+
"organizationId",
|
|
23991
|
+
"orderNo",
|
|
23992
|
+
"siteId"
|
|
23993
|
+
];
|
|
23994
|
+
readonly removePaymentInstrumentFromOrder: readonly [
|
|
23995
|
+
"organizationId",
|
|
23996
|
+
"orderNo",
|
|
23997
|
+
"paymentInstrumentId",
|
|
23998
|
+
"siteId",
|
|
23999
|
+
"locale"
|
|
24000
|
+
];
|
|
24001
|
+
readonly removePaymentInstrumentFromOrderRequired: readonly [
|
|
24002
|
+
"organizationId",
|
|
24003
|
+
"orderNo",
|
|
24004
|
+
"paymentInstrumentId",
|
|
24005
|
+
"siteId"
|
|
24006
|
+
];
|
|
24007
|
+
readonly updatePaymentInstrumentForOrder: readonly [
|
|
24008
|
+
"organizationId",
|
|
24009
|
+
"orderNo",
|
|
24010
|
+
"paymentInstrumentId",
|
|
24011
|
+
"siteId",
|
|
24012
|
+
"locale"
|
|
24013
|
+
];
|
|
24014
|
+
readonly updatePaymentInstrumentForOrderRequired: readonly [
|
|
24015
|
+
"organizationId",
|
|
24016
|
+
"orderNo",
|
|
24017
|
+
"paymentInstrumentId",
|
|
24018
|
+
"siteId"
|
|
24019
|
+
];
|
|
24020
|
+
readonly getPaymentMethodsForOrder: readonly [
|
|
24021
|
+
"organizationId",
|
|
24022
|
+
"orderNo",
|
|
24023
|
+
"siteId",
|
|
24024
|
+
"locale"
|
|
24025
|
+
];
|
|
24026
|
+
readonly getPaymentMethodsForOrderRequired: readonly [
|
|
24027
|
+
"organizationId",
|
|
24028
|
+
"orderNo",
|
|
24029
|
+
"siteId"
|
|
24030
|
+
];
|
|
24031
|
+
readonly getTaxesFromOrder: readonly [
|
|
24032
|
+
"organizationId",
|
|
24033
|
+
"orderNo",
|
|
24034
|
+
"siteId"
|
|
24035
|
+
];
|
|
24036
|
+
readonly getTaxesFromOrderRequired: readonly [
|
|
24037
|
+
"organizationId",
|
|
24038
|
+
"orderNo",
|
|
24039
|
+
"siteId"
|
|
24040
|
+
];
|
|
24041
|
+
};
|
|
21882
24042
|
/**
|
|
21883
24043
|
* Submits an order based on a prepared basket. The only considered value from the request body is basketId.
|
|
21884
24044
|
*
|
|
@@ -22874,9 +25034,8 @@ type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParamete
|
|
|
22874
25034
|
* API Version: 0.0.32<br />
|
|
22875
25035
|
* Last Updated: <br />
|
|
22876
25036
|
* </span>
|
|
22877
|
-
|
|
22878
25037
|
*
|
|
22879
|
-
|
|
25038
|
+
*
|
|
22880
25039
|
*/
|
|
22881
25040
|
declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters & Record<string, unknown>> {
|
|
22882
25041
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -22885,6 +25044,66 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
|
|
|
22885
25044
|
};
|
|
22886
25045
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/product/shopper-products/{version}";
|
|
22887
25046
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
25047
|
+
static readonly paramKeys: {
|
|
25048
|
+
readonly getProducts: readonly [
|
|
25049
|
+
"organizationId",
|
|
25050
|
+
"select",
|
|
25051
|
+
"ids",
|
|
25052
|
+
"inventoryIds",
|
|
25053
|
+
"currency",
|
|
25054
|
+
"expand",
|
|
25055
|
+
"locale",
|
|
25056
|
+
"allImages",
|
|
25057
|
+
"perPricebook",
|
|
25058
|
+
"siteId"
|
|
25059
|
+
];
|
|
25060
|
+
readonly getProductsRequired: readonly [
|
|
25061
|
+
"organizationId",
|
|
25062
|
+
"ids",
|
|
25063
|
+
"siteId"
|
|
25064
|
+
];
|
|
25065
|
+
readonly getProduct: readonly [
|
|
25066
|
+
"organizationId",
|
|
25067
|
+
"id",
|
|
25068
|
+
"select",
|
|
25069
|
+
"inventoryIds",
|
|
25070
|
+
"currency",
|
|
25071
|
+
"expand",
|
|
25072
|
+
"locale",
|
|
25073
|
+
"allImages",
|
|
25074
|
+
"perPricebook",
|
|
25075
|
+
"siteId"
|
|
25076
|
+
];
|
|
25077
|
+
readonly getProductRequired: readonly [
|
|
25078
|
+
"organizationId",
|
|
25079
|
+
"id",
|
|
25080
|
+
"siteId"
|
|
25081
|
+
];
|
|
25082
|
+
readonly getCategories: readonly [
|
|
25083
|
+
"organizationId",
|
|
25084
|
+
"ids",
|
|
25085
|
+
"levels",
|
|
25086
|
+
"locale",
|
|
25087
|
+
"siteId"
|
|
25088
|
+
];
|
|
25089
|
+
readonly getCategoriesRequired: readonly [
|
|
25090
|
+
"organizationId",
|
|
25091
|
+
"ids",
|
|
25092
|
+
"siteId"
|
|
25093
|
+
];
|
|
25094
|
+
readonly getCategory: readonly [
|
|
25095
|
+
"organizationId",
|
|
25096
|
+
"id",
|
|
25097
|
+
"levels",
|
|
25098
|
+
"locale",
|
|
25099
|
+
"siteId"
|
|
25100
|
+
];
|
|
25101
|
+
readonly getCategoryRequired: readonly [
|
|
25102
|
+
"organizationId",
|
|
25103
|
+
"id",
|
|
25104
|
+
"siteId"
|
|
25105
|
+
];
|
|
25106
|
+
};
|
|
22888
25107
|
/**
|
|
22889
25108
|
* Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
|
|
22890
25109
|
*
|
|
@@ -23823,9 +26042,8 @@ declare namespace ShopperProductsTypes {
|
|
|
23823
26042
|
* API Version: 0.0.32<br />
|
|
23824
26043
|
* Last Updated: <br />
|
|
23825
26044
|
* </span>
|
|
23826
|
-
|
|
23827
26045
|
*
|
|
23828
|
-
|
|
26046
|
+
*
|
|
23829
26047
|
*/
|
|
23830
26048
|
class ShopperProducts<ConfigParameters extends ShopperProductsParameters & Record<string, unknown>> {
|
|
23831
26049
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -23834,6 +26052,66 @@ declare namespace ShopperProductsTypes {
|
|
|
23834
26052
|
};
|
|
23835
26053
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/product/shopper-products/{version}";
|
|
23836
26054
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
26055
|
+
static readonly paramKeys: {
|
|
26056
|
+
readonly getProducts: readonly [
|
|
26057
|
+
"organizationId",
|
|
26058
|
+
"select",
|
|
26059
|
+
"ids",
|
|
26060
|
+
"inventoryIds",
|
|
26061
|
+
"currency",
|
|
26062
|
+
"expand",
|
|
26063
|
+
"locale",
|
|
26064
|
+
"allImages",
|
|
26065
|
+
"perPricebook",
|
|
26066
|
+
"siteId"
|
|
26067
|
+
];
|
|
26068
|
+
readonly getProductsRequired: readonly [
|
|
26069
|
+
"organizationId",
|
|
26070
|
+
"ids",
|
|
26071
|
+
"siteId"
|
|
26072
|
+
];
|
|
26073
|
+
readonly getProduct: readonly [
|
|
26074
|
+
"organizationId",
|
|
26075
|
+
"id",
|
|
26076
|
+
"select",
|
|
26077
|
+
"inventoryIds",
|
|
26078
|
+
"currency",
|
|
26079
|
+
"expand",
|
|
26080
|
+
"locale",
|
|
26081
|
+
"allImages",
|
|
26082
|
+
"perPricebook",
|
|
26083
|
+
"siteId"
|
|
26084
|
+
];
|
|
26085
|
+
readonly getProductRequired: readonly [
|
|
26086
|
+
"organizationId",
|
|
26087
|
+
"id",
|
|
26088
|
+
"siteId"
|
|
26089
|
+
];
|
|
26090
|
+
readonly getCategories: readonly [
|
|
26091
|
+
"organizationId",
|
|
26092
|
+
"ids",
|
|
26093
|
+
"levels",
|
|
26094
|
+
"locale",
|
|
26095
|
+
"siteId"
|
|
26096
|
+
];
|
|
26097
|
+
readonly getCategoriesRequired: readonly [
|
|
26098
|
+
"organizationId",
|
|
26099
|
+
"ids",
|
|
26100
|
+
"siteId"
|
|
26101
|
+
];
|
|
26102
|
+
readonly getCategory: readonly [
|
|
26103
|
+
"organizationId",
|
|
26104
|
+
"id",
|
|
26105
|
+
"levels",
|
|
26106
|
+
"locale",
|
|
26107
|
+
"siteId"
|
|
26108
|
+
];
|
|
26109
|
+
readonly getCategoryRequired: readonly [
|
|
26110
|
+
"organizationId",
|
|
26111
|
+
"id",
|
|
26112
|
+
"siteId"
|
|
26113
|
+
];
|
|
26114
|
+
};
|
|
23837
26115
|
/**
|
|
23838
26116
|
* Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
|
|
23839
26117
|
*
|
|
@@ -24298,9 +26576,8 @@ type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriPara
|
|
|
24298
26576
|
* API Version: 1.0.25<br />
|
|
24299
26577
|
* Last Updated: <br />
|
|
24300
26578
|
* </span>
|
|
24301
|
-
|
|
24302
26579
|
*
|
|
24303
|
-
|
|
26580
|
+
*
|
|
24304
26581
|
*/
|
|
24305
26582
|
declare class ShopperPromotions<ConfigParameters extends ShopperPromotionsParameters & Record<string, unknown>> {
|
|
24306
26583
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -24309,6 +26586,32 @@ declare class ShopperPromotions<ConfigParameters extends ShopperPromotionsParame
|
|
|
24309
26586
|
};
|
|
24310
26587
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-promotions/{version}";
|
|
24311
26588
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
26589
|
+
static readonly paramKeys: {
|
|
26590
|
+
readonly getPromotions: readonly [
|
|
26591
|
+
"organizationId",
|
|
26592
|
+
"siteId",
|
|
26593
|
+
"ids",
|
|
26594
|
+
"locale"
|
|
26595
|
+
];
|
|
26596
|
+
readonly getPromotionsRequired: readonly [
|
|
26597
|
+
"organizationId",
|
|
26598
|
+
"siteId",
|
|
26599
|
+
"ids"
|
|
26600
|
+
];
|
|
26601
|
+
readonly getPromotionsForCampaign: readonly [
|
|
26602
|
+
"organizationId",
|
|
26603
|
+
"campaignId",
|
|
26604
|
+
"siteId",
|
|
26605
|
+
"startDate",
|
|
26606
|
+
"endDate",
|
|
26607
|
+
"currency"
|
|
26608
|
+
];
|
|
26609
|
+
readonly getPromotionsForCampaignRequired: readonly [
|
|
26610
|
+
"organizationId",
|
|
26611
|
+
"campaignId",
|
|
26612
|
+
"siteId"
|
|
26613
|
+
];
|
|
26614
|
+
};
|
|
24312
26615
|
/**
|
|
24313
26616
|
* Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
|
|
24314
26617
|
*
|
|
@@ -24858,9 +27161,8 @@ declare namespace ShopperPromotionsTypes {
|
|
|
24858
27161
|
* API Version: 1.0.25<br />
|
|
24859
27162
|
* Last Updated: <br />
|
|
24860
27163
|
* </span>
|
|
24861
|
-
|
|
24862
27164
|
*
|
|
24863
|
-
|
|
27165
|
+
*
|
|
24864
27166
|
*/
|
|
24865
27167
|
class ShopperPromotions<ConfigParameters extends ShopperPromotionsParameters & Record<string, unknown>> {
|
|
24866
27168
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -24869,6 +27171,32 @@ declare namespace ShopperPromotionsTypes {
|
|
|
24869
27171
|
};
|
|
24870
27172
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-promotions/{version}";
|
|
24871
27173
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
27174
|
+
static readonly paramKeys: {
|
|
27175
|
+
readonly getPromotions: readonly [
|
|
27176
|
+
"organizationId",
|
|
27177
|
+
"siteId",
|
|
27178
|
+
"ids",
|
|
27179
|
+
"locale"
|
|
27180
|
+
];
|
|
27181
|
+
readonly getPromotionsRequired: readonly [
|
|
27182
|
+
"organizationId",
|
|
27183
|
+
"siteId",
|
|
27184
|
+
"ids"
|
|
27185
|
+
];
|
|
27186
|
+
readonly getPromotionsForCampaign: readonly [
|
|
27187
|
+
"organizationId",
|
|
27188
|
+
"campaignId",
|
|
27189
|
+
"siteId",
|
|
27190
|
+
"startDate",
|
|
27191
|
+
"endDate",
|
|
27192
|
+
"currency"
|
|
27193
|
+
];
|
|
27194
|
+
readonly getPromotionsForCampaignRequired: readonly [
|
|
27195
|
+
"organizationId",
|
|
27196
|
+
"campaignId",
|
|
27197
|
+
"siteId"
|
|
27198
|
+
];
|
|
27199
|
+
};
|
|
24872
27200
|
/**
|
|
24873
27201
|
* Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
|
|
24874
27202
|
*
|
|
@@ -25395,9 +27723,8 @@ type ShopperSearchParameters = ShopperSearchPathParameters & BaseUriParameters &
|
|
|
25395
27723
|
* API Version: 1.0.40<br />
|
|
25396
27724
|
* Last Updated: <br />
|
|
25397
27725
|
* </span>
|
|
25398
|
-
|
|
25399
27726
|
*
|
|
25400
|
-
|
|
27727
|
+
*
|
|
25401
27728
|
*/
|
|
25402
27729
|
declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & Record<string, unknown>> {
|
|
25403
27730
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -25406,6 +27733,41 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25406
27733
|
};
|
|
25407
27734
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/search/shopper-search/{version}/";
|
|
25408
27735
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
27736
|
+
static readonly paramKeys: {
|
|
27737
|
+
readonly productSearch: readonly [
|
|
27738
|
+
"organizationId",
|
|
27739
|
+
"select",
|
|
27740
|
+
"siteId",
|
|
27741
|
+
"q",
|
|
27742
|
+
"refine",
|
|
27743
|
+
"sort",
|
|
27744
|
+
"currency",
|
|
27745
|
+
"locale",
|
|
27746
|
+
"expand",
|
|
27747
|
+
"allImages",
|
|
27748
|
+
"perPricebook",
|
|
27749
|
+
"allVariationProperties",
|
|
27750
|
+
"offset",
|
|
27751
|
+
"limit"
|
|
27752
|
+
];
|
|
27753
|
+
readonly productSearchRequired: readonly [
|
|
27754
|
+
"organizationId",
|
|
27755
|
+
"siteId"
|
|
27756
|
+
];
|
|
27757
|
+
readonly getSearchSuggestions: readonly [
|
|
27758
|
+
"organizationId",
|
|
27759
|
+
"siteId",
|
|
27760
|
+
"q",
|
|
27761
|
+
"limit",
|
|
27762
|
+
"currency",
|
|
27763
|
+
"locale"
|
|
27764
|
+
];
|
|
27765
|
+
readonly getSearchSuggestionsRequired: readonly [
|
|
27766
|
+
"organizationId",
|
|
27767
|
+
"siteId",
|
|
27768
|
+
"q"
|
|
27769
|
+
];
|
|
27770
|
+
};
|
|
25409
27771
|
/**
|
|
25410
27772
|
* Provides keyword and refinement search functionality for products. Only returns the product ID, link, and name in
|
|
25411
27773
|
the product search hit. The search result contains only products that are online and assigned to site catalog.
|
|
@@ -26231,9 +28593,8 @@ declare namespace ShopperSearchTypes {
|
|
|
26231
28593
|
* API Version: 1.0.40<br />
|
|
26232
28594
|
* Last Updated: <br />
|
|
26233
28595
|
* </span>
|
|
26234
|
-
|
|
26235
28596
|
*
|
|
26236
|
-
|
|
28597
|
+
*
|
|
26237
28598
|
*/
|
|
26238
28599
|
class ShopperSearch<ConfigParameters extends ShopperSearchParameters & Record<string, unknown>> {
|
|
26239
28600
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -26242,6 +28603,41 @@ declare namespace ShopperSearchTypes {
|
|
|
26242
28603
|
};
|
|
26243
28604
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/search/shopper-search/{version}/";
|
|
26244
28605
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
28606
|
+
static readonly paramKeys: {
|
|
28607
|
+
readonly productSearch: readonly [
|
|
28608
|
+
"organizationId",
|
|
28609
|
+
"select",
|
|
28610
|
+
"siteId",
|
|
28611
|
+
"q",
|
|
28612
|
+
"refine",
|
|
28613
|
+
"sort",
|
|
28614
|
+
"currency",
|
|
28615
|
+
"locale",
|
|
28616
|
+
"expand",
|
|
28617
|
+
"allImages",
|
|
28618
|
+
"perPricebook",
|
|
28619
|
+
"allVariationProperties",
|
|
28620
|
+
"offset",
|
|
28621
|
+
"limit"
|
|
28622
|
+
];
|
|
28623
|
+
readonly productSearchRequired: readonly [
|
|
28624
|
+
"organizationId",
|
|
28625
|
+
"siteId"
|
|
28626
|
+
];
|
|
28627
|
+
readonly getSearchSuggestions: readonly [
|
|
28628
|
+
"organizationId",
|
|
28629
|
+
"siteId",
|
|
28630
|
+
"q",
|
|
28631
|
+
"limit",
|
|
28632
|
+
"currency",
|
|
28633
|
+
"locale"
|
|
28634
|
+
];
|
|
28635
|
+
readonly getSearchSuggestionsRequired: readonly [
|
|
28636
|
+
"organizationId",
|
|
28637
|
+
"siteId",
|
|
28638
|
+
"q"
|
|
28639
|
+
];
|
|
28640
|
+
};
|
|
26245
28641
|
/**
|
|
26246
28642
|
* Provides keyword and refinement search functionality for products. Only returns the product ID, link, and name in
|
|
26247
28643
|
the product search hit. The search result contains only products that are online and assigned to site catalog.
|
|
@@ -26598,9 +28994,8 @@ type ShopperSeoParameters = ShopperSeoPathParameters & BaseUriParameters & Shopp
|
|
|
26598
28994
|
* API Version: 1.0.8<br />
|
|
26599
28995
|
* Last Updated: <br />
|
|
26600
28996
|
* </span>
|
|
26601
|
-
|
|
26602
28997
|
*
|
|
26603
|
-
|
|
28998
|
+
*
|
|
26604
28999
|
*/
|
|
26605
29000
|
declare class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<string, unknown>> {
|
|
26606
29001
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -26609,6 +29004,19 @@ declare class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<
|
|
|
26609
29004
|
};
|
|
26610
29005
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/site/shopper-seo/{version}";
|
|
26611
29006
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
29007
|
+
static readonly paramKeys: {
|
|
29008
|
+
readonly getUrlMapping: readonly [
|
|
29009
|
+
"organizationId",
|
|
29010
|
+
"urlSegment",
|
|
29011
|
+
"siteId",
|
|
29012
|
+
"locale"
|
|
29013
|
+
];
|
|
29014
|
+
readonly getUrlMappingRequired: readonly [
|
|
29015
|
+
"organizationId",
|
|
29016
|
+
"urlSegment",
|
|
29017
|
+
"siteId"
|
|
29018
|
+
];
|
|
29019
|
+
};
|
|
26612
29020
|
/**
|
|
26613
29021
|
* Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
|
|
26614
29022
|
*
|
|
@@ -27094,9 +29502,8 @@ declare namespace ShopperSeoTypes {
|
|
|
27094
29502
|
* API Version: 1.0.8<br />
|
|
27095
29503
|
* Last Updated: <br />
|
|
27096
29504
|
* </span>
|
|
27097
|
-
|
|
27098
29505
|
*
|
|
27099
|
-
|
|
29506
|
+
*
|
|
27100
29507
|
*/
|
|
27101
29508
|
class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<string, unknown>> {
|
|
27102
29509
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -27105,6 +29512,19 @@ declare namespace ShopperSeoTypes {
|
|
|
27105
29512
|
};
|
|
27106
29513
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/site/shopper-seo/{version}";
|
|
27107
29514
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
29515
|
+
static readonly paramKeys: {
|
|
29516
|
+
readonly getUrlMapping: readonly [
|
|
29517
|
+
"organizationId",
|
|
29518
|
+
"urlSegment",
|
|
29519
|
+
"siteId",
|
|
29520
|
+
"locale"
|
|
29521
|
+
];
|
|
29522
|
+
readonly getUrlMappingRequired: readonly [
|
|
29523
|
+
"organizationId",
|
|
29524
|
+
"urlSegment",
|
|
29525
|
+
"siteId"
|
|
29526
|
+
];
|
|
29527
|
+
};
|
|
27108
29528
|
/**
|
|
27109
29529
|
* Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
|
|
27110
29530
|
*
|
|
@@ -27371,10 +29791,10 @@ type ShopperStoresParameters = ShopperStoresPathParameters & BaseUriParameters &
|
|
|
27371
29791
|
* API Version: 1.0.13<br />
|
|
27372
29792
|
* Last Updated: <br />
|
|
27373
29793
|
* </span>
|
|
29794
|
+
*
|
|
27374
29795
|
* @beta
|
|
27375
29796
|
*
|
|
27376
29797
|
*
|
|
27377
|
-
|
|
27378
29798
|
*/
|
|
27379
29799
|
declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & Record<string, unknown>> {
|
|
27380
29800
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -27383,6 +29803,36 @@ declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & R
|
|
|
27383
29803
|
};
|
|
27384
29804
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/store/shopper-stores/{version}";
|
|
27385
29805
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
29806
|
+
static readonly paramKeys: {
|
|
29807
|
+
readonly searchStores: readonly [
|
|
29808
|
+
"organizationId",
|
|
29809
|
+
"countryCode",
|
|
29810
|
+
"distanceUnit",
|
|
29811
|
+
"latitude",
|
|
29812
|
+
"longitude",
|
|
29813
|
+
"maxDistance",
|
|
29814
|
+
"postalCode",
|
|
29815
|
+
"siteId",
|
|
29816
|
+
"locale",
|
|
29817
|
+
"offset",
|
|
29818
|
+
"limit"
|
|
29819
|
+
];
|
|
29820
|
+
readonly searchStoresRequired: readonly [
|
|
29821
|
+
"organizationId",
|
|
29822
|
+
"siteId"
|
|
29823
|
+
];
|
|
29824
|
+
readonly getStores: readonly [
|
|
29825
|
+
"organizationId",
|
|
29826
|
+
"siteId",
|
|
29827
|
+
"ids",
|
|
29828
|
+
"locale"
|
|
29829
|
+
];
|
|
29830
|
+
readonly getStoresRequired: readonly [
|
|
29831
|
+
"organizationId",
|
|
29832
|
+
"siteId",
|
|
29833
|
+
"ids"
|
|
29834
|
+
];
|
|
29835
|
+
};
|
|
27386
29836
|
/**
|
|
27387
29837
|
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
|
|
27388
29838
|
*
|
|
@@ -27996,10 +30446,10 @@ declare namespace ShopperStoresTypes {
|
|
|
27996
30446
|
* API Version: 1.0.13<br />
|
|
27997
30447
|
* Last Updated: <br />
|
|
27998
30448
|
* </span>
|
|
30449
|
+
*
|
|
27999
30450
|
* @beta
|
|
28000
30451
|
*
|
|
28001
30452
|
*
|
|
28002
|
-
|
|
28003
30453
|
*/
|
|
28004
30454
|
class ShopperStores<ConfigParameters extends ShopperStoresParameters & Record<string, unknown>> {
|
|
28005
30455
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -28008,6 +30458,36 @@ declare namespace ShopperStoresTypes {
|
|
|
28008
30458
|
};
|
|
28009
30459
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/store/shopper-stores/{version}";
|
|
28010
30460
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
30461
|
+
static readonly paramKeys: {
|
|
30462
|
+
readonly searchStores: readonly [
|
|
30463
|
+
"organizationId",
|
|
30464
|
+
"countryCode",
|
|
30465
|
+
"distanceUnit",
|
|
30466
|
+
"latitude",
|
|
30467
|
+
"longitude",
|
|
30468
|
+
"maxDistance",
|
|
30469
|
+
"postalCode",
|
|
30470
|
+
"siteId",
|
|
30471
|
+
"locale",
|
|
30472
|
+
"offset",
|
|
30473
|
+
"limit"
|
|
30474
|
+
];
|
|
30475
|
+
readonly searchStoresRequired: readonly [
|
|
30476
|
+
"organizationId",
|
|
30477
|
+
"siteId"
|
|
30478
|
+
];
|
|
30479
|
+
readonly getStores: readonly [
|
|
30480
|
+
"organizationId",
|
|
30481
|
+
"siteId",
|
|
30482
|
+
"ids",
|
|
30483
|
+
"locale"
|
|
30484
|
+
];
|
|
30485
|
+
readonly getStoresRequired: readonly [
|
|
30486
|
+
"organizationId",
|
|
30487
|
+
"siteId",
|
|
30488
|
+
"ids"
|
|
30489
|
+
];
|
|
30490
|
+
};
|
|
28011
30491
|
/**
|
|
28012
30492
|
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
|
|
28013
30493
|
*
|
|
@@ -28775,9 +31255,8 @@ declare namespace helpers {
|
|
|
28775
31255
|
* API Version: 1.39.22<br />
|
|
28776
31256
|
* Last Updated: <br />
|
|
28777
31257
|
* </span>
|
|
28778
|
-
|
|
28779
31258
|
*
|
|
28780
|
-
|
|
31259
|
+
*
|
|
28781
31260
|
*/
|
|
28782
31261
|
class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Record<string, unknown>> {
|
|
28783
31262
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -28786,6 +31265,145 @@ declare namespace helpers {
|
|
|
28786
31265
|
};
|
|
28787
31266
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
28788
31267
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
31268
|
+
static readonly paramKeys: {
|
|
31269
|
+
readonly authenticateCustomer: readonly [
|
|
31270
|
+
"organizationId"
|
|
31271
|
+
];
|
|
31272
|
+
readonly authenticateCustomerRequired: readonly [
|
|
31273
|
+
"organizationId"
|
|
31274
|
+
];
|
|
31275
|
+
readonly authorizePasswordlessCustomer: readonly [
|
|
31276
|
+
"organizationId"
|
|
31277
|
+
];
|
|
31278
|
+
readonly authorizePasswordlessCustomerRequired: readonly [
|
|
31279
|
+
"organizationId"
|
|
31280
|
+
];
|
|
31281
|
+
readonly logoutCustomer: readonly [
|
|
31282
|
+
"organizationId",
|
|
31283
|
+
"client_id",
|
|
31284
|
+
"refresh_token",
|
|
31285
|
+
"channel_id",
|
|
31286
|
+
"hint"
|
|
31287
|
+
];
|
|
31288
|
+
readonly logoutCustomerRequired: readonly [
|
|
31289
|
+
"organizationId",
|
|
31290
|
+
"client_id",
|
|
31291
|
+
"refresh_token"
|
|
31292
|
+
];
|
|
31293
|
+
readonly authorizeCustomer: readonly [
|
|
31294
|
+
"organizationId",
|
|
31295
|
+
"redirect_uri",
|
|
31296
|
+
"response_type",
|
|
31297
|
+
"client_id",
|
|
31298
|
+
"scope",
|
|
31299
|
+
"state",
|
|
31300
|
+
"usid",
|
|
31301
|
+
"hint",
|
|
31302
|
+
"channel_id",
|
|
31303
|
+
"code_challenge",
|
|
31304
|
+
"ui_locales"
|
|
31305
|
+
];
|
|
31306
|
+
readonly authorizeCustomerRequired: readonly [
|
|
31307
|
+
"organizationId",
|
|
31308
|
+
"redirect_uri",
|
|
31309
|
+
"response_type",
|
|
31310
|
+
"client_id",
|
|
31311
|
+
"code_challenge"
|
|
31312
|
+
];
|
|
31313
|
+
readonly getAccessToken: readonly [
|
|
31314
|
+
"organizationId"
|
|
31315
|
+
];
|
|
31316
|
+
readonly getAccessTokenRequired: readonly [
|
|
31317
|
+
"organizationId"
|
|
31318
|
+
];
|
|
31319
|
+
readonly getSessionBridgeAccessToken: readonly [
|
|
31320
|
+
"organizationId"
|
|
31321
|
+
];
|
|
31322
|
+
readonly getSessionBridgeAccessTokenRequired: readonly [
|
|
31323
|
+
"organizationId"
|
|
31324
|
+
];
|
|
31325
|
+
readonly getTrustedSystemAccessToken: readonly [
|
|
31326
|
+
"organizationId"
|
|
31327
|
+
];
|
|
31328
|
+
readonly getTrustedSystemAccessTokenRequired: readonly [
|
|
31329
|
+
"organizationId"
|
|
31330
|
+
];
|
|
31331
|
+
readonly getTrustedAgentAuthorizationToken: readonly [
|
|
31332
|
+
"organizationId",
|
|
31333
|
+
"client_id",
|
|
31334
|
+
"channel_id",
|
|
31335
|
+
"code_challenge",
|
|
31336
|
+
"login_id",
|
|
31337
|
+
"idp_origin",
|
|
31338
|
+
"redirect_uri",
|
|
31339
|
+
"response_type"
|
|
31340
|
+
];
|
|
31341
|
+
readonly getTrustedAgentAuthorizationTokenRequired: readonly [
|
|
31342
|
+
"organizationId",
|
|
31343
|
+
"client_id",
|
|
31344
|
+
"channel_id",
|
|
31345
|
+
"code_challenge",
|
|
31346
|
+
"login_id",
|
|
31347
|
+
"idp_origin",
|
|
31348
|
+
"redirect_uri",
|
|
31349
|
+
"response_type"
|
|
31350
|
+
];
|
|
31351
|
+
readonly getTrustedAgentAccessToken: readonly [
|
|
31352
|
+
"organizationId"
|
|
31353
|
+
];
|
|
31354
|
+
readonly getTrustedAgentAccessTokenRequired: readonly [
|
|
31355
|
+
"organizationId"
|
|
31356
|
+
];
|
|
31357
|
+
readonly getPasswordResetToken: readonly [
|
|
31358
|
+
"organizationId"
|
|
31359
|
+
];
|
|
31360
|
+
readonly getPasswordResetTokenRequired: readonly [
|
|
31361
|
+
"organizationId"
|
|
31362
|
+
];
|
|
31363
|
+
readonly resetPassword: readonly [
|
|
31364
|
+
"organizationId"
|
|
31365
|
+
];
|
|
31366
|
+
readonly resetPasswordRequired: readonly [
|
|
31367
|
+
"organizationId"
|
|
31368
|
+
];
|
|
31369
|
+
readonly getPasswordLessAccessToken: readonly [
|
|
31370
|
+
"organizationId"
|
|
31371
|
+
];
|
|
31372
|
+
readonly getPasswordLessAccessTokenRequired: readonly [
|
|
31373
|
+
"organizationId"
|
|
31374
|
+
];
|
|
31375
|
+
readonly revokeToken: readonly [
|
|
31376
|
+
"organizationId"
|
|
31377
|
+
];
|
|
31378
|
+
readonly revokeTokenRequired: readonly [
|
|
31379
|
+
"organizationId"
|
|
31380
|
+
];
|
|
31381
|
+
readonly introspectToken: readonly [
|
|
31382
|
+
"organizationId"
|
|
31383
|
+
];
|
|
31384
|
+
readonly introspectTokenRequired: readonly [
|
|
31385
|
+
"organizationId"
|
|
31386
|
+
];
|
|
31387
|
+
readonly getUserInfo: readonly [
|
|
31388
|
+
"organizationId",
|
|
31389
|
+
"channel_id"
|
|
31390
|
+
];
|
|
31391
|
+
readonly getUserInfoRequired: readonly [
|
|
31392
|
+
"organizationId"
|
|
31393
|
+
];
|
|
31394
|
+
readonly getWellknownOpenidConfiguration: readonly [
|
|
31395
|
+
"organizationId"
|
|
31396
|
+
];
|
|
31397
|
+
readonly getWellknownOpenidConfigurationRequired: readonly [
|
|
31398
|
+
"organizationId"
|
|
31399
|
+
];
|
|
31400
|
+
readonly getJwksUri: readonly [
|
|
31401
|
+
"organizationId"
|
|
31402
|
+
];
|
|
31403
|
+
readonly getJwksUriRequired: readonly [
|
|
31404
|
+
"organizationId"
|
|
31405
|
+
];
|
|
31406
|
+
};
|
|
28789
31407
|
/**
|
|
28790
31408
|
* Logs in a shopper with credentials that are managed by a B2C Commerce instance (ECOM). It follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).
|
|
28791
31409
|
|