Options
All
  • Public
  • Public/Protected
  • All
Menu

Module shopperConfigurations

Index

References

ErrorResponse

Re-exports ErrorResponse

ErrorResponse

Re-exports ErrorResponse

ModelConfiguration

Re-exports ModelConfiguration

ModelConfiguration

Re-exports ModelConfiguration

ShopperConfigurations

Re-exports ShopperConfigurations

ShopperConfigurations

Re-exports ShopperConfigurations

ShopperConfigurationsParameters

Re-exports ShopperConfigurationsParameters

ShopperConfigurationsParameters

Re-exports ShopperConfigurationsParameters

ShopperConfigurationsPathParameters

Re-exports ShopperConfigurationsPathParameters

ShopperConfigurationsPathParameters

Re-exports ShopperConfigurationsPathParameters

ShopperConfigurationsQueryParameters

Re-exports ShopperConfigurationsQueryParameters

ShopperConfigurationsQueryParameters

Re-exports ShopperConfigurationsQueryParameters

SiteConfiguration

Re-exports SiteConfiguration

SiteConfiguration

Re-exports SiteConfiguration

defaultBaseUri

Re-exports defaultBaseUri

getConfigurationsPathParameters

Re-exports getConfigurationsPathParameters

getConfigurationsPathParameters

Re-exports getConfigurationsPathParameters

getConfigurationsQueryParameters

Re-exports getConfigurationsQueryParameters

getConfigurationsQueryParameters

Re-exports getConfigurationsQueryParameters

Type aliases

ErrorResponse

ErrorResponse: { detail: string; instance?: undefined | string; title: string; type: string } & {}
property

title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization

  • Max Length: 256
property

type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

  • Max Length: 2048
property

detail: A human-readable explanation specific to this occurrence of the problem.

property

instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

  • Max Length: 2048

ModelConfiguration

ModelConfiguration: { configurationType?: undefined | string; id: string; value: any | null } & {}
property

id: identifier

  • Max Length: 255
property

value: value for identifier

  • Max Length: 255
property

configurationType: type of configuration value

  • Max Length: 255

ShopperConfigurationsParameters

All parameters that are used by ShopperConfigurations.

ShopperConfigurationsPathParameters

ShopperConfigurationsPathParameters: Partial<getConfigurationsPathParameters & {}>

All path parameters that are used by at least one ShopperConfigurations method.

ShopperConfigurationsQueryParameters

ShopperConfigurationsQueryParameters: Partial<getConfigurationsQueryParameters & {}>

All query parameters that are used by at least one ShopperConfigurations method.

SiteConfiguration

SiteConfiguration: { configurations: Array<ModelConfiguration> } & {}
property

configurations: List configurations for the instance and site

getConfigurationsPathParameters

getConfigurationsPathParameters: { organizationId: string }

Type declaration

  • organizationId: string

getConfigurationsQueryParameters

getConfigurationsQueryParameters: { siteId: string }

Type declaration

  • siteId: string

Variables

Const defaultBaseUri

defaultBaseUri: "https://{shortCode}.api.commercecloud.salesforce.com/configuration/shopper-configurations/v1" = "https://{shortCode}.api.commercecloud.salesforce.com/configuration/shopper-configurations/v1"

Generated using TypeDoc