Options
All
  • Public
  • Public/Protected
  • All
Menu

Product Override Facade to interact with Vlocity Product Console functionality.

Hierarchy

  • ProductOverride

Index

Constructors

constructor

  • Parameters

    • config: any

    Returns ProductOverride

Properties

config

config: any

Methods

createCreateOverrideInput

  • Creates an instance of CreateOverrideInput object

    Returns CreateOverrideInput

    • an instance of CreateOverrideInput

createDeleteOverrideInput

  • Creates an instance of DeleteOverrideInput object

    Returns DeleteOverrideInput

    • an instance of DeleteOverrideInput

createGetAttributeOverrideListInput

  • Creates an instance of GetAttributeOverrideListInput object

    Returns GetAttributeOverrideListInput

    • an instance of GetAttributeOverrideListInput

createGetOverrideInput

  • Creates an instance of GetOverrideInput object

    Returns GetOverrideInput

    • an instance of GetOverrideInput

createGetSpecDetailsInput

  • Creates an instance of GetSpecDetailsInput object

    Returns GetSpecDetailsInput

    • an instance of GetSpecDetailsInput

createOverride

  • method

    createOverride - executes remote call to create override

    example
    
       // Instantiate the input object for createOverride using createCreateOverrideInput method
       const input = productconsole.getProductOverrideSdk().createCreateOverrideInput();
    
       // Invoke API via method createOverride()
       productconsole
      .getProductOverrideSdk().createOverride(input)
      .then(result => {
        Logger.info("createOverride() success " + result);
      })
      .catch(error => {
        Logger.info("createOverride() failed " + error);
      });
    
    throws

    {Error} - "CreateOverrideInput :: createOverride() must be defined"

    throws

    {Error} - "CreateOverrideInput :: createOverride() must have type as 'Attribute' or 'Product Definition' "

    throws

    {Error} - "CreateOverrideInput :: createOverride() must have contextId"

    throws

    {Error} - "CreateOverrideInput :: createOverride() must have overriddenObjectId"

    throws

    {Error} - "CreateOverrideInput :: createOverride() must have overriddenPCIId"

    throws

    {Error} - "CreateOverrideInput :: createOverride() must have hierarchyPath"

    throws

    {Error} - "CreateOverrideInput :: createOverride() must have productHierarchyGroupKeyPath"

    throws

    {Error} - "CreateOverrideInput :: createOverride() must have productId"

    Parameters

    Returns Promise<any>

    • Promise that returns a success or failure message

createSaveOverrideInput

  • Creates an instance of SaveOverrideInput object

    Returns SaveOverrideInput

    • an instance of SaveOverrideInput

createValidateAndSaveOverrideInput

  • Creates an instance of ValidateAndSaveOverrideInput object

    Returns ValidateAndSaveOverrideInput

    • an instance of ValidateAndSaveOverrideInput

deleteOverride

  • method

    deleteOverride - executes remote call to delete override

    example
    
       // Instantiate the input object for deleteOverride using createDeleteOverrideInput method
       const input = productconsole.getProductOverrideSdk().createDeleteOverrideInput();
    
       // Invoke API via method deleteOverride()
       productconsole
      .getProductOverrideSdk().deleteOverride(input)
      .then(result => {
        Logger.info("deleteOverride() success " + result);
      })
      .catch(error => {
        Logger.info("deleteOverride() failed " + error);
      });
    
    throws

    {Error} - "DeleteOverrideInput :: deleteOverride() must be defined"

    throws

    {Error} - "DeleteOverrideInput :: deleteOverride() must have type as 'Attribute' or 'Product Definition' "

    throws

    {Error} - "DeleteOverrideInput :: deleteOverride() must have contextId"

    throws

    {Error} - "DeleteOverrideInput :: deleteOverride() must have overriddenObjectId"

    throws

    {Error} - "DeleteOverrideInput :: deleteOverride() must have overrideDefinitionId"

    Parameters

    Returns Promise<any>

    • Promise that returns a success or failure message

getAttributeOverrideList

  • method

    getAttributeOverrideList - executes remote call to get attribute override list

    example
    
       // Instantiate the input object for getAttributeOverrideList using createGetAttributeOverrideListInput method
       const input = productconsole.getProductOverrideSdk().createGetAttributeOverrideListInput();
    
       // Invoke API via method getAttributeOverrideList()
       productconsole
      .getProductOverrideSdk().getAttributeOverrideList(input)
      .then(result => {
        Logger.info("getAttributeOverrideList() success " + result);
      })
      .catch(error => {
        Logger.info("getAttributeOverrideList() failed " + error);
      });
    
    throws

    {Error} - "GetAttributeOverrideListInput :: getAttributeOverrideList() must be defined"

    throws

    {Error} - "GetAttributeOverrideListInput :: getAttributeOverrideList() must have type as 'Attribute' "

    throws

    {Error} - "GetAttributeOverrideListInput :: getAttributeOverrideList() must have contextId"

    throws

    {Error} - "GetAttributeOverrideListInput :: getAttributeOverrideList() must have overriddenObjectIds"

    throws

    {Error} - "GetAttributeOverrideListInput :: getAttributeOverrideList() must have overriddenPCIId"

    throws

    {Error} - "GetAttributeOverrideListInput :: getAttributeOverrideList() must have hierarchyPath"

    throws

    {Error} - "GetAttributeOverrideListInput :: getAttributeOverrideList() must have productHierarchyGroupKeyPath"

    Parameters

    Returns Promise<any>

    • Promise that returns a success or failure message

