commerce-sdk-isomorphic 4.0.1-preview-shopper-test.0 → 4.0.1-preview-shopper-configurations.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.
Files changed (45) hide show
  1. package/lib/helpers.cjs.js +1 -1
  2. package/lib/helpers.js +1 -1
  3. package/lib/index.cjs.d.ts +731 -6
  4. package/lib/index.cjs.js +1 -1
  5. package/lib/index.esm.d.ts +731 -6
  6. package/lib/index.esm.js +1 -1
  7. package/lib/shopperBaskets.cjs.js +1 -1
  8. package/lib/shopperBaskets.js +1 -1
  9. package/lib/shopperBasketsv2.cjs.js +1 -1
  10. package/lib/shopperBasketsv2.js +1 -1
  11. package/lib/shopperConfigurations.cjs.d.ts +601 -0
  12. package/lib/shopperConfigurations.cjs.js +1 -0
  13. package/lib/shopperConfigurations.d.ts +601 -0
  14. package/lib/shopperConfigurations.js +1 -0
  15. package/lib/shopperConsents.cjs.js +1 -1
  16. package/lib/shopperConsents.js +1 -1
  17. package/lib/shopperContext.cjs.js +1 -1
  18. package/lib/shopperContext.js +1 -1
  19. package/lib/shopperCustomers.cjs.d.ts +245 -5
  20. package/lib/shopperCustomers.cjs.js +1 -1
  21. package/lib/shopperCustomers.d.ts +245 -5
  22. package/lib/shopperCustomers.js +1 -1
  23. package/lib/shopperExperience.cjs.js +1 -1
  24. package/lib/shopperExperience.js +1 -1
  25. package/lib/shopperGiftCertificates.cjs.js +1 -1
  26. package/lib/shopperGiftCertificates.js +1 -1
  27. package/lib/shopperLogin.cjs.js +1 -1
  28. package/lib/shopperLogin.js +1 -1
  29. package/lib/shopperOrders.cjs.js +1 -1
  30. package/lib/shopperOrders.js +1 -1
  31. package/lib/shopperProducts.cjs.js +1 -1
  32. package/lib/shopperProducts.js +1 -1
  33. package/lib/shopperPromotions.cjs.js +1 -1
  34. package/lib/shopperPromotions.js +1 -1
  35. package/lib/shopperSearch.cjs.js +1 -1
  36. package/lib/shopperSearch.js +1 -1
  37. package/lib/shopperSeo.cjs.js +1 -1
  38. package/lib/shopperSeo.js +1 -1
  39. package/lib/shopperStores.cjs.js +1 -1
  40. package/lib/shopperStores.js +1 -1
  41. package/lib/version.cjs.d.ts +1 -1
  42. package/lib/version.cjs.js +1 -1
  43. package/lib/version.d.ts +1 -1
  44. package/lib/version.js +1 -1
  45. package/package.json +1 -1
@@ -2124,6 +2124,34 @@ type CustomerPaymentInstrumentRequest = {
2124
2124
  } & {
2125
2125
  [key: string]: any;
2126
2126
  };
2127
+ /**
2128
+ * @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
2129
+ *
2130
+ * @property expirationMonth: The month when the payment card expires.
2131
+ *
2132
+ * @property expirationYear: The year when the payment card expires.
2133
+ *
2134
+ */
2135
+ type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
2136
+ expirationMonth?: number;
2137
+ expirationYear?: number;
2138
+ } & {
2139
+ [key: string]: any;
2140
+ };
2141
+ /**
2142
+ * @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
2143
+ *
2144
+ * @property default: The default payment instrument.
2145
+ *
2146
+ * @property paymentCard:
2147
+ *
2148
+ */
2149
+ type CustomerPaymentInstrumentUpdateRequest = {
2150
+ default?: boolean;
2151
+ paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
2152
+ } & {
2153
+ [key: string]: any;
2154
+ };
2127
2155
  /**
2128
2156
  * @type ProductListEvent: Document representing a product list event.
2129
2157
  *
@@ -2766,6 +2794,14 @@ type updateCustomerPasswordPathParameters = {
2766
2794
  customerId: string;
2767
2795
  organizationId: string;
2768
2796
  };
2797
+ type updateCustomerPaymentInstrumentQueryParameters = {
2798
+ siteId: string;
2799
+ };
2800
+ type updateCustomerPaymentInstrumentPathParameters = {
2801
+ paymentInstrumentId: string;
2802
+ customerId: string;
2803
+ organizationId: string;
2804
+ };
2769
2805
  type updateCustomerProductListQueryParameters = {
2770
2806
  siteId: string;
2771
2807
  };
@@ -2786,11 +2822,11 @@ type updateCustomerProductListItemPathParameters = {
2786
2822
  /**
2787
2823
  * All path parameters that are used by at least one ShopperCustomers method.
2788
2824
  */
