Yalo Standard Libraries

HTTP.post(url: string, body?: table, headers?: table) -> HttpResponse
						How to interpret this function:
            
HTTP					the namespace of the Standard Library
post					the method to be used
url: string		url is a required parameter and the expected data type is string
body?: table	body is an optional parameter -- as indicated by the '?' suffix -- and not required 
							for the method call to be valid
HttpResponse	the data type returned by the method. In the case of HTTP.post, an object 
							(Lua table) that contains multiple properties inside it. (See the HTTP Standard Library for more information on this data type)

HTTP.post(url: string, body?: table, headers?: table) -> HttpResponse


                 How we can interpret the function.

HTTP             The namemespace of the Standard Library.
post             The method name.
url: string      url is the expected input and string the datatype.
body?: table     if the input has a ? suffix it means it is an optional argument
                 meaning that HTTP.post(url) would be a valid call too.

HttpResponse     This is the data type that the function returns in this case is an
                 object (lua table) that contains multiple properties inside (See HTTP
                 Standard Library for information on this data type)

-- send a variable value to whatsapp
local name = "Studio Core"
Debug.print(name)

-- you can also send a Lua table which will be formatted as a JSON string

local user = {
	name = "Studio Core"
  email = "[email protected]"
}

Debug.print(user)

-- Whatsapp output:
-- {"name":"Studio Core", "email":"[email protected]"

Workflow.branch(stepId: number) -> nil

local age = 20

-- We want to move to a Step 1 if the age is equals or greater than 18
-- else we want to move to a Step 2 if its lower than 18.
if age >= 18 then
  Workflow.branch(1)
else
  Workflow.branch(2)
end

JSON.encode(object: table) -> string
JSON.decode(jsonString: string) -> table

local user = {
  name = "Studio Core",
  email = "[email protected]"
}

local userJsonString = JSON.encode(user)

-- userJsonString
-- {"name":"Studio Core","email":"[email protected]"}

local userJsonString = '{"name":"Studio Core","email":"[email protected]"}'

local user = JSON.decode(userJsonString)

Debug.print(user.name) -- Would send "Studio Core"

-- API that returns a random generated user
url = "https://randomuser.me/api/"

-- Make the HTTP Get request
response = HTTP.get(url)

-- Notice Lua first index is 1 not 0.
user = response.data.result[1]

-- We can send the name to whatsapp
Debug.print(user.name.first .. " " .. user.name.last) -- Would send "First Last"


-- Fictional REST API to handle users
url = "https://external-api-service.net/v1/users"

body = {
  name = "Studio Core",
  email = "[email protected]"
}

headers = {
  authorization = "Bearer securitytoken",
  [content-type] = "application/json" -- Notice the use of [ ] is the variable has
}                                     -- invalid characters like ( - )

-- Make the HTTP Post request with body and headers
response = HTTP.post(url, body, headers)

if response.status == 201 then
  Debug.print("The user has been created")
else
  Debug.print("There was a problem creating the user")
  -- You could inspect the contents of response.data which
  -- could contain the error message that caused it to fail

-- Name of the Lambda
lambda = 'add-product-shopping-cart'

-- Body to the Lambda
body = {
  name = "Studio NG",
  price = 9999
}

-- Since the body of the lambda has to be a string we
-- need to convert our body to a JSON string.
result = Invoke.cloudFunction(lambda, JSON.encode(body))

if result.success then
  Debug.print(result.payload) -- This would send the lambda response to whatsapp.
else
	Debug.print("There was a problem executing the lambda")
end

-- Check if a value exists in a list of keywords
match = Input.match('contains', 'blue|red', 'blue')
-- match would be True.

-- Check if a value matches to a custom regex
-- Using a phone regex which accepts only numbers, () and -
match = Input.match('regex', '^[0-9()-]+$', '(656) 123-1234')
-- match would be True.

-- Check if the value is equal to the other value
match = Input.match('isEqualTo', 'Studio NG', 'Other Product')
-- match would be False.

-- Explicitly state the value to compare
Input.intent(domain: string, value: string)

-- Implicitly infer the value to compare from the last user message
Input.intent(domain: string)

-- Example the explicit way
-- We use generic-en domain for the intent.
intent = Input.intent('generic-en', 'hello!')

if intent.confidence.greeting > .025 then
  Debug.print("We understand you are doing a greeting intent")
else
  Debug.print("Not a greeting intent")
end

input = Input.getMessage()

Debug.print(input.message) -- Would send the latest user message to whatsapp.

profile = Input.getProfile()

Debug.print("Hello " .. profile.name .. " your phone is " .. profile.userId)

local email = "[email protected]"
Context.set("email", email)

email = Context.get("email")
Debug.print(email) -- Would send [email protected] to whatsapp

Context.delete("email") -- Would delete the value from the user context

Context.set("email", "[email protected]")

if Context.check("email") then
  Debug.print("Email exists in the Context")
end

-- Retrieving JSON string from the Context
-- and convert it back to a Lua table
-- Context (user) = '{"name":"Studio Core","email":"[email protected]"}'
userJsonString = Context.get("user")

-- Convert to Lua table using JSON (See JSON Documentation above)
user = JSON.decode(userJsonString)

-- This would send "Studio Core"
Debug.print(user.name)

address = "Studio Avenue 123"
Profile.set("address", address)

address = Profile.get("address")
Debug.print(address) -- Would send "Studio Avenue 123"

Profile.delete("address") -- Would delete the value from the user profile

Profile.set("addresss", "Studio Avenue 123")

if Profile.check("address") then
  Debug.print("Address exists in the Context")
end

sheetId = '61258430ca635768d3e07932'

-- This will send the latest user message as a question to the FAQs
-- table specified in the second argument.
result = FAQ.searchQuestion("What do you sell?", sheetId)

-- If the question has a single match 
if result.singleMatch then Workflow.branch(13) end

-- If there were mutliple questions matched
if result.multipleMatch then Workflow.branch(14) end

-- If there was no match for the question.
if result.noMatch then Workflow.branch(15) end

-- If multiple questions matched the question asked then a context variable
-- FAQsQuestions will be available which will contain all the matched questions
-- which can be displayed to the user using handlebars with the following snippet

-- Message (with handlebars)
{{#each FAQsQuestions}}
{{index}}) {{title}}
{{/each}}

-- On the Actions following that message you can check the user response with the 
-- index of the question he wants to see. Using the selectQuestion if the index is valid
-- it would set that question as the single match and you can display it to the user
-- in a another step message.
isValid = FAQ.selectQuestion(Context.get('userMessage'))

if isValid then Workflow.branch(13) end

-- Step 13 (Message)
Q: {{FAQsMatchQuestion}}
A: {{FAQsMatchAnswer}}

Location.stores(keyword: string, radius: number, placeType: string, address: string) -> LocationResult

LocationResult
{
  success: boolean -- True if there was something matched
  places: LocationDetail
}

LocationDetail
{
  address_components: AddressComponent[]
  adr_address: string
  business_status: string
  formatted_address: string
  formatted_phone_number: string
  geometry: Geometry
  icon: string
  international_phone_number: string
  name: string
  opening_hours: ExtendedBusinesHours[]
  photos: Photo[]
  place_id: string
  plus_code: Plus
  price_level: number
  rating: number
  reference: string
  reviews: Review[]
  types: PlaceType[]
  url: string
  user_ratings_total: number
  utc_offset: number
  vicinity: string
  website: string
}

AddressComponent
{
	long_name: string
  short_name: string
  types: string
}

ExtendedBusinessHours
{
	weekday_text: string[]
	periods {
	    close {
	        day: number
	        time: string
	    }
	    open {
	        day: number
	        time: string
	    }
	}
}

-- Explicitly state the address you want to nearby search
stores = Location.stores(keyword, radius, PlaceType, address)

-- Implicitly infer the address value from user's last message
stores = Location.stores(keyword, radius, PlaceType)

if stores.success then
  -- Storing the results in storesFound context
	Context.set("storesFound", stores.places)
else
	Debug.print("We did not find any location/store")
end

-- You can use handlebars in another step to display this information
-- Step Message
{{#each storesFound}}
📍{{name}}
🔗{{url}}
🗺️{{formatted_address}}
📞{{formatted_phone_number}}
{{/each}}

clean = String.cleanText(string)
-- e.g. "äDiós"
-- returns "aDios"

number = String.onlyNumbers(string)
-- e.g. "my age is 25"
-- returns "25"

-- e.g. "my age is 25 next friday the 20th"
-- returns "2520"

message = 'Apple iPhone 13 Pro Max'
words = String.split(message)

-- words = {'Apple', 'iPhone', '13', 'Pro', 'Max'}

message = 'Apple iPhone 13 Pro Max'
urlString = String.encodeURI(message)

-- urlString = Apple%20iPhone%2013%20Pro%20Max