Configuration for this SDK.
Singleton instance of this SDK.
getter method for namespace. Provides the salesforce org namespace
setter method for namespace. Set custom namespace
Adds a context rule set on a price list entry.
The input used to add a context rule set.
Create a default GetAppliedPriceListEntriesInput object.
Create a default GetAppliedPromotionsInput object.
Creates Attribute Assignments for a given object.
This function will execute remote call to create override for an attribute
This function will create a new child product as provided in the CreateChildProductInput.
with fields to create a new child product.
result in a promise of the child product creation. Result will contain the newly created relationship ID.
Creates and returns an instance of input class for GetPriceListEntryInput
Creates and returns an instance of input class for CreateChildProductInput
Creates and returns an instance of input class for CreateOverrideInput
Creates and returns an instance of input class for CreateProductInput
Creates and returns input object for creating VlocityAttachment objects.
Creates and returns an instance of input class for DeletePriceListEntryInput
Creates and returns an instance of input class for DeleteOverrideInput
Creates and returns an instance of input class for DeletePriceListEntryInput
Creates and returns an instance of input class for DeleteSalesForceDocumentInput(
Creates and returns an instance of input class for DeleteVlocityAttachmentInput
Creates and returns an instance of input class for GetEditPriceListEntryInput
Creates and returns an instance of input class for GetEditPromotionOfferPriceListEntryInput
Returns an instance of GetObjectPicklistisInput class
Creates and returns an instance of input class for GetOverrideInput
Creates and returns Input object for getting Product2 object details
Return instance of GetProductAttributeAssignmentsInput
This function creates and returns a default input object that can be used to call the getProductDefinition sdk function.
Create a default GetProductDetails object.
Creates and returns an instance of input class for GetHierarchyPathInput
Creates and returns Input object for getting product templates
Creates and returns Input object for getting products
Creates and returns an instance of input class for GetTimePlanPolicyInput
Creates and returns an instance of input class for GetVlocityAttachmentDetailsInput
Creates and returns Input object for getting vlocity attachments
Creates input object for createAttributeAssignments sdk function.
Creates and returns an instance of input class for GetOffersInput
Creates and returns an instance of input class for ParentChildItemInput
Creates and returns an instance of input class for PreValidatePCIOverrideObjectInput
Creates a price list entry for price, cost, promotion, and offer tables. Aside from the standard price list entry, this method supports overrides and adjustments.
The input used to create a price list entry.
Creates and returns an instance of input class for GetPriceListEntryInput
Creates and returns an instance of input class for GetPriceListInput
Creates and returns an instance of input class for GetPricingElementInput
Creates and returns an instance of input class for GetPricingPickListInput
Creates and returns an instance of input class for GetPricingVariableInput
This function will create a new product as provided in the CreateProductInput.
with fields to create a new product.
result in a promise of the product creation. Result will contain the newly created product with ID.
Creates a promotion.
The input used to create a promotion.
Creates and returns an instance of input class for CreatePromotionInput
Creates a promotion item.
The input used to create a promotion item.
Creates and returns an instance of input class for CreatePromotionItemInput
Creates and returns an instance of input class for AdjustmentPriceListEntryObject
Creates the input object for publishProduct remote action.
Creates an input for getting the quick adds pricing properties.
This function returns the default input object which can be used for calling getQuickAddProductProperties sdk function.
Creates and returns an instance of input class for SaveOverrideInput
Returns the input instance getSearchResults sdk function.
Creates the input object for searchProductByText remote action.
Creates and returns an instance of input class for GetTimePlanPolicyIdsInput
Returns the instance of the input class when updating all attributes for an object
Returns the instance of the input class when updating all fields for an object
Returns the default input object for calling updateProductAttribute
Creates and returns a default instance of input object for calling updateProductDefinition sdk function.
Creates and returns input object for updating a single field. Input object contains a key value pair for field name and field value.
Creates and returns an instance of input class for UpdateProductInput
Creates multiple VlocityAttachment records. Used for linking documents with product.
API Path: (POST) /services/data/v43.0/composite/sobjects
This function will execute remote call to create override for an attribute
Deletes a context rule.
The input used to delete context rule.
This will delete an existing ParentChildItem record as provided in ParentChildItemInput.
API Path: (DELETE) /services/data/v43.0/sobjects/{namespacePrefix}ProductChildItem__c/{input.parentChildItemId}
Input object that consists of a parentChildItemId.
Deletes a price list entry.
The input used to delete price list entry.
Salesforce document delete
The input is used to delete the document record.
Vlocity Attachment delete
The input is used to delete the attachment record.
Edits a price list entry for price, cost, promotion, and offer tables. Aside from the standard price list entry, this method supports overrides and adjustments.
The input used to create a price list entry.
This function will return a list of pricelists that are applicable for this product.
the input with the product id used to display pricelists.
Get fields and attributes mapped to the object id. Currently uses remote datasource. So this needs VF Page to work.
Input class for getting fields and attributes assigned to the product
This function will return a list of pricelists that are applicable for this product.
the input with the product id used to display pricelists.
This function will return a list of promotions that are applicable for this product.
the input with the product id used to display promotions.
This function will execute remote call to get override for an attribute
Returns the folderId for a given folder name. FolderId is required when creating documents.
API Path: (GET) /services/data/v43.0/query
Gets a productId and all of the offers for it.
The offers input with the remoteClass, remoteMethod, parameters and paramsArray function.
This function returns a list of price list.
Input object that contains a query to get the price list.
Gets a pricing element and returns it's id.
The pricing element input with the remoteClass, remoteMethod, parameters and paramsArray function.
Gets the list of picklist items for the pricing tab.
The picklist item input with the remoteClass, remoteMethod, and paramsArray function.
Gets the list of pricing variables.
The pricing variable input with the remoteClass, remoteMethod, parameters and paramsArray function.
Returns Id for Product2 object
This function returns a list of attributes, fields and attribute values that are available for the corresponding ProductChildItem Id.
API Path: (GET) /services/data/v43.0/sobjects/{namespacePrefix}ProductChildItem__c/{input.parentChildItemId}
Input object that consists of a parentChildItemId.
Gets the product definition for a given product. Definition contains a list of sections and section elements within each section.
API Path: (GET) /v1/studio/object/{input.productId}/facets/{input.facetName}
input with the product id to fetch the product definition
sectionElements.records which represent the fields and attributes.Function which returns a product and its children
This function will execute remote call to get hierarchy path for a product
Returns a list of product template records for a given productId.
Returns a list of products.
This function returns a list of attributes, fields and attribute values that are available for assignment to a given product.
Input object that consists of a productId.
This function returns a list of attributes, fields and attribute values that are available for assignment to a given product.
Input object that consists of a productId.
This function returns a list of attributes, fields and attribute values that are available for assignment to a given product.
Input object that consists of a productId.
This function returns a list of attributes, fields and attribute values that are available for assignment to a given product.
API Path: /v1/studio/object/{input.productid}/facet/{input.facet}/available.
Input object that consists of a productId.
Returns the list of most recently viewed products ordered descending by Last viewed date.
Salesforce document details
The documentId to fetch details.
Gets Time Plan information.
The input used to get time plan information.
Assigns the time plan and time policy to a price list entry.
The pricing variable input with the remoteClass, remoteMethod, parameters and paramsArray function.
Gets Time Policy information.
The input used to get time policy information.
Get Vlocity Attachment details
The input is used to get the attachment details.
Returns a list of VlocityAttachment records for a given productId. These records have the url (UrlLong__c) which can be used as a download link.
API Path: (GET) /services/data/v43.0/query
This function will execute remote call to preValidate PCI Override Object
Executes the remote action for publishing the product. This action would populate the JSONAttributes field of the product to ensure that the product attributes are visible in CPQ.
Calls the remote function to Save Attribute Assignment object.
This function will execute remote call to create override for an attribute
Simple text search for products using SOSL on NAME FIELDS
Calls the getSearchResultsMap remote action.
Executes a remote call to update all attributes of a given object.
Executes remote call to update all fields of an object.
This will update an existing product as provided in UpdateProductInput.
Sends a PUT request to update a single attribute on the product.
API Path: (PUT) /v1/studio/products/{input.productId}/attributes
This function updates fields and attribute values that are available for the corresponding ProductChildItem Id.
API Path: (PATCH) /services/data/v43.0/sobjects/{namespacePrefix}ProductChildItem__c/{input.parentChildItemId}
Input object that consists of a parentChildItemId and reqBody.
Posts the updated product definition (sections and sectionElements) to the api endpoint for updating a product.
API Path: (PUT) /v1/studio/object/{input.productId}/facets/{input.facet}
Input class for product that has the product definition.
Posts an update to the standard salesforce REST API for updating a single field on the Product2 Object.
API Path: (PATCH) /services/data/v43.0/sobjects/Product2/{input.productId}
replaces document specified in the FormData with the old document. Request body is of type multipart/form-data
API Path: (PATCH) /services/data/v43.0/sobjects/Document/${documentId}
Exepcutes remote call to update the settings for a given product id and attribute id.
Get Vlocity Attachment details
The input is used to update the attachment details.
Uploads files specified in the FormData to SalesForce Documents section. Request body is of type multipart/form-data
API Path: (POST) /services/data/v43.0/composite/sobjects
Returns the version number of SDK.
Returns SDK version number as string
Adds all the enumerable string keyed function properties of a source
object to the sdk prototype.
.extend should only be used to add new methods and it won't override the existing methods.
Note: If the property already exists, it will be not be added.
Custom functions which are being extended should have proper namespaces to avoid issues during upgrades. When Vlocity releases new changes it won't impact if unique namespaces are used.
Example: myCompanyOrFeatureMethodName
The object of functions
Get a singleton instance of this SDK.
an instance of this SDK.
Adds all the enumerable string keyed function properties of a source object to the sdk prototype.
.override method should only be used to override the existing methods and should only be used in rare cases.
Overriding the existing or default methods may cause unintended consequences and may also impact during upgrades.
Please be cautious while using this
The object of functions
Generated using TypeDoc
Product Console Facade to interact with Vlocity Product Console functionality.
v104