HomeMaster

List what HomeMaster sells in Singapore (home cleaning, aircon servicing), the options for each (cleaning visit lengths and how often; aircon jobs and unit counts) and their list prices in SGD, GST included. Call this first when you need the options. For an exact price with offers, use get_quote.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Check whether a service is available at a Singapore postal code, before looking for times. Coverage depends on which cleaners or technicians work near the address.

{
  "type": "object",
  "properties": {
    "postal_code": {
      "type": "string",
      "pattern": "^\\d{6}$",
      "description": "6-digit Singapore postal code, e.g. 238823."
    },
    "service": {
      "type": "string",
      "enum": [
        "cleaning",
        "aircon"
      ],
      "default": "cleaning",
      "description": "cleaning = home cleaning by the hour; aircon = aircon servicing, priced per job and number of units."
    }
  },
  "required": [
    "postal_code"
  ],
  "additionalProperties": false
}

Find real open dates, or start times on one date, for a booking at a postal code. Without `date`: the open dates in the next 14 days. With `date` only: that day's start times, each with its price. With `date` and `end_date`: the open dates in that range (at most 14 days). Times are not held here: the customer picks the time on the checkout page, which holds it for 7 minutes.

{
  "type": "object",
  "properties": {
    "postal_code": {
      "type": "string",
      "pattern": "^\\d{6}$",
      "description": "6-digit Singapore postal code, e.g. 238823."
    },
    "service": {
      "type": "string",
      "enum": [
        "cleaning",
        "aircon"
      ],
      "default": "cleaning",
      "description": "cleaning = home cleaning by the hour; aircon = aircon servicing, priced per job and number of units."
    },
    "hours": {
      "type": "number",
      "description": "Cleaning only: visit length in hours (see find_services for the lengths we sell, e.g. 2, 3 or 4)."
    },
    "frequency": {
      "type": "string",
      "enum": [
        "one-time",
        "weekly",
        "bi-weekly"
      ],
      "default": "one-time",
      "description": "Cleaning only: one-time, weekly, or bi-weekly (every 2 weeks)."
    },
    "job_type": {
      "type": "string",
      "description": "Aircon only: the job, e.g. general_service, chemical_wash, chemical_overhaul (see find_services)."
    },
    "unit_count": {
      "type": "integer",
      "minimum": 1,
      "description": "Aircon only: number of aircon units (fan coils)."
    },
    "date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "YYYY-MM-DD, Singapore date."
    },
    "end_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "YYYY-MM-DD. With date, return open dates in the range instead of times."
    }
  },
  "required": [
    "postal_code"
  ],
  "additionalProperties": false
}

Get the price the checkout will show a new customer, with any evening rate or public voucher it applies. Give `date` and `start_time` (from find_times) for the exact figure for that slot; without them you get the price for that length or job, and the evening rate is described separately. For weekly and every-2-weeks cleans it returns both the prepaid 3-visit pack (what the checkout starts on) and paying per visit.

{
  "type": "object",
  "properties": {
    "service": {
      "type": "string",
      "enum": [
        "cleaning",
        "aircon"
      ],
      "default": "cleaning",
      "description": "cleaning = home cleaning by the hour; aircon = aircon servicing, priced per job and number of units."
    },
    "hours": {
      "type": "number",
      "description": "Cleaning only: visit length in hours (see find_services for the lengths we sell, e.g. 2, 3 or 4)."
    },
    "frequency": {
      "type": "string",
      "enum": [
        "one-time",
        "weekly",
        "bi-weekly"
      ],
      "default": "one-time",
      "description": "Cleaning only: one-time, weekly, or bi-weekly (every 2 weeks)."
    },
    "job_type": {
      "type": "string",
      "description": "Aircon only: the job, e.g. general_service, chemical_wash, chemical_overhaul (see find_services)."
    },
    "unit_count": {
      "type": "integer",
      "minimum": 1,
      "description": "Aircon only: number of aircon units (fan coils)."
    },
    "date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "YYYY-MM-DD, Singapore date."
    },
    "start_time": {
      "type": "string",
      "description": "Start time from find_times, 24-hour HH:MM (e.g. 19:30) or like 7:30 PM."
    }
  },
  "additionalProperties": false
}