2789
- type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
2825
+ type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerPaymentInstrumentPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
2790
2826
  /**
2791
2827
  * All query parameters that are used by at least one ShopperCustomers method.
2792
2828
  */
2793
- type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
2829
+ type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerPaymentInstrumentQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
2794
2830
  /**
2795
2831
  * All parameters that are used by ShopperCustomers.
2796
2832
  */
@@ -2910,6 +2946,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
2910
2946
  updateCustomer: string;
2911
2947
  updateCustomerAddress: string;
2912
2948
  updateCustomerPassword: string;
2949
+ updateCustomerPaymentInstrument: string;
2913
2950
  updateCustomerProductList: string;
2914
2951
  updateCustomerProductListItem: string;
2915
2952
  };
@@ -3212,6 +3249,18 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
3212
3249
  "organizationId",
3213
3250
  "siteId"
3214
3251
  ];
3252
+ readonly updateCustomerPaymentInstrument: readonly [
3253
+ "paymentInstrumentId",
3254
+ "customerId",
3255
+ "organizationId",
3256
+ "siteId"
3257
+ ];
3258
+ readonly updateCustomerPaymentInstrumentRequired: readonly [
3259
+ "paymentInstrumentId",
3260
+ "customerId",
3261
+ "organizationId",
3262
+ "siteId"
3263
+ ];
3215
3264
  readonly updateCustomerProductList: readonly [
3216
3265
  "listId",
3217
3266
  "customerId",
@@ -4646,6 +4695,61 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
4646
4695
  };
4647
4696
  body: PasswordChangeRequest & CustomRequestBody;
