{"openapi":"3.1.0","info":{"title":"SpotHopper API (Bowmark)","version":"e833508f87ff","description":"SpotHopper restaurant sites (tmt.spotapps.co): reservations, menus, online ordering, party and catering inquiries.\n\nEvery function Bowmark has for SpotHopper (spotapps.co) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/spotapps/findRestaurant":{"post":{"operationId":"findRestaurant","summary":"Finds a SpotHopper restaurant's spot_id from its own website (e.g.","description":"Finds a SpotHopper restaurant's spot_id from its own website (e.g. { url: \"barrelhousechicago.com\" }), and says when the site hands reservations to OpenTable (with the rid) instead of the SpotHopper widget.\n\nCalls `bowmark.providers.spotapps.findRestaurant`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsRestaurant>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsFindRestaurantArgs","description":"TypeScript: `SpotappsFindRestaurantArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/getReservationSettings":{"post":{"operationId":"getReservationSettings","summary":"Reads one restaurant's reservation widget settings: whether online reservations are on, party-size limits, time step, auto-confirm, deposit/cancellation-fee policy, time zone, and the bookable time sl","description":"Reads one restaurant's reservation widget settings: whether online reservations are on, party-size limits, time step, auto-confirm, deposit/cancellation-fee policy, time zone, and the bookable time slots per weekday and per upcoming date.\n\nCalls `bowmark.providers.spotapps.getReservationSettings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsReservationSettings>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsSpotArgs","description":"TypeScript: `SpotappsSpotArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/checkAvailability":{"post":{"operationId":"checkAvailability","summary":"Checks whether a restaurant has a table for a party size at a date and time, and returns the alternative times it offers when it does not.","description":"Checks whether a restaurant has a table for a party size at a date and time, and returns the alternative times it offers when it does not.\n\nCalls `bowmark.providers.spotapps.checkAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsCheckAvailabilityArgs","description":"TypeScript: `SpotappsCheckAvailabilityArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/getMenu":{"post":{"operationId":"getMenu","summary":"Reads a restaurant's menu as its contactless-menu page shows it: food and drink menus, sections, items, descriptions, stock and prices per size.","description":"Reads a restaurant's menu as its contactless-menu page shows it: food and drink menus, sections, items, descriptions, stock and prices per size.\n\nCalls `bowmark.providers.spotapps.getMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsMenuResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsSpotArgs","description":"TypeScript: `SpotappsSpotArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/getOnlineOrderMenu":{"post":{"operationId":"getOnlineOrderMenu","summary":"Reads a restaurant's online-ordering menu: orderable items with per-size ids and prices, modifiers, pickup/delivery availability, fees, lead times and pickup/delivery hours per weekday.","description":"Reads a restaurant's online-ordering menu: orderable items with per-size ids and prices, modifiers, pickup/delivery availability, fees, lead times and pickup/delivery hours per weekday.\n\nCalls `bowmark.providers.spotapps.getOnlineOrderMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsOnlineOrderMenu>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsSpotArgs","description":"TypeScript: `SpotappsSpotArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/getPrivatePartyOptions":{"post":{"operationId":"getPrivatePartyOptions","summary":"Reads a restaurant's private-party / event inquiry form: whether it's open, party-size limits, occasions, event spaces, and the bookable time slots per weekday and per upcoming date.","description":"Reads a restaurant's private-party / event inquiry form: whether it's open, party-size limits, occasions, event spaces, and the bookable time slots per weekday and per upcoming date.\n\nCalls `bowmark.providers.spotapps.getPrivatePartyOptions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsPrivatePartyOptions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsSpotArgs","description":"TypeScript: `SpotappsSpotArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/getCateringOptions":{"post":{"operationId":"getCateringOptions","summary":"Reads a restaurant's catering inquiry form: whether it's open, party-size limits, fulfilment types (pick-up, delivery, fully staffed), occasions, and the bookable time slots per weekday and per upcomi","description":"Reads a restaurant's catering inquiry form: whether it's open, party-size limits, fulfilment types (pick-up, delivery, fully staffed), occasions, and the bookable time slots per weekday and per upcoming date.\n\nCalls `bowmark.providers.spotapps.getCateringOptions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsCateringOptions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsSpotArgs","description":"TypeScript: `SpotappsSpotArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/bookReservation":{"post":{"operationId":"bookReservation","summary":"Sends a guest reservation request (name, email, phone, party size, date, time, notes) through the restaurant's widget; refuses to submit when the spot requires a deposit or cancellation-fee card, sinc","description":"Sends a guest reservation request (name, email, phone, party size, date, time, notes) through the restaurant's widget; refuses to submit when the spot requires a deposit or cancellation-fee card, since Bowmark does not take payment details.\n\nCalls `bowmark.providers.spotapps.bookReservation`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsReservationRequest>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsBookReservationArgs","description":"TypeScript: `SpotappsBookReservationArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/listJobs":{"post":{"operationId":"listJobs","summary":"Reads a restaurant's job-application form: whether it's hiring, the position titles the form lets a candidate choose, and the application instructions — SpotHopper publishes no per-posting detail beyo","description":"Reads a restaurant's job-application form: whether it's hiring, the position titles the form lets a candidate choose, and the application instructions — SpotHopper publishes no per-posting detail beyond this category list.\n\nCalls `bowmark.providers.spotapps.listJobs`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsJobListing>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsSpotArgs","description":"TypeScript: `SpotappsSpotArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/requestPrivateParty":{"post":{"operationId":"requestPrivateParty","summary":"Sends a private-party / group-event inquiry (date, time, guest count, occasion, budget, contact details) through the restaurant's widget — an inquiry the restaurant follows up on, not a confirmed book","description":"Sends a private-party / group-event inquiry (date, time, guest count, occasion, budget, contact details) through the restaurant's widget — an inquiry the restaurant follows up on, not a confirmed booking.\n\nCalls `bowmark.providers.spotapps.requestPrivateParty`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsInquiryRequest>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsPrivatePartyArgs","description":"TypeScript: `SpotappsPrivatePartyArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/requestCatering":{"post":{"operationId":"requestCatering","summary":"Sends a catering inquiry (date, time, guest count, fulfilment type, contact details) through the restaurant's widget — an inquiry the restaurant follows up on, not a paid order.","description":"Sends a catering inquiry (date, time, guest count, fulfilment type, contact details) through the restaurant's widget — an inquiry the restaurant follows up on, not a paid order.\n\nCalls `bowmark.providers.spotapps.requestCatering`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsInquiryRequest>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsCateringArgs","description":"TypeScript: `SpotappsCateringArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/applyForJob":{"post":{"operationId":"applyForJob","summary":"Submits a job application (name, email, phone, positions, cover letter, experience, resume link) through the restaurant's widget.","description":"Submits a job application (name, email, phone, positions, cover letter, experience, resume link) through the restaurant's widget.\n\nCalls `bowmark.providers.spotapps.applyForJob`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsJobApplication>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsApplyForJobArgs","description":"TypeScript: `SpotappsApplyForJobArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/joinMailingList":{"post":{"operationId":"joinMailingList","summary":"Signs an email (and optionally a phone, for texts) up for a restaurant's mailing list through its widget.","description":"Signs an email (and optionally a phone, for texts) up for a restaurant's mailing list through its widget.\n\nCalls `bowmark.providers.spotapps.joinMailingList`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsMailingListSignup>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsJoinMailingListArgs","description":"TypeScript: `SpotappsJoinMailingListArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/spotapps/startOnlineOrder":{"post":{"operationId":"startOnlineOrder","summary":"Starts a scheduled pickup order on a restaurant's online-ordering widget and stops at the payment step; refuses spots that take payment at pickup, where starting would place the order.","description":"Starts a scheduled pickup order on a restaurant's online-ordering widget and stops at the payment step; refuses spots that take payment at pickup, where starting would place the order.\n\nCalls `bowmark.providers.spotapps.startOnlineOrder`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpotappsOnlineOrderStart>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpotappsStartOnlineOrderArgs","description":"TypeScript: `SpotappsStartOnlineOrderArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"SpotappsApplyForJobArgs":{"type":"object","properties":{"spotId":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"positions":{"type":"array","items":{"type":"string"}},"coverLetter":{"type":"string"},"experience":{"type":"string"},"cvLink":{"type":"string"}},"required":["spotId","name","email","phone","positions"],"additionalProperties":true},"SpotappsBookReservationArgs":{"type":"object","properties":{"spotId":{"type":"string"},"date":{"type":"string"},"time":{"type":"string"},"partySize":{"type":"number"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"instructions":{"type":"string"},"space":{"type":"string"},"textingPermission":{"type":"boolean"}},"required":["spotId","date","time","partySize","firstName","lastName","email","phone"],"additionalProperties":true},"SpotappsCateringArgs":{"type":"object","properties":{"spotId":{"type":"string"},"date":{"type":"string"},"time":{"type":"string"},"partySize":{"type":"number"},"firstName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"occasion":{"type":"string"},"budget":{"anyOf":[{"type":"number"},{"type":"string"}]},"instructions":{"type":"string"},"textingPermission":{"type":"boolean"},"cateringType":{"type":"string"},"address":{"type":"string"}},"required":["spotId","date","time","partySize","firstName","email","phone"],"additionalProperties":true},"SpotappsCheckAvailabilityArgs":{"type":"object","properties":{"spotId":{"type":"string"},"partySize":{"type":"number"},"date":{"type":"string"},"time":{"type":"string"}},"required":["spotId","partySize","date","time"],"additionalProperties":true},"SpotappsFindRestaurantArgs":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":true},"SpotappsJoinMailingListArgs":{"type":"object","properties":{"spotId":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"textingPermission":{"type":"boolean"}},"required":["spotId","email"],"additionalProperties":true},"SpotappsPrivatePartyArgs":{"type":"object","properties":{"spotId":{"type":"string"},"date":{"type":"string"},"time":{"type":"string"},"partySize":{"type":"number"},"firstName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"occasion":{"type":"string"},"budget":{"anyOf":[{"type":"number"},{"type":"string"}]},"instructions":{"type":"string"},"textingPermission":{"type":"boolean"},"space":{"type":"string"}},"required":["spotId","date","time","partySize","firstName","email","phone"],"additionalProperties":true},"SpotappsSpotArgs":{"type":"object","properties":{"spotId":{"type":"string"}},"required":["spotId"],"additionalProperties":true},"SpotappsStartOnlineOrderArgs":{"type":"object","properties":{"spotId":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"uniqueId":{"type":"string"},"quantity":{"type":"number"}},"required":["uniqueId","quantity"],"additionalProperties":true}},"date":{"type":"string"},"time":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"instructions":{"type":"string"}},"required":["spotId","items","date","time","firstName","lastName","email","phone"],"additionalProperties":true}}}}