{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"The Interceptor API’s provides default API functions available in each intercepted method. This interface enables various operations and interactions within the pricefx.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"6"},"include":{"value":""},"outline":{"value":"false"},"indent":{"value":""},"style":{"value":"none"},"exclude":{"value":""},"type":{"value":"list"},"class":{"value":""},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"e117c8ed-12f6-441f-a828-9819ed19a7ec"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"d2cb9a79-13ea-496a-b0b3-410e8a2afd3d"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"API Methods","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"add","type":"text"}]},{"type":"paragraph","content":[{"text":"Methods for adding new customers and products.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"customer","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"customer: ((customer) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a new customer.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"customer","type":"text","marks":[{"type":"code"}]},{"text":": any - Customer Object.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"product","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"product: ((product) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a new product to products.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"product","type":"text","marks":[{"type":"code"}]},{"text":": any - Product Object.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"await api.add.product({\n sku: 'KS-2003',\n label: 'Test2',\n unitOfMeasure: 1,\n currency: 'CZK',\n formulaName: 'ActionButtons',\n attribute18: 'A'\n});","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"app","type":"text"}]},{"type":"paragraph","content":[{"text":"Used for obtaining data from Unity which are not accessible through configuration.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getCurrentUser","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"getCurrentUser: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the logged-in user.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"await api.app.getCurrentUser()\n/*\n{\n \"version\": 2,\n \"typedId\": 123,\n \"loginName\": \"donatas.ka\",\n ...\n}\n*/","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"Methods for managing configuration.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"overrideConfig","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"overrideConfig: ((path, value) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Used to ","type":"text"},{"text":"temporarily","type":"text","marks":[{"type":"strong"}]},{"text":" set a value in the configuration. Updated configuration is valid only in the current web browser tab.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"path","type":"text","marks":[{"type":"code"}]},{"text":": string - Name of configuration.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"code"}]},{"text":": any - Configuration new value.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"await api.configuration.overrideConfig(\n 'applicationEnvironment',\n 'salesforce'\n);","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"retrieveConfig","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"retrieveConfig: ((path, defaultValue?) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Reads values from Pricefx configuration object.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can use it to get values from feature flags or some other values such as:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type - dev | prod","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"partition","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"applicationEnvironment - standalone | salesforce | c4c | dynamics | sugarCRM","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"apiUrl","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"locale","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"path","type":"text","marks":[{"type":"code"}]},{"text":": string - Name of configuration.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"defaultValue","type":"text","marks":[{"type":"code"}]},{"text":": any - (Optional) If retrieving the configuration is unsuccessful, the default value will be returned.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"const visibleDashboards = await configuration.retrieveConfig(\n 'customerSpecificFeatureFlag.dashboards.visible.account',\n []\n);","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"crmManager","type":"text"}]},{"type":"paragraph","content":[{"text":"Enables communication with CRMs in which Pricefx is embedded. ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"callAndReceive","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"callAndReceive: ((message) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Triggers postMessage with a message in the window with CRM.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"message","type":"text","marks":[{"type":"code"}]},{"text":": any - Data which will be sent to CRM.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"const message = {\n fields: [\n { id: 'name', value: 'New name' },\n { id: 'description', value: 'New description' }\n ]\n};\nreturn api.crmManager.callAndReceive({ action: 'createNewQuote', data: message })","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"findAccount","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"findAccount: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns Account from CRM with provided ID.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"findAccounts","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"findAccounts: ((name) => Promise<{ Id: string; Name: string; }[]>)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns max 10 Accounts from CRM which contains the value passed into the function.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":": any - Name of the account.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"findByQuery","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"findByQuery: ((query) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Finds data in CRM’s by SQL query. Supported keywords: ","type":"text"},{"text":"SELECT","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"FROM","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"WHERE","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"LIMIT","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"AND","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"OR","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"Supported operators for Salesforce, C4C, and Dynamics: ","type":"text"},{"text":"=","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"!=","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"<","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":">","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"<=","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":">=","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"LIKE","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"Supported operators for SugarCRM: ","type":"text"},{"text":"=","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"LIKE","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":": string - Query which will be executed.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"export const crmFindOpportunitiesPre = ({\n result,\n searchText,\n api\n}) => {\n const query = `\n SELECT Id, Name, StageName, RecordType.Name\n FROM Opportunity\n WHERE Name = '%${searchText}%'\n LIMIT 10\n `;\n return api.crmManager.findByQuery(query).then(list => {\n list.forEach(item => {\n item.Name = `${item.Name} (${item.RecordType.Name})`;\n });\n result.list = list;\n return result;\n });\n};","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getAccountAssociatedValue","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getAccountAssociatedValue: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the value of the accountAssociatedValue feature flag.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getAccountAssociationField","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getAccountAssociationField: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the value of the accountAssociationField feature flag.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getCurrentUser","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getCurrentUser: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves the current user from the CRM.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getOpportunityAssociatedValue","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getOpportunityAssociatedValue: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the value of the opportunityAssociatedValue feature flag.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getOpportunityLineItemURL","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getOpportunityLineItemURL: ((externalId) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a link to the opportunity line items with provided ID. Salesforce only.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"externalId","type":"text","marks":[{"type":"code"}]},{"text":": string - Id of the opportunity.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getOpportunityURL","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getOpportunityURL: ((externalId) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a link to the opportunity with provided ID. Salesforce only.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"externalId","type":"text","marks":[{"type":"code"}]},{"text":": string - Id of the opportunity.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getPayload","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getPayload: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns CRM payload. The value of the payload will vary based on CRM used with Pricefx.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"export const quotesDetailNew = async ({\n quoteAPI,\n api\n}) => {\n const payload = await api.crmManager.getPayload();\n await quoteAPI.setHeaderValue('label', payload.Name);\n await quoteAPI.setHeaderInputValue('Customer', payload.Customer_Number__c);\n await quoteAPI.setHeaderInputValue('ProjectID', payload.Project_Id__c);\n await quoteAPI.setHeaderInputValue('ProjectName', payload.Project__c);\n};","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getQuoteAccountReferenceField","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getQuoteAccountReferenceField: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the value of the quoteAccountReferenceField feature flag. (Deprecated, use getAccountAssociationField instead)","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getSObjectURL","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getSObjectURL: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a link of the SObject. Salesforce only.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getSugarCrmEntityById","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getSugarCrmEntityById: ((module, id) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Loads an entity by ID from the module. SugarCRM only.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"module","type":"text","marks":[{"type":"code"}]},{"text":": string - Name of the module.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":": string - Id of the object in module.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"const parentAccount = await api.crmManager.getSugarCrmEntityById('Accounts', parentId);","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"isAccountPage","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"isAccountPage: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns true when Pricefx is embedded under an account page in CRM.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"export const quotesDetailSubmit = async ({\n api\n}) => {\n if(await api.crmManager.isAccountPage()) {\n await api.notify.success('We on account page');\n }\n};","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"isOpportunityPage","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"isOpportunityPage: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns true when Pricefx is embedded under the opportunity page in CRM.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"export const quotesDetailSubmit = async ({\n api\n}) => {\n if(await api.crmManager.isOpportunityPage()) {\n await api.notify.success('We on opportunity page');\n }\n};","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"postCall","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"postCall: ((url, method, payload) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Calls HTTP request in CRM. Salesforce and SugarCRM only.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"url","type":"text","marks":[{"type":"code"}]},{"text":": string - API call url.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"method","type":"text","marks":[{"type":"code"}]},{"text":": GET | POST | PUT | DELETE - Method which will be used for API call.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"payload","type":"text","marks":[{"type":"code"}]},{"text":": any - Body of the API call.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"export const quotesDetailSubmit = async ({\n quoteAPI,\n api\n}) => {\n const externalRef = await quoteAPI.getHeaderValue('externalRef');\n const opportunityUrl = await api.crmManager.getOpportunityURL(externalRef);\n const totalValue = await quoteAPI.getHeaderOutputResult('TotalAmount');\n const payloadForSF = {\n PriceFx_Quote_No__c: quoteAPI.getHeaderValue('uniqueName'),\n Amount: totalValue\n };\n api.crmManager.postCall(opportunityUrl, 'PATCH', payloadForSF).then(() => {\n api.notify.success('Opportunity was updated.');\n });\n};","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"updateCache","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"updateCache: ((path, data) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"This function is used to manipulate _initCache in SugarcrmManager. It is mainly used to modify the parent account under the account page in SugarCRM. ","type":"text"},{"text":"SugarCRM only.","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"path","type":"text","marks":[{"type":"code"}]},{"text":": string - Path to Cache.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"data","type":"text","marks":[{"type":"code"}]},{"text":": any - Data for update.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"// Data is a parent account for the current account\ncrmManager.updateCache('sugarCRMData.payload.Account', data)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"fetch","type":"text"}]},{"type":"paragraph","content":[{"text":"Methods for fetching customer and product data.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"customer","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"customer: ((customerId) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Fetches a customer by their ID.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"customerId","type":"text","marks":[{"type":"code"}]},{"text":": string - Customer ID.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"customerByFilter","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"customerByFilter: ((customFilter) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Fetches customers based on a custom filter.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"customFilter","type":"text","marks":[{"type":"code"}]},{"text":": string - Criteria.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"customerByName","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"customerByName: ((customerName) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Fetches customers by their name.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"customerName","type":"text","marks":[{"type":"code"}]},{"text":": string - Customer Name.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"customerExtension","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"customerExtension: ((tableName, filter) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Fetches customer extension data based on the table name and filter.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"tableName","type":"text","marks":[{"type":"code"}]},{"text":": string - Name of the Customer Table.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"filter","type":"text","marks":[{"type":"code"}]},{"text":": string - Advance filter.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"productById","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"productById: ((sku) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Fetches a product by its SKU.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"label","type":"text","marks":[{"type":"code"}]},{"text":": string - Product sku.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"productByLabel","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"productByLabel: ((label) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Fetches products by their label.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"label","type":"text","marks":[{"type":"code"}]},{"text":": string - Product label.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"navigate","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"navigate: ((targetPage, targetPageState) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Allows page navigation using interceptor API. This API uses ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://pricefx.atlassian.net/wiki/spaces/KB/pages/4336648258"}},{"text":" for navigation.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"targetPage","type":"text","marks":[{"type":"code"}]},{"text":": string - Page to which user should be navigated.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"targetPageState","type":"text","marks":[{"type":"code"}]},{"text":": any - Additional parameters for navigation.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"export const quotesListDataLoad = async ({ api, appPages }) => {\n await api.navigate(appPages.QC_NEW_QUOTE, { id: 'P-123' });\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"notify","type":"text"}]},{"type":"paragraph","content":[{"text":"API for displaying notifications.","type":"text"}]},{"type":"paragraph","content":[{"text":"Methods:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"alert","type":"text","marks":[{"type":"code"}]},{"text":": Displays a blue notification message.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"error","type":"text","marks":[{"type":"code"}]},{"text":": Displays a red notification message.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"info","type":"text","marks":[{"type":"code"}]},{"text":": Displays a blue notification message.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"success","type":"text","marks":[{"type":"code"}]},{"text":": Displays a green notification message.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"warning","type":"text","marks":[{"type":"code"}]},{"text":": Displays an orange notification message.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"message","type":"text","marks":[{"type":"code"}]},{"text":": string - Translation value key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"options","type":"text","marks":[{"type":"code"}]},{"text":": {duration?: number, url?: string, urlName?: string} - (Optional) Settings for notification.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"await api.notify.error(\n 'Error message, with help link',\n {\n urlName: \"help\",\n url: \"\",\n duration: 0\n }\n)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"translate","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"translate: ((key, params?) => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Translates text based on the provided key and parameters.","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]},{"text":": string - Translation value key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"params","type":"text","marks":[{"type":"code"}]},{"text":": any - Parameters for translation string formatting.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"await api.translate(\n 'unity_interceptor_already_exists',\n {\n name: 'myInterceptor'\n }\n)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"url","type":"text"}]},{"type":"paragraph","content":[{"text":"Methods related to URL handling.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"getParameters","type":"text"}]},{"type":"codeBlock","attrs":{"language":"typescript"},"content":[{"text":"getParameters: (() => Promise)","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves URL parameters.","type":"text"}]}],"version":1}

Browser not supported