4648
4697
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
4698
+ /**
4699
+ *
4700
+ *
4701
+ * If you would like to get a raw Response object use the other updateCustomerPaymentInstrument function.
4702
+ *
4703
+ * @param options - An object containing the options for this method.
4704
+ * @param options.parameters - An object containing the parameters for this method.
4705
+ * @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
4706
+ * @param options.parameters.customerId - The customer ID.
4707
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
4708
+ * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
4709
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
4710
+ * @param options.body - The data to send as the request body.
4711
+ *
4712
+ * @returns A promise of type CustomerPaymentInstrument.
4713
+ */
4714
+ updateCustomerPaymentInstrument(options: RequireParametersUnlessAllAreOptional<{
4715
+ parameters?: CompositeParameters<{
4716
+ paymentInstrumentId: string;
4717
+ customerId: string;
4718
+ organizationId: string;
4719
+ siteId: string;
4720
+ } & QueryParameters, ConfigParameters>;
4721
+ headers?: {
4722
+ [key: string]: string;
4723
+ };
4724
+ body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
4725
+ }>): Promise<CustomerPaymentInstrument>;
4726
+ /**
4727
+ *
4728
+ *
4729
+ * @param options - An object containing the options for this method.
4730
+ * @param options.parameters - An object containing the parameters for this method.
4731
+ * @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
4732
+ * @param options.parameters.customerId - The customer ID.
4733
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
4734
+ * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
4735
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
4736
+ * @param options.body - The data to send as the request body.
4737
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
4738
+ *
4739
+ * @returns A promise of type Response if rawResponse is true, a promise of type CustomerPaymentInstrument otherwise.
4740
+ */
4741
+ updateCustomerPaymentInstrument<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
4742
+ parameters?: CompositeParameters<{
4743
+ paymentInstrumentId: string;
4744
+ customerId: string;
4745
+ organizationId: string;
4746
+ siteId: string;
4747
+ } & QueryParameters, ConfigParameters>;
4748
+ headers?: {
4749
+ [key: string]: string;
4750
+ };
4751
+ body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
4752
+ }>, rawResponse?: T): Promise<T extends true ? Response : CustomerPaymentInstrument>;
4649
4753
  /**
4650
4754
  *
4651
4755
  *
@@ -6910,6 +7014,34 @@ declare namespace ShopperCustomersApiTypes {
6910
7014
  } & {
6911
7015
  [key: string]: any;
6912
7016
  };
7017
+ /**
7018
+ * @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
7019
+ *
7020
+ * @property expirationMonth: The month when the payment card expires.
7021
+ *
7022
+ * @property expirationYear: The year when the payment card expires.
7023
+ *
7024
+ */
7025
+ type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
7026
+ expirationMonth?: number;
7027
+ expirationYear?: number;
7028
+ } & {
7029
+ [key: string]: any;
7030
+ };
7031
+ /**
7032
+ * @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
7033
+ *
7034
+ * @property default: The default payment instrument.
7035
+ *
7036
+ * @property paymentCard:
7037
+ *
7038
+ */
7039
+ type CustomerPaymentInstrumentUpdateRequest = {
7040
+ default?: boolean;
7041
+ paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
7042
+ } & {
7043
+ [key: string]: any;
7044
+ };
6913
7045
  /**
6914
7046
  * @type ProductListEvent: Document representing a product list event.
6915
7047
  *
@@ -7552,6 +7684,14 @@ declare namespace ShopperCustomersApiTypes {
7552
7684
  customerId: string;
7553
7685
  organizationId: string;
7554
7686
  };
7687
+ type updateCustomerPaymentInstrumentQueryParameters = {
7688
+ siteId: string;
7689
+ };
7690
+ type updateCustomerPaymentInstrumentPathParameters = {
7691
+ paymentInstrumentId: string;
7692
+ customerId: string;
7693
+ organizationId: string;
7694
+ };
7555
7695
  type updateCustomerProductListQueryParameters = {
7556
7696
  siteId: string;
7557
7697
  };
@@ -7572,11 +7712,11 @@ declare namespace ShopperCustomersApiTypes {
7572
7712
  /**
7573
7713
  * All path parameters that are used by at least one ShopperCustomers method.
7574
7714
  */
7575
- type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
7715
+ type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerPaymentInstrumentPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
7576
7716
  /**
7577
7717
  * All query parameters that are used by at least one ShopperCustomers method.
7578
7718
  */
7579
- type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
7719
+ type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerPaymentInstrumentQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
7580
7720
  /**
7581
7721
  * All parameters that are used by ShopperCustomers.
7582
7722
  */
@@ -7696,6 +7836,7 @@ declare namespace ShopperCustomersApiTypes {
7696
7836
  updateCustomer: string;
7697
7837
  updateCustomerAddress: string;
7698
7838
  updateCustomerPassword: string;
7839
+ updateCustomerPaymentInstrument: string;
7699
7840
  updateCustomerProductList: string;
7700
7841
  updateCustomerProductListItem: string;
7701
7842
  };
@@ -7998,6 +8139,18 @@ declare namespace ShopperCustomersApiTypes {
7998
8139
  "organizationId",
7999
8140
  "siteId"
8000
8141
  ];