Get a link to HomeMaster's checkout with the address and the visit already filled in, to give to the customer. Nothing is booked or charged by this tool. On the page the customer picks the start time (it is held for 7 minutes), enters their name and phone, types the 6-digit code we send to their WhatsApp, and pays on our payment page. Never pay on the customer's behalf. To book it FOR the customer instead (home cleaning), use request_booking: they confirm with one tap on WhatsApp.

{
  "type": "object",
  "properties": {
    "postal_code": {
      "type": "string",
      "pattern": "^\\d{6}$",
      "description": "6-digit Singapore postal code, e.g. 238823."
    },
    "service": {
      "type": "string",
      "enum": [
        "cleaning",
        "aircon"
      ],
      "default": "cleaning",
      "description": "cleaning = home cleaning by the hour; aircon = aircon servicing, priced per job and number of units."
    },
    "hours": {
      "type": "number",
      "description": "Cleaning only: visit length in hours (see find_services for the lengths we sell, e.g. 2, 3 or 4)."
    },
    "frequency": {
      "type": "string",
      "enum": [
        "one-time",
        "weekly",
        "bi-weekly"
      ],
      "default": "one-time",
      "description": "Cleaning only: one-time, weekly, or bi-weekly (every 2 weeks)."
    }
  },
  "required": [
    "postal_code"
  ],
  "additionalProperties": false
}

Ask HomeMaster a question about its services and policies (what a clean includes, supplies, pets, cancelling or rescheduling, what to prepare). The answer comes only from HomeMaster's own service guide, the one Helen, our WhatsApp assistant, uses; `answered_from_guide` is false when the guide does not cover it. Slower than the other tools (up to about 20 seconds). Not for prices or times: use get_quote and find_times.

{
  "type": "object",
  "properties": {
    "question": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    }
  },
  "required": [
    "question"
  ],
  "additionalProperties": false
}

Ask HomeMaster to book a home clean for the customer. We send the customer Helen's booking card on WhatsApp, showing the date, their address, the clean and their price. Nothing is booked until the customer taps "Yes, book it" within 60 minutes; they then pay by the payment link Helen sends. The time is not held while they decide. Use a start time from find_times. Returns a reference: keep it and use booking_status to follow the request. Cleaning only; for aircon use start_booking. Ask the customer before sending: it messages their phone.

{
  "type": "object",
  "properties": {
    "postal_code": {
      "type": "string",
      "pattern": "^\\d{6}$",
      "description": "6-digit Singapore postal code, e.g. 238823."
    },
    "unit": {
      "type": "string",
      "description": "Floor and unit number, e.g. #05-12."
    },
    "date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "YYYY-MM-DD, Singapore date."
    },
    "start_time": {
      "type": "string",
      "pattern": "^\\d{2}:\\d{2}$",
      "description": "HH:MM in Singapore time, one of the start times from find_times."
    },
    "hours": {
      "type": "number",
      "description": "Cleaning only: visit length in hours (see find_services for the lengths we sell, e.g. 2, 3 or 4)."
    },
    "frequency": {
      "type": "string",
      "enum": [
        "one-time",
        "weekly",
        "bi-weekly"
      ],
      "default": "one-time",
      "description": "Cleaning only: one-time, weekly, or bi-weekly (every 2 weeks)."
    },
    "phone": {
      "type": "string",
      "description": "The customer's WhatsApp number, e.g. +6591234567."
    },
    "customer_name": {
      "type": "string",
      "maxLength": 60,
      "description": "Recommended: the customer's name, so their cleaning expert and receipt can greet them. Saved only once they confirm, and never over a name we already have."
    },
    "agent_name": {
      "type": "string",
      "maxLength": 30,
      "description": "Optional: your name as the customer knows you (letters, digits and spaces), shown on the card as \"<name> asked us to book this for you\"."
    }
  },
  "required": [
    "postal_code",
    "unit",
    "date",
    "start_time",
    "hours",
    "phone"
  ],
  "additionalProperties": false
}

Where a request_booking request stands: waiting for the customer on WhatsApp, declined, expired, awaiting payment (with the payment link), finding a cleaning expert, booked (with the next visit), done or cancelled. Never includes the customer's details. For changes, the customer messages Helen on WhatsApp.

{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "description": "The reference request_booking returned (starts with hmr_)."
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false
}