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.
- package/lib/helpers.cjs.js +1 -1
- package/lib/helpers.js +1 -1
- package/lib/index.cjs.d.ts +731 -6
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +731 -6
- package/lib/index.esm.js +1 -1
- package/lib/shopperBaskets.cjs.js +1 -1
- package/lib/shopperBaskets.js +1 -1
- package/lib/shopperBasketsv2.cjs.js +1 -1
- package/lib/shopperBasketsv2.js +1 -1
- package/lib/shopperConfigurations.cjs.d.ts +601 -0
- package/lib/shopperConfigurations.cjs.js +1 -0
- package/lib/shopperConfigurations.d.ts +601 -0
- package/lib/shopperConfigurations.js +1 -0
- package/lib/shopperConsents.cjs.js +1 -1
- package/lib/shopperConsents.js +1 -1
- package/lib/shopperContext.cjs.js +1 -1
- package/lib/shopperContext.js +1 -1
- package/lib/shopperCustomers.cjs.d.ts +245 -5
- package/lib/shopperCustomers.cjs.js +1 -1
- package/lib/shopperCustomers.d.ts +245 -5
- package/lib/shopperCustomers.js +1 -1
- package/lib/shopperExperience.cjs.js +1 -1
- package/lib/shopperExperience.js +1 -1
- package/lib/shopperGiftCertificates.cjs.js +1 -1
- package/lib/shopperGiftCertificates.js +1 -1
- package/lib/shopperLogin.cjs.js +1 -1
- package/lib/shopperLogin.js +1 -1
- package/lib/shopperOrders.cjs.js +1 -1
- package/lib/shopperOrders.js +1 -1
- package/lib/shopperProducts.cjs.js +1 -1
- package/lib/shopperProducts.js +1 -1
- package/lib/shopperPromotions.cjs.js +1 -1
- package/lib/shopperPromotions.js +1 -1
- package/lib/shopperSearch.cjs.js +1 -1
- package/lib/shopperSearch.js +1 -1
- package/lib/shopperSeo.cjs.js +1 -1
- package/lib/shopperSeo.js +1 -1
- package/lib/shopperStores.cjs.js +1 -1
- package/lib/shopperStores.js +1 -1
- package/lib/version.cjs.d.ts +1 -1
- package/lib/version.cjs.js +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +1 -1
package/lib/index.esm.d.ts
CHANGED
|
@@ -20570,6 +20570,490 @@ declare namespace ShopperBasketsV2Types {
|
|
|
20570
20570
|
type TaxItems = ShopperBasketsV2ModelTypes.TaxItems;
|
|
20571
20571
|
type Taxes = ShopperBasketsV2ModelTypes.Taxes;
|
|
20572
20572
|
}
|
|
20573
|
+
/**
|
|
20574
|
+
* @type ModelConfiguration: Configuration object
|
|
20575
|
+
*
|
|
20576
|
+
* @property id: identifier
|
|
20577
|
+
* - **Max Length:** 255
|
|
20578
|
+
*
|
|
20579
|
+
* @property value: value for identifier
|
|
20580
|
+
* - **Max Length:** 255
|
|
20581
|
+
*
|
|
20582
|
+
* @property configurationType: type of configuration value
|
|
20583
|
+
* - **Max Length:** 255
|
|
20584
|
+
*
|
|
20585
|
+
*/
|
|
20586
|
+
type ModelConfiguration = {
|
|
20587
|
+
id: string;
|
|
20588
|
+
value: any | null;
|
|
20589
|
+
configurationType?: string;
|
|
20590
|
+
} & {
|
|
20591
|
+
[key: string]: any;
|
|
20592
|
+
};
|
|
20593
|
+
/**
|
|
20594
|
+
* @type SiteConfiguration: Site Configuration object
|
|
20595
|
+
*
|
|
20596
|
+
* @property configurations: List configurations for the instance and site
|
|
20597
|
+
*
|
|
20598
|
+
*/
|
|
20599
|
+
type SiteConfiguration = {
|
|
20600
|
+
configurations: Array<ModelConfiguration>;
|
|
20601
|
+
} & {
|
|
20602
|
+
[key: string]: any;
|
|
20603
|
+
};
|
|
20604
|
+
type getConfigurationsQueryParameters = {
|
|
20605
|
+
siteId: string;
|
|
20606
|
+
};
|
|
20607
|
+
type getConfigurationsPathParameters = {
|
|
20608
|
+
organizationId: string;
|
|
20609
|
+
};
|
|
20610
|
+
/**
|
|
20611
|
+
* All path parameters that are used by at least one ShopperConfigurations method.
|
|
20612
|
+
*/
|
|
20613
|
+
type ShopperConfigurationsPathParameters = Partial<getConfigurationsPathParameters & {}>;
|
|
20614
|
+
/**
|
|
20615
|
+
* All query parameters that are used by at least one ShopperConfigurations method.
|
|
20616
|
+
*/
|
|
20617
|
+
type ShopperConfigurationsQueryParameters = Partial<getConfigurationsQueryParameters & {}>;
|
|
20618
|
+
/**
|
|
20619
|
+
* All parameters that are used by ShopperConfigurations.
|
|
20620
|
+
*/
|
|
20621
|
+
type ShopperConfigurationsParameters = ShopperConfigurationsPathParameters & BaseUriParameters & ShopperConfigurationsQueryParameters;
|
|
20622
|
+
/**
|
|
20623
|
+
* [Shopper Configurations](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-configurations:Summary)
|
|
20624
|
+
* ==================================
|
|
20625
|
+
*
|
|
20626
|
+
* *<shopper-configurations-description.md>*<br />
|
|
20627
|
+
*
|
|
20628
|
+
* Simple example:
|
|
20629
|
+
*
|
|
20630
|
+
* ```typescript
|
|
20631
|
+
* import { ShopperConfigurations } from "commerce-sdk-isomorphic";
|
|
20632
|
+
*
|
|
20633
|
+
* const clientConfig = {
|
|
20634
|
+
* parameters: {
|
|
20635
|
+
* clientId: "XXXXXX",
|
|
20636
|
+
* organizationId: "XXXX",
|
|
20637
|
+
* shortCode: "XXX",
|
|
20638
|
+
* siteId: "XX"
|
|
20639
|
+
* }
|
|
20640
|
+
* };
|
|
20641
|
+
* const shopperConfigurationsClient = new ShopperConfigurations(clientConfig);
|
|
20642
|
+
* ```
|
|
20643
|
+
*
|
|
20644
|
+
* <span style="font-size:.7em; display:block; text-align: right">
|
|
20645
|
+
* API Version: 0.0.33<br />
|
|
20646
|
+
* Last Updated: <br />
|
|
20647
|
+
* </span>
|
|
20648
|
+
*
|
|
20649
|
+
*
|
|
20650
|
+
*/
|
|
20651
|
+
declare class ShopperConfigurations<ConfigParameters extends ShopperConfigurationsParameters & Record<string, unknown>> {
|
|
20652
|
+
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
20653
|
+
clientConfig: ClientConfig<ConfigParameters> & {
|
|
20654
|
+
baseUri: string;
|
|
20655
|
+
};
|
|
20656
|
+
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/configuration/shopper-configurations/v1";
|
|
20657
|
+
static readonly apiPaths: {
|
|
20658
|
+
getConfigurations: string;
|
|
20659
|
+
};
|
|
20660
|
+
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
20661
|
+
static readonly paramKeys: {
|
|
20662
|
+
readonly getConfigurations: readonly [
|
|
20663
|
+
"organizationId",
|
|
20664
|
+
"siteId"
|
|
20665
|
+
];
|
|
20666
|
+
readonly getConfigurationsRequired: readonly [
|
|
20667
|
+
"organizationId",
|
|
20668
|
+
"siteId"
|
|
20669
|
+
];
|
|
20670
|
+
};
|
|
20671
|
+
/**
|
|
20672
|
+
* Retrieves configurations for the specified organization and site.
|
|
20673
|
+
*
|
|
20674
|
+
* If you would like to get a raw Response object use the other getConfigurations function.
|
|
20675
|
+
*
|
|
20676
|
+
* @param options - An object containing the options for this method.
|
|
20677
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
20678
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
20679
|
+
* @param options.parameters.siteId - The identifier of the site that a request is being made in the context of.
|
|
20680
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
20681
|
+
*
|
|
20682
|
+
* @returns A promise of type SiteConfiguration.
|
|
20683
|
+
*/
|
|
20684
|
+
getConfigurations(options?: RequireParametersUnlessAllAreOptional<{
|
|
20685
|
+
parameters?: CompositeParameters<{
|
|
20686
|
+
organizationId: string;
|
|
20687
|
+
siteId: string;
|
|
20688
|
+
} & QueryParameters, ConfigParameters>;
|
|
20689
|
+
headers?: {
|
|
20690
|
+
[key: string]: string;
|
|
20691
|
+
};
|
|
20692
|
+
}>): Promise<SiteConfiguration>;
|
|
20693
|
+
/**
|
|
20694
|
+
* Retrieves configurations for the specified organization and site.
|
|
20695
|
+
*
|
|
20696
|
+
* @param options - An object containing the options for this method.
|
|
20697
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
20698
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
20699
|
+
* @param options.parameters.siteId - The identifier of the site that a request is being made in the context of.
|
|
20700
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
20701
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
20702
|
+
*
|
|
20703
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type SiteConfiguration otherwise.
|
|
20704
|
+
*/
|
|
20705
|
+
getConfigurations<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
20706
|
+
parameters?: CompositeParameters<{
|
|
20707
|
+
organizationId: string;
|
|
20708
|
+
siteId: string;
|
|
20709
|
+
} & QueryParameters, ConfigParameters>;
|
|
20710
|
+
headers?: {
|
|
20711
|
+
[key: string]: string;
|
|
20712
|
+
};
|
|
20713
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : SiteConfiguration>;
|
|
20714
|
+
}
|
|
20715
|
+
declare namespace ShopperConfigurationsApiTypes {
|
|
20716
|
+
/*
|
|
20717
|
+
* Copyright (c) 2023, Salesforce, Inc.
|
|
20718
|
+
* All rights reserved.
|
|
20719
|
+
* SPDX-License-Identifier: BSD-3-Clause
|
|
20720
|
+
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
20721
|
+
*/
|
|
20722
|
+
/**
|
|
20723
|
+
* Makes a type easier to read.
|
|
20724
|
+
*/
|
|
20725
|
+
type Prettify<T> = NonNullable<{
|
|
20726
|
+
[K in keyof T]: T[K];
|
|
20727
|
+
}>;
|
|
20728
|
+
/**
|
|
20729
|
+
* Generates the types required on a method, based on those provided in the config.
|
|
20730
|
+
*/
|
|
20731
|
+
type CompositeParameters<MethodParameters extends Record<string, unknown>, ConfigParameters extends Record<string, unknown>> = Prettify<Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>>;
|
|
20732
|
+
/**
|
|
20733
|
+
* If an object has a `parameters` property, and the `parameters` object has required properties,
|
|
20734
|
+
* then the `parameters` property on the root object is marked as required.
|
|
20735
|
+
*/
|
|
20736
|
+
type RequireParametersUnlessAllAreOptional<T extends {
|
|
20737
|
+
parameters?: Record<string, unknown>;
|
|
20738
|
+
}> = Record<string, never> extends NonNullable<T["parameters"]> ? T : Prettify<T & Required<Pick<T, "parameters">>>;
|
|
20739
|
+
/**
|
|
20740
|
+
* Template parameters used in the base URI of all API endpoints. `version` will default to `"v1"`
|
|
20741
|
+
* if not specified.
|
|
20742
|
+
*/
|
|
20743
|
+
interface BaseUriParameters {
|
|
20744
|
+
shortCode: string;
|
|
20745
|
+
}
|
|
20746
|
+
type LocaleCode = {
|
|
20747
|
+
[key: string]: any;
|
|
20748
|
+
};
|
|
20749
|
+
/**
|
|
20750
|
+
* Generic interface for path parameters.
|
|
20751
|
+
*/
|
|
20752
|
+
interface PathParameters {
|
|
20753
|
+
[key: string]: string | number | boolean;
|
|
20754
|
+
}
|
|
20755
|
+
/**
|
|
20756
|
+
* Generic interface for query parameters.
|
|
20757
|
+
*/
|
|
20758
|
+
interface QueryParameters {
|
|
20759
|
+
[key: string]: string | number | boolean | string[] | number[] | LocaleCode;
|
|
20760
|
+
}
|
|
20761
|
+
/**
|
|
20762
|
+
* Generic interface for all parameter types.
|
|
20763
|
+
*/
|
|
20764
|
+
type UrlParameters = PathParameters | QueryParameters;
|
|
20765
|
+
/**
|
|
20766
|
+
* Custom query parameter type with any string prefixed with `c_` as the key and the allowed
|
|
20767
|
+
* types for query parameters for the value.
|
|
20768
|
+
*/
|
|
20769
|
+
type CustomQueryParameters = {
|
|
20770
|
+
[key in `c_${string}`]: string | number | boolean | string[] | number[];
|
|
20771
|
+
};
|
|
20772
|
+
/**
|
|
20773
|
+
* Custom body request type with any string prefixed with `c_` as the key and the allowed
|
|
20774
|
+
* types for the value.
|
|
20775
|
+
*/
|
|
20776
|
+
type CustomRequestBody = {
|
|
20777
|
+
[key in `c_${string}`]: string | number | boolean | string[] | number[] | {
|
|
20778
|
+
[key: string]: unknown;
|
|
20779
|
+
};
|
|
20780
|
+
};
|
|
20781
|
+
/**
|
|
20782
|
+
* Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
|
|
20783
|
+
* it from the `RequestInit` provided by node-fetch.
|
|
20784
|
+
*/
|
|
20785
|
+
type BrowserRequestInit = RequestInit;
|
|
20786
|
+
/**
|
|
20787
|
+
* Any properties supported in either the browser or node are accepted.
|
|
20788
|
+
* Using the right properties in the right context is left to the user.
|
|
20789
|
+
*/
|
|
20790
|
+
type FetchOptions = NodeRequestInit & BrowserRequestInit;
|
|
20791
|
+
/**
|
|
20792
|
+
* Base options that can be passed to the `ClientConfig` class.
|
|
20793
|
+
*/
|
|
20794
|
+
interface ClientConfigInit<Params extends BaseUriParameters> {
|
|
20795
|
+
baseUri?: string;
|
|
20796
|
+
proxy?: string;
|
|
20797
|
+
headers?: {
|
|
20798
|
+
[key: string]: string;
|
|
20799
|
+
};
|
|
20800
|
+
parameters: Params;
|
|
20801
|
+
fetchOptions?: FetchOptions;
|
|
20802
|
+
transformRequest?: (data: unknown, headers: {
|
|
20803
|
+
[key: string]: string;
|
|
20804
|
+
}) => Required<FetchOptions>["body"];
|
|
20805
|
+
throwOnBadResponse?: boolean;
|
|
20806
|
+
}
|
|
20807
|
+
type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
|
|
20808
|
+
/**
|
|
20809
|
+
* Configuration parameters common to Commerce SDK clients
|
|
20810
|
+
*/
|
|
20811
|
+
class ClientConfig<Params extends BaseUriParameters> implements ClientConfigInit<Params> {
|
|
20812
|
+
baseUri?: string;
|
|
20813
|
+
proxy?: string;
|
|
20814
|
+
headers: {
|
|
20815
|
+
[key: string]: string;
|
|
20816
|
+
};
|
|
20817
|
+
parameters: Params;
|
|
20818
|
+
fetchOptions: FetchOptions;
|
|
20819
|
+
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
20820
|
+
throwOnBadResponse: boolean;
|
|
20821
|
+
constructor(config: ClientConfigInit<Params>);
|
|
20822
|
+
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
20823
|
+
}
|
|
20824
|
+
/**
|
|
20825
|
+
* @type ErrorResponse:
|
|
20826
|
+
*
|
|
20827
|
+
* @property title: A short, human-readable summary of the problem type.
|
|
20828
|
+
* - **Max Length:** 256
|
|
20829
|
+
*
|
|
20830
|
+
* @property type: A URI reference that identifies the problem type.
|
|
20831
|
+
* - **Max Length:** 2048
|
|
20832
|
+
*
|
|
20833
|
+
* @property detail: A human-readable explanation specific to this occurrence of the problem.
|
|
20834
|
+
*
|
|
20835
|
+
* @property instance: A URI reference that identifies the specific occurrence of the problem.
|
|
20836
|
+
* - **Max Length:** 2048
|
|
20837
|
+
*
|
|
20838
|
+
*/
|
|
20839
|
+
type ErrorResponse = {
|
|
20840
|
+
title: string;
|
|
20841
|
+
type: string;
|
|
20842
|
+
detail: string;
|
|
20843
|
+
instance?: string;
|
|
20844
|
+
} & {
|
|
20845
|
+
[key: string]: any;
|
|
20846
|
+
};
|
|
20847
|
+
/**
|
|
20848
|
+
* @type ModelConfiguration: Configuration object
|
|
20849
|
+
*
|
|
20850
|
+
* @property id: identifier
|
|
20851
|
+
* - **Max Length:** 255
|
|
20852
|
+
*
|
|
20853
|
+
* @property value: value for identifier
|
|
20854
|
+
* - **Max Length:** 255
|
|
20855
|
+
*
|
|
20856
|
+
* @property configurationType: type of configuration value
|
|
20857
|
+
* - **Max Length:** 255
|
|
20858
|
+
*
|
|
20859
|
+
*/
|
|
20860
|
+
type ModelConfiguration = {
|
|
20861
|
+
id: string;
|
|
20862
|
+
value: any | null;
|
|
20863
|
+
configurationType?: string;
|
|
20864
|
+
} & {
|
|
20865
|
+
[key: string]: any;
|
|
20866
|
+
};
|
|
20867
|
+
/**
|
|
20868
|
+
* @type SiteConfiguration: Site Configuration object
|
|
20869
|
+
*
|
|
20870
|
+
* @property configurations: List configurations for the instance and site
|
|
20871
|
+
*
|
|
20872
|
+
*/
|
|
20873
|
+
type SiteConfiguration = {
|
|
20874
|
+
configurations: Array<ModelConfiguration>;
|
|
20875
|
+
} & {
|
|
20876
|
+
[key: string]: any;
|
|
20877
|
+
};
|
|
20878
|
+
type getConfigurationsQueryParameters = {
|
|
20879
|
+
siteId: string;
|
|
20880
|
+
};
|
|
20881
|
+
type getConfigurationsPathParameters = {
|
|
20882
|
+
organizationId: string;
|
|
20883
|
+
};
|
|
20884
|
+
/**
|
|
20885
|
+
* All path parameters that are used by at least one ShopperConfigurations method.
|
|
20886
|
+
*/
|
|
20887
|
+
type ShopperConfigurationsPathParameters = Partial<getConfigurationsPathParameters & {}>;
|
|
20888
|
+
/**
|
|
20889
|
+
* All query parameters that are used by at least one ShopperConfigurations method.
|
|
20890
|
+
*/
|
|
20891
|
+
type ShopperConfigurationsQueryParameters = Partial<getConfigurationsQueryParameters & {}>;
|
|
20892
|
+
/**
|
|
20893
|
+
* All parameters that are used by ShopperConfigurations.
|
|
20894
|
+
*/
|
|
20895
|
+
type ShopperConfigurationsParameters = ShopperConfigurationsPathParameters & BaseUriParameters & ShopperConfigurationsQueryParameters;
|
|
20896
|
+
/**
|
|
20897
|
+
* [Shopper Configurations](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-configurations:Summary)
|
|
20898
|
+
* ==================================
|
|
20899
|
+
*
|
|
20900
|
+
* *<shopper-configurations-description.md>*<br />
|
|
20901
|
+
*
|
|
20902
|
+
* Simple example:
|
|
20903
|
+
*
|
|
20904
|
+
* ```typescript
|
|
20905
|
+
* import { ShopperConfigurations } from "commerce-sdk-isomorphic";
|
|
20906
|
+
*
|
|
20907
|
+
* const clientConfig = {
|
|
20908
|
+
* parameters: {
|
|
20909
|
+
* clientId: "XXXXXX",
|
|
20910
|
+
* organizationId: "XXXX",
|
|
20911
|
+
* shortCode: "XXX",
|
|
20912
|
+
* siteId: "XX"
|
|
20913
|
+
* }
|
|
20914
|
+
* };
|
|
20915
|
+
* const shopperConfigurationsClient = new ShopperConfigurations(clientConfig);
|
|
20916
|
+
* ```
|
|
20917
|
+
*
|
|
20918
|
+
* <span style="font-size:.7em; display:block; text-align: right">
|
|
20919
|
+
* API Version: 0.0.33<br />
|
|
20920
|
+
* Last Updated: <br />
|
|
20921
|
+
* </span>
|
|
20922
|
+
*
|
|
20923
|
+
*
|
|
20924
|
+
*/
|
|
20925
|
+
class ShopperConfigurations<ConfigParameters extends ShopperConfigurationsParameters & Record<string, unknown>> {
|
|
20926
|
+
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
20927
|
+
clientConfig: ClientConfig<ConfigParameters> & {
|
|
20928
|
+
baseUri: string;
|
|
20929
|
+
};
|
|
20930
|
+
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/configuration/shopper-configurations/v1";
|
|
20931
|
+
static readonly apiPaths: {
|
|
20932
|
+
getConfigurations: string;
|
|
20933
|
+
};
|
|
20934
|
+
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
20935
|
+
static readonly paramKeys: {
|
|
20936
|
+
readonly getConfigurations: readonly [
|
|
20937
|
+
"organizationId",
|
|
20938
|
+
"siteId"
|
|
20939
|
+
];
|
|
20940
|
+
readonly getConfigurationsRequired: readonly [
|
|
20941
|
+
"organizationId",
|
|
20942
|
+
"siteId"
|
|
20943
|
+
];
|
|
20944
|
+
};
|
|
20945
|
+
/**
|
|
20946
|
+
* Retrieves configurations for the specified organization and site.
|
|
20947
|
+
*
|
|
20948
|
+
* If you would like to get a raw Response object use the other getConfigurations function.
|
|
20949
|
+
*
|
|
20950
|
+
* @param options - An object containing the options for this method.
|
|
20951
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
20952
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
20953
|
+
* @param options.parameters.siteId - The identifier of the site that a request is being made in the context of.
|
|
20954
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
20955
|
+
*
|
|
20956
|
+
* @returns A promise of type SiteConfiguration.
|
|
20957
|
+
*/
|
|
20958
|
+
getConfigurations(options?: RequireParametersUnlessAllAreOptional<{
|
|
20959
|
+
parameters?: CompositeParameters<{
|
|
20960
|
+
organizationId: string;
|
|
20961
|
+
siteId: string;
|
|
20962
|
+
} & QueryParameters, ConfigParameters>;
|
|
20963
|
+
headers?: {
|
|
20964
|
+
[key: string]: string;
|
|
20965
|
+
};
|
|
20966
|
+
}>): Promise<SiteConfiguration>;
|
|
20967
|
+
/**
|
|
20968
|
+
* Retrieves configurations for the specified organization and site.
|
|
20969
|
+
*
|
|
20970
|
+
* @param options - An object containing the options for this method.
|
|
20971
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
20972
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
20973
|
+
* @param options.parameters.siteId - The identifier of the site that a request is being made in the context of.
|
|
20974
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
20975
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
20976
|
+
*
|
|
20977
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type SiteConfiguration otherwise.
|
|
20978
|
+
*/
|
|
20979
|
+
getConfigurations<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
20980
|
+
parameters?: CompositeParameters<{
|
|
20981
|
+
organizationId: string;
|
|
20982
|
+
siteId: string;
|
|
20983
|
+
} & QueryParameters, ConfigParameters>;
|
|
20984
|
+
headers?: {
|
|
20985
|
+
[key: string]: string;
|
|
20986
|
+
};
|
|
20987
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : SiteConfiguration>;
|
|
20988
|
+
}
|
|
20989
|
+
}
|
|
20990
|
+
declare namespace ShopperConfigurationsModelTypes {
|
|
20991
|
+
/**
|
|
20992
|
+
* @type ErrorResponse:
|
|
20993
|
+
*
|
|
20994
|
+
* @property title: A short, human-readable summary of the problem type.
|
|
20995
|
+
* - **Max Length:** 256
|
|
20996
|
+
*
|
|
20997
|
+
* @property type: A URI reference that identifies the problem type.
|
|
20998
|
+
* - **Max Length:** 2048
|
|
20999
|
+
*
|
|
21000
|
+
* @property detail: A human-readable explanation specific to this occurrence of the problem.
|
|
21001
|
+
*
|
|
21002
|
+
* @property instance: A URI reference that identifies the specific occurrence of the problem.
|
|
21003
|
+
* - **Max Length:** 2048
|
|
21004
|
+
*
|
|
21005
|
+
*/
|
|
21006
|
+
type ErrorResponse = {
|
|
21007
|
+
title: string;
|
|
21008
|
+
type: string;
|
|
21009
|
+
detail: string;
|
|
21010
|
+
instance?: string;
|
|
21011
|
+
} & {
|
|
21012
|
+
[key: string]: any;
|
|
21013
|
+
};
|
|
21014
|
+
/**
|
|
21015
|
+
* @type ModelConfiguration: Configuration object
|
|
21016
|
+
*
|
|
21017
|
+
* @property id: identifier
|
|
21018
|
+
* - **Max Length:** 255
|
|
21019
|
+
*
|
|
21020
|
+
* @property value: value for identifier
|
|
21021
|
+
* - **Max Length:** 255
|
|
21022
|
+
*
|
|
21023
|
+
* @property configurationType: type of configuration value
|
|
21024
|
+
* - **Max Length:** 255
|
|
21025
|
+
*
|
|
21026
|
+
*/
|
|
21027
|
+
type ModelConfiguration = {
|
|
21028
|
+
id: string;
|
|
21029
|
+
value: any | null;
|
|
21030
|
+
configurationType?: string;
|
|
21031
|
+
} & {
|
|
21032
|
+
[key: string]: any;
|
|
21033
|
+
};
|
|
21034
|
+
/**
|
|
21035
|
+
* @type SiteConfiguration: Site Configuration object
|
|
21036
|
+
*
|
|
21037
|
+
* @property configurations: List configurations for the instance and site
|
|
21038
|
+
*
|
|
21039
|
+
*/
|
|
21040
|
+
type SiteConfiguration = {
|
|
21041
|
+
configurations: Array<ModelConfiguration>;
|
|
21042
|
+
} & {
|
|
21043
|
+
[key: string]: any;
|
|
21044
|
+
};
|
|
21045
|
+
}
|
|
21046
|
+
declare namespace ShopperConfigurationsTypes {
|
|
21047
|
+
// API types
|
|
21048
|
+
type ShopperConfigurationsPathParameters = ShopperConfigurationsApiTypes.ShopperConfigurationsPathParameters;
|
|
21049
|
+
type ShopperConfigurationsQueryParameters = ShopperConfigurationsApiTypes.ShopperConfigurationsQueryParameters;
|
|
21050
|
+
type getConfigurationsQueryParameters = ShopperConfigurationsApiTypes.getConfigurationsQueryParameters;
|
|
21051
|
+
type getConfigurationsPathParameters = ShopperConfigurationsApiTypes.getConfigurationsPathParameters;
|
|
21052
|
+
// Model types
|
|
21053
|
+
type ErrorResponse = ShopperConfigurationsModelTypes.ErrorResponse;
|
|
21054
|
+
type ModelConfiguration = ShopperConfigurationsModelTypes.ModelConfiguration;
|
|
21055
|
+
type SiteConfiguration = ShopperConfigurationsModelTypes.SiteConfiguration;
|
|
21056
|
+
}
|
|
20573
21057
|
/**
|
|
20574
21058
|
* The consent status of the subscription as supplied or recorded by this system
|
|
20575
21059
|
*/
|
|
@@ -24883,6 +25367,34 @@ type CustomerPaymentInstrumentRequest = {
|
|
|
24883
25367
|
} & {
|
|
24884
25368
|
[key: string]: any;
|
|
24885
25369
|
};
|
|
25370
|
+
/**
|
|
25371
|
+
* @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
|
|
25372
|
+
*
|
|
25373
|
+
* @property expirationMonth: The month when the payment card expires.
|
|
25374
|
+
*
|
|
25375
|
+
* @property expirationYear: The year when the payment card expires.
|
|
25376
|
+
*
|
|
25377
|
+
*/
|
|
25378
|
+
type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
|
|
25379
|
+
expirationMonth?: number;
|
|
25380
|
+
expirationYear?: number;
|
|
25381
|
+
} & {
|
|
25382
|
+
[key: string]: any;
|
|
25383
|
+
};
|
|
25384
|
+
/**
|
|
25385
|
+
* @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
|
|
25386
|
+
*
|
|
25387
|
+
* @property default: The default payment instrument.
|
|
25388
|
+
*
|
|
25389
|
+
* @property paymentCard:
|
|
25390
|
+
*
|
|
25391
|
+
*/
|
|
25392
|
+
type CustomerPaymentInstrumentUpdateRequest = {
|
|
25393
|
+
default?: boolean;
|
|
25394
|
+
paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
|
|
25395
|
+
} & {
|
|
25396
|
+
[key: string]: any;
|
|
25397
|
+
};
|
|
24886
25398
|
/**
|
|
24887
25399
|
* @type ProductListEvent: Document representing a product list event.
|
|
24888
25400
|
*
|
|
@@ -25471,6 +25983,14 @@ type updateCustomerPasswordPathParameters = {
|
|
|
25471
25983
|
customerId: string;
|
|
25472
25984
|
organizationId: string;
|
|
25473
25985
|
};
|
|
25986
|
+
type updateCustomerPaymentInstrumentQueryParameters = {
|
|
25987
|
+
siteId: string;
|
|
25988
|
+
};
|
|
25989
|
+
type updateCustomerPaymentInstrumentPathParameters = {
|
|
25990
|
+
paymentInstrumentId: string;
|
|
25991
|
+
customerId: string;
|
|
25992
|
+
organizationId: string;
|
|
25993
|
+
};
|
|
25474
25994
|
type updateCustomerProductListQueryParameters = {
|
|
25475
25995
|
siteId: string;
|
|
25476
25996
|
};
|
|
@@ -25491,11 +26011,11 @@ type updateCustomerProductListItemPathParameters = {
|
|
|
25491
26011
|
/**
|
|
25492
26012
|
* All path parameters that are used by at least one ShopperCustomers method.
|
|
25493
26013
|
*/
|
|
25494
|
-
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 & {}>;
|
|
26014
|
+
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 & {}>;
|
|
25495
26015
|
/**
|
|
25496
26016
|
* All query parameters that are used by at least one ShopperCustomers method.
|
|
25497
26017
|
*/
|
|
25498
|
-
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 & {}>;
|
|
26018
|
+
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 & {}>;
|
|
25499
26019
|
/**
|
|
25500
26020
|
* All parameters that are used by ShopperCustomers.
|
|
25501
26021
|
*/
|
|
@@ -25615,6 +26135,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
25615
26135
|
updateCustomer: string;
|
|
25616
26136
|
updateCustomerAddress: string;
|
|
25617
26137
|
updateCustomerPassword: string;
|
|
26138
|
+
updateCustomerPaymentInstrument: string;
|
|
25618
26139
|
updateCustomerProductList: string;
|
|
25619
26140
|
updateCustomerProductListItem: string;
|
|
25620
26141
|
};
|
|
@@ -25917,6 +26438,18 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
25917
26438
|
"organizationId",
|
|
25918
26439
|
"siteId"
|
|
25919
26440
|
];
|
|
26441
|
+
readonly updateCustomerPaymentInstrument: readonly [
|
|
26442
|
+
"paymentInstrumentId",
|
|
26443
|
+
"customerId",
|
|
26444
|
+
"organizationId",
|
|
26445
|
+
"siteId"
|
|
26446
|
+
];
|
|
26447
|
+
readonly updateCustomerPaymentInstrumentRequired: readonly [
|
|
26448
|
+
"paymentInstrumentId",
|
|
26449
|
+
"customerId",
|
|
26450
|
+
"organizationId",
|
|
26451
|
+
"siteId"
|
|
26452
|
+
];
|
|
25920
26453
|
readonly updateCustomerProductList: readonly [
|
|
25921
26454
|
"listId",
|
|
25922
26455
|
"customerId",
|
|
@@ -27351,6 +27884,61 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
27351
27884
|
};
|
|
27352
27885
|
body: PasswordChangeRequest & CustomRequestBody;
|
|
27353
27886
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
27887
|
+
/**
|
|
27888
|
+
*
|
|
27889
|
+
*
|
|
27890
|
+
* If you would like to get a raw Response object use the other updateCustomerPaymentInstrument function.
|
|
27891
|
+
*
|
|
27892
|
+
* @param options - An object containing the options for this method.
|
|
27893
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
27894
|
+
* @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
|
|
27895
|
+
* @param options.parameters.customerId - The customer ID.
|
|
27896
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
27897
|
+
* @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.
|
|
27898
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
27899
|
+
* @param options.body - The data to send as the request body.
|
|
27900
|
+
*
|
|
27901
|
+
* @returns A promise of type CustomerPaymentInstrument.
|
|
27902
|
+
*/
|
|
27903
|
+
updateCustomerPaymentInstrument(options: RequireParametersUnlessAllAreOptional<{
|
|
27904
|
+
parameters?: CompositeParameters<{
|
|
27905
|
+
paymentInstrumentId: string;
|
|
27906
|
+
customerId: string;
|
|
27907
|
+
organizationId: string;
|
|
27908
|
+
siteId: string;
|
|
27909
|
+
} & QueryParameters, ConfigParameters>;
|
|
27910
|
+
headers?: {
|
|
27911
|
+
[key: string]: string;
|
|
27912
|
+
};
|
|
27913
|
+
body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
|
|
27914
|
+
}>): Promise<CustomerPaymentInstrument>;
|
|
27915
|
+
/**
|
|
27916
|
+
*
|
|
27917
|
+
*
|
|
27918
|
+
* @param options - An object containing the options for this method.
|
|
27919
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
27920
|
+
* @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
|
|
27921
|
+
* @param options.parameters.customerId - The customer ID.
|
|
27922
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
27923
|
+
* @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.
|
|
27924
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
27925
|
+
* @param options.body - The data to send as the request body.
|
|
27926
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
27927
|
+
*
|
|
27928
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type CustomerPaymentInstrument otherwise.
|
|
27929
|
+
*/
|
|
27930
|
+
updateCustomerPaymentInstrument<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
27931
|
+
parameters?: CompositeParameters<{
|
|
27932
|
+
paymentInstrumentId: string;
|
|
27933
|
+
customerId: string;
|
|
27934
|
+
organizationId: string;
|
|
27935
|
+
siteId: string;
|
|
27936
|
+
} & QueryParameters, ConfigParameters>;
|
|
27937
|
+
headers?: {
|
|
27938
|
+
[key: string]: string;
|
|
27939
|
+
};
|
|
27940
|
+
body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
|
|
27941
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : CustomerPaymentInstrument>;
|
|
27354
27942
|
/**
|
|
27355
27943
|
*
|
|
27356
27944
|
*
|
|
@@ -29615,6 +30203,34 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
29615
30203
|
} & {
|
|
29616
30204
|
[key: string]: any;
|
|
29617
30205
|
};
|
|
30206
|
+
/**
|
|
30207
|
+
* @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
|
|
30208
|
+
*
|
|
30209
|
+
* @property expirationMonth: The month when the payment card expires.
|
|
30210
|
+
*
|
|
30211
|
+
* @property expirationYear: The year when the payment card expires.
|
|
30212
|
+
*
|
|
30213
|
+
*/
|
|
30214
|
+
type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
|
|
30215
|
+
expirationMonth?: number;
|
|
30216
|
+
expirationYear?: number;
|
|
30217
|
+
} & {
|
|
30218
|
+
[key: string]: any;
|
|
30219
|
+
};
|
|
30220
|
+
/**
|
|
30221
|
+
* @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
|
|
30222
|
+
*
|
|
30223
|
+
* @property default: The default payment instrument.
|
|
30224
|
+
*
|
|
30225
|
+
* @property paymentCard:
|
|
30226
|
+
*
|
|
30227
|
+
*/
|
|
30228
|
+
type CustomerPaymentInstrumentUpdateRequest = {
|
|
30229
|
+
default?: boolean;
|
|
30230
|
+
paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
|
|
30231
|
+
} & {
|
|
30232
|
+
[key: string]: any;
|
|
30233
|
+
};
|
|
29618
30234
|
/**
|
|
29619
30235
|
* @type ProductListEvent: Document representing a product list event.
|
|
29620
30236
|
*
|
|
@@ -30257,6 +30873,14 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
30257
30873
|
customerId: string;
|
|
30258
30874
|
organizationId: string;
|
|
30259
30875
|
};
|
|
30876
|
+
type updateCustomerPaymentInstrumentQueryParameters = {
|
|
30877
|
+
siteId: string;
|
|
30878
|
+
};
|
|
30879
|
+
type updateCustomerPaymentInstrumentPathParameters = {
|
|
30880
|
+
paymentInstrumentId: string;
|
|
30881
|
+
customerId: string;
|
|
30882
|
+
organizationId: string;
|
|
30883
|
+
};
|
|
30260
30884
|
type updateCustomerProductListQueryParameters = {
|
|
30261
30885
|
siteId: string;
|
|
30262
30886
|
};
|
|
@@ -30277,11 +30901,11 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
30277
30901
|
/**
|
|
30278
30902
|
* All path parameters that are used by at least one ShopperCustomers method.
|
|
30279
30903
|
*/
|
|
30280
|
-
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 & {}>;
|
|
30904
|
+
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 & {}>;
|
|
30281
30905
|
/**
|
|
30282
30906
|
* All query parameters that are used by at least one ShopperCustomers method.
|
|
30283
30907
|
*/
|
|
30284
|
-
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 & {}>;
|
|
30908
|
+
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 & {}>;
|
|
30285
30909
|
/**
|
|
30286
30910
|
* All parameters that are used by ShopperCustomers.
|
|
30287
30911
|
*/
|
|
@@ -30401,6 +31025,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
30401
31025
|
updateCustomer: string;
|
|
30402
31026
|
updateCustomerAddress: string;
|
|
30403
31027
|
updateCustomerPassword: string;
|
|
31028
|
+
updateCustomerPaymentInstrument: string;
|
|
30404
31029
|
updateCustomerProductList: string;
|
|
30405
31030
|
updateCustomerProductListItem: string;
|
|
30406
31031
|
};
|
|
@@ -30703,6 +31328,18 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
30703
31328
|
"organizationId",
|
|
30704
31329
|
"siteId"
|
|
30705
31330
|
];
|
|
31331
|
+
readonly updateCustomerPaymentInstrument: readonly [
|
|
31332
|
+
"paymentInstrumentId",
|
|
31333
|
+
"customerId",
|
|
31334
|
+
"organizationId",
|
|
31335
|
+
"siteId"
|
|
31336
|
+
];
|
|
31337
|
+
readonly updateCustomerPaymentInstrumentRequired: readonly [
|
|
31338
|
+
"paymentInstrumentId",
|
|
31339
|
+
"customerId",
|
|
31340
|
+
"organizationId",
|
|
31341
|
+
"siteId"
|
|
31342
|
+
];
|
|
30706
31343
|
readonly updateCustomerProductList: readonly [
|
|
30707
31344
|
"listId",
|
|
30708
31345
|
"customerId",
|
|
@@ -32137,6 +32774,61 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
32137
32774
|
};
|
|
32138
32775
|
body: PasswordChangeRequest & CustomRequestBody;
|
|
32139
32776
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
32777
|
+
/**
|
|
32778
|
+
*
|
|
32779
|
+
*
|
|
32780
|
+
* If you would like to get a raw Response object use the other updateCustomerPaymentInstrument function.
|
|
32781
|
+
*
|
|
32782
|
+
* @param options - An object containing the options for this method.
|
|
32783
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
32784
|
+
* @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
|
|
32785
|
+
* @param options.parameters.customerId - The customer ID.
|
|
32786
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
32787
|
+
* @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.
|
|
32788
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
32789
|
+
* @param options.body - The data to send as the request body.
|
|
32790
|
+
*
|
|
32791
|
+
* @returns A promise of type CustomerPaymentInstrument.
|
|
32792
|
+
*/
|
|
32793
|
+
updateCustomerPaymentInstrument(options: RequireParametersUnlessAllAreOptional<{
|
|
32794
|
+
parameters?: CompositeParameters<{
|
|
32795
|
+
paymentInstrumentId: string;
|
|
32796
|
+
customerId: string;
|
|
32797
|
+
organizationId: string;
|
|
32798
|
+
siteId: string;
|
|
32799
|
+
} & QueryParameters, ConfigParameters>;
|
|
32800
|
+
headers?: {
|
|
32801
|
+
[key: string]: string;
|
|
32802
|
+
};
|
|
32803
|
+
body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
|
|
32804
|
+
}>): Promise<CustomerPaymentInstrument>;
|
|
32805
|
+
/**
|
|
32806
|
+
*
|
|
32807
|
+
*
|
|
32808
|
+
* @param options - An object containing the options for this method.
|
|
32809
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
32810
|
+
* @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
|
|
32811
|
+
* @param options.parameters.customerId - The customer ID.
|
|
32812
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
32813
|
+
* @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.
|
|
32814
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
32815
|
+
* @param options.body - The data to send as the request body.
|
|
32816
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
32817
|
+
*
|
|
32818
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type CustomerPaymentInstrument otherwise.
|
|
32819
|
+
*/
|
|
32820
|
+
updateCustomerPaymentInstrument<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
32821
|
+
parameters?: CompositeParameters<{
|
|
32822
|
+
paymentInstrumentId: string;
|
|
32823
|
+
customerId: string;
|
|
32824
|
+
organizationId: string;
|
|
32825
|
+
siteId: string;
|
|
32826
|
+
} & QueryParameters, ConfigParameters>;
|
|
32827
|
+
headers?: {
|
|
32828
|
+
[key: string]: string;
|
|
32829
|
+
};
|
|
32830
|
+
body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
|
|
32831
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : CustomerPaymentInstrument>;
|
|
32140
32832
|
/**
|
|
32141
32833
|
*
|
|
32142
32834
|
*
|
|
@@ -34294,6 +34986,34 @@ declare namespace ShopperCustomersModelTypes {
|
|
|
34294
34986
|
} & {
|
|
34295
34987
|
[key: string]: any;
|
|
34296
34988
|
};
|
|
34989
|
+
/**
|
|
34990
|
+
* @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
|
|
34991
|
+
*
|
|
34992
|
+
* @property expirationMonth: The month when the payment card expires.
|
|
34993
|
+
*
|
|
34994
|
+
* @property expirationYear: The year when the payment card expires.
|
|
34995
|
+
*
|
|
34996
|
+
*/
|
|
34997
|
+
type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
|
|
34998
|
+
expirationMonth?: number;
|
|
34999
|
+
expirationYear?: number;
|
|
35000
|
+
} & {
|
|
35001
|
+
[key: string]: any;
|
|
35002
|
+
};
|
|
35003
|
+
/**
|
|
35004
|
+
* @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
|
|
35005
|
+
*
|
|
35006
|
+
* @property default: The default payment instrument.
|
|
35007
|
+
*
|
|
35008
|
+
* @property paymentCard:
|
|
35009
|
+
*
|
|
35010
|
+
*/
|
|
35011
|
+
type CustomerPaymentInstrumentUpdateRequest = {
|
|
35012
|
+
default?: boolean;
|
|
35013
|
+
paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
|
|
35014
|
+
} & {
|
|
35015
|
+
[key: string]: any;
|
|
35016
|
+
};
|
|
34297
35017
|
/**
|
|
34298
35018
|
* @type ProductListEvent: Document representing a product list event.
|
|
34299
35019
|
*
|
|
@@ -34788,6 +35508,8 @@ declare namespace ShopperCustomersTypes {
|
|
|
34788
35508
|
type updateCustomerAddressPathParameters = ShopperCustomersApiTypes.updateCustomerAddressPathParameters;
|
|
34789
35509
|
type updateCustomerPasswordQueryParameters = ShopperCustomersApiTypes.updateCustomerPasswordQueryParameters;
|
|
34790
35510
|
type updateCustomerPasswordPathParameters = ShopperCustomersApiTypes.updateCustomerPasswordPathParameters;
|
|
35511
|
+
type updateCustomerPaymentInstrumentQueryParameters = ShopperCustomersApiTypes.updateCustomerPaymentInstrumentQueryParameters;
|
|
35512
|
+
type updateCustomerPaymentInstrumentPathParameters = ShopperCustomersApiTypes.updateCustomerPaymentInstrumentPathParameters;
|
|
34791
35513
|
type updateCustomerProductListQueryParameters = ShopperCustomersApiTypes.updateCustomerProductListQueryParameters;
|
|
34792
35514
|
type updateCustomerProductListPathParameters = ShopperCustomersApiTypes.updateCustomerProductListPathParameters;
|
|
34793
35515
|
type updateCustomerProductListItemQueryParameters = ShopperCustomersApiTypes.updateCustomerProductListItemQueryParameters;
|
|
@@ -34813,6 +35535,8 @@ declare namespace ShopperCustomersTypes {
|
|
|
34813
35535
|
type CustomerPaymentCardRequest = ShopperCustomersModelTypes.CustomerPaymentCardRequest;
|
|
34814
35536
|
type CustomerPaymentInstrument = ShopperCustomersModelTypes.CustomerPaymentInstrument;
|
|
34815
35537
|
type CustomerPaymentInstrumentRequest = ShopperCustomersModelTypes.CustomerPaymentInstrumentRequest;
|
|
35538
|
+
type CustomerPaymentInstrumentUpdateRequest = ShopperCustomersModelTypes.CustomerPaymentInstrumentUpdateRequest;
|
|
35539
|
+
type CustomerPaymentInstrumentUpdateRequestPaymentCard = ShopperCustomersModelTypes.CustomerPaymentInstrumentUpdateRequestPaymentCard;
|
|
34816
35540
|
type CustomerProductList = ShopperCustomersModelTypes.CustomerProductList;
|
|
34817
35541
|
type CustomerProductListTypeEnum = ShopperCustomersModelTypes.CustomerProductListTypeEnum;
|
|
34818
35542
|
type CustomerProductListItem = ShopperCustomersModelTypes.CustomerProductListItem;
|
|
@@ -57015,6 +57739,7 @@ declare namespace helpers {
|
|
|
57015
57739
|
declare const pkg: {
|
|
57016
57740
|
ShopperBaskets: typeof ShopperBaskets;
|
|
57017
57741
|
ShopperBasketsV2: typeof ShopperBasketsV2;
|
|
57742
|
+
ShopperConfigurations: typeof ShopperConfigurations;
|
|
57018
57743
|
ShopperConsents: typeof ShopperConsents;
|
|
57019
57744
|
ShopperContexts: typeof ShopperContexts;
|
|
57020
57745
|
ShopperCustomers: typeof ShopperCustomers;
|
|
@@ -57028,5 +57753,5 @@ declare const pkg: {
|
|
|
57028
57753
|
ShopperSEO: typeof ShopperSEO;
|
|
57029
57754
|
ShopperStores: typeof ShopperStores;
|
|
57030
57755
|
};
|
|
57031
|
-
export { pkg as default, ShopperBaskets, ShopperBasketsV2, ShopperConsents, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSEO, ShopperStores, ClientConfig, TemplateURL, helpers };
|
|
57032
|
-
export type { ShopperBasketsTypes, ShopperBasketsV2Types, ShopperConsentsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperLoginTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSEOTypes, ShopperStoresTypes, ClientConfigInit, FetchFunction, FetchOptions };
|
|
57756
|
+
export { pkg as default, ShopperBaskets, ShopperBasketsV2, ShopperConfigurations, ShopperConsents, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSEO, ShopperStores, ClientConfig, TemplateURL, helpers };
|
|
57757
|
+
export type { ShopperBasketsTypes, ShopperBasketsV2Types, ShopperConfigurationsTypes, ShopperConsentsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperLoginTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSEOTypes, ShopperStoresTypes, ClientConfigInit, FetchFunction, FetchOptions };
|