8142
+ readonly updateCustomerPaymentInstrument: readonly [
8143
+ "paymentInstrumentId",
8144
+ "customerId",
8145
+ "organizationId",
8146
+ "siteId"
8147
+ ];
8148
+ readonly updateCustomerPaymentInstrumentRequired: readonly [
8149
+ "paymentInstrumentId",
8150
+ "customerId",
8151
+ "organizationId",
8152
+ "siteId"
8153
+ ];
8001
8154
  readonly updateCustomerProductList: readonly [
8002
8155
  "listId",
8003
8156
  "customerId",
@@ -9432,6 +9585,61 @@ declare namespace ShopperCustomersApiTypes {
9432
9585
  };
9433
9586
  body: PasswordChangeRequest & CustomRequestBody;
9434
9587
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
9588
+ /**
9589
+ *
9590
+ *
9591
+ * If you would like to get a raw Response object use the other updateCustomerPaymentInstrument function.
9592
+ *
9593
+ * @param options - An object containing the options for this method.
9594
+ * @param options.parameters - An object containing the parameters for this method.
9595
+ * @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
9596
+ * @param options.parameters.customerId - The customer ID.
9597
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
9598
+ * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
9599
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
9600
+ * @param options.body - The data to send as the request body.
9601
+ *
9602
+ * @returns A promise of type CustomerPaymentInstrument.
9603
+ */
9604
+ updateCustomerPaymentInstrument(options: RequireParametersUnlessAllAreOptional<{
9605
+ parameters?: CompositeParameters<{
9606
+ paymentInstrumentId: string;
9607
+ customerId: string;
9608
+ organizationId: string;
9609
+ siteId: string;
9610
+ } & QueryParameters, ConfigParameters>;
9611
+ headers?: {
9612
+ [key: string]: string;
9613
+ };
9614
+ body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
9615
+ }>): Promise<CustomerPaymentInstrument>;
9616
+ /**
9617
+ *
9618
+ *
9619
+ * @param options - An object containing the options for this method.
9620
+ * @param options.parameters - An object containing the parameters for this method.
9621
+ * @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
9622
+ * @param options.parameters.customerId - The customer ID.
9623
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
9624
+ * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
9625
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
9626
+ * @param options.body - The data to send as the request body.
9627
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
9628
+ *
9629
+ * @returns A promise of type Response if rawResponse is true, a promise of type CustomerPaymentInstrument otherwise.
9630
+ */
9631
+ updateCustomerPaymentInstrument<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
9632
+ parameters?: CompositeParameters<{
9633
+ paymentInstrumentId: string;
9634
+ customerId: string;
9635
+ organizationId: string;
9636
+ siteId: string;
9637
+ } & QueryParameters, ConfigParameters>;
9638
+ headers?: {
9639
+ [key: string]: string;
9640
+ };
9641
+ body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
9642
+ }>, rawResponse?: T): Promise<T extends true ? Response : CustomerPaymentInstrument>;
9435
9643
  /**
9436
9644
  *
9437
9645
  *
@@ -11589,6 +11797,34 @@ declare namespace ShopperCustomersModelTypes {
11589
11797
  } & {
11590
11798
  [key: string]: any;
11591
11799
  };
11800
+ /**
11801
+ * @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
11802
+ *
11803
+ * @property expirationMonth: The month when the payment card expires.
11804
+ *
11805
+ * @property expirationYear: The year when the payment card expires.
11806
+ *
11807
+ */
11808
+ type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
11809
+ expirationMonth?: number;
11810
+ expirationYear?: number;
11811
+ } & {
11812
+ [key: string]: any;
11813
+ };
11814
+ /**
11815
+ * @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
11816
+ *
11817
+ * @property default: The default payment instrument.
11818
+ *
11819
+ * @property paymentCard:
11820
+ *
11821
+ */
11822
+ type CustomerPaymentInstrumentUpdateRequest = {
11823
+ default?: boolean;
11824
+ paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
11825
+ } & {
11826
+ [key: string]: any;
11827
+ };
11592
11828
  /**
11593
11829
  * @type ProductListEvent: Document representing a product list event.
11594
11830
  *
@@ -12082,6 +12318,8 @@ declare namespace ShopperCustomersTypes {
12082
12318
  type updateCustomerAddressPathParameters = ShopperCustomersApiTypes.updateCustomerAddressPathParameters;
12083
12319
  type updateCustomerPasswordQueryParameters = ShopperCustomersApiTypes.updateCustomerPasswordQueryParameters;
12084
12320
  type updateCustomerPasswordPathParameters = ShopperCustomersApiTypes.updateCustomerPasswordPathParameters;
12321
+ type updateCustomerPaymentInstrumentQueryParameters = ShopperCustomersApiTypes.updateCustomerPaymentInstrumentQueryParameters;
12322
+ type updateCustomerPaymentInstrumentPathParameters = ShopperCustomersApiTypes.updateCustomerPaymentInstrumentPathParameters;
12085
12323
  type updateCustomerProductListQueryParameters = ShopperCustomersApiTypes.updateCustomerProductListQueryParameters;
12086
12324
  type updateCustomerProductListPathParameters = ShopperCustomersApiTypes.updateCustomerProductListPathParameters;
12087
12325
  type updateCustomerProductListItemQueryParameters = ShopperCustomersApiTypes.updateCustomerProductListItemQueryParameters;
@@ -12106,6 +12344,8 @@ declare namespace ShopperCustomersTypes {
12106
12344
  type CustomerPaymentCardRequest = ShopperCustomersModelTypes.CustomerPaymentCardRequest;
12107
12345
  type CustomerPaymentInstrument = ShopperCustomersModelTypes.CustomerPaymentInstrument;
12108
12346
  type CustomerPaymentInstrumentRequest = ShopperCustomersModelTypes.CustomerPaymentInstrumentRequest;
12347
+ type CustomerPaymentInstrumentUpdateRequest = ShopperCustomersModelTypes.CustomerPaymentInstrumentUpdateRequest;
12348
+ type CustomerPaymentInstrumentUpdateRequestPaymentCard = ShopperCustomersModelTypes.CustomerPaymentInstrumentUpdateRequestPaymentCard;
12109
12349
  type CustomerProductList = ShopperCustomersModelTypes.CustomerProductList;
12110
12350
  type CustomerProductListTypeEnum = ShopperCustomersModelTypes.CustomerProductListTypeEnum;
12111
12351
  type CustomerProductListItem = ShopperCustomersModelTypes.CustomerProductListItem;
@@ -12182,4 +12422,4 @@ declare namespace ShopperCustomersTypes {
12182
12422
  type VariationAttributeValue = ShopperCustomersModelTypes.VariationAttributeValue;
12183
12423
  type VariationGroup = ShopperCustomersModelTypes.VariationGroup;
12184
12424
  }
12185
- export { defaultBaseUri, createCustomerAddressQueryParameters, createCustomerAddressPathParameters, createCustomerPaymentInstrumentQueryParameters, createCustomerPaymentInstrumentPathParameters, createCustomerProductListQueryParameters, createCustomerProductListPathParameters, createCustomerProductListItemQueryParameters, createCustomerProductListItemPathParameters, deleteCustomerPaymentInstrumentQueryParameters, deleteCustomerPaymentInstrumentPathParameters, deleteCustomerProductListQueryParameters, deleteCustomerProductListPathParameters, deleteCustomerProductListItemQueryParameters, deleteCustomerProductListItemPathParameters, getCustomerQueryParameters, getCustomerPathParameters, getCustomerAddressQueryParameters, getCustomerAddressPathParameters, getCustomerBasketsQueryParameters, getCustomerBasketsPathParameters, getCustomerOrdersQueryParameters, getCustomerOrdersPathParameters, getCustomerPaymentInstrumentQueryParameters, getCustomerPaymentInstrumentPathParameters, getCustomerProductListQueryParameters, getCustomerProductListPathParameters, getCustomerProductListItemQueryParameters, getCustomerProductListItemPathParameters, getCustomerProductListsQueryParameters, getCustomerProductListsPathParameters, getExternalProfileQueryParameters, getExternalProfilePathParameters, getProductListItemQueryParameters, getProductListItemPathParameters, getPublicProductListQueryParameters, getPublicProductListPathParameters, getPublicProductListsBySearchTermQueryParameters, getPublicProductListsBySearchTermPathParameters, getResetPasswordTokenQueryParameters, getResetPasswordTokenPathParameters, registerCustomerQueryParameters, registerCustomerPathParameters, registerExternalProfileQueryParameters, registerExternalProfilePathParameters, removeCustomerAddressQueryParameters, removeCustomerAddressPathParameters, resetPasswordQueryParameters, resetPasswordPathParameters, updateCustomerQueryParameters, updateCustomerPathParameters, updateCustomerAddressQueryParameters, updateCustomerAddressPathParameters, updateCustomerPasswordQueryParameters, updateCustomerPasswordPathParameters, updateCustomerProductListQueryParameters, updateCustomerProductListPathParameters, updateCustomerProductListItemQueryParameters, updateCustomerProductListItemPathParameters, ShopperCustomersPathParameters, ShopperCustomersQueryParameters, ShopperCustomersParameters, ShopperCustomers, Basket, BasketChannelTypeEnum, BasketTaxationEnum, BasketsResult, BonusDiscountLineItem, BundledProduct, CouponItem, CouponItemStatusCodeEnum, CurrencyCode, Customer, CustomerAuthTypeEnum, CustomerAddress, CustomerAddressInfo, CustomerExtProfileRequest, CustomerExternalProfile, CustomerInfo, CustomerOrderResult, CustomerPaymentCardRequest, CustomerPaymentInstrument, CustomerPaymentInstrumentRequest, CustomerProductList, CustomerProductListTypeEnum, CustomerProductListItem, CustomerProductListItemTypeEnum, CustomerProductListRegistrant, CustomerProductListResult, CustomerRegistration, Discount, DiscountTypeEnum, ErrorResponse, GiftCertificateItem, GroupedTaxItem, Image, ImageGroup, Inventory, Master, NoValue, Option, OptionItem, OptionValue, Order, OrderChannelTypeEnum, OrderConfirmationStatusEnum, OrderExportStatusEnum, OrderPaymentStatusEnum, OrderShippingStatusEnum, OrderStatusEnum, OrderTaxationEnum, OrderAddress, OrderPaymentInstrument, PageMetaTag, PaginatedResultBase, PasswordChangeRequest, PaymentBankAccountRequest, PaymentCard, PriceAdjustment, PriceRange, Product, ProductDetailsLink, ProductItem, ProductLink, ProductLinkTypeEnum, ProductListEvent, ProductListItemReference, ProductListItemReferenceTypeEnum, ProductListLink, ProductListLinkTypeEnum, ProductListRegistrant, ProductListShippingAddress, ProductPriceTable, ProductPromotion, ProductType, PublicProductList, PublicProductListTypeEnum, PublicProductListInfo, PublicProductListInfoTypeEnum, PublicProductListItem, PublicProductListItemTypeEnum, PublicProductListResult, Recommendation, RecommendationType, ResetPasswordRequest, ResetPasswordToken, ResetPasswordTokenRequest, ResultBase, Shipment, ShipmentShippingStatusEnum, ShippingItem, ShippingMethod, ShippingPromotion, Status, Variant, VariationAttribute, VariationAttributeValue, VariationGroup, ShopperCustomersTypes };
12425
+ export { defaultBaseUri, createCustomerAddressQueryParameters, createCustomerAddressPathParameters, createCustomerPaymentInstrumentQueryParameters, createCustomerPaymentInstrumentPathParameters, createCustomerProductListQueryParameters, createCustomerProductListPathParameters, createCustomerProductListItemQueryParameters, createCustomerProductListItemPathParameters, deleteCustomerPaymentInstrumentQueryParameters, deleteCustomerPaymentInstrumentPathParameters, deleteCustomerProductListQueryParameters, deleteCustomerProductListPathParameters, deleteCustomerProductListItemQueryParameters, deleteCustomerProductListItemPathParameters, getCustomerQueryParameters, getCustomerPathParameters, getCustomerAddressQueryParameters, getCustomerAddressPathParameters, getCustomerBasketsQueryParameters, getCustomerBasketsPathParameters, getCustomerOrdersQueryParameters, getCustomerOrdersPathParameters, getCustomerPaymentInstrumentQueryParameters, getCustomerPaymentInstrumentPathParameters, getCustomerProductListQueryParameters, getCustomerProductListPathParameters, getCustomerProductListItemQueryParameters, getCustomerProductListItemPathParameters, getCustomerProductListsQueryParameters, getCustomerProductListsPathParameters, getExternalProfileQueryParameters, getExternalProfilePathParameters, getProductListItemQueryParameters, getProductListItemPathParameters, getPublicProductListQueryParameters, getPublicProductListPathParameters, getPublicProductListsBySearchTermQueryParameters, getPublicProductListsBySearchTermPathParameters, getResetPasswordTokenQueryParameters, getResetPasswordTokenPathParameters, registerCustomerQueryParameters, registerCustomerPathParameters, registerExternalProfileQueryParameters, registerExternalProfilePathParameters, removeCustomerAddressQueryParameters, removeCustomerAddressPathParameters, resetPasswordQueryParameters, resetPasswordPathParameters, updateCustomerQueryParameters, updateCustomerPathParameters, updateCustomerAddressQueryParameters, updateCustomerAddressPathParameters, updateCustomerPasswordQueryParameters, updateCustomerPasswordPathParameters, updateCustomerPaymentInstrumentQueryParameters, updateCustomerPaymentInstrumentPathParameters, updateCustomerProductListQueryParameters, updateCustomerProductListPathParameters, updateCustomerProductListItemQueryParameters, updateCustomerProductListItemPathParameters, ShopperCustomersPathParameters, ShopperCustomersQueryParameters, ShopperCustomersParameters, ShopperCustomers, Basket, BasketChannelTypeEnum, BasketTaxationEnum, BasketsResult, BonusDiscountLineItem, BundledProduct, CouponItem, CouponItemStatusCodeEnum, CurrencyCode, Customer, CustomerAuthTypeEnum, CustomerAddress, CustomerAddressInfo, CustomerExtProfileRequest, CustomerExternalProfile, CustomerInfo, CustomerOrderResult, CustomerPaymentCardRequest, CustomerPaymentInstrument, CustomerPaymentInstrumentRequest, CustomerPaymentInstrumentUpdateRequest, CustomerPaymentInstrumentUpdateRequestPaymentCard, CustomerProductList, CustomerProductListTypeEnum, CustomerProductListItem, CustomerProductListItemTypeEnum, CustomerProductListRegistrant, CustomerProductListResult, CustomerRegistration, Discount, DiscountTypeEnum, ErrorResponse, GiftCertificateItem, GroupedTaxItem, Image, ImageGroup, Inventory, Master, NoValue, Option, OptionItem, OptionValue, Order, OrderChannelTypeEnum, OrderConfirmationStatusEnum, OrderExportStatusEnum, OrderPaymentStatusEnum, OrderShippingStatusEnum, OrderStatusEnum, OrderTaxationEnum, OrderAddress, OrderPaymentInstrument, PageMetaTag, PaginatedResultBase, PasswordChangeRequest, PaymentBankAccountRequest, PaymentCard, PriceAdjustment, PriceRange, Product, ProductDetailsLink, ProductItem, ProductLink, ProductLinkTypeEnum, ProductListEvent, ProductListItemReference, ProductListItemReferenceTypeEnum, ProductListLink, ProductListLinkTypeEnum, ProductListRegistrant, ProductListShippingAddress, ProductPriceTable, ProductPromotion, ProductType, PublicProductList, PublicProductListTypeEnum, PublicProductListInfo, PublicProductListInfoTypeEnum, PublicProductListItem, PublicProductListItemTypeEnum, PublicProductListResult, Recommendation, RecommendationType, ResetPasswordRequest, ResetPasswordToken, ResetPasswordTokenRequest, ResultBase, Shipment, ShipmentShippingStatusEnum, ShippingItem, ShippingMethod, ShippingPromotion, Status, Variant, VariationAttribute, VariationAttributeValue, VariationGroup, ShopperCustomersTypes };