"use strict"; const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; function _createMdxContent(props) { const _components = { a: "a", blockquote: "blockquote", code: "code", h2: "h2", h3: "h3", li: "li", ol: "ol", p: "p", pre: "pre", strong: "strong", table: "table", tbody: "tbody", td: "td", th: "th", thead: "thead", tr: "tr", ul: "ul", ..._provideComponents(), ...props.components }, {Note, Tip} = _components; if (!Note) _missingMdxReference("Note", true); if (!Tip) _missingMdxReference("Tip", true); return _jsxs(_Fragment, { children: [_jsx(_components.h2, { id: "introduction", children: "Introduction" }), "\n", _jsxs(_components.p, { children: ["We provide an API endpoint called ", _jsx(_components.code, { children: "Utilities" }), " where you can send API requests during your tests in order to process data."] }), "\n", _jsxs(Note, { children: [" It's easier to use the standard ", _jsx("a", { className: "endtest_link", href: "/docs/advanced/utilities/", children: "Utilities" }), ", which is an option available in the ", _jsx(_components.code, { children: "Miscellaneous" }), " action, instead of the Utilities API. "] }), "\n", _jsx(_components.h2, { id: "steps", children: "Steps" }), "\n", _jsxs(_components.ol, { children: ["\n", _jsxs(_components.li, { children: ["Add a ", _jsx(_components.code, { children: "Send API Request" }), " step in your test."] }), "\n", _jsxs(_components.li, { children: ["Select the ", _jsx(_components.code, { children: "GET" }), " option from the list of request types."] }), "\n", _jsxs(_components.li, { children: ["Add the following URL in the ", _jsx(_components.code, { children: "Enter request URL" }), " input: ", _jsx(_components.code, { children: "https://app.endtest.io/utilities" })] }), "\n", _jsxs(_components.li, { children: ["In the ", _jsx(_components.code, { children: "Params" }), " section, add the ", _jsx(_components.code, { children: "action" }), " that you need together with the rest of Quary Params."] }), "\n", _jsxs(_components.li, { children: ["The ", _jsx(_components.code, { children: "action" }), " and the rest of the Query Params need to be added in the standard key-value format."] }), "\n", _jsxs(_components.li, { children: ["You can also add Endtest variables in the ", _jsx(_components.code, { children: "Params" }), " section, simply typing ", _jsx(_components.code, { children: "$" }), " in one of the inputs will show you a dropdown with all the available Endtest variables."] }), "\n", _jsx(_components.li, { children: "You can choose to save the response of that API request into a new Endtest variable." }), "\n", _jsxs(_components.li, { children: ["Go to the ", _jsx(_components.code, { children: "Response" }), " section, in the ", _jsx(_components.code, { children: "Body" }), " subsection."] }), "\n", _jsxs(_components.li, { children: ["Choose the ", _jsx(_components.code, { children: "Store in variable" }), " option from the ", _jsx(_components.code, { children: "Action" }), " dropdown from the the ", _jsx(_components.code, { children: "Body" }), " subsection."] }), "\n", _jsx(_components.li, { children: "Add the name of the variable that will contain the body of the response." }), "\n"] }), "\n", _jsx(_components.h2, { id: "actions", children: "Actions" }), "\n", _jsx(_components.p, { children: "You can choose from different actions:" }), "\n", _jsx(_components.h3, { id: "1-extract-text-after-pattern", children: "1. Extract Text After Pattern" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractTextAfterPattern" }), " action can be used to extract a substring from a string, by providing another substring as a pattern."] }), "\n", _jsx(_components.p, { children: _jsxs(_components.strong, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }) }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractTextAfterPattern" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "pattern" }), _jsx(_components.td, { children: "the pattern of text or the name of the variable" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, let's say you have the following text:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "Your validation code is 1234\n" }) }), "\n", _jsxs(_components.p, { children: ["You can extract the ", _jsx(_components.code, { children: "1234" }), " portion of that text by providing the following pattern:"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "Your validation code is\n" }) }), "\n", _jsx(_components.p, { children: "That will extract the following substring:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "1234\n" }) }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_utilities_extract_text_after_pattern.png", alt: "endtest utiliites", height: "450" }), "\n", _jsx(_components.h3, { id: "2-extract-text-before-pattern", children: "2. Extract Text Before Pattern" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractTextBeforePattern" }), " action can be used to extract a substring from a string, by providing another substring as a pattern."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractTextBeforePattern" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "pattern" }), _jsx(_components.td, { children: "the pattern of text or the name of the variable" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, let's say you have the following text:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "1234 is your validation code\n" }) }), "\n", _jsxs(_components.p, { children: ["You can extract the ", _jsx(_components.code, { children: "1234" }), " portion of that text by providing the following pattern:"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "is your validation code\n" }) }), "\n", _jsx(_components.p, { children: "That will extract the following substring:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "1234\n" }) }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_utilities_extract_text_before_pattern.png", alt: "endtest utiliites", height: "450" }), "\n", _jsx(_components.h3, { id: "3-extract-numbers-from-text", children: "3. Extract Numbers From Text" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractNumbersFromText" }), " action can used to extract all the numbers from a string."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractNumbersFromText" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, let's say you have the following text:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "Your validation code is 1234. Do not share it with anyone else.\n" }) }), "\n", _jsxs(_components.p, { children: ["You can extract the ", _jsx(_components.code, { children: "1234" }), " portion of that text because it's entirely made up of numbers."] }), "\n", _jsx(_components.h3, { id: "4-extract-value-from-json", children: "4. Extract Value From JSON" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractValueFromJSON" }), " action can used to get a value from a JSON object."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractValueFromJSON" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "json" }), _jsx(_components.td, { children: "the JSON object" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "name" }), _jsx(_components.td, { children: "the name for which you will get the value" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, if you have the following JSON object:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-javascript", children: "{\"firstName\":\"John\", \"lastName\":\"Doe\"}\n" }) }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like if you want to extract the ", _jsx(_components.code, { children: "firstName" }), " value:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/extractValueFromJSON.png", alt: "endtest utilities extract json", height: "450" }), "\n", _jsxs(Tip, { children: [" Don't forget, you can also use Endtest variables in the ", _jsx(_components.code, { children: "Send API Request" }), " modal. "] }), "\n", _jsx(_components.h3, { id: "5-extract-item-from-array", children: "5. Extract Item From Array" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractItemFromArray" }), " action can used to get an item from an array."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractItemFromArray" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "array" }), _jsx(_components.td, { children: "the array from which you will extract the items" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "index" }), _jsx(_components.td, { children: "the location of the item from the array (the first array index is 0)" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, if you have the following array:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-javascript", children: "[\"apple\", \"orange\", \"tomato\"]\n" }) }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like if you want to extract the second item:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/extractItemFromArray.png", alt: "endtest utilities extract item array", height: "450" }), "\n", _jsxs(_components.p, { children: ["Since you can use Endtest variables in the ", _jsx(_components.code, { children: "Params" }), ", ", _jsx(_components.code, { children: "Authorization" }), " and ", _jsx(_components.code, { children: "Headers" }), " sections and you can also store the responses in Endtest variables, you can chain together multiple ", _jsx(_components.code, { children: "Send API Request" }), " steps which can use the ", _jsx(_components.code, { children: "extractItemFromArray" }), " and ", _jsx(_components.code, { children: "extractValueFromJSON" }), " actions to extract values from complex JSON objects."] }), "\n", _jsxs(_components.p, { children: ["In each ", _jsx(_components.code, { children: "Send API Request" }), "step, go to the ", _jsx(_components.code, { children: "Body" }), " section from the ", _jsx(_components.code, { children: "Response" }), " tab and select the option to store the value inside an Endtest variable, which will be used in the next step."] }), "\n", _jsx(_components.p, { children: "For example, you might have a complex JSON object like this:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-javascript", children: "{\n\"employees\":[\n {\"firstName\":\"John\", \"lastName\":\"Doe\"},\n {\"firstName\":\"Anna\", \"lastName\":\"Smith\"},\n {\"firstName\":\"Peter\", \"lastName\":\"Jones\"}\n]\n}\n" }) }), "\n", _jsxs(_components.p, { children: ["If you want to extract the second ", _jsx(_components.code, { children: "firstName" }), " value from that JSON object, you have to chain together 3 ", _jsx(_components.code, { children: "Send API Request" }), " steps:"] }), "\n", _jsxs(_components.p, { children: ["Start by using the ", _jsx(_components.code, { children: "extractValueFromJSON" }), " action to get the value for the ", _jsx(_components.code, { children: "employees" }), " item:"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-javascript", children: "[\n {\"firstName\":\"John\", \"lastName\":\"Doe\"},\n {\"firstName\":\"Anna\", \"lastName\":\"Smith\"},\n {\"firstName\":\"Peter\", \"lastName\":\"Jones\"}\n]\n" }) }), "\n", _jsxs(_components.p, { children: ["That value will be an array and you can use the ", _jsx(_components.code, { children: "extractItemFromArray" }), " to get the second item from that array."] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-javascript", children: "{\"firstName\":\"Anna\", \"lastName\":\"Smith\"}\n" }) }), "\n", _jsxs(_components.p, { children: ["That item will be a JSON object and you can once again use the ", _jsx(_components.code, { children: "extractValueFromJSON" }), " action to get the value for the ", _jsx(_components.code, { children: "firstName" }), "."] }), "\n", _jsx(_components.h3, { id: "6-extract-last-item-from-array", children: "6. Extract Last Item From Array" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractLastItemFromArray" }), " action can used to get the last item from an array."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractLastItemFromArray" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "array" }), _jsx(_components.td, { children: "the array from which you will extract the item" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, if you have the following array:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-javascript", children: "[\"apple\", \"orange\", \"tomato\"]\n" }) }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like if you want to extract the last item:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/extractLastItemFromArray.png", alt: "endtest utilities extract last item array", height: "450" }), "\n", _jsx(_components.h3, { id: "7-get-text-length", children: "7. Get Text Length" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "getTextLength" }), " action can used to get the character count of a text."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "getTextLength" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] })] })] }), "\n", _jsx(_components.h3, { id: "8-store-item-in-vault", children: "8. Store Item in Vault" }), "\n", _jsx(_components.p, { children: "In some scenarios, you might need to manage values across different test suites." }), "\n", _jsxs(_components.p, { children: ["These use cases can usually be handled by using ", _jsx("a", { className: "endtest_link", href: "/docs/advanced/how-to-use-variables/", children: "Variables" }), " and ", _jsx("a", { className: "endtest_link", href: "/docs/advanced/importing-test-cases/", children: "Import Test Case" }), " actions."] }), "\n", _jsx(_components.p, { children: "But there are other scenarios where one test suite might update a value which is used by other test suites." }), "\n", _jsxs(_components.p, { children: ["You can use the ", _jsx(_components.code, { children: "Endtest Vault" }), " to store and fetch global values, which can be accessed from all your test suites."] }), "\n", _jsxs(_components.p, { children: ["These global values are called ", _jsx(_components.code, { children: "items" }), "."] }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "storeItemInVault" }), " action can be used to store an item."] }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "items" }), " stored in the ", _jsx(_components.code, { children: "Endtest Vault" }), " can only be accessed by you and your Team."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "storeItemInVault" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "itemName" }), _jsx(_components.td, { children: "the name of the item" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "itemValue" }), _jsx(_components.td, { children: "the value of the item" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] })] })] }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_store_item_in_vault_1.png", alt: "endtest store item vault", height: "450" }), "\n", _jsxs(_components.p, { children: ["You can also use ", _jsx("a", { className: "endtest_link", href: "/docs/advanced/how-to-use-variables/", children: "Variables" }), ":"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_store_item_in_vault_2.png", alt: "endtest store item vault", height: "450" }), "\n", _jsxs(_components.p, { children: ["After clicking on the ", _jsx(_components.code, { children: "Send" }), " button, you will see the 'done' message in the ", _jsx(_components.code, { children: "Body" }), " subsection of the ", _jsx(_components.code, { children: "Response" }), " section if the request was successful:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_store_item_in_vault_3.png", alt: "endtest store item vault", height: "450" }), "\n", _jsx(_components.h3, { id: "9-get-item-from-vault", children: "9. Get Item from Vault" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "getItemFromVault" }), " action can be used to fetch global values stored in the ", _jsx(_components.code, { children: "Endtest Vault" }), "."] }), "\n", _jsxs(_components.p, { children: ["These global values are called ", _jsx(_components.code, { children: "items" }), "."] }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "items" }), " stored in the ", _jsx(_components.code, { children: "Endtest Vault" }), " can only be accessed by you and your Team."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "getItemFromVault" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "itemName" }), _jsx(_components.td, { children: "the name of the item" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] })] })] }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_get_item_from_vault_1.png", alt: "endtest get item vault", height: "450" }), "\n", _jsxs(_components.p, { children: ["After clicking on the ", _jsx(_components.code, { children: "Send" }), " button, you will see the value of the ", _jsx(_components.code, { children: "item" }), " in the ", _jsx(_components.code, { children: "Body" }), " subsection of the ", _jsx(_components.code, { children: "Response" }), " section if the request was successful:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_get_item_from_vault_2.png", alt: "endtest get item vault", height: "450" }), "\n", _jsx(_components.p, { children: "That value can be stored in an Endtest variable and used in your test suite:" }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_get_item_from_vault_3.png", alt: "endtest get item vault", height: "450" }), "\n", _jsx(_components.h3, { id: "10-generate-random-name", children: "10. Generate Random Name" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "generateRandomName" }), " action can be used to generate random names."] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "generateRandomName" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "type" }), _jsx(_components.td, { children: "first, last or full" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "gender" }), _jsx(_components.td, { children: "female or male" })] })] })] }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/generateRandomNameApiRequest1.png", alt: "endtest generate random name", height: "450" }), "\n", _jsxs(_components.p, { children: ["After clicking on the ", _jsx(_components.code, { children: "Send" }), " button, you will see the value of the name in the ", _jsx(_components.code, { children: "Body" }), " subsection of the ", _jsx(_components.code, { children: "Response" }), " section if the request was successful:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/generateRandomNameApiRequest2.png", alt: "endtest generate random name response", height: "450" }), "\n", _jsx(_components.p, { children: "That value can be stored in an Endtest variable and used in your test suite:" }), "\n", _jsx("img", { src: "https://app.endtest.io/images/generateRandomNameApiRequest3.png", alt: "endtest get item vault", height: "450" }), "\n", _jsx(_components.h3, { id: "11-extract-character-from-string", children: "11. Extract Character from String" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractCharacterFromString" }), " action can be used to extract a certain character from a string."] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractCharacterFromString" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "string" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "index" }), _jsx(_components.td, { children: "the location of the character from the string (the first index is 0)" })] })] })] }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/extractCharacterFromString1.png", alt: "get character from text", height: "450" }), "\n", _jsxs(_components.p, { children: ["After clicking on the ", _jsx(_components.code, { children: "Send" }), " button, you will see the character in the ", _jsx(_components.code, { children: "Body" }), " subsection of the ", _jsx(_components.code, { children: "Response" }), " section if the request was successful:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/extractCharacterFromString2.png", alt: "endtest response of character", height: "450" }), "\n", _jsx(_components.p, { children: "That value can be stored in an Endtest variable and used in your test suite:" }), "\n", _jsx("img", { src: "https://app.endtest.io/images/extractCharacterFromString3.png", alt: "endtest extract character", height: "450" }), "\n", _jsx(_components.h3, { id: "12-convert-text-to-lowercase", children: "12. Convert Text to LowerCase" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "toLowerCase" }), " action can be used to convert a text to LowerCase."] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "toLowerCase" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] })] })] }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/toLowerCase1.png", alt: "convert to lower case", height: "450" }), "\n", _jsxs(_components.p, { children: ["After clicking on the ", _jsx(_components.code, { children: "Send" }), " button, you will see the converted text in the ", _jsx(_components.code, { children: "Body" }), " subsection of the ", _jsx(_components.code, { children: "Response" }), " section if the request was successful:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/toLowerCase2.png", alt: "convert to lower case result", height: "450" }), "\n", _jsx(_components.p, { children: "That converted text can be stored in an Endtest variable and used in your test suite:" }), "\n", _jsx("img", { src: "https://app.endtest.io/images/toLowerCase3.png", alt: "convert to lower case variable", height: "450" }), "\n", _jsx(_components.h3, { id: "13-convert-text-to-uppercase", children: "13. Convert Text to UpperCase" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "toUpperCase" }), " action can be used to convert a text to UpperCase."] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "toUpperCase" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] })] })] }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/toUpperCase1.png", alt: "convert to upper case", height: "450" }), "\n", _jsxs(_components.p, { children: ["After clicking on the ", _jsx(_components.code, { children: "Send" }), " button, you will see the converted text in the ", _jsx(_components.code, { children: "Body" }), " subsection of the ", _jsx(_components.code, { children: "Response" }), " section if the request was successful:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/toUpperCase2.png", alt: "convert to upper case result", height: "450" }), "\n", _jsx(_components.p, { children: "That converted text can be stored in an Endtest variable and used in your test suite:" }), "\n", _jsx("img", { src: "https://app.endtest.io/images/toUpperCase3.png", alt: "convert to upper case variable", height: "450" }), "\n", _jsx(_components.h3, { id: "14-capitalize-text", children: "14. Capitalize Text" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "capitalizeText" }), " action can be used to capitalize a text, converting the first letter of each word to a capital letter (uppercase letter) and the remaining letters to lower case."] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "capitalizeText" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] })] })] }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/capitalizeText.jpg", alt: "capitalize text", height: "450" }), "\n", _jsxs(_components.p, { children: ["After clicking on the ", _jsx(_components.code, { children: "Send" }), " button, you will see the converted text in the ", _jsx(_components.code, { children: "Body" }), " subsection of the ", _jsx(_components.code, { children: "Response" }), " section if the request was successful."] }), "\n", _jsx(_components.p, { children: "That converted text can be stored in an Endtest variable and used in your test suite." }), "\n", _jsx(_components.h3, { id: "15-send-email", children: "15. Send Email" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "sendEmail" }), " action can be used to send an email from any ", _jsx(_components.code, { children: "endtest-mail.io" }), " address."] }), "\n", _jsx(_components.p, { children: "This feature is not available during the free trial." }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "sendEmail" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "from" }), _jsx(_components.td, { children: "Email address of sender" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "to" }), _jsx(_components.td, { children: "Email address of recipient" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "subject" }), _jsx(_components.td, { children: "The subject of the email" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "body" }), _jsx(_components.td, { children: "The body of the email" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "attachment" }), _jsx(_components.td, { children: "The File Download Link from the Endtest Drive (optional)" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] })] })] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/utilities_send_email.png", alt: "send email", height: "450" }), "\n", _jsx(_components.h3, { id: "16-send-slack-message", children: "16. Send Slack Message" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "sendSlackMessage" }), " action can be used to send a message to a Slack Channel."] }), "\n", _jsx(_components.p, { children: "This feature is not available during the free trial." }), "\n", _jsxs(_components.p, { children: ["And it works only if you connected that Slack Channel to Endtest (details about that ", _jsx("a", { className: "endtest_link", href: "/docs/integrations/slack/", children: "here" }), ")."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "sendSlackMessage" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "channel" }), _jsx(_components.td, { children: "the name of the Slack channel" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "message" }), _jsx(_components.td, { children: "the message you want to send" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] })] })] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_utilities_send_slack_message_1.jpg", alt: "send slack message", height: "450" }), "\n", _jsx(_components.h3, { id: "17-math-calculations", children: "17. Math Calculations" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "math" }), " action can be used to perform mathematical operations."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "math" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "operation" }), _jsx(_components.td, { children: "the arithmetical operation" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "items" }), _jsx(_components.td, { children: "a list of numbers, separated by ;" })] })] })] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_utilities_math.png", alt: "endtest math operations", height: "450" }), "\n", _jsxs(_components.blockquote, { children: ["\n", _jsx(_components.p, { children: "Supported parameters for operation: addition, subtraction, multiplication, division, round, rounddown, roundup." }), "\n", _jsx(_components.p, { children: "You can perform math operations with variables by placing the variable name between double curly brackets:" }), "\n", _jsx(_components.p, { children: _jsx(_components.code, { children: "{{$price}};{{$tax}}" }) }), "\n"] }), "\n", _jsx(_components.h3, { id: "18-remove-newline-characters", children: "18. Remove Newline Characters" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "removeNewLines" }), " action can be used to remove Newline characters."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "removeNewLines" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the text from which the Newline characters will be removed" })] })] })] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_utilities_remove_new_lines.png", alt: "endtest remove newline", height: "450" }), "\n", _jsx(_components.h3, { id: "19-extract-random-item-from-list", children: "19. Extract Random Item From List" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractRandomItemFromList" }), " action can used to get a random item from a list."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractRandomItemFromList" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "list" }), _jsx(_components.td, { children: "the list from which you will extract the item" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, if you have the following array:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-javascript", children: "orange; apple; tomato\n" }) }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like if you want to extract the last item:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/utilities_extractRandomItemFromList.jpg", alt: "endtest utilities extract random item from list", height: "450" }), "\n", _jsx(_components.h3, { id: "20-extract-value-from-xml", children: "20. Extract Value From XML" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractValueFromXML" }), " action can used to get a value from an XML object."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractValueFromXML" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "xml" }), _jsx(_components.td, { children: "the XML object" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "name" }), _jsx(_components.td, { children: "the name for which you will get the value" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, if you have the following XML object:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-xml", children: "\nUS\nUnited States\nCA\nCalifornia\nMountain View\n94043\n37.4192\n-122.0574\n807\n650\n\n" }) }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like if you want to extract the ", _jsx(_components.code, { children: "City" }), " value:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/utilities_api_extract_from_xml.jpg", alt: "endtest utilities extract xml", height: "450" }), "\n", _jsxs(Tip, { children: [" Don't forget, you can also use Endtest variables in the ", _jsx(_components.code, { children: "Send API Request" }), " modal. "] }), "\n", _jsx(_components.h3, { id: "21-truncate-text", children: "21. Truncate Text" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "truncateText" }), " action can be used to extract a substring from a string, by providing the number of characters you want to extract."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "truncateText" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "count" }), _jsx(_components.td, { children: "the number of characters or the name of the variable" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, let's say you have the following text:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "Hello world!\n" }) }), "\n", _jsxs(_components.p, { children: ["You can extract the ", _jsx(_components.code, { children: "Hello" }), " portion of that text by providing the following ", _jsx(_components.code, { children: "count" }), ":"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "5\n" }) }), "\n", _jsx(_components.p, { children: "That will extract the following substring:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "Hello\n" }) }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_documentation_utilities_api_truncate.png", alt: "endtest utiliites truncate text", height: "450" }), "\n", _jsx(_components.h3, { id: "22-generate-file", children: "22. Generate File" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "generateFile" }), " action can be used to generate a file, by providing the content and the name."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "generateFile" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "fileName" }), _jsx(_components.td, { children: "the name of the file (needs to include the extension)" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "content" }), _jsx(_components.td, { children: "the content that will be placed inside the file" })] })] })] }), "\n", _jsxs(_components.p, { children: ["For example, let's say you have the following ", _jsx(_components.code, { children: "content" }), ":"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "Hello\n" }) }), "\n", _jsxs(_components.p, { children: ["And you want to save it in a file called ", _jsx(_components.code, { children: "sample.txt" }), ":"] }), "\n", _jsxs(_components.p, { children: ["That will generate a text file with the name ", _jsx(_components.code, { children: "sample.txt" }), " that contains the text ", _jsx(_components.code, { children: "Hello" }), "."] }), "\n", _jsx(_components.p, { children: "The file will be automatically stored on our side and the Response Body from that request will contain the online link to that file." }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_documentation_utilities_generate_file.png", alt: "endtest utiliites generate file", height: "450" }), "\n", _jsx(Note, { children: "The generated file will not be listed in the Endtest Drive." }), "\n", _jsx(_components.h3, { id: "23-rename-file", children: "23. Rename File" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "renameFile" }), " action can be used to rename a file, by providing the link to the original file and the new file name."] }), "\n", _jsx(Note, { children: "This feature is not available during the free trial." }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "renameFile" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "fileLink" }), _jsx(_components.td, { children: "the link to the original file (needs to be in the Endtest Drive)" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "newFileName" }), _jsx(_components.td, { children: "the new name for the file, including the extension" })] })] })] }), "\n", _jsx(_components.p, { children: "The response will contain the link to the new file." }), "\n", _jsx(_components.p, { children: "The original file is not automatically deleted or replaced." }), "\n", _jsx(_components.p, { children: "The new file is generated in a separate folder, but will not be listed in the Endtest Drive." }), "\n", _jsx(_components.h3, { id: "24-extract-latest-sms", children: "24. Extract Latest SMS" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractLatestSMS" }), " action can be used to fetch the latest SMS from a Phone Number assigned to your team."] }), "\n", _jsxs(Note, { children: [" This functionality requires real phone numbers to be assigned to your team. ", _jsx("br", {}), " ", _jsx("br", {}), " We provide real phone numbers for our users. You don't have to use any external service. ", _jsx("br", {}), " ", _jsx("br", {}), " If there are no real phone numbers assigned to your team, you can request one by contacting our Support Team. ", _jsx("br", {}), " ", _jsx("br", {}), " This functionality is not related in any way to the phone number that you have provide for the Two-Factor Authentication (2FA) for your Endtest account. "] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractLatestSMS" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "number" }), _jsx(_components.td, { children: "the phone number" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "markAsRead" }), _jsx(_components.td, { children: "true or false" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "delete" }), _jsx(_components.td, { children: "true or false" })] })] })] }), "\n", _jsxs(_components.p, { children: ["This is how the ", _jsx(_components.code, { children: "Send API Request" }), " modal would look like:"] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_documentation_utilities_sms.png", alt: "endtest extract latest sms utilities", height: "450" }), "\n", _jsx(_components.p, { children: "If everything is correct, the response will contain this JSON:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-javascript", children: "{\n \"from_number\": \"The phone number that sent the SMS message\",\n \"to_number\": \"The phone number that received the SMS message\",\n \"body\": \"The body of the SMS message\",\n \"timestamp\": \"The UTC timestamp, e.g., 2023-08-29 17:27:57\"\n}\n" }) }), "\n", _jsxs(_components.blockquote, { children: ["\n", _jsxs(_components.p, { children: ["After the request is sent, the SMS message will be automatically marked as Read if the ", _jsx(_components.code, { children: "markAsRead" }), " parameter is set to ", _jsx(_components.code, { children: "true" }), ".\nThat means you won't be able to access it with another request or ", _jsx(_components.code, { children: "Extract Latest SMS" }), " step."] }), "\n", _jsxs(_components.p, { children: ["If the ", _jsx(_components.code, { children: "delete" }), " parameter is set to ", _jsx(_components.code, { children: "true" }), ", the SMS will also be deleted.\nYou can also read and delete SMS messages manually in the Team section from the ", _jsx("a", { className: "endtest_link", href: "https://app.endtest.io/settings", children: "Settings" }), " page."] }), "\n"] }), "\n", _jsxs(_components.p, { children: ["An easier approach to extract the latest SMS is by using the ", _jsx(_components.code, { children: "Extract Latest SMS" }), " method from the Set Variable action, as described in the ", _jsx("a", { className: "endtest_link", href: "/docs/advanced/read-sms/", children: "Read SMS" }), " chapter."] }), "\n", _jsx(_components.h3, { id: "25-remove-all-spaces", children: "25. Remove All Spaces" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "removeAllSpaces" }), " action can be used to remove all the spaces from a text."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "removeAllSpaces" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the text from which the spaces will be removed" })] })] })] }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_utilities_remove_all_spaces.jpg", alt: "endtest remove all spaces", height: "450" }), "\n", _jsx(_components.h3, { id: "26-remove-pattern-from-text", children: "26. Remove Pattern from Text" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "removePatternFromText" }), " action can be used to remove a substring from a string."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "removePatternFromText" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "text" }), _jsx(_components.td, { children: "the full text or the name of the variable" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "pattern" }), _jsx(_components.td, { children: "the pattern of text that you want to remove" })] })] })] }), "\n", _jsx(_components.p, { children: "For example, let's say you have the following text:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "57EUR\n" }) }), "\n", _jsxs(_components.p, { children: ["You can remove the ", _jsx(_components.code, { children: "EUR" }), " portion from that text by providing the following pattern:"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "EUR\n" }) }), "\n", _jsx(_components.p, { children: "The result will be the remaining text:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { children: "57\n" }) }), "\n", _jsx("img", { src: "https://app.endtest.io/images/endtest_utilities_remove_pattern_from_text.png", alt: "endtest utiliites", height: "450" }), "\n", _jsx(_components.h3, { id: "27-get-array-length", children: "27. Get Array Length" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "getArrayLength" }), " action can used to get the number of items from an array."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "getArrayLength" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "array" }), _jsx(_components.td, { children: "the array where you want to count the items" })] })] })] }), "\n", _jsx(_components.h3, { id: "28-extract-invoice-data-from-pdf", children: "28. Extract Invoice Data From PDF" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractInvoiceDataFromPDF" }), " action allows you to extract structured information from an invoice contained in a PDF file."] }), "\n", _jsx(_components.p, { children: "Endtest automatically analyzes the first page of the PDF and returns a standardized JSON object containing the most important invoice fields, as well as all detected line items." }), "\n", _jsx(_components.p, { children: "This feature uses AI with Deep Learning OCR and Document Understanding Models to extract invoice fields, which Endtest converts into a clean, predictable JSON format." }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractInvoiceDataFromPDF" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "fileLink" }), _jsx(_components.td, { children: "the link to the PDF invoice" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] })] })] }), "\n", _jsx(_components.p, { children: "Below is the exact JSON format returned by this method:" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-json", children: "{\n \"invoice_number\": \"INV-12345\",\n \"invoice_date\": \"2025-03-01\",\n \"vendor_name\": \"Example Vendor Ltd\",\n \"total\": \"129.99\",\n \"currency\": \"USD\",\n \"summary_fields\": {\n \"INVOICE_RECEIPT_ID\": \"INV-12345\",\n \"INVOICE_RECEIPT_DATE\": \"2025-03-01\",\n \"VENDOR_NAME\": \"Example Vendor Ltd\",\n \"SUBTOTAL\": \"100.00\",\n \"TAX\": \"29.99\",\n \"TOTAL\": \"129.99\"\n },\n \"items\": [\n {\n \"description\": \"Product A\",\n \"quantity\": \"2\",\n \"unit_price\": \"50.00\",\n \"amount\": \"100.00\",\n \"raw_fields\": {\n \"ITEM\": \"Product A\",\n \"QUANTITY\": \"2\",\n \"UNIT_PRICE\": \"50.00\",\n \"AMOUNT\": \"100.00\"\n }\n }\n ],\n \"raw\": { /* full payload */ }\n}\n" }) }), "\n", _jsxs(Note, { children: ["This action is available only with the Pro and Enterprise Plans, since it's part of the ", _jsx(_components.a, { href: "/docs/web-tests/how-to-test-pdf-files", children: "PDF Testing" }), " feature."] }), "\n", _jsxs(_components.p, { children: ["If your test downloaded the PDF, you can get the link by using the variable generated by ", _jsx(_components.code, { children: "Set Variable → Link to Most Recent Downloaded File" }), "."] }), "\n", _jsx(_components.h3, { id: "29-convert-pdf-to-html", children: "29. Convert PDF to HTML" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "convertPDFtoHTML" }), " action converts a PDF into an HTML file, making it easy to interact with using standard Endtest actions such as:"] }), "\n", _jsxs(_components.ul, { children: ["\n", _jsx(_components.li, { children: _jsx(_components.code, { children: "Scroll" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.code, { children: "Click" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.code, { children: "Snipping Tool" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.code, { children: "Miscellaneous → Generate Full Page Screenshot" }) }), "\n", _jsx(_components.li, { children: "and others" }), "\n"] }), "\n", _jsxs(_components.p, { children: ["If the PDF contains links, you can also click them by locating elements with a ", _jsx(_components.code, { children: "Text Inside" }), " locator in a ", _jsx(_components.code, { children: "Click" }), " step."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "convertPDFtoHTML" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "fileLink" }), _jsx(_components.td, { children: "the link to the PDF file" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] })] })] }), "\n", _jsx(_components.p, { children: "The request returns a link to the generated HTML file." }), "\n", _jsxs(Note, { children: ["This action is available only with the Pro and Enterprise Plans, since it's part of the ", _jsx(_components.a, { href: "/docs/web-tests/how-to-test-pdf-files", children: "PDF Testing" }), " feature."] }), "\n", _jsxs(_components.p, { children: ["If your test downloaded the PDF, you can get the link by using the variable generated by ", _jsx(_components.code, { children: "Set Variable → Link to Most Recent Downloaded File" }), "."] }), "\n", _jsx(_components.h3, { id: "30-extract-page-from-pdf", children: "30. Extract Page From PDF" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "extractPageFromPDF" }), " action allows you to extract a single page from a PDF file."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "extractPageFromPDF" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "fileLink" }), _jsx(_components.td, { children: "the link to the PDF file" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "pageNumber" }), _jsx(_components.td, { children: "the number of the page you want to extract" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] })] })] }), "\n", _jsx(_components.p, { children: "The request returns a link with the generated PDF file." }), "\n", _jsxs(Note, { children: ["This action is available only with the Enterprise Plan, since it's part of the ", _jsx(_components.a, { href: "/docs/web-tests/how-to-test-pdf-files", children: "PDF Testing" }), " feature."] }), "\n", _jsxs(_components.p, { children: ["If your test downloaded the PDF, you can get the link by using the variable generated by ", _jsx(_components.code, { children: "Set Variable → Link to Most Recent Downloaded File" }), "."] }), "\n", _jsx(_components.h3, { id: "31-convert-csv-to-html", children: "31. Convert CSV to HTML" }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "convertCSVtoHTML" }), " action converts a CSV into an HTML file, making it easy to view and validate the data."] }), "\n", _jsxs(_components.p, { children: ["Query Params that you need to add in the ", _jsx(_components.code, { children: "Send API Request" }), " modal:"] }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: "Key" }), _jsx(_components.th, { children: "Value" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "action" }), _jsx(_components.td, { children: "convertCSVtoHTML" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "fileLink" }), _jsx(_components.td, { children: "the link to the CSV file" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appId" }), _jsx(_components.td, { children: "the appId for your Endtest account" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "appCode" }), _jsx(_components.td, { children: "the appCode for your Endtest account" })] })] })] }), "\n", _jsx(_components.p, { children: "The request returns a link to the generated HTML file." }), "\n", _jsxs(_components.p, { children: ["You can then access that generated HTML file with a ", _jsx(_components.code, { children: "Go to URL" }), " step."] }), "\n", _jsxs(Note, { children: ["After your test downloads the CSV file, you can get the link by using the variable generated by ", _jsx(_components.code, { children: "Set Variable → Link to Most Recent Downloaded File" }), ". More details about this workflow can be found in the ", _jsx(_components.a, { href: "/docs/web-tests/how-to-test-file-downloads", children: "How to Test File Downloads" }), " chapter."] })] }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = { ..._provideComponents(), ...props.components }; return MDXLayout ? _jsx(MDXLayout, { ...props, children: _jsx(_createMdxContent, { ...props }) }) : _createMdxContent(props); } return { default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }