{"openapi":"3.1.0","info":{"title":"Spectrum API (Bowmark)","version":"e833508f87ff","description":"Spectrum (Charter) residential internet, mobile and cable TV: browse plans, check address availability, mobile coverage and deals, and channel lineups — all public on spectrum.com — and (signed in, on the separate spectrum.net account site) read billing/usage and manage the account.\n\nEvery function Bowmark has for Spectrum (spectrum.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/spectrum/listInternetPlans":{"post":{"operationId":"listInternetPlans","summary":"Every residential internet-only plan Spectrum advertises on spectrum.com/internet/plans — plan name, download speed and the advertised first-year monthly price, straight off the page's own comparison ","description":"Every residential internet-only plan Spectrum advertises on spectrum.com/internet/plans — plan name, download speed and the advertised first-year monthly price, straight off the page's own comparison table.\n\nCalls `bowmark.providers.spectrum.listInternetPlans`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumInternetPlan[]>`.","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/spectrum/listTvAddOns":{"post":{"operationId":"listTvAddOns","summary":"Every premium channel Spectrum TV sells as an add-on, read off spectrum.com/cable-tv/premium-channels (Paramount+ with Showtime, HBO Max, Starz & Starz Encore, Cinemax, The Movie Channel, MGM+) — name","description":"Every premium channel Spectrum TV sells as an add-on, read off spectrum.com/cable-tv/premium-channels (Paramount+ with Showtime, HBO Max, Starz & Starz Encore, Cinemax, The Movie Channel, MGM+) — name and the shows it features. monthlyPrice is null: the page sends a shopper to the cart for prices. The old /cable-tv/add-ons page (Sports View, Entertainment Pack +) was retired by Spectrum in November 2026 and now redirects to the TV landing page.\n\nCalls `bowmark.providers.spectrum.listTvAddOns`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumTvAddOn[]>`.","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/spectrum/getInternetPlanDetails":{"post":{"operationId":"getInternetPlanDetails","summary":"One Gig-tier internet plan's own detail page — download speed, connection type, included WiFi equipment and its stated retail value, who it's 'ideal for', and the Year 1 price (with the struck-through","description":"One Gig-tier internet plan's own detail page — download speed, connection type, included WiFi equipment and its stated retail value, who it's 'ideal for', and the Year 1 price (with the struck-through standard rate when shown). Takes the plan name as listInternetPlans/the page itself states it, e.g. \"Internet 1 Gig\" or \"1 Gig\". Covers Internet 1 Gig, 2 Gig and 7 Gig only — spectrum.com publishes no dedicated detail page for Internet 100 or Internet 500, which this function says plainly rather than guessing a URL.\n\nCalls `bowmark.providers.spectrum.getInternetPlanDetails`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumInternetPlanDetails>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planName":{"type":"string","description":"TypeScript: `string`"}},"required":["planName"],"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/spectrum/listTvPlans":{"post":{"operationId":"listTvPlans","summary":"Every Spectrum TV package on spectrum.com/cable-tv/plans — package name, the page's own channel-count claim (null for TV Latino, which states none), and the promotional/standard monthly price off the ","description":"Every Spectrum TV package on spectrum.com/cable-tv/plans — package name, the page's own channel-count claim (null for TV Latino, which states none), and the promotional/standard monthly price off the plan's own price table at /modals/cable-tv/spectrum-tv-plan-prices.\n\nCalls `bowmark.providers.spectrum.listTvPlans`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumTvPlan[]>`.","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/spectrum/listMobilePlans":{"post":{"operationId":"listMobilePlans","summary":"The three Spectrum Mobile \"Unlimited\" plans on spectrum.com/mobile/plans (Unlimited, Unlimited Plus, Unlimited Plus Premium) — plan name, description, the regular per-line price, any new-customer firs","description":"The three Spectrum Mobile \"Unlimited\" plans on spectrum.com/mobile/plans (Unlimited, Unlimited Plus, Unlimited Plus Premium) — plan name, description, the regular per-line price, any new-customer first-line intro price, and the plan's own highlights (hotspot allowance, international roaming caps). \"By the Gig\" has its own separate page and is not covered.\n\nCalls `bowmark.providers.spectrum.listMobilePlans`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumMobilePlan[]>`.","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/spectrum/getByTheGigPlan":{"post":{"operationId":"getByTheGigPlan","summary":"Spectrum Mobile's pay-per-gig \"By the Gig\" plan (the one listMobilePlans leaves out), read off the JSON-LD of spectrum.com/mobile/plans/data-by-the-gig — what the first GB costs per month, the price o","description":"Spectrum Mobile's pay-per-gig \"By the Gig\" plan (the one listMobilePlans leaves out), read off the JSON-LD of spectrum.com/mobile/plans/data-by-the-gig — what the first GB costs per month, the price of each GB after it and how many lines can share the data.\n\nCalls `bowmark.providers.spectrum.getByTheGigPlan`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumByTheGigPlan>`.","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/spectrum/listMobileDeals":{"post":{"operationId":"listMobileDeals","summary":"Current Spectrum Mobile device and line promotions on spectrum.com/mobile/mobile-deals — device, discount and the line/plan requirement to qualify.","description":"Current Spectrum Mobile device and line promotions on spectrum.com/mobile/mobile-deals — device, discount and the line/plan requirement to qualify.\n\nCalls `bowmark.providers.spectrum.listMobileDeals`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumMobileDeal[]>`.","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/spectrum/checkMobileCoverage":{"post":{"operationId":"checkMobileCoverage","summary":"Spectrum Mobile's network coverage at an address, city or ZIP, off the raster overlay spectrum.com/mobile/coverage-map renders (a third-party Cellmaps/GCellmap widget, embedded in the page's own Angul","description":"Spectrum Mobile's network coverage at an address, city or ZIP, off the raster overlay spectrum.com/mobile/coverage-map renders (a third-party Cellmaps/GCellmap widget, embedded in the page's own Angular SSR state). Geocodes `location` with Nominatim, then reads the single pixel of the widget's own 'Mobile Coverage' coverage tile at that point — `covered` is true when the tile's alpha there is >= 128; `rasterAlpha` is the raw [0,255] value for a caller who wants to judge how close a point sits to a coverage boundary. Takes the same free text a geocoder accepts: a street address, \"City, ST\", or a ZIP.\n\nCalls `bowmark.providers.spectrum.checkMobileCoverage`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumMobileCoverage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"TypeScript: `string`"}},"required":["location"],"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/spectrum/getBillingHistory":{"post":{"operationId":"getBillingHistory","summary":"The signed-in caller's Spectrum payment history (date, amount, status, payment type, confirmation number) and list of digital bill statements, read off spectrum.net's own account GraphQL.","description":"The signed-in caller's Spectrum payment history (date, amount, status, payment type, confirmation number) and list of digital bill statements, read off spectrum.net's own account GraphQL. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.getBillingHistory`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumBillingHistory>`.","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/spectrum/getAccountBalance":{"post":{"operationId":"getAccountBalance","summary":"The signed-in caller's current Spectrum bill: total amount due, due date, previous balance, payments made and unpaid balance, read off the newest statement on spectrum.net's own account GraphQL.","description":"The signed-in caller's current Spectrum bill: total amount due, due date, previous balance, payments made and unpaid balance, read off the newest statement on spectrum.net's own account GraphQL. Returns only the account number's last four digits. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.getAccountBalance`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumAccountBalance>`.","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/spectrum/getUsageSummary":{"post":{"operationId":"getUsageSummary","summary":"The signed-in caller's Spectrum Mobile usage for the current bill cycle: per line, data used, minutes and messages, with the plan name and cycle dates, read off spectrum.net's own account GraphQL.","description":"The signed-in caller's Spectrum Mobile usage for the current bill cycle: per line, data used, minutes and messages, with the plan name and cycle dates, read off spectrum.net's own account GraphQL. Mobile only — Spectrum Internet has no data cap and spectrum.net exposes no internet usage meter. Empty when the account has no mobile lines. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.getUsageSummary`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumUsageCycle[]>`.","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/spectrum/getChannelLineup":{"post":{"operationId":"getChannelLineup","summary":"The signed-in caller's Spectrum TV channel lineup for their own market: every channel's name, guide number, genres and logo, with whether the caller's package includes it, plus Spectrum's own lineup-c","description":"The signed-in caller's Spectrum TV channel lineup for their own market: every channel's name, guide number, genres and logo, with whether the caller's package includes it, plus Spectrum's own lineup-change notices. Read off spectrum.net's own account GraphQL. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.getChannelLineup`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumChannelLineup>`.","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/spectrum/scheduleServiceAppointment":{"post":{"operationId":"scheduleServiceAppointment","summary":"Book a Spectrum technician visit for the signed-in caller's internet (reason internetOut or internetSlow), through spectrum.net's own account GraphQL.","description":"Book a Spectrum technician visit for the signed-in caller's internet (reason internetOut or internetSlow), through spectrum.net's own account GraphQL. Call it with only a reason to get the open appointment windows (nothing is booked), then again with a window's scheduleDate and scheduleTimeCode to book that visit; returns the appointment id, time and whether it can be rescheduled or cancelled. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.scheduleServiceAppointment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumServiceAppointment>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpectrumScheduleAppointmentArgs","description":"TypeScript: `SpectrumScheduleAppointmentArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/spectrum/updateWifiNetwork":{"post":{"operationId":"updateWifiNetwork","summary":"Change the signed-in caller's Spectrum home WiFi network name and password in one step, on every band, through spectrum.net's own account GraphQL (the same call its \"Change WiFi name and password\" for","description":"Change the signed-in caller's Spectrum home WiFi network name and password in one step, on every band, through spectrum.net's own account GraphQL (the same call its \"Change WiFi name and password\" form makes). Picks the account's router when it has exactly one; otherwise pass equipmentId from getEquipmentStatus. Devices on the old network drop off until reconnected. Never returns the password. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.updateWifiNetwork`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumWifiUpdate>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpectrumUpdateWifiArgs","description":"TypeScript: `SpectrumUpdateWifiArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/spectrum/getOutageStatus":{"post":{"operationId":"getOutageStatus","summary":"Is Spectrum down where I live?","description":"Is Spectrum down where I live? Every open outage or maintenance event on the signed-in caller's Spectrum account — which services it hits, when it started, the estimated restoration time and whether a credit applies — read off spectrum.net's own account GraphQL (the same call as its outage banner). An empty list means Spectrum knows of no outage at the caller's address. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.getOutageStatus`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumOutage[]>`.","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/spectrum/restartEquipment":{"post":{"operationId":"restartEquipment","summary":"Restart the signed-in caller's Spectrum modem (or another device, by equipmentId from getEquipmentStatus) remotely, through spectrum.net's own account GraphQL — the same call as its \"Restart modem\" tr","description":"Restart the signed-in caller's Spectrum modem (or another device, by equipmentId from getEquipmentStatus) remotely, through spectrum.net's own account GraphQL — the same call as its \"Restart modem\" troubleshooting step. The connection drops for a few minutes while it reboots; returns roughly how long until it is back. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.restartEquipment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumEquipmentRestart>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpectrumRestartEquipmentArgs","description":"TypeScript: `SpectrumRestartEquipmentArgs`"},"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/spectrum/listServiceAppointments":{"post":{"operationId":"listServiceAppointments","summary":"The signed-in caller's Spectrum technician visits — upcoming and recent — with each one's time window, status, reason, whether it can still be cancelled or rescheduled, and the live technician-trackin","description":"The signed-in caller's Spectrum technician visits — upcoming and recent — with each one's time window, status, reason, whether it can still be cancelled or rescheduled, and the live technician-tracking link when there is one, read off spectrum.net's own account GraphQL. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.listServiceAppointments`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumAppointmentListing[]>`.","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/spectrum/rescheduleServiceAppointment":{"post":{"operationId":"rescheduleServiceAppointment","summary":"Move one of the signed-in caller's Spectrum technician visits to another window, through spectrum.net's own account GraphQL — the same calls as its \"Reschedule appointment\" flow.","description":"Move one of the signed-in caller's Spectrum technician visits to another window, through spectrum.net's own account GraphQL — the same calls as its \"Reschedule appointment\" flow. Pass only the appointmentId (from listServiceAppointments) to list the open windows; pass a window's scheduleDate and scheduleTimeCode as well to move the visit. Only a visit listServiceAppointments marks rescheduleAllowed can be moved. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.rescheduleServiceAppointment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumAppointmentReschedule>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpectrumRescheduleAppointmentArgs","description":"TypeScript: `SpectrumRescheduleAppointmentArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/spectrum/cancelServiceAppointment":{"post":{"operationId":"cancelServiceAppointment","summary":"Cancel one of the signed-in caller's Spectrum technician visits, by the appointmentId listServiceAppointments returns, through spectrum.net's own account GraphQL — the same call as its \"Cancel appoint","description":"Cancel one of the signed-in caller's Spectrum technician visits, by the appointmentId listServiceAppointments returns, through spectrum.net's own account GraphQL — the same call as its \"Cancel appointment\" button. Only a visit listServiceAppointments marks cancelAllowed can be cancelled. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.cancelServiceAppointment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumAppointmentCancellation>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SpectrumCancelAppointmentArgs","description":"TypeScript: `SpectrumCancelAppointmentArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/spectrum/getEquipmentStatus":{"post":{"operationId":"getEquipmentStatus","summary":"The signed-in caller's Spectrum equipment (modem, router, WiFi pods, TV boxes) with each device's connection state, model, ownership and firmware, plus the WiFi network names the router broadcasts (ne","description":"The signed-in caller's Spectrum equipment (modem, router, WiFi pods, TV boxes) with each device's connection state, model, ownership and firmware, plus the WiFi network names the router broadcasts (never the passwords) and pod backhaul health, read off spectrum.net's own account GraphQL. Needs the caller signed in to spectrum.net.\n\nCalls `bowmark.providers.spectrum.getEquipmentStatus`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SpectrumEquipment[]>`.","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"}}}}}}}},"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}}},"SpectrumCancelAppointmentArgs":{"type":"object","properties":{"appointmentId":{"type":"string"}},"required":["appointmentId"],"additionalProperties":true},"SpectrumRescheduleAppointmentArgs":{"type":"object","properties":{"appointmentId":{"type":"string"},"scheduleDate":{"type":"string"},"scheduleTimeCode":{"type":"string"},"scheduleTime":{"type":"string"}},"required":["appointmentId"],"additionalProperties":true},"SpectrumRestartEquipmentArgs":{"type":"object","properties":{"equipmentId":{"type":"string"}},"additionalProperties":true},"SpectrumScheduleAppointmentArgs":{"type":"object","properties":{"reason":{"anyOf":[{"const":"internetOut"},{"const":"internetSlow"}]},"scheduleDate":{"type":"string"},"scheduleTimeCode":{"type":"string"}},"required":["reason"],"additionalProperties":true},"SpectrumUpdateWifiArgs":{"type":"object","properties":{"ssid":{"type":"string"},"password":{"type":"string"},"equipmentId":{"type":"string"}},"required":["ssid","password"],"additionalProperties":true}}}}