{"openapi":"3.1.0","info":{"title":"Punchpass API (Bowmark)","version":"e833508f87ff","description":"Punchpass studios (yoga, fitness, dance): find a studio, read its class schedule with spots left, series, appointment slots and passes, and book, cancel or waitlist as the signed-in customer.\n\nEvery function Bowmark has for Punchpass (punchpass.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/punchpass/getStudio":{"post":{"operationId":"getStudio","summary":"Gets one studio's public profile — name, org id, subdomain, own website, welcome text, address and which public sections it turns on (instructors page, appointment timeslots, series) — from its schedu","description":"Gets one studio's public profile — name, org id, subdomain, own website, welcome text, address and which public sections it turns on (instructors page, appointment timeslots, series) — from its schedule page; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.getStudio`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassStudio>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"}},"required":["studio"],"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/punchpass/listScheduleFilters":{"post":{"operationId":"listScheduleFilters","summary":"Lists what a studio's schedule can be filtered by — its courses (class types, with ids), locations (e.g.","description":"Lists what a studio's schedule can be filtered by — its courses (class types, with ids), locations (e.g. Studio, Online) and instructors (with ids) — the values getSchedule's filters take; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.listScheduleFilters`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassScheduleFilters>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"}},"required":["studio"],"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/punchpass/getSchedule":{"post":{"operationId":"getSchedule","summary":"Lists a studio's upcoming classes from a start date — class id, name, local start (and with UTC offset where the page names it), duration, instructor, location, online, canceled, free, spots left and ","description":"Lists a studio's upcoming classes from a start date — class id, name, local start (and with UTC offset where the page names it), duration, instructor, location, online, canceled, free, spots left and waitlist — filterable by course, location and instructor ids from listScheduleFilters, with `to` as an inclusive last day; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.getSchedule`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassSchedule>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"},"options":{"$ref":"#/components/schemas/PunchpassScheduleOptions","description":"TypeScript: `PunchpassScheduleOptions`"}},"required":["studio"],"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/punchpass/getClass":{"post":{"operationId":"getClass","summary":"Gets one class by the id getSchedule returned — title, instructor, date, time, duration, online or in-studio, full description, spots left, and whether booking needs a sign-in or is open to a name and","description":"Gets one class by the id getSchedule returned — title, instructor, date, time, duration, online or in-studio, full description, spots left, and whether booking needs a sign-in or is open to a name and email.\n\nCalls `bowmark.providers.punchpass.getClass`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassClass>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"},"classId":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["studio","classId"],"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/punchpass/listPasses":{"post":{"operationId":"listPasses","summary":"Lists the passes, class packs and memberships a studio sells — name, price, billing period for a membership, and the purchase door.","description":"Lists the passes, class packs and memberships a studio sells — name, price, billing period for a membership, and the purchase door. Read-only: buying one is money and is not offered; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.listPasses`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassPasses>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"}},"required":["studio"],"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/punchpass/listSeries":{"post":{"operationId":"listSeries","summary":"Lists a studio's upcoming multi-session series and workshops — id, title, instructor and date range, for getSeries — by walking the category page's groups; takes the studio as its <studio>.punchpass.c","description":"Lists a studio's upcoming multi-session series and workshops — id, title, instructor and date range, for getSeries — by walking the category page's groups; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.listSeries`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassSeriesSummary[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"}},"required":["studio"],"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/punchpass/getSeries":{"post":{"operationId":"getSeries","summary":"Gets one series by id — title, instructor, date range, full description, price, spots left and the class id of every session.","description":"Gets one series by id — title, instructor, date range, full description, price, spots left and the class id of every session.\n\nCalls `bowmark.providers.punchpass.getSeries`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassSeries>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"},"seriesId":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["studio","seriesId"],"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/punchpass/listInstructors":{"post":{"operationId":"listInstructors","summary":"Lists a studio's instructors — name, credentials and styles they teach, full bio and photo — from its instructors page, with `published: false` for a studio that does not publish one; takes the studio","description":"Lists a studio's instructors — name, credentials and styles they teach, full bio and photo — from its instructors page, with `published: false` for a studio that does not publish one; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.listInstructors`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassInstructors>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"}},"required":["studio"],"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/punchpass/listAppointmentSlots":{"post":{"operationId":"listAppointmentSlots","summary":"Lists a studio's bookable private-session and appointment times — class id, date, local start, length, provider, location and spots left — from its timeslot page, with `published: false` for a studio ","description":"Lists a studio's bookable private-session and appointment times — class id, date, local start, length, provider, location and spots left — from its timeslot page, with `published: false` for a studio that offers none; each slot books like a class; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.listAppointmentSlots`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassAppointmentSlots>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"}},"required":["studio"],"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/punchpass/getPass":{"post":{"operationId":"getPass","summary":"Gets one pass or membership's full terms by the id listPasses returned (kind is found when omitted) — name, description, price (per payment for a membership), expiry or billing period — from its purch","description":"Gets one pass or membership's full terms by the id listPasses returned (kind is found when omitted) — name, description, price (per payment for a membership), expiry or billing period — from its purchase page. Read-only: stops before the checkout form, buying is never offered.\n\nCalls `bowmark.providers.punchpass.getPass`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassPassDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"},"passId":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"kind":{"anyOf":[{"const":"pass"},{"const":"membership"}],"description":"TypeScript: `\"pass\" | \"membership\"`"}},"required":["studio","passId"],"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/punchpass/getCalendarFeed":{"post":{"operationId":"getCalendarFeed","summary":"Returns a studio's subscribable iCal feed url and its parsed events — every class and series from one month back to three months ahead in one call, with id, kind, local start and end, location and des","description":"Returns a studio's subscribable iCal feed url and its parsed events — every class and series from one month back to three months ahead in one call, with id, kind, local start and end, location and description — for a longer window than getSchedule; never returns the organizer's email or livestream join links; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.getCalendarFeed`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassCalendarFeed>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"}},"required":["studio"],"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/punchpass/getMyProfile":{"post":{"operationId":"getMyProfile","summary":"Gets the signed-in caller's own Punchpass account (needs the caller signed in): email and every visible field of the app.punchpass.com account form, keyed by the site's own field names.","description":"Gets the signed-in caller's own Punchpass account (needs the caller signed in): email and every visible field of the app.punchpass.com account form, keyed by the site's own field names. Never returns the password.\n\nCalls `bowmark.providers.punchpass.getMyProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/punchpass/listMyReservations":{"post":{"operationId":"listMyReservations","summary":"Lists the signed-in caller's upcoming reservations and waitlist entries at one studio (needs the caller signed in) — class id, name, local start, instructor, location, online — from the studio's membe","description":"Lists the signed-in caller's upcoming reservations and waitlist entries at one studio (needs the caller signed in) — class id, name, local start, instructor, location, online — from the studio's member reservations page; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.listMyReservations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassMemberList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["studio"],"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/punchpass/getMyClassHistory":{"post":{"operationId":"getMyClassHistory","summary":"Lists the classes the signed-in caller has attended at one studio (needs the caller signed in), with dates, from the studio's member history page; takes the studio as its <studio>.punchpass.com subdom","description":"Lists the classes the signed-in caller has attended at one studio (needs the caller signed in), with dates, from the studio's member history page; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.getMyClassHistory`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassMemberList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["studio"],"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/punchpass/listMyPasses":{"post":{"operationId":"listMyPasses","summary":"Lists the signed-in caller's passes and memberships at one studio (needs the caller signed in) from the studio's member memberships page, as rows of visible cell text plus links; takes the studio as i","description":"Lists the signed-in caller's passes and memberships at one studio (needs the caller signed in) from the studio's member memberships page, as rows of visible cell text plus links; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.listMyPasses`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassMemberRows>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["studio"],"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/punchpass/listMyChildren":{"post":{"operationId":"listMyChildren","summary":"Lists the children on the signed-in caller's family account at one studio (needs the caller signed in) from the studio's member children page, as rows of visible cell text plus links; takes the studio","description":"Lists the children on the signed-in caller's family account at one studio (needs the caller signed in) from the studio's member children page, as rows of visible cell text plus links; takes the studio as its <studio>.punchpass.com subdomain, a punchpass url, or its numeric org id.\n\nCalls `bowmark.providers.punchpass.listMyChildren`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PunchpassMemberRows>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"$ref":"#/components/schemas/PunchpassStudioArg","description":"TypeScript: `PunchpassStudioArg`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["studio"],"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/punchpass/signup":{"post":{"operationId":"signup","summary":"Makes a NEW Punchpass account with the person's own email and password, in a session.","description":"Makes a NEW Punchpass account with the person's own email and password, in a session. Pauses with `needs_code` / `needs_phone` whenever the site wants something only the person has; continue with `confirmSignup` in the same session. Ends `signed_up` with the login saved and the credentials in the person's secrets.\n\nCalls `bowmark.providers.punchpass.signup`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ status: \"needs_code\"; channel: \"email\" | \"sms\"; sentTo?: string } | { status: \"needs_phone\" } | { status: \"in_progress\"; retryAfterSeconds: number } | { status: \"signed_up\"; username: string; email: string; connection: string | null; twoFactor: \"enrolled\" | \"none\"; secrets: string[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"description":"TypeScript: `SignupInput`"}},"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/punchpass/confirmSignup":{"post":{"operationId":"confirmSignup","summary":"Continues the sign-up `signup` started in this session with the emailed or texted `code`, the email's verification `link`, or the person's `phone`.","description":"Continues the sign-up `signup` started in this session with the emailed or texted `code`, the email's verification `link`, or the person's `phone`.\n\nCalls `bowmark.providers.punchpass.confirmSignup`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ status: \"needs_code\"; channel: \"email\" | \"sms\"; sentTo?: string } | { status: \"needs_phone\" } | { status: \"in_progress\"; retryAfterSeconds: number } | { status: \"signed_up\"; username: string; email: string; connection: string | null; twoFactor: \"enrolled\" | \"none\"; secrets: string[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"description":"TypeScript: `SignupConfirmInput`"}},"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}}},"PunchpassScheduleOptions":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"courses":{"type":"array","items":{"type":"string"}},"locations":{"type":"array","items":{"type":"string"}},"instructors":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"PunchpassStudioArg":{"anyOf":[{"type":"string"},{"type":"number"}]}}}}