getOverride

  • method

    getOverride - executes remote call to get override

    example
    
       // Instantiate the input object for getOverride using createGetOverrideInput method
       const input = productconsole.getProductOverrideSdk().createGetOverrideInput();
    
       // Invoke API via method getOverride()
       productconsole
      .getProductOverrideSdk().getOverride(input)
      .then(result => {
        Logger.info("getOverride() success " + result);
      })
      .catch(error => {
        Logger.info("getOverride() failed " + error);
      });
    
    throws

    {Error} - "GetOverrideInput :: getOverride() must be defined"

    throws

    {Error} - "GetOverrideInput :: getOverride() must have type as 'Attribute' or 'Product Definition' "

    throws

    {Error} - "GetOverrideInput :: getOverride() must have contextId"

    throws

    {Error} - "GetOverrideInput :: getOverride() must have overriddenObjectId"

    throws

    {Error} - "GetOverrideInput :: getOverride() must have overriddenPCIId"

    throws

    {Error} - "GetOverrideInput :: getOverride() must have hierarchyPath"

    throws

    {Error} - "GetOverrideInput :: getOverride() must have productHierarchyGroupKeyPath"

    Parameters

    Returns Promise<any>

    • Promise that returns a success or failure message

getSpecDetails

  • method

    getSpecDetails - executes remote call to get specification details for a product

    example
    
       // Instantiate the input object for getSpecDetails using createGetSpecDetailsInput method
       const input = productconsole.getProductOverrideSdk().createGetSpecDetailsInput();
    
       // Invoke API via method getSpecDetails()
       productconsole
      .getProductOverrideSdk().getSpecDetails(input)
      .then(result => {
        Logger.info("getSpecDetails() success " + result);
      })
      .catch(error => {
        Logger.info("getSpecDetails() failed " + error);
      });
    
    throws

    {Error} - "GetSpecDetailsInput :: getSpecDetails() must be defined"

    throws

    {Error} - "GetSpecDetailsInput :: getSpecDetails() must have objectId"

    Parameters

    Returns Promise<any>

    • Promise that returns a success or failure message

saveOverride

  • method

    saveOverride - executes remote call to save override

    example
    
       // Instantiate the input object for saveOverride using createSaveOverrideInput method
       const input = productconsole.getProductOverrideSdk().createSaveOverrideInput();
    
       // Invoke API via method saveOverride()
       productconsole
      .getProductOverrideSdk().saveOverride(input)
      .then(result => {
        Logger.info("saveOverride() success " + result);
      })
      .catch(error => {
        Logger.info("saveOverride() failed " + error);
      });
    
    throws

    {Error} - "SaveOverrideInput :: saveOverride() must be defined"

    throws

    {Error} - "SaveOverrideInput :: saveOverride() must have type as 'Attribute' or 'Product Definition' "

    throws

    {Error} - "SaveOverrideInput :: saveOverride() must have contextId"

    throws

    {Error} - "SaveOverrideInput :: saveOverride() must have sObject"

    throws

    {Error} - "SaveOverrideInput :: saveOverride() must have hierarchyPath"

    throws

    {Error} - "SaveOverrideInput :: saveOverride() must have productHierarchyGroupKeyPath"

    Parameters

    Returns Promise<any>

    • Promise that returns a success or failure message

validateAndSaveOverride

  • method

    validateAndSaveOverride - executes remote call to validate and save cardinality override

    example
    
       // Instantiate the input object for validateAndSaveOverride using createValidateAndSaveOverrideInput method
       const input = productconsole.getProductOverrideSdk().createValidateAndSaveOverrideInput();
    
       // Invoke API via method validateAndSaveOverride()
       productconsole
      .getProductOverrideSdk().validateAndSaveOverride(input)
      .then(result => {
        Logger.info("validateAndSaveOverride() success " + result);
      })
      .catch(error => {
        Logger.info("validateAndSaveOverride() failed " + error);
      });
    
    throws

    {Error} - "ValidateAndSaveOverrideInput :: validateAndSaveOverride() must be defined"

    throws

    {Error} - "ValidateAndSaveOverrideInput :: validateAndSaveOverride() must have type as 'Product Definition' "

    throws

    {Error} - "ValidateAndSaveOverrideInput :: validateAndSaveOverride() must have contextId"

    throws

    {Error} - "ValidateAndSaveOverrideInput :: validateAndSaveOverride() must have sObject"

    throws

    {Error} - "ValidateAndSaveOverrideInput :: validateAndSaveOverride() must have hierarchyPath"

    throws

    {Error} - "ValidateAndSaveOverrideInput :: validateAndSaveOverride() must have productHierarchyGroupKeyPath"

    Parameters

    Returns Promise<any>

    • Promise that returns a success or failure message

Generated using TypeDoc