MESA SDK
Last updated
Last updated
Log info to Mesa Logs.
Parameters
Name | Type | Description | |
---|---|---|---|
Returns
Void
Log a warning to Mesa Logs.
Parameters
Name | Type | Description | |
---|---|---|---|
Returns
Void
Log an error to Mesa Logs.
Parameters
Returns
Void
Log info to Mesa Logs only if the Automation is in Debug Mode.
Parameters
Returns
Void
Make a GET request to an external Rest API.
Parameters
Returns
Types.Response
Types.ResponseRaw
The response returned by the request. object
if options.json
is true
, string
if options.json
is false
.
Make a POST request to an external Rest API.
Parameters
Returns
Types.Response
Types.ResponseRaw
The response returned by the request. object
if options.json
is true
, string
if options.json
is false
.
Make a PUT request to an external Rest API.
Parameters
Returns
Types.Response
Types.ResponseRaw
The response returned by the request. object
if options.json
is true
, string
if options.json
is false
.
Make a PATCH request to an external Rest API.
Parameters
Returns
Types.Response
Types.ResponseRaw
The response returned by the request. object
if options.json
is true
, string
if options.json
is false
.
Make a DELETE request to an external Rest API.
Parameters
Returns
Types.Response
Types.ResponseRaw
The response returned by the request. object
if options.json
is true
, string
if options.json
is false
.
Make a request to an external Rest API.
Parameters
Returns
Types.Response
Types.ResponseRaw
The response returned by the request. object
if options.json
is true
, string
if options.json
is false
.
Base-64 encode a string. This is helpful when building an Authorization
header for basic auth requests.
Parameters
Returns
string
The base-64 encoded version of the input string parameter.
Base64 decode a string. Decodes data encoded with MIME base64
Parameters
Returns
string
The decoded string.
Generate a hash of a string. This is helpful when creating signed requests.
Parameters
Returns
string
The raw binary data of the hash
Generate a keyed hash value using the HMAC method. This is helpful when creating signed requests.
Parameters
Returns
string
The raw binary data of the hash
Pauses execution
Parameters
Returns
Get a secret.
Parameters
Returns
string
The secret value.
Save a secret value.
Parameters
Returns
Void
Get a storage item
Parameters
Returns
array
The result of the query.
Get a storage item
Parameters
Returns
string
The storage value.
Get a storage item
Parameters
Returns
Void
Render a liquid template with the params
passed.
Parameters
Returns
string
The rendered template code.
Generates the URL for input webhooks
Parameters
Returns
string
array
The rendered template code.
Pass a payload to the service and call the next step in this Automation.
Parameters
Returns
Void
Call an arbitrary output from a MESA Script
Parameters
Returns
Void
Call another automation from a MESA Script
Parameters
Returns
Void
Delete the file loaded by the Input.
Parameters
Returns
Void
Move the file loaded by the Input to a new location.
Parameters
Returns
Void
Convert an XML file into an {object}. This function will condense XML namespaces into {namespaceSep = '_'} separated values: soapenv:Body becomes { soapenv_Body: {} }
Parameters
Returns
object
Convert an object into an XML string.
Parameters
Examples
Returns
string
Check if xml is valid
Parameters
Examples
Returns
bool
Convert a CSV file into an object. Keys will be matched from the first header row of the CSV file.
Parameters
Returns
object
array
Convert an object a CSV string.
Parameters
Returns
string
Push to a Virtual Output.
Parameters
Returns
Void
Mark the matching Virtual Output records as cleared by the current Mesa Script.
Parameters
Returns
Void
Mark a single Virtual Output record as cleared by the current Mesa Script.
Parameters
Returns
Void
Set the timezone to use to execute all script commands.
Parameters
Returns
string
The timezone identifier, like UTC or Europe/Lisbon.
Returns a date as a formatted string.
Parameters
Returns
string
The formatted date string.
Send an email.
Parameters
Returns
Void
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
Name | Type | Description | |
---|---|---|---|
message
string
meta
object
Optional
message
string
meta
object
Optional
message
string
meta
object
Optional
message
string
meta
object
Optional
path
string
options
Types.RequestOptions
path
string
data
object
options
Types.RequestOptions
path
string
data
object
options
Types.RequestOptions
path
string
data
object
options
Types.RequestOptions
path
string
options
Types.RequestOptions
method
string
One of GET
, POST
, PUT
, PATCH
, or DELETE
path
string
data
object
options
Types.RequestOptions
string
string
The string to encode
string
string
The base-64 encoded version of the input string parameter.
strict
bool
If the strict parameter is set to TRUE then the base64_decode() function will return FALSE if the input contains character from outside the base64 alphabet. Defaults to FALSE.
Optional
algorithm
string
The algorithm to use. Options: sha1
, sha256
, md5
string
string
The string to create the hash from
base64encode
string
Should we base64-encode the raw value of the hash?
Optional
algorithm
string
The algorithm to use. Options: sha1
, sha256
, md5
string
string
The string to create the hash from
string
string
Shared secret key used for generating the HMAC variant of the message digest
base64encode
string
Should we base64-encode the raw value of the hash?
Optional
$seconds
int
key
string
defaultValue
string
A default value to use if the secret cannot be found. If defaultValue
is empty, the script will throw a fatal error if the secret is not found.
Optional
key
string
The credential key or id.
value
string
The value to save. This will be encrypted at rest, and can contained a stringified JSON array.
options
object
Optional
options.oauth_provider
bool
Optional
options.oauth_scope
object
Optional
options.trigger_type
object
Optional
sql
string
The SQL query to run
key
string
defaultValue
string
A default value to use if the storage key cannot be found. If defaultValue
is empty, the script will throw a fatal error if the storage key is not found.
Optional
key
string
value
string
template
string
String representing a liquid template.
params
object
A keyed object of parameters to replace.
type
string
Type of webhook: json
, shopify
format
string
Format of the returned data: string
or array
. If string, a full URL is returned. If array
, URL will comprise two fields suffix
and prefix
automationId
string
ID of the Automation
key
string
The key of the trigger
payload
object
params
object
Parameters to send to the output, such as tokens to construct a Shopify API url
params.enqueue
bool
Defaults to false. Set to true if you are exploding multiple tasks that can be run in parallel.
Optional
outputKey
string
payload
object
enqueue
bool
Defaults to false. Set to true if you are exploding multiple tasks that can be run in parallel.
automationKey
string
In the form ${automationKey}
, this will trigger the first input in the Automation. In the form ${automationKey}/${inputKey}
, this will trigger a specific input in the automation.
payload
object
filename
string
Typically passed from context.filename
.
filename
string
Typically passed from context.filename
.
destinationFilenameAndPath
string
xmlString
string
The xml file to be decoded
namespaceSep='_'
string
Namespace separator for replacing soapenv:Body type values with soapenv_Body
Optional
xmlObject
object
The object to be turned into xml.
wrapReplace
string
Replace the default wrapping provided with another value
Optional
namespaceSep='_'
string
Namespace separator for replacing soapenv_Body: {} values with soapenv:Body
Optional
xmlString
string
data
string
returnObject
bool
Defaults to true
, which will return an object keyed by the first row in the CSV content. Set to false
to return an array.
Optional
options
object
Optional
options.delimiter=','
string
The delimiter to use when parsing the CSV file. Must be a single character.
Optional
data
object
headerRow
bool
Defaults to true
. Set to false
to skip the header row when returning CSV.
Optional
outputKey
string
payload
mixed
outputKey
string
outputKey
string
mesaId
string
The ID of the record to clear (returned as mesa_id in the Virtual Output).
timezone
string
The timezone identifier, like UTC or America/Los_Angeles. See a full list of TZ Database names.
format
string
The format of the outputted date string. See full list of options.
timestamp
int
Defaults to now. Optional
to
string
subject
string
body
string
from
string
All emails will be sent from no-reply@getmesa.com. The from email address will be used as the From name and reply-to email address.
Optional