{"openapi":"3.1.0","info":{"title":"WellnessLiving API (Bowmark)","version":"e833508f87ff","description":"WellnessLiving fitness/wellness studio platform (schedules, classes, locations across many studio brands): read studio and class schedule info, and (signed in) book, waitlist, cancel and manage a customer's account.\n\nEvery function Bowmark has for WellnessLiving (wellnessliving.com) 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/wellnessliving/listKnownBusinesses":{"post":{"operationId":"listKnownBusinesses","summary":"Lists the WellnessLiving businesses this provider already has a confirmed, working scheduleUrl for — the entry point for a caller who only knows a studio's NAME.","description":"Lists the WellnessLiving businesses this provider already has a confirmed, working scheduleUrl for — the entry point for a caller who only knows a studio's NAME. Pass the returned `scheduleUrl` to `listLocations`. WellnessLiving publishes no searchable cross-business directory, so this is the intake's own list, not a site-wide search.\n\nCalls `bowmark.providers.wellnessliving.listKnownBusinesses`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingKnownBusiness[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"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/wellnessliving/listLocations":{"post":{"operationId":"listLocations","summary":"Lists every studio location under the business a WellnessLiving schedule URL belongs to — address, phone, email, lat/lng and timezone for each.","description":"Lists every studio location under the business a WellnessLiving schedule URL belongs to — address, phone, email, lat/lng and timezone for each. Pass the business's own `wellnessliving.com/rs/schedule/<slug>?k_business=<id>` page (what a studio's custom domain redirects to, or embeds as an iframe) — `listKnownBusinesses` has it for a studio whose name you already know. An empty array is a real business with no locations on file.\n\nCalls `bowmark.providers.wellnessliving.listLocations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingLocation[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingListLocationsArgs","description":"TypeScript: `WellnesslivingListLocationsArgs`"}},"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/wellnessliving/getLocationDetails":{"post":{"operationId":"getLocationDetails","summary":"Reads one studio location — address, phone, email, lat/lng and timezone — by the id `listLocations` returned.","description":"Reads one studio location — address, phone, email, lat/lng and timezone — by the id `listLocations` returned. WellnessLiving's public location record carries no opening hours or amenities. An unknown id throws, naming the ids that do exist.\n\nCalls `bowmark.providers.wellnessliving.getLocationDetails`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingLocation>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingGetLocationDetailsArgs","description":"TypeScript: `WellnesslivingGetLocationDetailsArgs`"}},"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/wellnessliving/listScheduleClasses":{"post":{"operationId":"listScheduleClasses","summary":"Lists the class sessions on a business's public schedule for the week it opens on (today onward, ~7 days) — title, local and UTC start, duration, instructor ids, booked vs capacity, waitlist, and the ","description":"Lists the class sessions on a business's public schedule for the week it opens on (today onward, ~7 days) — title, local and UTC start, duration, instructor ids, booked vs capacity, waitlist, and the `bookUrl` a signed-in customer books through. Optional `locationId` narrows to one studio.\n\nCalls `bowmark.providers.wellnessliving.listScheduleClasses`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingClassSession[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingListScheduleClassesArgs","description":"TypeScript: `WellnesslivingListScheduleClassesArgs`"}},"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/wellnessliving/searchClasses":{"post":{"operationId":"searchClasses","summary":"Searches this week's class sessions on a business's public schedule by any of: text in the title or description (`query`), an instructor id from `getInstructors` (`staffId`), a location id (`locationI","description":"Searches this week's class sessions on a business's public schedule by any of: text in the title or description (`query`), an instructor id from `getInstructors` (`staffId`), a location id (`locationId`), or a local date `YYYY-MM-DD` (`date`). Same one-week window as `listScheduleClasses`; at least one filter is required.\n\nCalls `bowmark.providers.wellnessliving.searchClasses`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingClassSession[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingSearchClassesArgs","description":"TypeScript: `WellnesslivingSearchClassesArgs`"}},"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/wellnessliving/getLocationInfo":{"post":{"operationId":"getLocationInfo","summary":"Reads a studio location's contact and general info: the location record (address, phone, email, timezone) joined with the business's own name, reply-to email, website, booking/catalog/sign-up/review l","description":"Reads a studio location's contact and general info: the location record (address, phone, email, timezone) joined with the business's own name, reply-to email, website, booking/catalog/sign-up/review links, logo, social profiles and which services it offers. `hours` is always null — WellnessLiving's public pages publish no opening hours.\n\nCalls `bowmark.providers.wellnessliving.getLocationInfo`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingLocationInfo>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingGetLocationDetailsArgs","description":"TypeScript: `WellnesslivingGetLocationDetailsArgs`"}},"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/wellnessliving/getLocationSchedule":{"post":{"operationId":"getLocationSchedule","summary":"Reads one studio location's class schedule for the week the business's schedule page opens on (today onward, ~7 days), grouped by local date in time order — each day's sessions carry the same fields a","description":"Reads one studio location's class schedule for the week the business's schedule page opens on (today onward, ~7 days), grouped by local date in time order — each day's sessions carry the same fields as `listScheduleClasses`. Pass a `locationId` from `listLocations`; an empty `days` is a real week with nothing scheduled there.\n\nCalls `bowmark.providers.wellnessliving.getLocationSchedule`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingLocationSchedule>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingGetLocationScheduleArgs","description":"TypeScript: `WellnesslivingGetLocationScheduleArgs`"}},"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/wellnessliving/getInstructors":{"post":{"operationId":"getInstructors","summary":"Lists every staff member on file for a business's schedule page — name, image, position, and whether they teach classes, take appointments or run events.","description":"Lists every staff member on file for a business's schedule page — name, image, position, and whether they teach classes, take appointments or run events. This is the whole roster, not filtered to instructors currently teaching a class; cross-reference `listScheduleClasses`'s `staffIds` to find who teaches what this week.\n\nCalls `bowmark.providers.wellnessliving.getInstructors`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingInstructor[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingListLocationsArgs","description":"TypeScript: `WellnesslivingListLocationsArgs`"}},"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/wellnessliving/getClassTypes":{"post":{"operationId":"getClassTypes","summary":"Lists the class TYPES in a business's catalogue — the class a scheduled session belongs to, not a session itself — with its active/event flags.","description":"Lists the class TYPES in a business's catalogue — the class a scheduled session belongs to, not a session itself — with its active/event flags. Cross-reference `listScheduleClasses`'s `title` to find which sessions this week belong to which type.\n\nCalls `bowmark.providers.wellnessliving.getClassTypes`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingClassType[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingListLocationsArgs","description":"TypeScript: `WellnesslivingListLocationsArgs`"}},"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/wellnessliving/getClassDetails":{"post":{"operationId":"getClassDetails","summary":"Reads full detail for one scheduled class session — description, duration, price, room, image, tags and assigned instructors — by the `classPeriodId` a session from `listScheduleClasses` returns.","description":"Reads full detail for one scheduled class session — description, duration, price, room, image, tags and assigned instructors — by the `classPeriodId` a session from `listScheduleClasses` returns. Only covers the week the schedule page opens on (the same window `listScheduleClasses` returns); an unknown classPeriodId throws, naming the ids that are currently visible.\n\nCalls `bowmark.providers.wellnessliving.getClassDetails`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingClassDetails>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingGetClassDetailsArgs","description":"TypeScript: `WellnesslivingGetClassDetailsArgs`"}},"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/wellnessliving/getClassCapacity":{"post":{"operationId":"getClassCapacity","summary":"Reads booked, capacity and waitlist counts for one scheduled class session, by the `classPeriodId` a session from `listScheduleClasses` returns.","description":"Reads booked, capacity and waitlist counts for one scheduled class session, by the `classPeriodId` a session from `listScheduleClasses` returns. Same door and the same one-week window as `getClassDetails`; an unknown classPeriodId throws the same way.\n\nCalls `bowmark.providers.wellnessliving.getClassCapacity`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<WellnesslivingClassCapacity>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/WellnesslivingGetClassDetailsArgs","description":"TypeScript: `WellnesslivingGetClassDetailsArgs`"}},"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}}},"WellnesslivingGetClassDetailsArgs":{"type":"object","properties":{"scheduleUrl":{"type":"string"},"classPeriodId":{"type":"string"}},"required":["scheduleUrl","classPeriodId"],"additionalProperties":true},"WellnesslivingGetLocationDetailsArgs":{"type":"object","properties":{"scheduleUrl":{"type":"string"},"locationId":{"type":"string"}},"required":["scheduleUrl","locationId"],"additionalProperties":true},"WellnesslivingGetLocationScheduleArgs":{"type":"object","properties":{"scheduleUrl":{"type":"string"},"locationId":{"type":"string"}},"required":["scheduleUrl","locationId"],"additionalProperties":true},"WellnesslivingListLocationsArgs":{"type":"object","properties":{"scheduleUrl":{"type":"string"}},"required":["scheduleUrl"],"additionalProperties":true},"WellnesslivingListScheduleClassesArgs":{"type":"object","properties":{"scheduleUrl":{"type":"string"},"locationId":{"type":"string"}},"required":["scheduleUrl"],"additionalProperties":true},"WellnesslivingSearchClassesArgs":{"type":"object","properties":{"scheduleUrl":{"type":"string"},"query":{"type":"string"},"staffId":{"type":"string"},"locationId":{"type":"string"},"date":{"type":"string"}},"required":["scheduleUrl"],"additionalProperties":true}}}}